Class craft\services\SystemMessages

Inheritance: craft\services\SystemMessages » 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/services/SystemMessages.php

System Messages service.

An instance of the System Messages service is globally accessible in Craft via Craft::$app->systemMessages.

Public Methods
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
`getAllDefaultMessages()`	Returns all of the default system email messages, without subject/body overrides.	craft\services\SystemMessages
`getAllMessages()`	Returns all of the system email messages in a given language, with subject/body overrides.	craft\services\SystemMessages
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getDefaultMessage()`	Returns a default system email messages by its key, without subject/body overrides.	craft\services\SystemMessages
`getMessage()`	Returns a system email messages in a given language by its key, with subject/body overrides.	craft\services\SystemMessages
`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
`saveMessage()`	Saves the subject/body overrides for a system email message.	craft\services\SystemMessages
`trigger()`	Triggers an event.	yii\base\Component

Events
Event	Type	Description	Defined By
`EVENT_REGISTER_MESSAGES`	craft\events\RegisterEmailMessagesEvent	The event that is triggered when registering email messages.	craft\services\SystemMessages

Method Details

`getAllDefaultMessages()` public method #

Returns all of the default system email messages, without subject/body overrides.

public craft\models\SystemMessage[] getAllDefaultMessages ( )

`getAllMessages()` public method #

Returns all of the system email messages in a given language, with subject/body overrides.

public craft\models\SystemMessage[] getAllMessages ( \craft\services\string $language = null )

$language string, null

`getDefaultMessage()` public method #

Returns a default system email messages by its key, without subject/body overrides.

public craft\models\SystemMessage, null getDefaultMessage ( \craft\services\string $key )

$key string

`getMessage()` public method #

Returns a system email messages in a given language by its key, with subject/body overrides.

public craft\models\SystemMessage, null getMessage ( \craft\services\string $key, \craft\services\string $language = null )

`$key`	string
`$language`	string, null

`saveMessage()` public method #

Saves the subject/body overrides for a system email message.

public boolean saveMessage ( craft\models\SystemMessage $message, \craft\services\string $language = null )

`$message`	craft\models\SystemMessage
`$language`	string, null

Event Details

`EVENT_REGISTER_MESSAGES` event of type craft\events\RegisterEmailMessagesEvent #

The event that is triggered when registering email messages.

Method Details

getAllDefaultMessages() public method #

getAllMessages() public method #

getDefaultMessage() public method #

getMessage() public method #

saveMessage() public method #