DeliveryMethod
in
Define delivery method
Tags
Table of Contents
- CalculatePrice() : Result
- Calculate price
- CheckValidCargoMethod() : Result
- check cargo method check if this articles can be sent wit this cargo method and shipping
- FetchLegacyConfiguration() : Result
- Load a legacy configuration to this instance
- GetFormPreset() : Result
- preset load the common pickup settings preset for generation a form
- GetSettings() : Result
- get settings load the common pickup settings object
- GetTrackingLink() : string
- Get link Get the external racking link of this basket.
- HeadVersion() : string
- StoreSettings() : Result
- store store the common pickup settings object
Methods
CalculatePrice()
Calculate price
public
CalculatePrice(array<string|int, ArticleAssignment> $articles) : Result
Calculate the article list price when using this delivery method. Should take the resolved article data into account.
Parameters
- $articles : array<string|int, ArticleAssignment>
-
A list of basic contents
Return values
Result —A system result object
CheckValidCargoMethod()
check cargo method check if this articles can be sent wit this cargo method and shipping
public
CheckValidCargoMethod(array<string|int, ArticleAssignment> $articles[, PaymentMethod $payment_method = null ]) : Result
Parameters
- $articles : array<string|int, ArticleAssignment>
-
A list of article assignments
- $payment_method : PaymentMethod = null
-
The payment method to test against
Return values
Result —A system result object
FetchLegacyConfiguration()
Load a legacy configuration to this instance
public
FetchLegacyConfiguration(string $hash) : Result
Parameters
- $hash : string
-
A git hash with the used delivery method version
Return values
Result —A system result object
GetFormPreset()
preset load the common pickup settings preset for generation a form
public
GetFormPreset() : Result
Return values
Result —$result A system result object
GetSettings()
get settings load the common pickup settings object
public
GetSettings() : Result
Return values
Result —$result A system result object
GetTrackingLink()
Get link Get the external racking link of this basket.
public
GetTrackingLink(Basket &$basket) : string
Parameters
- $basket : Basket
-
The basket related to the method
Return values
string —The absolute external tracking link.
HeadVersion()
public
HeadVersion() : string
Return values
string —The head version
StoreSettings()
store store the common pickup settings object
public
StoreSettings(stdClass $values) : Result
Parameters
- $values : stdClass
-
The configuration values
Return values
Result —$result A system result object