1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Entity
  7. \
  8. Site
  9. \
  10. Locale

Locale

class Locale implements LocaleInterface, TreeInterface (View source)

Represents a site locale.

Traits

LocaleTrait

Properties

protected string $msLanguage

The language code.

 from  LocaleTrait
protected string $msCountry

The Country/territory code.

 from  LocaleTrait
protected int $msNumPlurals

The number of plural rules used in this locale.

 from  LocaleTrait
protected string $msPluralRule

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

 from  LocaleTrait
protected string $msPluralCases

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

 from  LocaleTrait
protected $siteLocaleID
protected $site
protected $tree
$msIsDefault

Methods

string
getLanguage()

Get the language code.

from  LocaleTrait
setLanguage(string $msLanguage)

Set the language code.

from  LocaleTrait
string
getCountry()

Get the Country/territory code.

from  LocaleTrait
setCountry(string $msCountry)

Set the Country/territory code.

from  LocaleTrait
int
getNumPlurals()

Get the number of plural rules used in this locale.

from  LocaleTrait
setNumPlurals(int $msNumPlurals)

Set the number of plural rules used in this locale.

from  LocaleTrait
string
getPluralRule()

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

from  LocaleTrait
setPluralRule(string $msPluralRule)

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

from  LocaleTrait
array
getPluralCases()

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

from  LocaleTrait
setPluralCases(string $msPluralCases)

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

from  LocaleTrait
string
getLocale()

Get the full code of this locale.

from  LocaleTrait
string
getLanguageText(string|null $locale = null)

Get the display name of this locale.

from  LocaleTrait
Locale
getExporter()

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

from  LocaleTrait
int|null
getLocaleID()

Get the locale record identifier.

bool
getIsDefault()

Is this the default locale?

setIsDefault(bool $msIsDefault)

Is this the default locale?

Site|null
getSite()

Get the site associated to this locale.

setSite(Site $site = null)

Set the site associated to this locale.

SiteTree|null
getSiteTree()

Get the site tree associated to this locale.

setSiteTree(SiteTree $tree = null)

Set the site tree associated to this locale.

int|null
getSiteTreeID()

No description

Tree|null
getSiteTreeObject()

No description

Details

in LocaleTrait at line 73
string getLanguage()

Get the language code.

Return Value

string

Examples

<code>en</code>

in LocaleTrait at line 85
setLanguage(string $msLanguage)

Set the language code.

Parameters

string $msLanguage

Examples

<code>en</code>

in LocaleTrait at line 97
string getCountry()

Get the Country/territory code.

Return Value

string

Examples

<code>US</code>

in LocaleTrait at line 109
setCountry(string $msCountry)

Set the Country/territory code.

Parameters

string $msCountry

Examples

<code>US</code>

in LocaleTrait at line 119
int getNumPlurals()

Get the number of plural rules used in this locale.

Return Value

int

in LocaleTrait at line 129
setNumPlurals(int $msNumPlurals)

Set the number of plural rules used in this locale.

Parameters

int $msNumPlurals

in LocaleTrait at line 141
string getPluralRule()

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

Return Value

string

Examples

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

in LocaleTrait 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>

in LocaleTrait 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>

in LocaleTrait 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>

in LocaleTrait at line 198
string getLocale()

Get the full code of this locale.

Return Value

string

Examples

<code>en_US</code>

in LocaleTrait 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

in LocaleTrait at line 232
Locale getExporter()

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

Return Value

Locale

at line 49
int|null getLocaleID()

Get the locale record identifier.

Return Value

int|null

See also

LocaleInterface::getLocaleID

at line 59
bool getIsDefault()

Is this the default locale?

Return Value

bool

at line 69
setIsDefault(bool $msIsDefault)

Is this the default locale?

Parameters

bool $msIsDefault

at line 79
Site|null getSite()

Get the site associated to this locale.

Return Value

Site|null

at line 89
setSite(Site $site = null)

Set the site associated to this locale.

Parameters

Site $site

at line 99
SiteTree|null getSiteTree()

Get the site tree associated to this locale.

Return Value

SiteTree|null

at line 109
setSiteTree(SiteTree $tree = null)

Set the site tree associated to this locale.

Parameters

SiteTree $tree

at line 119
int|null getSiteTreeID()

No description

Return Value

int|null

See also

TreeInterface::getSiteTreeID

at line 131
Tree|null getSiteTreeObject()

No description

Return Value

Tree|null

See also

TreeInterface::getSiteTreeObject