Class craft\i18n\PhpMessageSource
- Inheritance
- craft\i18n\PhpMessageSource » yii\i18n\PhpMessageSource » yii\i18n\MessageSource » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/i18n/PhpMessageSource.php
Class PhpMessageSource
| Property | Type | Description | Defined By |
|---|---|---|---|
$allowOverrides |
boolean | Whether the messages can be overridden by translations in the site’s translations folder | craft\i18n\PhpMessageSource |
$basePath |
string | The base path for all translated messages. | yii\i18n\PhpMessageSource |
$fileMap |
array | Mapping between message categories and the corresponding message file paths. | yii\i18n\PhpMessageSource |
$forceTranslation |
boolean | Whether to force message translation when the source and target languages are the same. | yii\i18n\MessageSource |
$sourceLanguage |
string | The language that the original messages are in. | yii\i18n\MessageSource |
| Method | Description | Defined By |
|---|---|---|
__call() |
Calls the named method which is not a class method. | yii\base\BaseObject |
__clone() |
This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() |
Constructor. | yii\base\BaseObject |
__get() |
Returns the value of an object property. | yii\base\BaseObject |
__isset() |
Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() |
Sets value of an object property. | yii\base\BaseObject |
__unset() |
Sets an object property to null. | yii\base\BaseObject |
attachBehavior() |
Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() |
Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() |
Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() |
Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() |
Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() |
Returns the fully qualified name of this class. | yii\base\BaseObject |
detachBehavior() |
Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() |
Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() |
Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
getBehavior() |
Returns the named behavior object. | yii\base\Component |
getBehaviors() |
Returns all behaviors attached to this component. | yii\base\Component |
hasEventHandlers() |
Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() |
Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() |
Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() |
Initializes the object. | yii\base\BaseObject |
off() |
Detaches an existing event handler from this component. | yii\base\Component |
on() |
Attaches an event handler to an event. | yii\base\Component |
translate() |
Translates a message to the specified language. | yii\i18n\MessageSource |
trigger() |
Triggers an event. | yii\base\Component |
| Method | Description | Defined By |
|---|---|---|
getMessageFilePath() |
Returns message file path for the specified language and category. | yii\i18n\PhpMessageSource |
loadFallbackMessages() |
The method is normally called by loadMessages() to load the fallback messages for the language. | yii\i18n\PhpMessageSource |
loadMessages() |
Loads the message translation for the specified $language and $category. | craft\i18n\PhpMessageSource |
loadMessagesFromFile() |
Loads the message translation for the specified language and category or returns null if file doesn't exist. | yii\i18n\PhpMessageSource |
translateMessage() |
Translates the specified message. | yii\i18n\MessageSource |
| Event | Type | Description | Defined By |
|---|---|---|---|
EVENT_MISSING_TRANSLATION |
yii\i18n\MissingTranslationEvent | An event that is triggered when a message translation is not found. | yii\i18n\MessageSource |
Property Details
$allowOverrides
public property
#
Whether the messages can be overridden by translations in the site’s translations folder
public boolean $allowOverrides = falseMethod Details
loadMessages()
protected method
#
Loads the message translation for the specified $language and $category.
If translation for specific locale code such as en-US isn't found it
tries more generic en. When both are present, the en-US messages will be merged
over en. See loadFallbackMessages() for details.
If the $language is less specific than $sourceLanguage, the method will try to
load the messages for $sourceLanguage. For example: $sourceLanguage is en-GB,
$language is en. The method will load the messages for en and merge them over en-GB.
protected array loadMessages ( $category, $language )$category |
string | The message category |
$language |
string | The target language |
| return | array | The loaded messages. The keys are original messages, and the values are the translated messages. |
|---|