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

HeadVersion()

HeadVersion(): string

Returns

string —

The head version

FetchLegacyConfiguration()

FetchLegacyConfiguration(string  $hash): \FAA\Obj\Result

Load a legacy configuration to this instance

Parameters

string $hash

A git hash with the used delivery method version

Returns

\FAA\Obj\Result —

A system result object

GetFormPreset()

GetFormPreset(): \FAA\Obj\Result

preset load the common pickup settings preset for generation a form

Returns

\FAA\Obj\Result —

$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 settings load the common pickup settings object

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 —

$result A system result object

GetTrackingLink()

GetTrackingLink(\FAA\Obj\Generic\Basket  $basket): string

Get link Get the external racking link of this basket.

Parameters

\FAA\Obj\Generic\Basket $basket

The basket related to the method

Returns

string —

The absolute external tracking link.

CheckValidCargoMethod()

CheckValidCargoMethod(array<mixed,\FAA\Obj\Sys\ArticleAssignment>  $articles,\FAA\Interfaces\PaymentMethod  $paymentmethod = null): \FAA\Obj\Result

check cargo method check if this articles can be sent wit this cargo method and shipping

Parameters

array<mixed,\FAA\Obj\Sys\ArticleAssignment> $articles

A list of article assignments

\FAA\Interfaces\PaymentMethod $paymentmethod

The payment method to test against

Returns

\FAA\Obj\Result —

A system result object

CalculatePrice()

CalculatePrice(array<mixed,\FAA\Obj\Sys\ArticleAssignment>  $articles): \FAA\Obj\Result

Calculate price

Calculate the article list price when using this delivery method. Should take the resolved article data into account.

Parameters

array<mixed,\FAA\Obj\Sys\ArticleAssignment> $articles

A list of basic contents

Returns

\FAA\Obj\Result —

A system result object

loadLocalSettings()

loadLocalSettings(): void

connect load settings object from local storage