Menu

## Customer extends Entity
in package

Customer.php : 22

This class allows you to store customers data safely to improve the shopping experience.

This will allow your customer to complete their purchases much faster and easily when used in conjunction with the Cards class.

##### Tags

link

  Click here for more infos

RestMethod

  (resource="/v1/customers/:id", method="read")

RestMethod

  (resource="/v1/customers/search", method="search")

RestMethod

  (resource="/v1/customers/", method="create")

RestMethod

  (resource="/v1/customers/:id", method="update")

RestMethod

  (resource="/v1/customers/:id", method="delete")

### Table of Contents

$_custom_headers : mixed
$_empty : mixed
$_last : mixed
$_manager : mixed
$_pagination_params : mixed
$address : object
  address
$addresses : array<string|int, mixed>
  addresses
$cards : array<string|int, mixed>
  card
$date_created : string
  date_created
$date_last_updated : string
  date_last_updated
$date_registered : string
  date_registered
$default_address : string
  default_address
$default_card : string
  default_card
$description : string
  description
$email : string
  email
$error : mixed
$first_name : string
  first_name
$id : string
  id
$identification : object
  identification
$last_name : string
  last_name
$live_mode : bool
  live_mode
$metadata : object
  metadata
$phone : object
  phone
__construct() : mixed
  Entity constructor.
__get() : mixed
__isset() : bool
__set() : mixed
all() : mixed
APCIteratorAll() : mixed
custom_action() : mixed
delete() : mixed
destroy() : mixed
Error() : mixed
find_by_id() : mixed
get() : mixed
getAttributes() : array<string|int, mixed>
getCustomHeader() : mixed
getCustomHeaders() : mixed
not_found() : mixed
process_error_body() : mixed
read() : mixed
save() : mixed
search() : mixed
setCustomHeader() : mixed
setCustomHeadersFromArray() : mixed
setManager() : mixed
toArray() : array<string|int, mixed>
unSetManager() : mixed
update() : mixed
_camelize() : mixed
_fillFromArray() : mixed
  Fill entity from data with nested object creation
_getDynamicAttributeDenied() : mixed
_getPropertyType() : mixed
_propertyExists() : bool
_propertyTypeAllowed() : bool
_setValue() : mixed
tryFormat() : array<string|int, mixed>|bool|float|int|string

### Properties

#### $_custom_headers

Entity.php : 16
`protected static mixed $_custom_headers = array()`

#### $_empty

Entity.php : 27
`protected mixed $_empty = false`

##### Tags

Attribute

  (serialize = false)

#### $_last

Entity.php : 21
`protected mixed $_last`

##### Tags

Attribute

  (serialize = false)

#### $_manager

Entity.php : 17
`protected static mixed $_manager`

#### $_pagination_params

Entity.php : 23
`protected mixed $_pagination_params`

#### $address

Customer.php : 78

address

`protected object $address`

##### Tags

Attribute

  ()

#### $addresses

Customer.php : 134

addresses

`protected array<string|int, mixed> $addresses`

##### Tags

Attribute

  ()

#### $cards

Customer.php : 127

card

`protected array<string|int, mixed> $cards`

##### Tags

Attribute

  ()

#### $date_created

Customer.php : 99

date_created

`protected string $date_created`

##### Tags

Attribute

  ()

#### $date_last_updated

Customer.php : 106

date_last_updated

`protected string $date_last_updated`

##### Tags

Attribute

  ()

#### $date_registered

Customer.php : 85

date_registered

`protected string $date_registered`

##### Tags

Attribute

  ()

#### $default_address

Customer.php : 71

default_address

`protected string $default_address`

##### Tags

Attribute

  ()

#### $default_card

Customer.php : 120

default_card

`protected string $default_card`

##### Tags

Attribute

  ()

#### $description

Customer.php : 92

description

`protected string $description`

##### Tags

Attribute

  ()

#### $email

Customer.php : 29

email

`protected string $email`

##### Tags

Attribute

  (primaryKey = true)

#### $error

Entity.php : 22
`protected mixed $error`

#### $first_name

Customer.php : 43

first_name

`protected string $first_name`

##### Tags

Attribute

  ()

#### $id

Customer.php : 36

id

`protected string $id`

##### Tags

Attribute

  ()

#### $identification

Customer.php : 64

identification

`protected object $identification`

##### Tags

Attribute

  ()

#### $last_name

Customer.php : 50

last_name

`protected string $last_name`

##### Tags

Attribute

  ()

#### $live_mode

Customer.php : 141

live_mode

`protected bool $live_mode`

##### Tags

Attribute

  (type = "boolean")

#### $metadata

Customer.php : 113

metadata

`protected object $metadata`

##### Tags

Attribute

  ()

#### $phone

Customer.php : 57

phone

`protected object $phone`

##### Tags

Attribute

  ()

### Methods

#### __construct()

Entity.php : 35

Entity constructor.

`public __construct([array<string|int, mixed> $params = [] ]) : mixed`

##### Parameters

$params : array<string|int, mixed> = []

##### Tags

throws
  Exception

##### Return values

mixed —

#### __get()

Entity.php : 287
`public __get( $name) : mixed`

##### Parameters

$name :

##### Return values

mixed —

#### __isset()

Entity.php : 299
`public __isset( $name) : bool`

##### Parameters

$name :

##### Return values

bool —

#### __set()

Entity.php : 310
`public __set( $name, $value) : mixed`

##### Parameters

$name :
$value :

##### Tags

throws
  Exception

##### Return values

mixed —

#### all()

Entity.php : 134
`public static all([mixed $options = [] ]) : mixed`

##### Parameters

$options : mixed = []

##### Return values

mixed —

#### APCIteratorAll()

Entity.php : 196
`public APCIteratorAll() : mixed`

##### Tags

codeCoverageIgnore

##### Return values

mixed —

#### custom_action()

Entity.php : 237
`public custom_action(mixed $method, mixed $action) : mixed`

##### Parameters

$method : mixed
$action : mixed

##### Return values

mixed —

#### delete()

Entity.php : 501
`public delete([mixed $options = [] ]) : mixed`

##### Parameters

$options : mixed = []

##### Return values

mixed —

#### destroy()

Entity.php : 229
`public static destroy() : mixed`

##### Tags

codeCoverageIgnore

##### Return values

mixed —

#### Error()

Entity.php : 46
`public Error() : mixed`

##### Return values

mixed —

#### find_by_id()

Entity.php : 73
`public static find_by_id(mixed $id) : mixed`

##### Parameters

$id : mixed

##### Return values

mixed —

#### get()

Entity.php : 66
`public static get(mixed $id) : mixed`

##### Parameters

$id : mixed

##### Return values

mixed —

#### getAttributes()

Entity.php : 320
`public getAttributes() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

#### getCustomHeader()

Entity.php : 81
`public static getCustomHeader(mixed $key) : mixed`

##### Parameters

$key : mixed

##### Return values

mixed —

#### getCustomHeaders()

Entity.php : 90
`public static getCustomHeaders() : mixed`

##### Return values

mixed —

#### not_found()

Entity.php : 98
`public not_found() : mixed`

##### Return values

mixed —

#### process_error_body()

Entity.php : 272
`public process_error_body(mixed $message) : mixed`

##### Parameters

$message : mixed

##### Return values

mixed —

#### read()

Entity.php : 106
`public static read([mixed $params = [] ][, mixed $options = [] ]) : mixed`

##### Parameters

$params : mixed = []
$options : mixed = []

##### Return values

mixed —

#### save()

Entity.php : 251
`public save([mixed $options = [] ]) : mixed`

##### Parameters

$options : mixed = []

##### Return values

mixed —

#### search()

Entity.php : 163
`public static search([mixed $filters = [] ][, mixed $options = [] ]) : mixed`

##### Parameters

$filters : mixed = []
$options : mixed = []

##### Return values

mixed —

#### setCustomHeader()

Entity.php : 77
`public static setCustomHeader(mixed $key, mixed $value) : mixed`

##### Parameters

$key : mixed
$value : mixed

##### Return values

mixed —

#### setCustomHeadersFromArray()

Entity.php : 85
`public static setCustomHeadersFromArray(mixed $array) : mixed`

##### Parameters

$array : mixed

##### Return values

mixed —

#### setManager()

Entity.php : 53
`public static setManager(Manager $manager) : mixed`

##### Parameters

$manager : Manager

##### Return values

mixed —

#### toArray()

Entity.php : 328
`public toArray([null $attributes = null ]) : array<string|int, mixed>`

##### Parameters

$attributes : null = null

##### Return values

array<string|int, mixed> —

#### unSetManager()

Entity.php : 59
`public static unSetManager() : mixed`

##### Return values

mixed —

#### update()

Entity.php : 205
`public update([mixed $options = [] ]) : mixed`

##### Parameters

$options : mixed = []

##### Return values

mixed —

#### _camelize()

Entity.php : 495
`protected _camelize( $input[, string $separator = '_' ]) : mixed`

##### Parameters

$input :
$separator : string = '_'

##### Return values

mixed —

#### _fillFromArray()

Entity.php : 467

Fill entity from data with nested object creation

`protected _fillFromArray( $entity, $data) : mixed`

##### Parameters

$entity :
$data :

##### Return values

mixed —

#### _getDynamicAttributeDenied()

Entity.php : 415
`protected _getDynamicAttributeDenied() : mixed`

##### Return values

mixed —

#### _getPropertyType()

Entity.php : 408
`protected _getPropertyType( $property) : mixed`

##### Parameters

$property :

##### Return values

mixed —

#### _propertyExists()

Entity.php : 382
`protected _propertyExists( $property) : bool`

##### Parameters

$property :

##### Return values

bool —

#### _propertyTypeAllowed()

Entity.php : 392
`protected _propertyTypeAllowed( $property, $type) : bool`

##### Parameters

$property :
$type :

##### Return values

bool —

#### _setValue()

Entity.php : 359
`protected _setValue( $property, $value[, mixed $validate = true ]) : mixed`

##### Parameters

$property :
$value :
$validate : mixed = true

##### Tags

throws
  Exception

##### Return values

mixed —

#### tryFormat()

Entity.php : 427
`protected tryFormat( $value, $type, $property) : array<string|int, mixed>|bool|float|int|string`

##### Parameters

$value :
$type :
$property :

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed>|bool|float|int|string —

## Search results