Craft 3 Class Reference

  • Root Namespace

  • craft\app\web

  • craft\base

  • craft\behaviors

  • craft\cache

  • craft\composer

  • craft\config

  • craft\console

  • craft\console\actions

  • craft\console\controllers

  • craft\controllers

  • craft\controllers\pluginstore

  • craft\db

  • craft\db\mysql

  • craft\db\pgsql

  • craft\debug

  • craft\elements

  • craft\elements\actions

  • craft\elements\db

  • craft\enums

  • craft\errors

  • craft\events

  • craft\feeds

  • craft\fields

  • craft\fields\data

  • craft\helpers

  • craft\i18n

  • craft\image

  • craft\log

  • craft\mail

  • craft\mail\transportadapters

  • craft\migrations

  • craft\models

  • craft\mutex

  • craft\queue

  • craft\queue\jobs

  • craft\records

  • craft\search

  • craft\services

  • craft\utilities

  • craft\validators

  • craft\volumes

  • craft\web

  • craft\web\assets\assetindexes

  • craft\web\assets\clearcaches

  • craft\web\assets\cp

  • craft\web\assets\craftsupport

  • craft\web\assets\d3

  • craft\web\assets\dashboard

  • craft\web\assets\datepickeri18n

  • craft\web\assets\dbbackup

  • craft\web\assets\deprecationerrors

  • craft\web\assets\editcategory

  • craft\web\assets\editentry

  • craft\web\assets\edittransform

  • craft\web\assets\edituser

  • craft\web\assets\elementresizedetector

  • craft\web\assets\fabric

  • craft\web\assets\feed

  • craft\web\assets\fields

  • craft\web\assets\fileupload

  • craft\web\assets\findreplace

  • craft\web\assets\garnish

  • craft\web\assets\generalsettings

  • craft\web\assets\installer

  • craft\web\assets\jquerypayment

  • craft\web\assets\jquerytouchevents

  • craft\web\assets\jqueryui

  • craft\web\assets\login

  • craft\web\assets\matrix

  • craft\web\assets\matrixsettings

  • craft\web\assets\newusers

  • craft\web\assets\picturefill

  • craft\web\assets\plugins

  • craft\web\assets\pluginstore

  • craft\web\assets\pluginstoreoauth

  • craft\web\assets\positionselect

  • craft\web\assets\prismjs

  • craft\web\assets\quickpost

  • craft\web\assets\qunit

  • craft\web\assets\recententries

  • craft\web\assets\routes

  • craft\web\assets\searchindexes

  • craft\web\assets\selectize

  • craft\web\assets\sites

  • craft\web\assets\systemmessages

  • craft\web\assets\tablesettings

  • craft\web\assets\tests

  • craft\web\assets\timepicker

  • craft\web\assets\updater

  • craft\web\assets\updates

  • craft\web\assets\updateswidget

  • craft\web\assets\userpermissions

  • craft\web\assets\utilities

  • craft\web\assets\velocity

  • craft\web\assets\vue

  • craft\web\assets\whatsnew

  • craft\web\assets\xregexp

  • craft\web\twig

  • craft\web\twig\nodes

  • craft\web\twig\nodevisitors

  • craft\web\twig\tokenparsers

  • craft\web\twig\variables

  • craft\widgets

I18N

Type
Class
Namespace
craft\i18n
Inherits
craft\i18n\I18N » yii\i18n\I18N » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

View source

Public Properties

PropertyDescription
$allLocaleIdsarray – An array of locale IDs.
$allLocalescraft\i18n\Locale[] – An array of craft\i18n\Locale objects.
$appLocaleIdsarray – An array of locale IDs.
$appLocalescraft\i18n\Locale[] – An array of craft\i18n\Locale objects.
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$editableLocaleIdsarray
$editableLocalesarray
$isIntlLoadedboolean – Whether the Intl extension is loaded.
$messageFormatteryii\i18n\MessageFormatter – The message formatter to be used to format message via ICU message format.
$primarySiteLocalecraft\i18n\Locale – A craft\i18n\Locale object representing the primary locale.
$primarySiteLocaleIdstring – The primary locale ID.
$siteLocaleIdsarray – An array of locale IDs.
$siteLocalescraft\i18n\Locale[] – An array of craft\i18n\Locale objects.
$translationsarray – List of \craft\i18n\MessageSource configurations or objects.

$allLocaleIds

Type
array
Access
Read-only

An array of locale IDs.

View source

Signature

public array getAllLocaleIds ( )

$allLocales

Type
craft\i18n\Locale[]
Access
Read-only

An array of craft\i18n\Locale objects.

View source

Signature

public craft\i18n\Locale[] getAllLocales ( )

$appLocaleIds

Type
array
Access
Read-only

An array of locale IDs.

View source

Signature

public array getAppLocaleIds ( )

$appLocales

Type
craft\i18n\Locale[]
Access
Read-only

An array of craft\i18n\Locale objects.

View source

Signature

public craft\i18n\Locale[] getAppLocales ( )

$editableLocaleIds

Type
array
Access
Read-only

View source

Signature

public array getEditableLocaleIds ( )

$editableLocales

Type
array
Access
Read-only

View source

Signature

public array getEditableLocales ( )

$isIntlLoaded

Type
boolean
Access
Read-only

Whether the Intl extension is loaded.

View source

Signature

public boolean getIsIntlLoaded ( )

$primarySiteLocale

Type
craft\i18n\Locale
Access
Read-only

A craft\i18n\Locale object representing the primary locale.

View source

Signature

public craft\i18n\Locale getPrimarySiteLocale ( )

$primarySiteLocaleId

Type
string
Access
Read-only

The primary locale ID.

View source

Signature

public string getPrimarySiteLocaleId ( )

$siteLocaleIds

Type
array
Access
Read-only

An array of locale IDs.

View source

Signature

public array getSiteLocaleIds ( )

$siteLocales

Type
craft\i18n\Locale[]
Access
Read-only

An array of craft\i18n\Locale objects.

View source

Signature

public craft\i18n\Locale[] getSiteLocales ( )

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__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.
__unset()Sets an object property to null.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
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.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
format()Formats a message using \craft\i18n\MessageFormatter.
getAllLocaleIds()Returns an array of all known locale IDs.
getAllLocales()Returns an array of all known locales.
getAppLocaleIds()Returns an array of the locale IDs which Craft has been translated into. The list of locales is based on whatever files exist in vendor/craftcms/cms/src/translations/.
getAppLocales()Returns an array of locales that Craft is translated into. The list of locales is based on whatever files exist in vendor/craftcms/cms/src/translations/.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getEditableLocaleIds()Returns an array of the editable locale IDs.
getEditableLocales()Returns a list of locales that are editable by the current user.
getIsIntlLoaded()Returns whether the Intl extension is loaded.
getLocaleById()Returns a locale by its ID.
getMessageFormatter()Returns the message formatter instance.
getMessageSource()Returns the message source for the given category.
getPrimarySiteLocale()Returns the site's primary locale. The primary locale is whatever is listed first in Settings > Locales in the control panel.
getPrimarySiteLocaleId()Returns the site's primary locale ID. The primary locale is whatever is listed first in Settings > Locales in the control panel.
getSiteLocaleIds()Returns an array of the site locale IDs.
getSiteLocales()Returns an array of the site locales.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the component by configuring the default message categories.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
setMessageFormatter()
translate()Translates a message to the specified language.
trigger()Triggers an event.

getAllLocaleIds()

Returns an array of all known locale IDs. If the PHP intl extension is loaded, then this will be based on all of the locale IDs it knows about. Otherwise, it will be based on the locale data files located in vendor/craftcms/cms/src/config/locales/ and config/locales/.

View source

Returns

array – An array of locale IDs.

Signature

public array getAllLocaleIds ( )

getAllLocales()

Returns an array of all known locales.

See also getAllLocaleIds()View source

Returns

craft\i18n\Locale[] – An array of craft\i18n\Locale objects.

Signature

public craft\i18n\Locale[] getAllLocales ( )

getAppLocaleIds()

Returns an array of the locale IDs which Craft has been translated into. The list of locales is based on whatever files exist in vendor/craftcms/cms/src/translations/.

View source

Returns

array – An array of locale IDs.

Throws

Signature

public array getAppLocaleIds ( )

getAppLocales()

Returns an array of locales that Craft is translated into. The list of locales is based on whatever files exist in vendor/craftcms/cms/src/translations/.

View source

Returns

craft\i18n\Locale[] – An array of craft\i18n\Locale objects.

Throws

Signature

public craft\i18n\Locale[] getAppLocales ( )

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

array

Signature

public array getEditableLocales ( )

getIsIntlLoaded()

Returns whether the Intl extension is loaded.

View source

Returns

boolean – Whether the Intl extension is loaded.

Signature

public boolean getIsIntlLoaded ( )

getLocaleById()

Returns a locale by its ID.

View source

Arguments

Returns

craft\i18n\Locale

Signature

public craft\i18n\Locale getLocaleById ( \craft\i18n\string $localeId )

getPrimarySiteLocale()

Returns the site's primary locale. The primary locale is whatever is listed first in Settings > Locales in the control panel.

View source

Returns

craft\i18n\Locale – A craft\i18n\Locale object representing the primary locale.

Signature

public craft\i18n\Locale getPrimarySiteLocale ( )

getPrimarySiteLocaleId()

Returns the site's primary locale ID. The primary locale is whatever is listed first in Settings > Locales in the control panel.

View source

Returns

string – The primary locale ID.

Signature

public string getPrimarySiteLocaleId ( )

getSiteLocaleIds()

Returns an array of the site locale IDs.

View source

Returns

array – An array of locale IDs.

Signature

public array getSiteLocaleIds ( )

getSiteLocales()

Returns an array of the site locales.

View source

Returns

craft\i18n\Locale[] – An array of craft\i18n\Locale objects.

Signature

public craft\i18n\Locale[] getSiteLocales ( )

init()

Initializes the component by configuring the default message categories.

View source

Signature

public void init ( )

translate()

Translates a message to the specified language.

After translation the message will be formatted using \craft\i18n\MessageFormatter if it contains ICU message format and $params are not empty.

View source

Arguments

  • $category (string) – The message category.
  • $message (string) – The message to be translated.
  • $params (array) – The parameters that will be used to replace the corresponding placeholders in the message.
  • $language (string) – The language code (e.g. en-US, en).

Returns

string – The translated and formatted message.

Signature

public string translate ( $category, $message, $params, $language )

← Locale →