class Locale implements LocaleInterface, TreeInterface (View source)

Represents a site locale.

Traits

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.

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.

getExporter()

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

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

string getLanguage()

Get the language code.

Return Value

string

setLanguage(string $msLanguage)

Set the language code.

Parameters

string $msLanguage

string getCountry()

Get the Country/territory code.

Return Value

string

setCountry(string $msCountry)

Set the Country/territory code.

Parameters

string $msCountry

int getNumPlurals()

Get the number of plural rules used in this locale.

Return Value

int

setNumPlurals(int $msNumPlurals)

Set the number of plural rules used in this locale.

Parameters

int $msNumPlurals

string getPluralRule()

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

Return Value

string

setPluralRule(string $msPluralRule)

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

Parameters

string $msPluralRule

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

setPluralCases(string $msPluralCases)

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

Parameters

string $msPluralCases

string getLocale()

Get the full code of this locale.

Return Value

string

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

Locale getExporter()

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

Return Value

Locale

int|null getLocaleID()

Get the locale record identifier.

Return Value

int|null

See also

\Concrete\Core\Localization\Locale\LocaleInterface::getLocaleID()

bool getIsDefault()

Is this the default locale?

Return Value

bool

setIsDefault(bool $msIsDefault)

Is this the default locale?

Parameters

bool $msIsDefault

Site|null getSite()

Get the site associated to this locale.

Return Value

Site|null

setSite(Site $site = null)

Set the site associated to this locale.

Parameters

Site $site

SiteTree|null getSiteTree()

Get the site tree associated to this locale.

Return Value

SiteTree|null

setSiteTree(SiteTree $tree = null)

Set the site tree associated to this locale.

Parameters

SiteTree $tree

int|null getSiteTreeID()

Return Value

int|null

See also

TreeInterface::getSiteTreeID()

Tree|null getSiteTreeObject()

Return Value

Tree|null

See also

TreeInterface::getSiteTreeObject()