MerchantOrder
extends Entity
in package
This class will allow you to create and manage your orders. You can attach one or more payments in your merchant order.
Tags
Table of Contents
- $_custom_headers : mixed
- $_empty : mixed
- $_last : mixed
- $_manager : mixed
- $_pagination_params : mixed
- $additionalInfo : string
- additionalInfo
- $applicationId : string
- applicationId
- $cancelled : bool
- cancelled
- $collector : object
- collector
- $dateCreated : string
- dateCreated
- $error : mixed
- $externalReference : string
- externalReference
- $id : int
- id
- $items : array<string|int, mixed>
- items
- $lastUpdate : string
- lastUpdated
- $marketplace : string
- marketplace
- $notificationUrl : string
- notificationUrl
- $paidAmount : float
- paidAmount
- $payer : object
- payer
- $payments : array<string|int, mixed>
- payments
- $preferenceId : string
- preferenceId
- $refundedAmount : float
- refundedAmount
- $shipments : array<string|int, mixed>
- shipments
- $shippingCost : float
- shippingCost
- $siteId : string
- siteId
- $sponsorId : int
- sponsorId
- $status : string
- status
- $totalAmount : float
- totalAmount
- __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
$_last
protected
mixed
$_last
Tags
$_manager
protected
static mixed
$_manager
$_pagination_params
protected
mixed
$_pagination_params
$additionalInfo
additionalInfo
protected
string
$additionalInfo
Tags
$applicationId
applicationId
protected
string
$applicationId
Tags
$cancelled
cancelled
protected
bool
$cancelled
Tags
$collector
collector
protected
object
$collector
Tags
$dateCreated
dateCreated
protected
string
$dateCreated
Tags
$error
protected
mixed
$error
$externalReference
externalReference
protected
string
$externalReference
Tags
$id
id
protected
int
$id
Tags
$items
items
protected
array<string|int, mixed>
$items
Tags
$lastUpdate
lastUpdated
protected
string
$lastUpdate
Tags
$marketplace
marketplace
protected
string
$marketplace
Tags
$notificationUrl
notificationUrl
protected
string
$notificationUrl
Tags
$paidAmount
paidAmount
protected
float
$paidAmount
Tags
$payer
payer
protected
object
$payer
Tags
$payments
payments
protected
array<string|int, mixed>
$payments
Tags
$preferenceId
preferenceId
protected
string
$preferenceId
Tags
$refundedAmount
refundedAmount
protected
float
$refundedAmount
Tags
$shipments
shipments
protected
array<string|int, mixed>
$shipments
Tags
$shippingCost
shippingCost
protected
float
$shippingCost
Tags
$siteId
siteId
protected
string
$siteId
Tags
$sponsorId
sponsorId
protected
int
$sponsorId
Tags
$status
status
protected
string
$status
Tags
$totalAmount
totalAmount
protected
float
$totalAmount
Tags
Methods
__construct()
Entity constructor.
public
__construct([array<string|int, mixed> $params = [] ]) : mixed
Parameters
- $params : array<string|int, mixed> = []
Tags
Return values
mixed —__get()
public
__get( $name) : mixed
Parameters
Return values
mixed —__isset()
public
__isset( $name) : bool
Parameters
Return values
bool —__set()
public
__set( $name, $value) : mixed
Parameters
Tags
Return values
mixed —all()
public
static all([mixed $options = [] ]) : mixed
Parameters
- $options : mixed = []
Return values
mixed —APCIteratorAll()
public
APCIteratorAll() : mixed
Tags
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
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 —search()
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
Return values
mixed —_fillFromArray()
Fill entity from data with nested object creation
protected
_fillFromArray( $entity, $data) : mixed
Parameters
Return values
mixed —_getDynamicAttributeDenied()
protected
_getDynamicAttributeDenied() : mixed
Return values
mixed —_getPropertyType()
protected
_getPropertyType( $property) : mixed
Parameters
Return values
mixed —_propertyExists()
protected
_propertyExists( $property) : bool
Parameters
Return values
bool —_propertyTypeAllowed()
protected
_propertyTypeAllowed( $property, $type) : bool
Parameters
Return values
bool —_setValue()
protected
_setValue( $property, $value[, mixed $validate = true ]) : mixed
Parameters
Tags
Return values
mixed —tryFormat()
protected
tryFormat( $value, $type, $property) : array<string|int, mixed>|bool|float|int|string