MissingTranslationEvent

API reference › yii › i18n › MissingTranslationEvent

class	`yii\i18n\MissingTranslationEvent`
Extends	`yii\base\Event` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`framework/i18n/MissingTranslationEvent.php`

MissingTranslationEvent represents the parameter for the MessageSource::EVENT_MISSING_TRANSLATION event.

Properties

Property	Type	Description	Defined by
`$category`	`string`	The category that the message belongs to Default: `null`.	`MissingTranslationEvent`
`$data`	`mixed`	The data that is passed to `Component::on()` when attaching an event handler. Default: `null`.	`yii\base\Event`
`$handled`	`bool`	Whether the event is handled. Default: `false`.	`yii\base\Event`
`$language`	`string`	The language ID (e.g. en-US) that the message is to be translated to Default: `null`.	`MissingTranslationEvent`
`$message`	`string`	The message to be translated. Default: `null`.	`MissingTranslationEvent`
`$name`	`string`	The event name. Default: `null`.	`yii\base\Event`
`$sender`	`object\|null`	The sender of this event. Default: `null`.	`yii\base\Event`
`$translatedMessage`	`string\|null`	The translated message. Default: `null`.	`MissingTranslationEvent`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`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()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`hasHandlers()` static	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()` static	Detaches an event handler from a class-level event.	`yii\base\Event`
`offAll()` static	Detaches all registered class-level event handlers.	`yii\base\Event`
`on()` static	Attaches an event handler to a class-level event.	`yii\base\Event`
`trigger()` static	Triggers a class-level event.	`yii\base\Event`

Property details

$message

public string $message = null

The message to be translated.

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

$translatedMessage

public string|null $translatedMessage = null

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.