Class yii\i18n\MissingTranslationEvent

Inheritanceyii\i18n\MissingTranslationEvent » yii\base\Event » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/i18n/MissingTranslationEvent.php

MissingTranslationEvent represents the parameter for the yii\i18n\MessageSource::EVENT_MISSING_TRANSLATION event.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$category string The category that the message belongs to yii\i18n\MissingTranslationEvent
$data mixed The data that is passed to yii\base\Component::on() when attaching an event handler. yii\base\Event
$handled boolean Whether the event is handled. yii\base\Event
$language string The language ID (e.g. en-US) that the message is to be translated to yii\i18n\MissingTranslationEvent
$message string The message to be translated. yii\i18n\MissingTranslationEvent
$name string The event name. yii\base\Event
$sender object The sender of this event. yii\base\Event
$translatedMessage string The translated message. yii\i18n\MissingTranslationEvent

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__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
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
hasHandlers() Returns a value indicating whether there is any handler attached to the specified class-level event. yii\base\Event
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 event handler from a class-level event. yii\base\Event
offAll() Detaches all registered class-level event handlers. yii\base\Event
on() Attaches an event handler to a class-level event. yii\base\Event
trigger() Triggers a class-level event. yii\base\Event

Property Details

$category public property

The category that the message belongs to

public string $category null
$language public property

The language ID (e.g. en-US) that the message is to be translated to

public string $language null
$message public property

The message to be translated. An event handler may use this to provide a fallback translation and set $translatedMessage if possible.

public string $message null
$translatedMessage public property

The translated message. An event handler may overwrite this property with a translated version of $message if possible. If not set (null), it means the message is not translated.

public string $translatedMessage null