edit this page Methods

When the currency() helper function is used without arguments it will return the \Torann\Currency\Currency instance, and with this we can do all types of amazing things.

hasCurrency($code)

Determine if given currency exists.

currency()->hasCurrency('EUR');

isActive($code)

Determine if the provided currency is active.

currency()->isActive('EUR');

setUserCurrency($code)

Set user's currency.

currency()->setUserCurrency('EUR');

getUserCurrency()

Return the user's currency code.

currency()->getUserCurrency();

getCurrency($code = null)

Return the current currency if the one supplied is not valid

currency()->getCurrency();

getCurrencies()

Return the all currencies.

currency()->getCurrencies();

getActiveCurrencies()

Return the all active currencies.

currency()->getActiveCurrencies();

clearCache()

Clear all cached currencies.

currency()->clearCache();

config($key, $default = null)

The config method gets the value of a configuration variable. The configuration values may be accessed using "dot" syntax. A default value may be specified and is returned if the configuration option does not exist:

currency()->config('default');

Managing Currencies

This can be helpful when manually managing currencies. The following methods access the default storage driver.

create(array $params)

Create a currency using the default driver.

currency()->create([
    'name' => 'U.S. Dollar',
    'code' => 'USD',
    'symbol' => '$',
    'format' => '$1,0.00',
    'exchange_rate' => 1.00000000,
    'active' => 1,
]);

find($code)

Get the provided currency using the default driver.

currency()->find('USD');

update($code, $value, DateTime $timestamp = null)

Update the provided currency's value using the default driver

currency()->update('USD', 1.22);

delete($code)

Delete the provided currency using the default driver.

currency()->delete('USD');

getDriver()

This method returns the default storage driver instance used.

currency()->getDriver();