I18N

Type
Class
Namespace
craft\web\twig\variables
Inherits
craft\web\twig\variables\I18N
Since
3.0
Deprecated in
in 3.0

Localization functions.

View source

Public Methods

MethodDescription
getAllLocales()Gets all known languages.
getAppLocales()Returns the locales that the application is translated for.
getCurrentLocale()Returns the current locale.
getDatepickerJsFormat()Returns the jQuery UI Datepicker date format, per the current locale.
getEditableLocaleIds()Returns an array of the editable locale IDs.
getEditableLocales()Returns a list of locales that are editable by the current user.
getLocaleById()Returns a locale by its ID.
getLocaleData()Returns the localization data for a given locale.
getPrimarySiteLocale()Returns the site's primary locale.
getSiteLocaleIds()Returns an array of the site locale IDs.
getSiteLocales()Returns the locales that the site is translated for.
getTimepickerJsFormat()Returns the jQuery Timepicker time format, per the current locale.

getAllLocales()

Gets all known languages.

View source

Returns

craft\i18n\Locale[]

Signature

public craft\i18n\Locale[] getAllLocales ( )

getAppLocales()

Returns the locales that the application is translated for.

View source

Returns

craft\i18n\Locale[]

Signature

public craft\i18n\Locale[] getAppLocales ( )

getCurrentLocale()

Returns the current locale.

View source

Returns

craft\i18n\Locale

Signature

public craft\i18n\Locale getCurrentLocale ( )

getDatepickerJsFormat()

Returns the jQuery UI Datepicker date format, per the current locale.

View source

Returns

string

Signature

public string getDatepickerJsFormat ( )

getEditableLocaleIds()

Returns an array of the editable locale IDs.

View source

Returns

array

Signature

public array getEditableLocaleIds ( )

getEditableLocales()

Returns a list of locales that are editable by the current user.

View source

Returns

craft\i18n\Locale[]

Signature

public craft\i18n\Locale[] getEditableLocales ( )

getLocaleById()

Returns a locale by its ID.

View source

Arguments

Returns

craft\i18n\Locale

Signature

public craft\i18n\Locale getLocaleById ( \craft\web\twig\variables\string $localeId )

getLocaleData()

Returns the localization data for a given locale.

View source

Arguments

Returns

craft\i18n\Locale

Signature

public craft\i18n\Locale getLocaleData ( \craft\web\twig\variables\string $localeId = null )

getPrimarySiteLocale()

Returns the site's primary locale.

View source

Returns

string

Signature

public string getPrimarySiteLocale ( )

getSiteLocaleIds()

Returns an array of the site locale IDs.

View source

Returns

array

Signature

public array getSiteLocaleIds ( )

getSiteLocales()

Returns the locales that the site is translated for.

View source

Returns

craft\i18n\Locale[]

Signature

public craft\i18n\Locale[] getSiteLocales ( )

getTimepickerJsFormat()

Returns the jQuery Timepicker time format, per the current locale.

View source

Returns

string

Signature

public string getTimepickerJsFormat ( )