Sunnysideup\Ecommerce\Model\Money\EcommerceCurrency
Object to manage currencies.
Synopsis
class EcommerceCurrency
extends DataObject
implements
EditableEcommerceObject
{
- // members
- private static string $table_name = 'EcommerceCurrency';
- private static string $exchange_provider_class = ExchangeRateProvider::class;
- private static boolean $show_currency_at_all = true;
- private static string $default_currency = 'NZD';
- private static array $db = ;
- private static array $indexes = ;
- private static array $casting = ;
- private static array $searchable_fields = ;
- private static array $field_labels = ;
- private static array $summary_fields = ;
- private static string $singular_name = 'Currency';
- private static string $plural_name = 'Currencies';
- private static array $default_sort = ;
- private static array $defaults = ;
- private static array $currencies = ;
- // methods
- public void i18n_singular_name()
- public void i18n_plural_name()
- public void canCreate()
- public void canView()
- public void canEdit()
- public bool canDelete()
- public static DataList ecommerce_currency_list()
- public static void get_list()
- public static DBMoney get_money_object_from_order_currency()
- public static void default_currency()
- public static string default_currency_code()
- public static int default_currency_id()
- public static DataObject|EcommerceCurrency get_one_from_code()
- public void getCMSFields()
- public string CMSEditLink()
- public void DefaultSymbol()
- public void getDefaultSymbol()
- public void ShortSymbol()
- public void getShortSymbol()
- public void LongSymbol()
- public void getLongSymbol()
- public bool IsDefault()
- public void getIsDefault()
- public string IsDefaultNice()
- public void getIsDefaultNice()
- public string InUseNice()
- public void getInUseNice()
- public float ExchangeRate()
- public float getExchangeRate()
- public string ExchangeRateExplanation()
- public void getExchangeRateExplanation()
- public bool IsCurrent()
- public string Link()
- public string LinkingMode()
- public void validate()
- public void populateDefaults()
- public void requireDefaultRecords()
- public static void create_new()
- public string debug()
- protected void onBeforeWrite()
Hierarchy
Extends
- SilverStripe\ORM\DataObject
Implements
Members
private
- $casting
—
array
standard SS variable. - $currencies
- $db
- $default_currency — string
- $default_sort
—
array
standard SS variable. - $defaults
—
array
standard SS variable. - $exchange_provider_class — string
- $field_labels
—
array
standard SS variable. - $indexes
—
array
standard SS variable. - $plural_name
—
string
standard SS variable. - $searchable_fields
—
array
standard SS variable. - $show_currency_at_all
- $singular_name
—
string
standard SS variable. - $summary_fields
—
array
standard SS variable. - $table_name
—
string
standard SS variable.
Methods
protected
public
- CMSEditLink() — link to edit the record.
- DefaultSymbol()
- ExchangeRate() — casted variable.
- ExchangeRateExplanation() — casted variable.
- InUseNice() — casted variable method.
- IsCurrent()
- IsDefault() — casted variable method.
- IsDefaultNice() — casted variable method.
- Link() — Returns the link that can be used in the shopping cart to set the preferred currency to this one.
- LinkingMode() — returns the link type.
- LongSymbol()
- ShortSymbol()
- canCreate() — Standard SS Method.
- canDelete() — Standard SS method.
- canEdit() — Standard SS Method.
- canView() — Standard SS Method.
- create_new() — checks if a currency exists, creates it and returns it.
- debug() — Debug helper method.
- default_currency() — returns the default currency.
- default_currency_code() — returns the default currency as Code.
- default_currency_id()
- ecommerce_currency_list() — NOTE: when there is only one currency we return an empty DataList as one currency is meaningless.
- getCMSFields() — STANDARD SILVERSTRIPE STUFF.
- getDefaultSymbol()
- getExchangeRate()
- getExchangeRateExplanation()
- getInUseNice()
- getIsDefault()
- getIsDefaultNice()
- getLongSymbol()
- getShortSymbol()
- get_list()
- get_money_object_from_order_currency()
- get_one_from_code() — Only returns a currency when it is a valid currency.
- i18n_plural_name()
- i18n_singular_name()
- populateDefaults() — Standard SS Method Adds the default currency.
- requireDefaultRecords() — Standard SS Method Adds the default currency.
- validate()