Craft 3 Class Reference

Appearance

Locale ​

Type
Class
Namespace
craft\i18n
Inherits
craft\i18n\Locale » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

Stores locale info.

View source

Public Properties ​

PropertyDescription
aMNamestring – The "AM" name.
dateFormatstring – The localized ICU date format.
dateTimeFormatstring – The localized ICU date + time format.
dateTimeFormatsarray
displayNamestring – The locale’s display name.
formattercraft\i18n\Formatter – A formatter for this locale.
idstring, null – The locale ID.
languageIDstring – This locale’s language ID.
monthNamesarray – The localized month names.
namestring, null
nativeNamestring, false
orientationstring – The language’s orientation.
pMNamestring – The "PM" name.
scriptIDstring, null – The locale’s script ID, if it has one.
territoryIDstring, null – The locale’s territory ID, if it has one.
timeFormatstring – The localized ICU time format.
weekDayNamesarray – The localized day of the week names.

aMName ​

Type
string
Default value
null
Access
Read-only

The "AM" name.

View source

dateFormat ​

Type
string
Default value
null
Access
Read-only

The localized ICU date format.

View source

dateTimeFormat ​

Type
string
Default value
null
Access
Read-only

The localized ICU date + time format.

View source

dateTimeFormats ​

Type
array
Default value
null
Access
Write-only
Since
3.6.0

View source

displayName ​

Type
string
Default value
null

The locale’s display name.

View source

formatter ​

Type
craft\i18n\Formatter
Default value
null
Access
Read-only

A formatter for this locale.

View source

id ​

Type
string, null
Default value
null

The locale ID.

View source

languageID ​

Type
string
Default value
null
Access
Read-only

This locale’s language ID.

View source

monthNames ​

Type
array
Default value
null
Access
Read-only

The localized month names.

View source

name ​

Type
string, null
Default value
null
Access
Read-only

View source

nativeName ​

Type
string, false
Default value
null
Access
Read-only

View source

orientation ​

Type
string
Default value
null
Access
Read-only

The language’s orientation.

View source

pMName ​

Type
string
Default value
null
Access
Read-only

The "PM" name.

View source

scriptID ​

Type
string, null
Default value
null
Access
Read-only

The locale’s script ID, if it has one.

View source

territoryID ​

Type
string, null
Default value
null
Access
Read-only

The locale’s territory ID, if it has one.

View source

timeFormat ​

Type
string
Default value
null
Access
Read-only

The localized ICU time format.

View source

weekDayNames ​

Type
array
Default value
null
Access
Read-only

The localized day of the week names.

View source

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__toString()Use the ID as the string representation of locales.
__unset()Sets an object property to null.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
getAMName()Returns the "AM" name for this locale.
getCurrencySymbol()Returns this locale’s symbol for a given currency.
getDateFormat()Returns the localized ICU date format.
getDateTimeFormat()Returns the localized ICU date + time format.
getDisplayName()Returns the locale name in a given language.
getFormatter()Returns a craft\i18n\Formatter for this locale.
getId()Returns the locale ID.
getLanguageID()Returns this locale’s language ID.
getMonthName()Returns a localized month name.
getMonthNames()Returns all of the localized month names.
getName()Returns the locale name in a given language.
getNativeName()Returns the locale name in its own language.
getNumberPattern()Returns a number pattern used by this locale.
getNumberSymbol()Returns a number symbol used by this locale.
getOrientation()Returns the language’s orientation (ltr or rtl).
getPMName()Returns the "PM" name for this locale.
getScriptID()Returns this locale’s script ID.
getTerritoryID()Returns this locale’s territory ID.
getTextAttribute()Returns a text attribute used by this locale.
getTimeFormat()Returns the localized ICU time format.
getWeekDayName()Returns a localized day of the week name.
getWeekDayNames()Returns all of the localized day of the week names.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
setDateTimeFormats()Sets the date/time formats used by this locale.

__construct() ​

Constructor.

View source

Arguments ​

  • $id (string) – The locale ID.
  • $config (array) – Name-value pairs that will be used to initialize the object properties.

Throws ​

__toString() ​

Use the ID as the string representation of locales.

View source

Returns ​

string

getAMName() ​

Returns the "AM" name for this locale.

View source

Returns ​

string – The "AM" name.

getCurrencySymbol() ​

Returns this locale’s symbol for a given currency.

View source

Arguments ​

  • $currency (string) – The 3-letter ISO 4217 currency code indicating the currency to use.

Returns ​

string – The currency symbol.

getDateFormat() ​

Returns the localized ICU date format.

View source

Arguments ​

  • $length (string, null) – The format length that should be returned. Values: Locale::LENGTH_SHORT, ::MEDIUM, ::LONG, ::FULL
  • $format (string) – The format type that should be returned. Values: Locale::FORMAT_ICU (default), ::FORMAT_PHP, ::FORMAT_JUI

Returns ​

string – The localized ICU date format.

getDateTimeFormat() ​

Returns the localized ICU date + time format.

View source

Arguments ​

  • $length (string, null) – The format length that should be returned. Values: Locale::LENGTH_SHORT, ::MEDIUM, ::LONG, ::FULL
  • $format (string) – The format type that should be returned. Values: Locale::FORMAT_ICU (default), ::FORMAT_PHP, ::FORMAT_JUI

Returns ​

string – The localized ICU date + time format.

getDisplayName() ​

Returns the locale name in a given language.

View source

Arguments ​

Returns ​

string

getFormatter() ​

Returns a craft\i18n\Formatter for this locale.

View source

Returns ​

craft\i18n\Formatter – A formatter for this locale.

getId() ​

DEPRECATED

Deprecated in 3.0.0. Use id instead.

Returns the locale ID.

View source

Returns ​

string

getLanguageID() ​

Returns this locale’s language ID.

View source

Returns ​

string – This locale’s language ID.

getMonthName() ​

Returns a localized month name.

View source

Arguments ​

  • $month (integer) – The month to return (1-12).
  • $length (string, null) – The format length that should be returned. Values: Locale::LENGTH_ABBREVIATED, ::MEDIUM, ::FULL
  • $standAlone (boolean) – Whether to return the "stand alone" month name.

Returns ​

string – The localized month name.

getMonthNames() ​

Returns all of the localized month names.

View source

Arguments ​

  • $length (string, null) – The format length that should be returned. Values: Locale::LENGTH_ABBREVIATED, ::MEDIUM, ::FULL
  • $standAlone (boolean) – Whether to return the "stand alone" month names.

Returns ​

array – The localized month names.

getName() ​

DEPRECATED

Deprecated in 3.0.0. Use getDisplayName() instead.

Returns the locale name in a given language.

View source

Arguments ​

Returns ​

string, null

getNativeName() ​

DEPRECATED

Deprecated in 3.0.0. Use getDisplayName() instead.

Returns the locale name in its own language.

View source

Returns ​

string, false

getNumberPattern() ​

Returns a number pattern used by this locale.

View source

Arguments ​

  • $style (integer) – The pattern style to return. Accepted values: Locale::STYLE_DECIMAL, ::STYLE_CURRENCY, ::STYLE_PERCENT, ::STYLE_SCIENTIFIC

Returns ​

string, null – The pattern

getNumberSymbol() ​

Returns a number symbol used by this locale.

View source

Arguments ​

  • $symbol (integer) – The symbol to return. Accepted values: Locale::SYMBOL_DECIMAL_SEPARATOR, ::SYMBOL_GROUPING_SEPARATOR, ::SYMBOL_PATTERN_SEPARATOR, ::SYMBOL_PERCENT, ::SYMBOL_ZERO_DIGIT, ::SYMBOL_DIGIT, ::SYMBOL_MINUS_SIGN, ::SYMBOL_PLUS_SIGN, ::SYMBOL_CURRENCY, ::SYMBOL_INTL_CURRENCY, ::SYMBOL_MONETARY_SEPARATOR, ::SYMBOL_EXPONENTIAL, ::SYMBOL_PERMILL, ::SYMBOL_PAD_ESCAPE, ::SYMBOL_INFINITY, ::SYMBOL_NAN, ::SYMBOL_SIGNIFICANT_DIGIT, ::SYMBOL_MONETARY_GROUPING_SEPARATOR

Returns ​

string, null – The symbol.

getOrientation() ​

Returns the language’s orientation (ltr or rtl).

View source

Returns ​

string – The language’s orientation.

getPMName() ​

Returns the "PM" name for this locale.

View source

Returns ​

string – The "PM" name.

getScriptID() ​

Returns this locale’s script ID.

A script ID consists of only the last four characters after a dash in the locale ID.

View source

Returns ​

string, null – The locale’s script ID, if it has one.

getTerritoryID() ​

Returns this locale’s territory ID.

A territory ID consists of only the last two to three letter or digits after a dash in the locale ID.

View source

Returns ​

string, null – The locale’s territory ID, if it has one.

getTextAttribute() ​

Returns a text attribute used by this locale.

View source

Arguments ​

  • $attribute (integer) – The attribute to return. Values: Locale::

Returns ​

string, null – The attribute.

getTimeFormat() ​

Returns the localized ICU time format.

View source

Arguments ​

  • $length (string, null) – The format length that should be returned. Values: Locale::LENGTH_SHORT, ::MEDIUM, ::LONG, ::FULL
  • $format (string) – The format type that should be returned. Values: Locale::FORMAT_ICU (default), ::FORMAT_PHP, ::FORMAT_JUI

Returns ​

string – The localized ICU time format.

getWeekDayName() ​

Returns a localized day of the week name.

View source

Arguments ​

  • $day (integer) – The day of the week to return (0-6), where 0 stands for Sunday.
  • $length (string, null) – The format length that should be returned. Values: Locale::LENGTH_ABBREVIATED, ::SHORT, ::MEDIUM, ::FULL
  • $standAlone (boolean) – Whether to return the "stand alone" day of the week name.

Returns ​

string – The localized day of the week name.

getWeekDayNames() ​

Returns all of the localized day of the week names.

View source

Arguments ​

  • $length (string, null) – The format length that should be returned. Values: Locale::LENGTH_ABBREVIATED, ::MEDIUM, ::FULL
  • $standAlone (boolean) – Whether to return the "stand alone" day of the week names.

Returns ​

array – The localized day of the week names.

setDateTimeFormats() ​

Since
3.6.0

Sets the date/time formats used by this locale.

You should pass an array with keys short, medium, long, and/or full, set to sub-arrays with keys date, time, and/or datetime, which should be set to the date/time formats using ICU date/time formatting syntax.

For example:

php
[
    'short' => [
        'date' => 'd/M/y',
        'time' => 'HH:mm',
        'datetime' => 'd/M/y HH:mm',
    ],
]

View source

Arguments ​

Returns ​

void

Constants ​

ConstantDescription
ATTR_CURRENCY_CODE
ATTR_DEFAULT_RULESET
ATTR_NEGATIVE_PREFIX
ATTR_NEGATIVE_SUFFIX
ATTR_PADDING_CHARACTER
ATTR_POSITIVE_PREFIX
ATTR_POSITIVE_SUFFIX
ATTR_PUBLIC_RULESETS
FORMAT_ICU
FORMAT_JUI
FORMAT_PHP
LENGTH_ABBREVIATED
LENGTH_FULL
LENGTH_LONG
LENGTH_MEDIUM
LENGTH_SHORT
STYLE_CURRENCY
STYLE_DECIMAL
STYLE_PERCENT
STYLE_SCIENTIFIC
SYMBOL_CURRENCY
SYMBOL_DECIMAL_SEPARATOR
SYMBOL_DIGIT
SYMBOL_EXPONENTIAL
SYMBOL_GROUPING_SEPARATOR
SYMBOL_INFINITY
SYMBOL_INTL_CURRENCY
SYMBOL_MINUS_SIGN
SYMBOL_MONETARY_GROUPING_SEPARATOR
SYMBOL_MONETARY_SEPARATOR
SYMBOL_NAN
SYMBOL_PAD_ESCAPE
SYMBOL_PATTERN_SEPARATOR
SYMBOL_PERCENT
SYMBOL_PERMILL
SYMBOL_PLUS_SIGN
SYMBOL_SIGNIFICANT_DIGIT
SYMBOL_ZERO_DIGIT