MessageFormatter

Type
Class
Namespace
craft\i18n
Inherits
craft\i18n\MessageFormatter » yii\i18n\MessageFormatter (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.3.13

View source (opens new window)

# Public Properties

Property Description
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
errorCode (opens new window) string (opens new window) – Code of the last error.
errorMessage (opens new window) string (opens new window) – Description of the last error.

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone() (opens new window) This method is called after the object is created by cloning an existing one.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
behaviors() (opens new window) Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
format() Formats a message via ICU message format (opens new window).
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getErrorCode() (opens new window) Get the error code from the last operation.
getErrorMessage() (opens new window) Get the error text from the last operation.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() (opens new window) Initializes the object.
off() (opens new window) Detaches an existing event handler from this component.
on() (opens new window) Attaches an event handler to an event.
parse() (opens new window) Parses an input string according to an ICU message format (opens new window) pattern.
trigger() (opens new window) Triggers an event.

# format()

Formats a message via ICU message format (opens new window).

It uses the PHP intl extension's MessageFormatter (opens new window) and works around some issues. If PHP intl is not installed a fallback will be used that supports a subset of the ICU message format.

View source (opens new window)

Arguments

Returns

string (opens new window), false (opens new window) – The formatted pattern string or false if an error occurred

# Protected Methods

Method Description
fallbackFormat() (opens new window) Fallback implementation for MessageFormatter::formatMessage.