Classes, interfaces and traits
APModuleCalc¶
Calc module
Access all of the API endpoints under the 'calc' path. Each module is loaded via {@link \APAPI\APLoader} and passed a
reference to a {@link \APAPI\APAPI} instance to use. In practice, usage of SDK modules is as simple as:
<pre>
$api->calc->initialize();
</pre>
« More »
APModuleCompany¶
Company module
Access all of the API endpoints under the 'company' path. Each module is loaded via {@link \APAPI\APLoader} and passed
a reference to a {@link \APAPI\APAPI} instance to use. In practice, usage of SDK modules is as simple as:
<pre>
$api->calc->initialize();
</pre>
« More »
APModuleReports¶
Reports module
Access all of the API endpoints under the 'reports' path. Each module is loaded via {@link \APAPI\APLoader} and passed a
reference to a {@link \APAPI\APAPI} instance to use. In practice, usage of SDK modules is as simple as:
<pre>
$api->reports->initialize();
</pre>
« More »
APModuleLoan¶
Loan module
Access all of the API endpoints under the 'loan' path. Each module is loaded via {@link \APAPI\APLoader} and passed
a reference to a {@link \APAPI\APAPI} instance to use. In practice, usage of SDK modules is as simple as:
<pre>
$api->loan->initialize();
</pre>
« More »
APCoreTx¶
Core API communication class
APCoreTx implements the core mechanism to send requests to the API and receive results. It takes care of setting
the proper headers and sending parameters either as a http query (for GET and DELETE) or as url encoded data
(for PUT and POST). Relies on the curl extension to make the request.
« More »
Classes, interfaces and traits
CSVUserSettingsParser¶
Parse user settings CSV data
Implements a CSV parser to convert user settings CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVUserSettingsParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVUserSettingsParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVLoanParser¶
Parse loan CSV data
Implements a CSV parser to convert loan CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVLoanParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVLoanParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVLinkParser¶
Base CSV Parser
Implements functionality that all CSV Parsers must have. Implementation of the inherited abstract parse method is
left to concrete classes.
« More »
CSVPaymentParser¶
Parse payment CSV data
Implements a CSV parser to convert payment CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVPaymentParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVPaymentParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVUserCustomFieldsParser¶
Parse user custom fields CSV data
Implements a CSV parser to convert user custom fields CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVUserCustomFieldsParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVUserCustomFieldsParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVChargesParser¶
Parse charges CSV data
Implements a CSV parser to convert charges CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVChargesParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVChargesParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVAdvancementParser¶
Parse advancement and credit CSV data
Implements a CSV parser to convert advancement and credit CSV data into a proper array that may be used with the API.
The parse implementation provides simple data type checking, to ensure in some cases proper values are passed
(for instance it converts boolean true|false to string '0'|'1' as that's the expected value in the API).
It also provides two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVAdvancementParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVAdvancementParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVEmployerParser¶
Base CSV Parser
Implements functionality that all CSV Parsers must have. Implementation of the inherited abstract parse method is
left to concrete classes.
« More »
CSVNoteParser¶
Parse note CSV data
Implements a CSV parser to convert note CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVNoteParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVNoteParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVCustomFieldsParser¶
Base CSV Parser
Implements functionality that all CSV Parsers must have. Implementation of the inherited abstract parse method is
left to concrete classes.
« More »
Parser¶
Parser
Defines the contract for all parsers. A parser receives a single row as input and generates a key => value array
with the result.
« More »
CSVEscrowParser¶
Base CSV Parser
Implements functionality that all CSV Parsers must have. Implementation of the inherited abstract parse method is
left to concrete classes.
« More »
CSVCollateralParser¶
Parse collateral CSV data
Implements a CSV parser to convert collateral CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVCollateralParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVCollateralParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVUserParser¶
Parse user CSV data
Implements a CSV parser to convert user CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVUserParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVUserParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVAutopayParser¶
Parse autopay CSV data
Implements a CSV parser to convert autopay CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVAutopayParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVAutopayParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVPaymentMethodParser¶
Parse payment methods CSV data
Implements a CSV parser to convert payment methods CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVPaymentMethodParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVPaymentMethodParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVInsuranceParser¶
Base CSV Parser
Implements functionality that all CSV Parsers must have. Implementation of the inherited abstract parse method is
left to concrete classes.
« More »
CSVParser¶
Base CSV Parser
Implements functionality that all CSV Parsers must have. Implementation of the inherited abstract parse method is
left to concrete classes.
« More »
CSVReferencesParser¶
Parse references CSV data
Implements a CSV parser to convert references CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVReferencesParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVReferencesParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVPromiseParser¶
Parse promises CSV data
Implements a CSV parser to convert promises CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVPromiseParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVPromiseParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVLoanSettingsParser¶
Base CSV Parser
Implements functionality that all CSV Parsers must have. Implementation of the inherited abstract parse method is
left to concrete classes.
« More »
CSVActivateParser¶
Parse activate CSV data
Implements a CSV parser to convert activate CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVActivateParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVActivateParser(array('foo', 'bar', 'baz'));</pre>
« More »
CSVChecklistParser¶
Parse checklist CSV data
Implements a CSV parser to convert checklist CSV data into a proper array that may be used with the API. The parse
implementation provides simple data type checking, to ensure in some cases proper values are passed (for instance
it converts boolean true|false to string '0'|'1' as that's the expected value in the API). It also provides
two static functions to create ready to be used parser instances: withHeaders and withFile.
withHeaders creates a parser from an array of header information:
<pre>$parser = CSVChecklistParser(array('foo', 'bar', 'baz'));</pre>
withFile creates a parser from a CSV file, and treats the first line as header information so it's not necessary to
set it independently:
<pre>$parser = CSVChecklistParser(array('foo', 'bar', 'baz'));</pre>
« More »