Response
extends Sand
in package
Class ResponseXML.
Table of Contents
- STATE_OK = 'ok'
- State when file was imported successfully.
- STATE_WARNING = 'warning'
- State when file was imported with warning.
- $messages : array<string|int, mixed>
- State when file was imported with error.
- $producedDetails : array<string|int, mixed>
- $ns : array<string|int, mixed>
- $xml : SimpleXMLElement
- $caller : Client
- $note : string
- Operation status note.
- $parsed : array<string|int, mixed>
- Parsed Result.
- $state : string
- Operation status.
- __construct() : mixed
- Create a new Response Instance.
- adbToArray() : array<string|int, mixed>
- Strip adb: prefix form key names.
- anyXmlToArray() : array<string|int, mixed>
- Convert Pohoda Response XML to Array.
- getAgendaData() : array<string|int, mixed>
- Obtain response data.
- getNote() : string
- getState() : string
- Return state of whole file.
- isOk() : bool
- Checks if import was successful.
- isWarning() : bool
- Checks if import produced warnings.
- parse() : array<string|int, mixed>
- Convert XML to Array.
- prepareElement() : mixed
- processBank() : array<string|int, mixed>
- processImportDetails() : void
- processLiquidationDetails() : mixed
- processListAddressBook() : array<string|int, mixed>
- processProducedDetails() : void
- processResponseData() : void
- processResponsePack() : void
- processResponsePackItem() : void
- stripArrayNames() : array<string|int, mixed>
- Strip prefix form key names.
- typesToArray() : array<string|int, mixed>
- typeToArray() : array<string|int, mixed>
- useCaller() : void
- xmlToArray() : array<string|int, mixed>
- Convert XML to Array.
Constants
STATE_OK
State when file was imported successfully.
public
mixed
STATE_OK
= 'ok'
STATE_WARNING
State when file was imported with warning.
public
mixed
STATE_WARNING
= 'warning'
Properties
$messages
State when file was imported with error.
public
array<string|int, mixed>
$messages
= ['error' => [], 'warning' => []]
$producedDetails
public
array<string|int, mixed>
$producedDetails
$ns
protected
array<string|int, mixed>
$ns
= []
$xml
protected
SimpleXMLElement
$xml
$caller
private
Client
$caller
$note
Operation status note.
private
string
$note
= ''
$parsed
Parsed Result.
private
array<string|int, mixed>
$parsed
= []
$state
Operation status.
private
string
$state
= ''
Methods
__construct()
Create a new Response Instance.
public
__construct(Client $caller) : mixed
Parameters
- $caller : Client
-
parent object
Return values
mixed —adbToArray()
Strip adb: prefix form key names.
public
static adbToArray(array<string|int, mixed> $entryData) : array<string|int, mixed>
Parameters
- $entryData : array<string|int, mixed>
Return values
array<string|int, mixed> —anyXmlToArray()
Convert Pohoda Response XML to Array.
public
anyXmlToArray(rawXML|string $xml) : array<string|int, mixed>
Parameters
- $xml : rawXML|string
Return values
array<string|int, mixed> —getAgendaData()
Obtain response data.
public
getAgendaData(string $agenda) : array<string|int, mixed>
Parameters
- $agenda : string
Return values
array<string|int, mixed> —item or array of items
getNote()
public
getNote() : string
Return values
string —getState()
Return state of whole file.
public
getState() : string
Return values
string —isOk()
Checks if import was successful.
public
isOk() : bool
Return values
bool —isWarning()
Checks if import produced warnings.
public
isWarning() : bool
Return values
bool —parse()
Convert XML to Array.
public
static parse(string $xml, array<string|int, mixed> $alwaysArrayElements) : array<string|int, mixed>
Parameters
- $xml : string
- $alwaysArrayElements : array<string|int, mixed>
Return values
array<string|int, mixed> —prepareElement()
public
static prepareElement(mixed $elementData) : mixed
Parameters
- $elementData : mixed
Return values
mixed —processBank()
public
processBank(array<string|int, mixed> $bank) : array<string|int, mixed>
Parameters
- $bank : array<string|int, mixed>
Return values
array<string|int, mixed> —processImportDetails()
public
processImportDetails(mixed $importDetails) : void
Parameters
- $importDetails : mixed
Return values
void —processLiquidationDetails()
public
processLiquidationDetails(array<string|int, mixed> $liquidationDetails) : mixed
Parameters
- $liquidationDetails : array<string|int, mixed>
Return values
mixed —processListAddressBook()
public
processListAddressBook(mixed $listAddressBook) : array<string|int, mixed>
Parameters
- $listAddressBook : mixed
Return values
array<string|int, mixed> —processProducedDetails()
public
processProducedDetails(mixed $productDetails) : void
Parameters
- $productDetails : mixed
Return values
void —processResponseData()
public
processResponseData(array<string|int, mixed> $responseData) : void
Parameters
- $responseData : array<string|int, mixed>
Return values
void —processResponsePack()
public
processResponsePack(mixed $responsePackData) : void
Parameters
- $responsePackData : mixed
Return values
void —processResponsePackItem()
public
processResponsePackItem(mixed $responsePackItem) : void
Parameters
- $responsePackItem : mixed
Return values
void —stripArrayNames()
Strip prefix form key names.
public
static stripArrayNames(string $prefix, array<string|int, mixed> $entryData) : array<string|int, mixed>
Parameters
- $prefix : string
- $entryData : array<string|int, mixed>
Return values
array<string|int, mixed> —typesToArray()
public
static typesToArray(array<string|int, mixed> $source) : array<string|int, mixed>
Parameters
- $source : array<string|int, mixed>
Return values
array<string|int, mixed> —typeToArray()
public
static typeToArray(array<string|int, mixed> $type) : array<string|int, mixed>
Parameters
- $type : array<string|int, mixed>
Return values
array<string|int, mixed> —useCaller()
public
useCaller(Client $caller) : void
Parameters
- $caller : Client
Return values
void —xmlToArray()
Convert XML to Array.
public
static xmlToArray(SimpleXMLElement $xml[, array<string, string> $options = [] ]) : array<string|int, mixed>
Parameters
- $xml : SimpleXMLElement
- $options : array<string, string> = []