SilverCommerce\Postage\Helpers\PostageOption
Generic container for postage data, PossiblePostage objects need to be created by PostageTypes and then returned as part of the ArrayList
This object contains 3 generic params:
- name (the name of the postage)
- price (the cost of this object)
- tax (the TaxCategory assigned to this object)
Synopsis
class PostageOption
{
- // methods
- public void getName()
- public PostageOption setName()
- public void getPrice()
- public PostageOption setPrice()
- public void getTax()
- public PostageOption setTax()
- public float getTaxPrice()
- public float getTotalPrice()
- public void getSummary()
- public string getKey()
- public void __construct()
Hierarchy
Uses
- SilverStripe\Core\Injector\Injectable
Members
protected
-
$name
The Name of the current postage item - $price
—
int
The price of this current shipping option - $tax
—
SilverCommerce\TaxAdmin\Model\TaxRate
Assign tax to this item, this should be an instance of TaxCategory
Methods
public
- __construct()
- getKey() — Generate a unique key for this parcel
- getName() — Get the value of name
- getPrice() — Get the value of price
- getSummary() — Generate a summary of this postage option
- getTax() — Get the value of tax
- getTaxPrice() — Get the monitary value of tax for this option
- getTotalPrice() — Get the total monitary value of this option
- setName() — Set the value of name
- setPrice() — Set the value of price
- setTax() — Set the value of tax