LocaleInterface
Locale interface.
Tags
Table of Contents
| getAuthors() | Returns the list of authors of the locale. | string[] |
|---|---|---|
| getConfigFile() | Returns defined configuration file. | string |
| getIdentifier() | Returns the locale identifier. | string |
| getConfig() | Return the raw configuration data. | (array|string)[] |
| getDependentLocales() | Return an array of parent locales. | \UserFrosting\I18n\LocaleInterface[] |
| getDependentLocalesIdentifier() | Return a list of parent locale identifier (eg. [fr_FR, en_US]). | string[] |
| getName() | Return the name of the locale, in English form. | string |
| getPluralRule() | Return the number representing the plural rule to use for this locale. | int |
| getRegionalName() | Return the localized version of the locale name. | string |
Methods
getAuthors()
Returns the list of authors of the locale.
public
getAuthors(
)
: string[]
Return values
string[] —The list of authors
getConfigFile()
Returns defined configuration file.
public
getConfigFile(
)
: string
Return values
stringgetIdentifier()
Returns the locale identifier.
public
getIdentifier(
)
: string
Return values
stringgetConfig()
Return the raw configuration data.
public
getConfig(
)
: (array|string)[]
Return values
(array|string)[]getDependentLocales()
Return an array of parent locales.
public
getDependentLocales(
)
: \UserFrosting\I18n\LocaleInterface[]
Return values
\UserFrosting\I18n\LocaleInterface[]getDependentLocalesIdentifier()
Return a list of parent locale identifier (eg. [fr_FR, en_US]).
public
getDependentLocalesIdentifier(
)
: string[]
Return values
string[]getName()
Return the name of the locale, in English form.
public
getName(
)
: string
Return values
stringgetPluralRule()
Return the number representing the plural rule to use for this locale.
public
getPluralRule(
)
: int
Return values
intgetRegionalName()
Return the localized version of the locale name.
public
getRegionalName(
)
: string