AdvancedPayment
extends Entity
in package
Advanced Payment class
Tags
Table of Contents
- $_custom_headers : mixed
- $_empty : mixed
- $_last : mixed
- $_manager : mixed
- $_pagination_params : mixed
- $application_id : int
- application_id
- $binary_mode : bool
- binary_mode
- $capture : bool
- capture
- $description : string
- description
- $disbursements : array<string|int, mixed>
- disbursements
- $error : mixed
- $external_reference : string
- external_reference
- $id : int
- id
- $payer : object
- payer
- $payments : array<string|int, mixed>
- payments
- $status : string
- status
- __construct() : mixed
- Entity constructor.
- __get() : mixed
- __isset() : bool
- __set() : mixed
- all() : mixed
- APCIteratorAll() : mixed
- cancel() : bool|mixed
- cancel
- capture() : bool|mixed
- capture
- 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
- refund() : bool
- refund
- refundDisbursement() : bool
- refundDisbursement
- 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
$application_id
application_id
protected
int
$application_id
Tags
$binary_mode
binary_mode
protected
bool
$binary_mode
Tags
$capture
capture
protected
bool
$capture
Tags
$description
description
protected
string
$description
Tags
$disbursements
disbursements
protected
array<string|int, mixed>
$disbursements
Tags
$error
protected
mixed
$error
$external_reference
external_reference
protected
string
$external_reference
Tags
$id
id
protected
int
$id
Tags
$payer
payer
protected
object
$payer
Tags
$payments
payments
protected
array<string|int, mixed>
$payments
Tags
$status
status
protected
string
$status
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 —cancel()
cancel
public
cancel() : bool|mixed
Tags
Return values
bool|mixed —capture()
capture
public
capture() : bool|mixed
Tags
Return values
bool|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 —refund()
refund
public
refund(int $amount) : bool
Parameters
- $amount : int
Tags
Return values
bool —refundDisbursement()
refundDisbursement
public
refundDisbursement( $disbursement_id, int $amount) : bool
Parameters
Tags
Return values
bool —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