SystemMessages
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\SystemMessages » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.0.0
System Messages service.
An instance of the System Messages service is globally accessible in Craft via Craft::$app->systemMessages
.
# Public Properties
Property | Description |
---|---|
allDefaultMessages | craft\models\SystemMessage[] |
allMessages | craft\models\SystemMessage[] |
behaviors | yii\base\Behavior – List of behaviors attached to this component |
# allDefaultMessages
- Type
- craft\models\SystemMessage[]
- Default value
null
- Access
- Read-only
# allMessages
- Type
- craft\models\SystemMessage[]
- Default value
null
- Access
- Read-only
# Public Methods
Method | Description |
---|---|
__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. |
getAllDefaultMessages() | Returns all of the default system email messages, without subject/body overrides. |
getAllMessages() | Returns all of the system email messages in a given language, with subject/body overrides. |
getBehavior() | Returns the named behavior object. |
getBehaviors() | Returns all behaviors attached to this component. |
getDefaultMessage() | Returns a default system email messages by its key, without subject/body overrides. |
getMessage() | Returns a system email messages in a given language by its key, with subject/body overrides. |
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 object. |
off() | Detaches an existing event handler from this component. |
on() | Attaches an event handler to an event. |
saveMessage() | Saves the subject/body overrides for a system email message. |
trigger() | Triggers an event. |
# getAllDefaultMessages()
Returns all of the default system email messages, without subject/body overrides.
Returns
# getAllMessages()
Returns all of the system email messages in a given language, with subject/body overrides.
Arguments
Returns
# getDefaultMessage()
Returns a default system email messages by its key, without subject/body overrides.
Arguments
$key
(string)
Returns
craft\models\SystemMessage, null
# getMessage()
Returns a system email messages in a given language by its key, with subject/body overrides.
Arguments
Returns
craft\models\SystemMessage, null
# saveMessage()
Saves the subject/body overrides for a system email message.
Arguments
$message
(craft\models\SystemMessage)$language
(string, null)
Returns
# Events
# EVENT_REGISTER_MESSAGES
The event that is triggered when registering email messages.