1. interface
  2. Concrete
  3. \
  4. Core
  5. \
  6. Localization
  7. \
  8. Locale
  9. \
  10. LocaleInterface

LocaleInterface

interface LocaleInterface (View source)

Methods

int|null
getLocaleID()

Get the locale record identifier.

string
getLanguage()

Get the language code.

string
getCountry()

Get the Country/territory code.

string
getLocale()

Get the full code of this locale.

int
getNumPlurals()

Get the number of plural rules used in this locale.

array
getPluralCases()

Get the plural rule names with examples (using CLDR format).

string
getPluralRule()

Get the plural rules definition of this locale (using gettext format).

setNumPlurals(mixed $numPlurals)

Set the number of plural rules used in this locale.

setPluralCases(mixed $numCases)

Set the plural rule names with examples (using CLDR format).

setPluralRule(mixed $pluralRule)

Set the plural rules definition of this locale (using gettext format).

string
getLanguageText(string|null $locale = null)

Get the display name of this locale.

Details

at line 12
int|null getLocaleID()

Get the locale record identifier.

Return Value

int|null

at line 21
string getLanguage()

Get the language code.

Return Value

string

Examples

<code>en</code>

at line 30
string getCountry()

Get the Country/territory code.

Return Value

string

Examples

<code>US</code>

at line 39
string getLocale()

Get the full code of this locale.

Return Value

string

Examples

<code>en_US</code>

at line 46
int getNumPlurals()

Get the number of plural rules used in this locale.

Return Value

int

at line 58
array getPluralCases()

Get the plural rule names with examples (using CLDR format).

Return Value

array

array keys are the CLDR identifiers or the plural rules (zero, one, two, few, many, other), array values are example values

Examples

<pre><code>[

    'one' => '1',

    'other' => '0, 2~16, 100, 1000, 10000, 100000, 1000000, …',

]</code></pre>

at line 67
string getPluralRule()

Get the plural rules definition of this locale (using gettext format).

Return Value

string

Examples

<code>(n != 1)</code>

at line 75
setNumPlurals(mixed $numPlurals)

Set the number of plural rules used in this locale.

Parameters

mixed $numPlurals

at line 85
setPluralCases(mixed $numCases)

Set the plural rule names with examples (using CLDR format).

Parameters

mixed $numCases

Examples

<code>one@1\nother@0, 2~16, 100, 1000, 10000, 100000, 1000000, …</code>

at line 95
setPluralRule(mixed $pluralRule)

Set the plural rules definition of this locale (using gettext format).

Parameters

mixed $pluralRule

Examples

<code>(n != 1)</code>

at line 108
string getLanguageText(string|null $locale = null)

Get the display name of this locale.

Parameters

string|null $locale

The locale to be used to localize the locale name

Return Value

string

Examples

<code>getLanguage('en_US')</code> returns the display name of this locale in American English
 
<code>getLanguage('it_IT')</code> returns the display name of this locale in Italian
 
<code>getLanguage()</code> returns the display name of this locale in the currently active locale