Documentation

Card extends Entity
in package

The cards class is the way to store card data of your customers safely to improve the shopping experience.

This will allow your customers to complete their purchases much faster and easily, since they will not have to complete their card data again.

This class must be used in conjunction with the Customer class.

Tags
link

Click here for more infos

RestMethod

(resource="/v1/customers/:customer_id/cards", method="create")

RestMethod

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

RestMethod

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

RestMethod

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

Table of Contents

$_custom_headers  : mixed
$_empty  : mixed
$_last  : mixed
$_manager  : mixed
$_pagination_params  : mixed
$cardholder  : object
cardholder
$customer_id  : string
customer_id
$date_created  : string
date_created
$date_last_updated  : string
date_last_updated
$error  : mixed
$expiration_month  : int
expiration_month
$expiration_year  : int
expiration_year
$first_six_digits  : string
first_six_digits
$id  : int
id
$issuer  : object
issuer
$last_four_digits  : string
last_four_digits
$payment_method  : object
payment_method
$security_code  : object
security_code
__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

protected static mixed $_custom_headers = array()

$_empty

protected mixed $_empty = false
Tags
Attribute

(serialize = false)

$_last

protected mixed $_last
Tags
Attribute

(serialize = false)

$_manager

protected static mixed $_manager

$_pagination_params

protected mixed $_pagination_params

$cardholder

cardholder

protected object $cardholder
Tags
Attribute

()

$customer_id

customer_id

protected string $customer_id
Tags
Attribute

(required = true)

$date_created

date_created

protected string $date_created
Tags
Attribute

()

$date_last_updated

date_last_updated

protected string $date_last_updated
Tags
Attribute

()

$expiration_month

expiration_month

protected int $expiration_month
Tags
Attribute

()

$expiration_year

expiration_year

protected int $expiration_year
Tags
Attribute

()

$first_six_digits

first_six_digits

protected string $first_six_digits
Tags
Attribute

()

$id

id

protected int $id
Tags
Attribute

(primaryKey = true)

$issuer

issuer

protected object $issuer
Tags
Attribute

()

$last_four_digits

last_four_digits

protected string $last_four_digits
Tags
Attribute

()

$payment_method

payment_method

protected object $payment_method
Tags
Attribute

()

$security_code

security_code

protected object $security_code
Tags
Attribute

()

Methods

__construct()

Entity constructor.

public __construct([array<string|int, mixed> $params = [] ]) : mixed
Parameters
$params : array<string|int, mixed> = []
Tags
throws
Exception
Return values
mixed

__get()

public __get( $name) : mixed
Parameters
$name :
Return values
mixed

__isset()

public __isset( $name) : bool
Parameters
$name :
Return values
bool

__set()

public __set( $name,  $value) : mixed
Parameters
$name :
$value :
Tags
throws
Exception
Return values
mixed

all()

public static all([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed

APCIteratorAll()

public APCIteratorAll() : mixed
Tags
codeCoverageIgnore
Return values
mixed

custom_action()

public custom_action(mixed $method, mixed $action) : mixed
Parameters
$method : mixed
$action : mixed
Return values
mixed

delete()

public delete([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed

destroy()

public static destroy() : mixed
Tags
codeCoverageIgnore
Return values
mixed

Error()

public Error() : mixed
Return values
mixed

find_by_id()

public static find_by_id(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

get()

public static get(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

getAttributes()

public getAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCustomHeader()

public static getCustomHeader(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

getCustomHeaders()

public static getCustomHeaders() : mixed
Return values
mixed

not_found()

public not_found() : mixed
Return values
mixed

process_error_body()

public process_error_body(mixed $message) : mixed
Parameters
$message : mixed
Return values
mixed

read()

public static read([mixed $params = [] ][, mixed $options = [] ]) : mixed
Parameters
$params : mixed = []
$options : mixed = []
Return values
mixed

save()

public save([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed
public static search([mixed $filters = [] ][, mixed $options = [] ]) : mixed
Parameters
$filters : mixed = []
$options : mixed = []
Return values
mixed

setCustomHeader()

public static setCustomHeader(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed
Return values
mixed

setCustomHeadersFromArray()

public static setCustomHeadersFromArray(mixed $array) : mixed
Parameters
$array : mixed
Return values
mixed

setManager()

public static setManager(Manager $manager) : mixed
Parameters
$manager : Manager
Return values
mixed

toArray()

public toArray([null $attributes = null ]) : array<string|int, mixed>
Parameters
$attributes : null = null
Return values
array<string|int, mixed>

unSetManager()

public static unSetManager() : mixed
Return values
mixed

update()

public update([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed

_camelize()

protected _camelize( $input[, string $separator = '_' ]) : mixed
Parameters
$input :
$separator : string = '_'
Return values
mixed

_fillFromArray()

Fill entity from data with nested object creation

protected _fillFromArray( $entity,  $data) : mixed
Parameters
$entity :
$data :
Return values
mixed

_getDynamicAttributeDenied()

protected _getDynamicAttributeDenied() : mixed
Return values
mixed

_getPropertyType()

protected _getPropertyType( $property) : mixed
Parameters
$property :
Return values
mixed

_propertyExists()

protected _propertyExists( $property) : bool
Parameters
$property :
Return values
bool

_propertyTypeAllowed()

protected _propertyTypeAllowed( $property,  $type) : bool
Parameters
$property :
$type :
Return values
bool

_setValue()

protected _setValue( $property,  $value[, mixed $validate = true ]) : mixed
Parameters
$property :
$value :
$validate : mixed = true
Tags
throws
Exception
Return values
mixed

tryFormat()

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