PaymentMethod
in
Define payment method
Tags
Table of Contents
- BasketProcessable() : Result
- Check if the basket can be processed using this method
- CalculatePrice() : Result
- Calculate price Calculate the price for this payment method
- CheckPrice() : Result
- Collect() : Result
- Collect the amount of a marked basket
- GetFormPreset() : Result
- preset load the common pickup settings preset for generation a form
- GetSettings() : Result
- get settings load the common pickup settings object
- IsTest() : bool
- Is in test system, identify by flag
- MaximumPrice() : float|null
- Get the max overall price
- MinimumPrice() : float|null
- Get the min overall price
- Name() : string
- Get the name
- PlaceOrder() : Result
- Place order call Called on place order of related basket, either pays it immediately or registers for later collection
- Priority() : int
- RegisterOrder() : Result
- register order callback called on register order of related basket
- RegisterReplacementOrder() : Result
- Register a replacement order
- RequireRedirect() : bool
- Has redirect clause Return true when this payment method requires a redirect on place order
- ResolveBasketUsedMethod() : Data|null
- ReverseCancelOrder() : mixed
- Restore an existing order
- StatusAfterDone() : string
- The status after done
- StoreSettings() : Result
- Store the common settings object
- SupportPartialPayments() : bool
- Has support for partial payments?
Methods
BasketProcessable()
Check if the basket can be processed using this method
public
BasketProcessable(Basket $basket) : Result
Parameters
- $basket : Basket
-
A system basket object
Return values
Result —A system result object
CalculatePrice()
Calculate price Calculate the price for this payment method
public
CalculatePrice(array<string|int, ArticleAssignment> $articles) : Result
Parameters
- $articles : array<string|int, ArticleAssignment>
-
A list of basic contents
Return values
Result —A system result object
CheckPrice()
public
CheckPrice(Basket $basket, PriceSummary $snapshot, Result $res) : Result
Parameters
- $basket : Basket
- $snapshot : PriceSummary
- $res : Result
Return values
Result —Collect()
Collect the amount of a marked basket
public
Collect(Basket $basket) : Result
Parameters
- $basket : Basket
Return values
Result —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
IsTest()
Is in test system, identify by flag
public
IsTest(Basket $basket) : bool
Parameters
- $basket : Basket
Return values
bool —MaximumPrice()
Get the max overall price
public
MaximumPrice() : float|null
Return values
float|null —MinimumPrice()
Get the min overall price
public
MinimumPrice() : float|null
Return values
float|null —Name()
Get the name
public
Name() : string
Return values
string —PlaceOrder()
Place order call Called on place order of related basket, either pays it immediately or registers for later collection
public
PlaceOrder(Basket $basket, Request $request, bool $collect_later) : Result
Parameters
- $basket : Basket
-
A system basket object
- $request : Request
-
The related http request
- $collect_later : bool
-
Register but collect later manually
Return values
Result —A system result object
Priority()
public
Priority() : int
Return values
int —RegisterOrder()
register order callback called on register order of related basket
public
RegisterOrder(Basket $basket, Request $request) : Result
Parameters
- $basket : Basket
-
A system basket object
- $request : Request
-
The related http request
Return values
Result —A system result object
RegisterReplacementOrder()
Register a replacement order
public
RegisterReplacementOrder(Basket $basket, Basket $original[, array<string|int, mixed> $params = [] ]) : Result
Parameters
- $basket : Basket
-
The new basket (helper entry from frontend)
- $original : Basket
-
The original subscription basket
- $params : array<string|int, mixed> = []
-
Extra arguments dependant on implementation
Return values
Result —RequireRedirect()
Has redirect clause Return true when this payment method requires a redirect on place order
public
RequireRedirect() : bool
Return values
bool —Does require a redirect
ResolveBasketUsedMethod()
public
ResolveBasketUsedMethod(Basket $basket) : Data|null
Parameters
- $basket : Basket
Return values
Data|null —ReverseCancelOrder()
Restore an existing order
public
ReverseCancelOrder(Basket $basket, Basket $original) : mixed
Parameters
- $basket : Basket
-
The new basket (helper entry from frontend)
- $original : Basket
-
The original subscription basket
Return values
mixed —StatusAfterDone()
The status after done
public
StatusAfterDone(Basket $basket) : string
The basket status after this method was processed successfully
Parameters
- $basket : Basket
Return values
string —The status when successfully
StoreSettings()
Store the common settings object
public
StoreSettings(array<string|int, mixed> $values) : Result
Parameters
- $values : array<string|int, mixed>
-
The configuration values
Return values
Result —$result A system result object
SupportPartialPayments()
Has support for partial payments?
public
SupportPartialPayments() : bool