Properties

$settings

$settings :\stdClass

Setup The local setup object

Type

\stdClass—A setup object

$config_file

$config_file :

Type

$preset_file

$preset_file :

Type

$default_config_file

$default_config_file :

Type

Methods

__construct()

__construct()

construct construct the abstraction layer

GetFormPreset()

GetFormPreset(): \FAA\obj\Result

preset load the common pickup settings preset for generation a form

Returns

\FAA\obj\Result —

A system result object

GetDefaultSettings()

GetDefaultSettings(): \FAA\obj\Result

load defaults load the default settings for this delivery method

Returns

\FAA\obj\Result —

A system result object

GetSettings()

GetSettings(): \FAA\obj\Result

get load the common pickup settings object

Returns

\FAA\obj\Result —

A system result object

BasketProcessable()

BasketProcessable(\FAA\Obj\Generic\Basket  $basket): \FAA\obj\Result

Check if the basket can be processed using this method

This method supports all known delivery methods but no recurring payments

Parameters

\FAA\Obj\Generic\Basket $basket

A system basket object

Returns

\FAA\obj\Result —

A system result object

RequireRedirect()

RequireRedirect(): boolean

Has redirect clause Return true when this payment method requires a redirect on place order

Returns

boolean —

Does require a redirect

StatusAfterDone()

StatusAfterDone(): string

The status after done The basket status after this method was processed successfully

Returns

string —

The status when successfully

RegisterOrder()

RegisterOrder(\FAA\Obj\Generic\Basket  $basket,\FAA\Obj\Request  $request): \FAA\obj\Result

register order callback called on register order of related basket

Parameters

\FAA\Obj\Generic\Basket $basket

A system basket object

\FAA\Obj\Request $request

The related http request

Returns

\FAA\obj\Result —

A system result object

PlaceOrder()

PlaceOrder(\FAA\Obj\Generic\Basket  $basket,\FAA\Obj\Request  $request): \FAA\obj\Result

place order callback called on place order of related basket

Parameters

\FAA\Obj\Generic\Basket $basket

A system basket object

\FAA\Obj\Request $request

The related http request

Returns

\FAA\obj\Result —

A system result object

StoreSettings()

StoreSettings(\stdClass  $values): \FAA\obj\Result

store store the common pickup settings object

Parameters

\stdClass $values

The configuration values

Returns

\FAA\obj\Result —

A system result object

CalculatePrice()

CalculatePrice(): \FAA\obj\Result

purge all values delete all files in a specific zone of the pickup

Returns

\FAA\obj\Result —

A system result object

loadLocalSettings()

loadLocalSettings(): void

connect load settings object from local storage