ibexa

Path

ez publish / technical manual / 3.9 / reference / objects / ezlocale


Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.

ezlocale

Summary

Contains information about a locale.

Persistent

No.

Attributes

Attribute

Type

Static*

Description

charset

string

Yes.

The character set that the locale uses (for example "iso-8859-1").

allowed_charsets

array

Yes.

An array of strings containing the allowed character sets.

country_name

string

Yes.

The name of the country that the locale belongs to (for example "United Kingdom").

country_comment

string

Yes.

A comment about the country that the locale belongs to (usually empty).

country_code

string

Yes.

The country code (for example "GB" for Great Britian).

country_variation

string

Yes.

The country variation.

language_name

string

Yes.

The native name of the language (for example "Norsk", "Magyar", etc.).

intl_language_name

string

Yes.

The international name of the language (for example "Norwegian", "Hungarian", etc.).

language_code

string

Yes.

The language code (for example "eng").

language_comment

string

Yes.

A comment about the language itself (usually empty).

locale_code

string

Yes.

The actual locale code (for example "eng-GB", "nor-NO", etc.).

locale_full_code

string

No.

The full locale code (for example "eng-GB").

http_locale_code

string

No.

The HTTP locale code (for example "eng-GB").

decimal_symbol

string

Yes.

The decimal symbol (for example a dot ".").

thousands_separator

string

Yes.

The character (if any) that is used to separate/split large numbers.

decimal_count

string

Yes.

The number of decimal digits that should be displayed.

negative_symbol

string

Yes.

The symbol used for displaying negative numbers (usually just a dash: "-").

positive_symbol

string

Yes.

The symbol used for displaying positive numbers (usually empty).

currency_decimal_symbol

string

Yes.

The symbol used for separating the integer part from the decimal part of currency values.

currency_thousands_separator

string

Yes.

The thousand separator used for currencies.

currency_decimal_count

string

Yes.

The number of decimal digits that should be included when displaying currencies.

currency_negative_symbol

string

Yes.

The symbol used for displaying negative currencies (usually just a dash: "-").

currency_positive_symbol

string

Yes.

The symbol used for displaying positive currencies (usually empty).

currency_symbol

string

Yes.

The currency symbol (for example "£").

currency_name

string

Yes.

The name of the currency (for example "British Pound", "Norwegian Kroner", etc.).

currency_short_name

string

Yes.

A short/abbreviated name for the currency (for example "BSP", "NOK", etc.).

is_monday_first

boolean

Yes.

Returns TRUE if monday is considered to be the first day of the week, FALSE otherwise.

weekday_name_list

array

No.

An array of strings containing the weekday names (for example "Monday", "Tuesday", etc.).

weekday_short_name_list

array

No.

An array of strings containing abbreviated weekday names (for example "Mon", "Tue", etc.).

weekday_number_list

array

Yes.

An array of strings containing the weekday numbers (for example "0", "1", etc.).

month_list

array

Yes.

An array of strings containing the month digits (for example "1" for January, "2" for February, etc.).

month_name_list

array

Yes.

An array of strings containing the name of the months (for example "January", "February", etc.).

is_valid

boolean

Yes.

Returns TRUE if the locale is valid (successfully read from disk), FALSE otherwise (unknown locale).

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

Balazs Halasy (24/02/2005 2:26 pm)

Svitlana Shatokhina (13/02/2007 12:21 pm)

Balazs Halasy, Svitlana Shatokhina


Comments

There are no comments.