Open Journal Systems  3.3.0
Currency Class Reference
Inheritance diagram for Currency:
DataObject

Public Member Functions

 format ($amount)
 
 getCodeAlpha ()
 
 getCodeNumeric ()
 
 getName ()
 
 setCodeAlpha ($codeAlpha)
 
 setCodeNumeric ($codeNumeric)
 
 setName ($name)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Basic class describing a currency.

See also
CurrencyDAO
Deprecated:
Use \Sokil\IsoCodes directly.

Definition at line 24 of file Currency.inc.php.

Member Function Documentation

◆ format()

Currency::format (   $amount)

Format a number per a currency.

Deprecated:
Use \Sokil\IsoCodes directly.
Parameters
$amountnumeric|null Numeric amount, or null
Returns
string|null Formatted amount, or null if null was supplied as amount

Definition at line 90 of file Currency.inc.php.

◆ getCodeAlpha()

Currency::getCodeAlpha ( )

Get currency alpha code.

Deprecated:
Use \Sokil\IsoCodes directly.
Returns
string

Definition at line 53 of file Currency.inc.php.

References DataObject\getData().

◆ getCodeNumeric()

Currency::getCodeNumeric ( )

Get currency numeric code.

Deprecated:
Use \Sokil\IsoCodes directly.
Returns
int

Definition at line 71 of file Currency.inc.php.

References DataObject\getData().

◆ getName()

Currency::getName ( )

Get the name of the currency.

Deprecated:
Use \Sokil\IsoCodes directly.
Returns
string

Definition at line 35 of file Currency.inc.php.

References DataObject\getData().

◆ setCodeAlpha()

Currency::setCodeAlpha (   $codeAlpha)

Set currency alpha code.

Deprecated:
Use \Sokil\IsoCodes directly.
Parameters
$alphaCodestring

Definition at line 62 of file Currency.inc.php.

References DataObject\setData().

◆ setCodeNumeric()

Currency::setCodeNumeric (   $codeNumeric)

Set currency numeric code.

Deprecated:
Use \Sokil\IsoCodes directly.
Parameters
$codeNumericstring

Definition at line 80 of file Currency.inc.php.

References DataObject\setData().

◆ setName()

Currency::setName (   $name)

Set the name of the currency.

Deprecated:
Use \Sokil\IsoCodes directly.
Parameters
$namestring

Definition at line 44 of file Currency.inc.php.

References DataObject\setData().


The documentation for this class was generated from the following file: