Yii Framework v1.0.3 Class Reference

CLocale

Package	system.i18n
Inheritance	class CLocale » CComponent
Since	1.0
Version	$Id: CLocale.php 433 2008-12-30 22:59:17Z qiang.xue $

Property Details

the AM name

the currency format

date format

the date formatter for this locale

datetime format, i.e., the order of date and time.

the decimal format

the locale ID (in canonical form)

the number formatter for this locale

the PM name

the percent format

the scientific format

date format

Method Details

protected void __construct(string $id)
$id	string	the locale ID (e.g. en_US)

Constructor. Since the constructor is protected, please use getInstance to obtain an instance of the specified locale.

public string getAMName()
{return}	string	the AM name

public static string getCanonicalID(string $id)
$id	string	the locale ID to be converted
{return}	string	the locale ID in canonical form

Converts a locale ID to its canonical form. In canonical form, a locale ID consists of only underscores and lower-case letters.

public string getCurrencyFormat()
{return}	string	the currency format

public string getCurrencySymbol(string $currency)
$currency	string	3-letter ISO 4217 code. For example, the code "USD" represents the US Dollar and "EUR" represents the Euro currency.
{return}	string	the localized currency symbol. Null if the symbol does not exist.

public string getDateFormat(string $width='medium')
$width	string	date format width. It can be 'full', 'long', 'medium' or 'short'.
{return}	string	date format

public CDateFormatter getDateFormatter()
{return}	CDateFormatter	the date formatter for this locale

public string getDateTimeFormat()
{return}	string	datetime format, i.e., the order of date and time.

public string getDecimalFormat()
{return}	string	the decimal format

public string getEraName(integer $era, string $width='wide')
$era	integer	era (0,1)
$width	string	era name width. It can be 'wide', 'abbreviated' or 'narrow'.
{return}	string	the era name

public string getId()
{return}	string	the locale ID (in canonical form)

public static CLocale getInstance(string $id)
$id	string	the locale ID (e.g. en_US)
{return}	CLocale	the locale instance

Returns the instance of the specified locale. Since the constructor of CLocale is protected, you can only use this method to obtain an instance of the specified locale.

public static array getLocaleIDs()
{return}	array	IDs of the locales which the framework can recognize

public string getMonthName(integer $month, string $width='wide')
$month	integer	month (1-12)
$width	string	month name width. It can be 'wide', 'abbreviated' or 'narrow'.
{return}	string	the month name

public CNumberFormatter getNumberFormatter()
{return}	CNumberFormatter	the number formatter for this locale

public string getNumberSymbol(string $name)
$name	string	symbol name
{return}	string	symbol

public string getPMName()
{return}	string	the PM name

public string getPercentFormat()
{return}	string	the percent format

public string getScientificFormat()
{return}	string	the scientific format

public string getTimeFormat(string $width='medium')
$width	string	time format width. It can be 'full', 'long', 'medium' or 'short'.
{return}	string	date format

public string getWeekDayName(integer $day, string $width='wide')
$day	integer	weekday (0-6)
$width	string	weekday name width. It can be 'wide', 'abbreviated' or 'narrow'.
{return}	string	the weekday name

Copyright © 2008-2009 by Yii Software LLC
All Rights Reserved.