Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

ezcurrencydata

Summary

Contains information about a currency.

Persistent

Yes.

Attributes

Attribute

Type

Static*

Description

id

string

Yes.

The ID number of the currency.

code

string

Yes.

The three-character currency code (for example "USD").

symbol

string

Yes.

A string that is used as the currency symbol (for example "$").

locale

string

Yes.

A locale that is used for price formatting (for example "eng-US").

status

string

Yes.

Returns 0 if the currency is inactive, 1 otherwise.

auto_rate_value

string

Yes.

The currency rate that is retrieved via automatic update of the exchange rates from the Internet.

custom_rate_value

string

Yes.

The currency rate that is specified manually (0.00000 by default).

rate_factor

string

Yes.

The rate factor value (1.00000 by default). If the custom rate is 0.00000 or not specified then the auto rate will be multiplied by the rate factor.

rate_value

string

No.

The actual rate value that will be used in calculations. The rate value will be the same as the custom rate if it is not zero. If the custom rate is 0.00000 or not specified then the auto rate will be multiplied by the rate factor.

* Indicates whether the attribute provides a pre-fetched value or if it needs to be computed upon request.

Svitlana Shatokhina (05/05/2006 9:05 am)

Svitlana Shatokhina (12/03/2007 10:50 am)


Comments

There are no comments.