Documentation

Preference extends Entity
in package

This class will allow you to charge your customers through our web form from any device in a simple, fast and secure way.

Tags
link

Click here for more infos

RestMethod

(resource="/checkout/preferences", method="create")

RestMethod

(resource="/checkout/preferences/:id", method="read")

RestMethod

(resource="/checkout/preferences/:id", method="update")

Table of Contents

$_custom_headers  : mixed
$_empty  : mixed
$_last  : mixed
$_manager  : mixed
$_pagination_params  : mixed
$additional_info  : string
additional_info
$auto_return  : string
auto_return
$back_urls  : object
back_urls
$binary_mode  : bool
binary_mode
$client_id  : int
client_id
$collector_id  : int
collector_id
$date_created  : DateTime
date_created
$differential_pricing  : object
differential_pricing
$error  : mixed
$expiration_date_from  : DateTime
expiration_date_from
$expiration_date_to  : DateTime
expiration_date_to
$expires  : bool
expires
$external_reference  : string
external_reference
$id  : string
id
$init_point  : string
init_point
$items  : array<string|int, mixed>
items
$marketplace  : string
marktplace
$marketplace_fee  : float
marketplace_fee
$metadata  : object
metadata
$notification_url  : string
notification_url
$operation_type  : string
operation_type
$payer  : object
payer
$payment_methods  : object
payment_methods
$processing_modes  : array<string|int, mixed>
processing_modes
$sandbox_init_point  : string
sandbox_init_point
$shipments  : object
shipments
$sponsor_id  : int
sponsor_id
$statement_descriptor  : string
statement_descriptor
$taxes  : array<string|int, mixed>
taxes
$tracks  : array<string|int, mixed>
tracks
__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

$additional_info

additional_info

protected string $additional_info
Tags
Attribute

(type = "string", maxLength = 600)

$auto_return

auto_return

protected string $auto_return
Tags
Attribute

()

$back_urls

back_urls

protected object $back_urls
Tags
Attribute

()

$binary_mode

binary_mode

protected bool $binary_mode
Tags
Attribute

()

$client_id

client_id

protected int $client_id
Tags
Attribute

(type = "int", readOnly = true)

$collector_id

collector_id

protected int $collector_id
Tags
Attribute

(type = "int", readOnly = true)

$date_created

date_created

protected DateTime $date_created
Tags
Attribute

(type = "date")

$differential_pricing

differential_pricing

protected object $differential_pricing
Tags
Attribute

()

$expiration_date_from

expiration_date_from

protected DateTime $expiration_date_from
Tags
Attribute

(type = "date")

$expiration_date_to

expiration_date_to

protected DateTime $expiration_date_to
Tags
Attribute

(type = "date")

$expires

expires

protected bool $expires
Tags
Attribute

()

$external_reference

external_reference

protected string $external_reference
Tags
Attribute

(type = "string", maxLength = 256)

$id

id

protected string $id
Tags
Attribute

(primaryKey = true, type = "string", readOnly = true)

$init_point

init_point

protected string $init_point
Tags
Attribute

(type = "string", readOnly = true)

$items

items

protected array<string|int, mixed> $items
Tags
Attribute

(type = "array", required = "true")

$marketplace

marktplace

protected string $marketplace
Tags
Attribute

(type = "string")

$marketplace_fee

marketplace_fee

protected float $marketplace_fee
Tags
Attribute

(type = "float")

$metadata

metadata

protected object $metadata
Tags
Attribute

()

$notification_url

notification_url

protected string $notification_url
Tags
Attribute

(type = "string", maxLength = 500)

$operation_type

operation_type

protected string $operation_type
Tags
Attribute

(type = "string", readOnly = true)

$payer

payer

protected object $payer
Tags
Attribute

(type = "object")

$payment_methods

payment_methods

protected object $payment_methods
Tags
Attribute

()

$processing_modes

processing_modes

protected array<string|int, mixed> $processing_modes
Tags
Attribute

(type = "array")

$sandbox_init_point

sandbox_init_point

protected string $sandbox_init_point
Tags
Attribute

(type = "string", readOnly = true)

$shipments

shipments

protected object $shipments
Tags
Attribute

(type = "object")

$sponsor_id

sponsor_id

protected int $sponsor_id
Tags
Attribute

(type = "integer")

$statement_descriptor

statement_descriptor

protected string $statement_descriptor
Tags
Attribute

()

$taxes

taxes

protected array<string|int, mixed> $taxes
Tags
Attribute

(type = "array")

$tracks

tracks

protected array<string|int, mixed> $tracks
Tags
Attribute

(type = "array")

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