+
-
-
-
+
+
$phone
+
@@ -1005,19 +1023,18 @@ at leat 1 special char
-
+
public
- string
+ string|null
$phone
-
-
-
+
+
$postcode
+
@@ -1040,19 +1058,18 @@ at leat 1 special char
-
+
public
- string
+ string|null
$postcode
The account city postcode
-
-
-
+
+
$status
+
@@ -1075,7 +1093,7 @@ at leat 1 special char
-
+
public
bool
@@ -1085,9 +1103,8 @@ at leat 1 special char
true if the account is activated
-
-
-
+
+
$invisibleFields
+
@@ -1119,9 +1137,9 @@ the should not be visible
$invisibleFields
= ['password']
-
-
-
+
+
+
$modelFields
+
@@ -1152,9 +1171,9 @@ the should not be visible
$modelFields
= ['hashcode', 'email', 'firstname', 'password', 'lastname', 'birth_date', 'phone', 'address', 'address2', 'city', 'postcode', 'country', 'opt_in', 'status', 'last_connection']
-
-
-
+
+
+
$validation
+
@@ -1185,9 +1205,9 @@ the should not be visible
$validation
= ['hashcode' => 'required|uuid', 'email' => 'required|email', 'firstname' => 'required|string|min:1|max:255', 'lastname' => 'required|string|min:1|max:255', 'password' => 'required|min:8|max:255|mixedCase|containDigit|containSymbol', 'birth_date' => 'required|date_format:Y-m-d', 'phone' => 'sometimes|nullable|string|max:255', 'address' => 'sometimes|string|max:255', 'address2' => 'sometimes|string|max:255', 'city' => 'sometimes|string|min:2|max:255', 'postcode' => 'sometimes|string|max:255', 'country' => ['sometimes'], 'opt_in' => 'required|bool', 'status' => 'required|bool', 'last_connection' => 'sometimes|date']
-
-
-
+
+
+
$address
+
@@ -1214,7 +1235,7 @@ the should not be visible
private
- string
+ string|null
$address
= null
@@ -1224,8 +1245,8 @@ Max length 255
Field Type varchar
-
-
+
+
$address2
+
@@ -1252,7 +1274,7 @@ Field Type varchar
private
- string
+ string|null
$address2
= null
@@ -1262,8 +1284,8 @@ Max length 255
Field Type varchar
-
-
+
+
$birth_date
+
@@ -1290,7 +1313,7 @@ Field Type varchar
private
- string
+ string|null
$birth_date
= null
@@ -1299,8 +1322,8 @@ Field Type varchar
Field Type Date
-
-
+
+
$city
+
@@ -1327,7 +1351,7 @@ Field Type Date
private
- string
+ string|null
$city
= null
@@ -1337,8 +1361,8 @@ Max length 255
Field Type varchar
-
-
+
+
$country
+
@@ -1374,8 +1399,8 @@ Field Type varchar
Field Type tinyInt
-
-
+
+
$email
+
@@ -1402,7 +1428,7 @@ Field Type tinyInt
private
- string
+ string|null
$email
= null
@@ -1413,8 +1439,8 @@ Max length 255
Field Type varchar
-
-
+
+
$firstname
+
@@ -1441,7 +1468,7 @@ Field Type varchar
private
- string
+ string|null
$firstname
= null
@@ -1451,8 +1478,8 @@ Max length 255
Field Type varchar
-
-
+
+
$hashcode
+
@@ -1480,9 +1508,9 @@ It is used to identify the customer itself.
private
- string
+ string|null
$hashcode
-
+ = null
Validate: UUID, in customer_infos
Required
@@ -1491,8 +1519,8 @@ Max length 36
Field Type varchar
-
-
+
+
$last_connection
+
@@ -1519,15 +1548,15 @@ Field Type varchar
private
- string
+ string|null
$last_connection
= null
-
-
+
+
$lastname
+
@@ -1554,7 +1584,7 @@ Field Type varchar
private
- string
+ string|null
$lastname
= null
@@ -1564,8 +1594,8 @@ Max length 255
Field Type varchar
-
-
+
+
$opt_in
+
@@ -1601,8 +1632,8 @@ Field Type varchar
Field Type TinyInt
-
-
+
+
$password
+
@@ -1631,7 +1663,7 @@ Otherwise it has to be set to null
private
- string
+ string|null
$password
= null
@@ -1641,8 +1673,8 @@ Max length 255
Field Type varchar
-
-
+
+
$phone
+
@@ -1669,7 +1702,7 @@ Field Type varchar
private
- string
+ string|null
$phone
= null
@@ -1680,8 +1713,8 @@ Max length 255
Field Type varchar
-
-
+
+
$postcode
+
@@ -1708,7 +1742,7 @@ Field Type varchar
private
- string
+ string|null
$postcode
= null
@@ -1719,8 +1753,8 @@ Max length 255
Field Type varchar
-
-
+
+
$status
+
@@ -1754,8 +1789,8 @@ Field Type varchar
-
-
+
+
@@ -1764,6 +1799,7 @@ Field Type varchar
__construct()
+
@@ -1786,9 +1823,11 @@ Field Type varchar
public
- __construct([array<string|int, mixed> $properties = [] ]) : mixed
-
+ __construct([array<string|int, mixed> $properties = [] ]) : mixed
+
+
+
Parameters
-
@@ -1796,14 +1835,15 @@ Field Type varchar
: array<string|int, mixed>
= []
-
-
+
-
+
-
@@ -1811,18 +1851,14 @@ Field Type varchar
-
ValidationException
-
+
If a field could not be validated.
-
-
- Return values
- mixed
- —
-
+
+
__get()
+
@@ -1845,9 +1882,11 @@ Field Type varchar
public
- __get(string $field) : mixed|null
-
+ __get(string $field) : mixed|null
+
+
+
Parameters
-
@@ -1855,18 +1894,20 @@ Field Type varchar
: string
-
-
+
+
-
+
Return values
- mixed|null
- —
- Returns null if the property was not found any way.
+ mixed|null
+ —
+ Returns null if the property was not found any way.
+
__set()
+
@@ -1890,9 +1932,11 @@ Field Type varchar
public
- __set(string $field, mixed $value) : void
-
+ __set(string $field, mixed $value) : void
+
+
+
Parameters
-
@@ -1900,21 +1944,22 @@ Field Type varchar
: string
-
-
+
-
$value
: mixed
-
-
+
-
+
-
@@ -1922,7 +1967,7 @@ Field Type varchar
-
ValidationException
-
+
If a field could not be validated.
@@ -1932,18 +1977,14 @@ Field Type varchar
-
AccessError
-
+
If trying to set a value on a unknown property.
-
-
- Return values
- void
- —
-
+
+
activate()
+
@@ -1966,14 +2008,17 @@ Field Type varchar
public
- activate() : bool
-
-
-
+ activate() : bool
+
+
+
+
+
-
@@ -1981,7 +2026,7 @@ Field Type varchar
-
ValidationException
-
+
If a customer's hashcode could not be validated.
@@ -1991,7 +2036,7 @@ Field Type varchar
-
CrmException
-
+
If an error occurs on server side or on getting response.
@@ -2001,7 +2046,7 @@ Field Type varchar
-
ApiErrorException
-
+
If any error or \LDC\LDCCRM\Enums\ApiError occurs.
Possibles are : - modelNotFound, If this customer hashcode could not be found.
- customerAlreadyActive, It the customer is already activated.
@@ -2012,19 +2057,21 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
phpcs:ignore
-
-
+
Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
-
+
+
Return values
- bool
- —
- true if succeeded
+ bool
+ —
+
+
delete()
+
@@ -2048,14 +2096,17 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
public
- delete() : bool
-
-
-
+ delete() : bool
+
+
+
+
+
-
@@ -2063,7 +2114,7 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
ValidationException
-
+
If a field could not be validated.
@@ -2073,7 +2124,7 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
CrmException
-
+
If an error occurs on server side or on getting response.
@@ -2083,7 +2134,7 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
ApiErrorException
-
+
If any error or \LDC\LDCCRM\Enums\ApiError occurs.
Possibles are : - modelNotFound, If this customer hashcode could not be found.
@@ -2093,19 +2144,21 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.phpcs:ignore
-
-
+
Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
-
+
+
Return values
- bool
- —
- true if succeeded
+ bool
+ —
+
+
fill()
+
@@ -2129,9 +2183,11 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
public
- fill(array<string|int, mixed> $properties) : void
-
+ fill(array<string|int, mixed> $properties) : void
+
+
+
Parameters
-
@@ -2139,14 +2195,15 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.array<string|int, mixed>
-
-
+
-
+
-
@@ -2154,18 +2211,14 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
ValidationException
-
+
If a field could not be validated.
-
-
- Return values
- void
- —
-
+
+
find()
+
@@ -2188,9 +2242,11 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
public
- static find(string $hashcode) : self|null
-
+ static find(string $hashcode) : self|null
+
+
+
Parameters
-
@@ -2198,14 +2254,15 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.string
-
-
+
-
+
-
@@ -2213,7 +2270,7 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
CrmException
-
+
If an error occurs on server side or on getting response.
@@ -2223,7 +2280,7 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
ApiErrorException
-
+
If any error or \LDC\LDCCRM\Enums\ApiError occurs.
@@ -2232,19 +2289,21 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.phpcs:ignore
-
-
+
Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
-
+
+
Return values
- self|null
- —
- Return null if the customer was not found
+ self|null
+ —
+ Return null if the customer was not found
+
findWithEmail()
+
@@ -2269,9 +2329,11 @@ This is an alias of Customer::find()
public
- static findWithEmail(string $email) : self|null
-
+ static findWithEmail(string $email) : self|null
+
+
+
Parameters
-
@@ -2279,14 +2341,15 @@ This is an alias of Customer::find()
: string
-
-
+
-
+
-
@@ -2294,7 +2357,7 @@ This is an alias of Customer::find()
-
CrmException
-
+
If an error occurs on server side or on getting response.
@@ -2304,7 +2367,7 @@ This is an alias of Customer::find()
-
ApiErrorException
-
+
If any error or \LDC\LDCCRM\Enums\ApiError occurs.
@@ -2313,17 +2376,17 @@ This is an alias of Customer::find()
phpcs:ignore
-
-
+
Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
-
+
+
Return values
- self|null
- —
-
+ self|null
+
jsonSerialize()
+
@@ -2347,16 +2411,18 @@ This is an alias of Customer::find()
public
- jsonSerialize() : array<string|int, mixed>
-
-
-
+ jsonSerialize() : array<string|int, mixed>
+
+
+
+
+
+
Return values
- array<string|int, mixed>
- —
-
+ array<string|int, mixed>
+
login()
+
@@ -2380,9 +2447,11 @@ This is an alias of Customer::find()
public
- static login(string $email, string $password) : bool
-
+ static login(string $email, string $password) : bool
+
+
+
Parameters
-
@@ -2390,21 +2459,22 @@ This is an alias of Customer::find()
: string
-
-
+
-
$password
: string
-
-
+
-
+
-
@@ -2412,7 +2482,7 @@ This is an alias of Customer::find()
-
ValidationException
-
+
If a customer's email could not be validated.
@@ -2422,7 +2492,7 @@ This is an alias of Customer::find()
-
CrmException
-
+
If an error occurs on server side or on getting response.
@@ -2432,7 +2502,7 @@ This is an alias of Customer::find()
-
ApiErrorException
-
+
If any error or \LDC\LDCCRM\Enums\ApiError occurs.
Possibles are : - authFailed, If credentials are not valid.
- customerNotActivated, If the account is not activated.
@@ -2443,17 +2513,17 @@ Possibles are : - authFailed, If credentials are not valid.
phpcs:ignore
-
-
+
Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
-
+
+
Return values
- bool
- —
-
+ bool
+
save()
+
@@ -2477,14 +2548,17 @@ Possibles are : - authFailed, If credentials are not valid.
public
- save() : bool
-
-
-
+ save() : bool
+
+
+
+
+
-
@@ -2492,7 +2566,7 @@ Possibles are : - authFailed, If credentials are not valid.
-
ValidationException
-
+
If a field could not be validated.
@@ -2502,7 +2576,7 @@ Possibles are : - authFailed, If credentials are not valid.
-
CrmException
-
+
If an error occurs on server side or on getting response.
@@ -2512,7 +2586,7 @@ Possibles are : - authFailed, If credentials are not valid.
-
ApiErrorException
-
+
If any error or \LDC\LDCCRM\Enums\ApiError occurs.
Possibles are : - validationFailed, If provided data is wrong(CRM side).
- modelNotFound, If this customer hashcode could not be found (new customers only).
@@ -2523,19 +2597,21 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
phpcs:ignore
-
-
+
Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
-
+
+
Return values
- bool
- —
- True if save was successfull.
+ bool
+ —
+ True if save was successfull.
+
toggleOptin()
+
@@ -2559,14 +2636,17 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
public
- toggleOptin() : bool
-
-
-
+ toggleOptin() : bool
+
+
+
+
+
-
@@ -2574,7 +2654,7 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
-
ValidationException
-
+
If a field could not be validated.
@@ -2584,7 +2664,7 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
-
CrmException
-
+
If an error occurs on server side or on getting response.
@@ -2594,7 +2674,7 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
-
ApiErrorException
-
+
If any error or \LDC\LDCCRM\Enums\ApiError occurs.
Possibles are : - modelNotFound, If this customer hashcode could not be found.
@@ -2604,19 +2684,21 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.phpcs:ignore
-
-
+
Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
-
+
+
Return values
- bool
- —
- true if succeeded
+ bool
+ —
+
+
validateAllValues()
+
@@ -2640,9 +2723,11 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
protected
- validateAllValues([array<string|int, mixed> $ignore = [] ]) : array<string|int, mixed>
-
+ validateAllValues([array<string|int, mixed> $ignore = [] ]) : array<string|int, mixed>
+
+
+
Parameters
-
@@ -2650,14 +2735,15 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.array<string|int, mixed>
= []
-
-
+
-
+
-
@@ -2665,19 +2751,21 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
ValidationException
-
+
If a field could not be validated.
-
+
+
Return values
- array<string|int, mixed>
- —
- the validated values
+ array<string|int, mixed>
+ —
+
+
store()
+
@@ -2701,14 +2790,17 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
private
- store() : bool
-
-
-
+ store() : bool
+
+
+
+
+
-
@@ -2716,7 +2808,7 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
ValidationException
-
+
If a field could not be validated.
@@ -2726,7 +2818,7 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
CrmException
-
+
If an error occurs on server side or on getting response.
@@ -2736,7 +2828,7 @@ Possibles are : - modelNotFound, If this customer hashcode could not be found.
-
ApiErrorException
-
+
If any error or \LDC\LDCCRM\Enums\ApiError occurs.
Possibles are : - validationFailed, If provided data is wrong(CRM side).
@@ -2746,19 +2838,21 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
phpcs:ignore
-
-
+
Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
-
+
+
Return values
- bool
- —
- True if save was successfull.
+ bool
+ —
+ True if save was successfull.
+
update()
+
@@ -2782,14 +2877,17 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
private
- update() : bool
-
-
-
+ update() : bool
+
+
+
+
+
-
@@ -2797,7 +2895,7 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
-
ValidationException
-
+
If a field could not be validated.
@@ -2807,7 +2905,7 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
-
CrmException
-
+
If an error occurs on server side or on getting response.
@@ -2817,7 +2915,7 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
-
ApiErrorException
-
+
If any error or \LDC\LDCCRM\Enums\ApiError occurs.
Possibles are : - validationFailed, If provided data is wrong(CRM side).
- modelNotFound, If this customer hashcode could not be found.
@@ -2828,87 +2926,198 @@ Possibles are : - validationFailed, If provided data is wrong(CRM side).
phpcs:ignore
-
-
+
Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
-
+
+
Return values
- bool
- —
- True if save was successfull.
+ bool
+ —
+ True if save was successfull.
+
+
-
+
+