class Locale implements LocaleInterface, TreeInterface (View source)

Represents a site locale.

Traits

Properties

protected $msLanguage from  LocaleTrait
protected $msCountry from  LocaleTrait
protected $msNumPlurals from  LocaleTrait
protected $msPluralRule from  LocaleTrait
protected $msPluralCases from  LocaleTrait
protected $siteLocaleID
protected $site
protected $tree
$msIsDefault

Methods

mixed
getLanguage()

No description

setLanguage(mixed $msLanguage)

No description

mixed
getCountry()

No description

setCountry(mixed $msCountry)

No description

mixed
getNumPlurals()

No description

setNumPlurals(mixed $msNumPlurals)

No description

mixed
getPluralRule()

No description

setPluralRule(mixed $msPluralRule)

No description

mixed
getPluralCases()

No description

setPluralCases(mixed $msPluralCases)

No description

getLocale()

No description

getLanguageText($locale = null)

No description

getExporter()

No description

getLocaleID()

Get the site locale record identifier (or NULL if the record has not been saved yet).

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

mixed getLanguage()

No description

Return Value

mixed

setLanguage(mixed $msLanguage)

No description

Parameters

mixed $msLanguage

mixed getCountry()

No description

Return Value

mixed

setCountry(mixed $msCountry)

No description

Parameters

mixed $msCountry

mixed getNumPlurals()

No description

Return Value

mixed

setNumPlurals(mixed $msNumPlurals)

No description

Parameters

mixed $msNumPlurals

mixed getPluralRule()

No description

Return Value

mixed

setPluralRule(mixed $msPluralRule)

No description

Parameters

mixed $msPluralRule

mixed getPluralCases()

No description

Return Value

mixed

setPluralCases(mixed $msPluralCases)

No description

Parameters

mixed $msPluralCases

getLocale()

No description

getLanguageText($locale = null)

No description

Parameters

$locale

getExporter()

No description

getLocaleID()

Get the site locale record identifier (or NULL if the record has not been saved yet).

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()

No description

Return Value

int|null

See also

TreeInterface::getSiteTreeID

Tree|null getSiteTreeObject()

No description

Return Value

Tree|null

See also

TreeInterface::getSiteTreeObject