phpDocumentor » \Zend

Base class for localization

category	Zend
package	Zend_Locale
copyright	Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License

Methods

Generates a locale object If no locale is given a automatic search is done Then the most probable locale will be automatically set Search order is 1. Given Locale 2. HTTP Client 3. Server Environment 4. Framework Standard

__construct(string | \Zend_Locale $locale)

Parameters

$locale

string\Zend_Locale

(Optional) Locale for parsing input

Exceptions

`\Zend_Locale_Exception`	When autodetection has been failed

Returns a string representation of the object Alias for toString

__toString() : string

Returns

string

Clears all set cache data

clearCache(string $tag) : void

Parameters

$tag

string

Tag to clear when the default tag name is not used

Disables the set cache

disableCache(boolean $flag) : void

Parameters

$flag

boolean

True disables any set cache, default is false

Returns true if both locales are equal

equals(Zend_Locale $object) : boolean

Parameters

$object

\Zend_Locale

Locale to check for equality

Returns

boolean

Finds the proper locale based on the input Checks if it exists, degrades it when necessary Detects registry locale and when all fails tries to detect a automatic locale Returns the found locale as string

findLocale(string $locale) : string

Parameters

$locale

string

Exceptions

`\Zend_Locale_Exception`	When the given locale is no locale or the autodetection fails

Returns

string

Return an array of all accepted languages of the client Expects RFC compilant Header !!

getBrowser() : array

The notation can be : de,en-UK-US;q=0.5,fr-FR;q=0.2

Returns

array- list of accepted languages including quality

Returns the set cache

getCache() : \Zend_Cache_Core

Returns

\Zend_Cache_CoreThe set cache

Returns the localized country name

getCountryTranslation(string $value, string | \Zend_Locale $locale) : array

deprecated

Parameters

$value

string

Name to get detailed information about

$locale

string\Zend_Locale

(Optional) Locale for country translation

Returns

array

Returns an array with the name of all countries translated to the given language

getCountryTranslationList(string | \Zend_Locale $locale) : array

deprecated

Parameters

$locale

string\Zend_Locale

(Optional) Locale for country translation

Returns

array

Return the default locale

getDefault() : array

Returns

arrayReturns an array of all locale string

Expects the Systems standard locale

getEnvironment() : array

For Windows: f.e.: LC_COLLATE=C;LC_CTYPE=German_Austria.1252;LC_MONETARY=C would be recognised as de_AT

Returns

array

Return the accepted charset of the client

getHttpCharset() : string

Returns

string

Returns the language part of the locale

getLanguage() : string

Returns

string

Returns the localized language name

getLanguageTranslation(string $value, string $locale) : array

deprecated

Parameters

$value

string

Name to get detailed information about

$locale

string

(Optional) Locale for language translation

Returns

array

Returns an array with the name of all languages translated to the given language

getLanguageTranslationList(string | \Zend_Locale $locale) : array

deprecated

Parameters

$locale

string\Zend_Locale

(Optional) Locale for language translation

Returns

array

Returns a list of all known locales where the locale is the key Only real locales are returned, the internal locales 'root', 'auto', 'browser' and 'environment' are suppressed

getLocaleList() : array

Returns

arrayList of all Locales

Returns the expected locale for a given territory

getLocaleToTerritory(string $territory) : string | null

Parameters

$territory

string

Territory for which the locale is being searched

Returns

stringnullLocale string or null when no locale has been found

Search the locale automatically and return all used locales ordered by quality

getOrder($order) : array

Standard Searchorder is Browser, Environment, Default

Parameters

$order

Returns

arrayReturns an array of all detected locales

Returns an array with translated yes strings

getQuestion(string | \Zend_Locale $locale) : array

Parameters

$locale

string\Zend_Locale

(Optional) Locale for language translation (defaults to $this locale)

Returns

array

Returns the region part of the locale if available

getRegion() : string | false

Returns

stringfalse- Regionstring

Returns the localized script name

getScriptTranslation(string $value, string $locale) : array

deprecated

Parameters

$value

string

Name to get detailed information about

$locale

string

(Optional) locale for script translation

Returns

array

Returns an array with the name of all scripts translated to the given language

getScriptTranslationList(string | \Zend_Locale $locale) : array

deprecated

Parameters

$locale

string\Zend_Locale

(Optional) Locale for script translation

Returns

array

Returns the localized territory name All territories contains other countries.

getTerritoryTranslation(string $value, string | \Zend_Locale $locale) : array

deprecated

Parameters

$value

string

Name to get detailed information about

$locale

string\Zend_Locale

(Optional) Locale for territory translation

Returns

array

Returns an array with the name of all territories translated to the given language All territories contains other countries.

getTerritoryTranslationList(string | \Zend_Locale $locale) : array

deprecated

Parameters

$locale

string\Zend_Locale

(Optional) Locale for territory translation

Returns

array

Returns a localized information string, supported are several types of informations.

getTranslation(string $value, string $path, string | \Zend_Locale $locale) : string | false

For detailed information about the types look into the documentation

Parameters

$value

string

Name to get detailed information about

$path

string

(Optional) Type of information to return

$locale

string\Zend_Locale

(Optional) Locale|Language for which this informations should be returned

Returns

stringfalseThe wished information in the given language

Returns localized informations as array, supported are several types of informations.

getTranslationList(string $path, string | \Zend_Locale $locale, string $value) : array

For detailed information about the types look into the documentation

Parameters

$path

string

(Optional) Type of information to return

$locale

string\Zend_Locale

(Optional) Locale|Language for which this informations should be returned

$value

string

(Optional) Value for detail list

Returns

arrayArray with the wished information in the given language

Returns true when a cache is set

hasCache() : boolean

Returns

boolean

Checks if a locale identifier is a real locale or not Examples: "en_XX" refers to "en", which returns true "XX_yy" refers to "root", which returns false

isLocale(string | \Zend_Locale $locale, boolean $strict, boolean $compatible) : boolean

Parameters

$locale

string\Zend_Locale

Locale to check for

$strict

boolean

(Optional) If true, no rerouting will be done when checking

$compatible

boolean

(DEPRECATED) Only for internal usage, brakes compatibility mode

Returns

booleanIf the locale is known dependend on the settings

Removes any set cache

removeCache() : void

Serialization Interface

serialize() : string

Returns

string

Sets a cache

setCache(Zend_Cache_Core $cache) : void

Parameters

$cache

\Zend_Cache_Core

Cache to set

Sets a new default locale which will be used when no locale can be detected If provided you can set a quality between 0 and 1 (or 2 and 100) which represents the percent of quality the browser requested within HTTP

setDefault(string | \Zend_Locale $locale, float $quality) : void

Parameters

$locale

string\Zend_Locale

Locale to set

$quality

float

The quality to set from 0 to 1

Exceptions

`\Zend_Locale_Exception`	When a autolocale was given
`\Zend_Locale_Exception`	When a unknown locale was given

Sets a new locale

setLocale(string | \Zend_Locale $locale) : void

Parameters

$locale

string\Zend_Locale

(Optional) New locale to set

Returns a string representation of the object

toString() : string

Returns

string

Internal function, returns a single locale on detection

_prepareLocale(string | \Zend_Locale $locale, boolean $strict) : string

Parameters

$locale

string\Zend_Locale

(Optional) Locale to work on

$strict

boolean

(Optional) Strict preparation

Exceptions

`\Zend_Locale_Exception`	When no locale is set which is only possible when the class was wrong extended

Returns

string

Internal function for preparing the returned question regex string

_prepareQuestionString(string $input) : string

Parameters

$input

string

Regex to parse

Returns

string

Properties

Defines if old behaviour should be supported Old behaviour throws notices and will be deleted in future releases

$compatibilityMode : boolean

Automatic detected locale

$_auto : string

Browser detected locale

$_browser : string

Default locale

$_default : string

Environment detected locale

$_environment : string

Actual set locale

$_locale : string

Internal variable

$_breakChain : boolean

Class wide Locale Constants

$_localeData : array

Class wide Locale Constants

$_territoryData : array

Constants

Autosearch constants

BROWSER

ENVIRONMENT

ENVIRONMENT

ZFDEFAULT

ZFDEFAULT