1. trait
  2. Concrete
  3. \
  4. Core
  5. \
  6. Entity
  7. \
  8. LocaleTrait

LocaleTrait

trait LocaleTrait (View source)

Properties

protected string $msLanguage

The language code.
protected string $msCountry

The Country/territory code.
protected int $msNumPlurals

The number of plural rules used in this locale.
protected string $msPluralRule

The plural rules definition of this locale (using gettext format).
protected string $msPluralCases

The plural rule names with examples (using CLDR format).

Methods

string
getLanguage()

Get the language code.

setLanguage(string $msLanguage)

Set the language code.

string
getCountry()

Get the Country/territory code.

setCountry(string $msCountry)

Set the Country/territory code.

int
getNumPlurals()

Get the number of plural rules used in this locale.

setNumPlurals(int $msNumPlurals)

Set the number of plural rules used in this locale.

string
getPluralRule()

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

setPluralRule(string $msPluralRule)

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

array
getPluralCases()

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

setPluralCases(string $msPluralCases)

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

string
getLocale()

Get the full code of this locale.

string
getLanguageText(string|null $locale = null)

Get the display name of this locale.

Locale
getExporter()

Get the object to be used to export this item to aSimpleXMLElement.

Details

at line 73
string getLanguage()

Get the language code.

Return Value

string

Examples

<code>en</code>

at line 85
setLanguage(string $msLanguage)

Set the language code.

Parameters

string $msLanguage

Examples

<code>en</code>

at line 97
string getCountry()

Get the Country/territory code.

Return Value

string

Examples

<code>US</code>

at line 109
setCountry(string $msCountry)

Set the Country/territory code.

Parameters

string $msCountry

Examples

<code>US</code>

at line 119
int getNumPlurals()

Get the number of plural rules used in this locale.

Return Value

int

at line 129
setNumPlurals(int $msNumPlurals)

Set the number of plural rules used in this locale.

Parameters

int $msNumPlurals

at line 141
string getPluralRule()

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

Return Value

string

Examples

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

at line 153
setPluralRule(string $msPluralRule)

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

Parameters

string $msPluralRule

Examples

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

at line 168
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 186
setPluralCases(string $msPluralCases)

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

Parameters

string $msPluralCases

Examples

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

at line 198
string getLocale()

Get the full code of this locale.

Return Value

string

Examples

<code>en_US</code>

at line 214
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

at line 232
Locale getExporter()

Get the object to be used to export this item to aSimpleXMLElement.

Return Value

Locale