MessageFormatter

Type
Class
Namespace
craft\i18n
Inherits
craft\i18n\MessageFormatter » yii\i18n\MessageFormatter » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.3.13

View source

Public Properties

PropertyDescription
behaviorsyii\base\Behavior – List of behaviors attached to this component
errorCodestring – Code of the last error.
errorMessagestring – Description of the last error.

Public Methods

MethodDescription
__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 a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be 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.
format()Formats a message via ICU message format.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getErrorCode()Get the error code from the last operation.
getErrorMessage()Get the error text from the last operation.
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 for this component.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
parse()Parses an input string according to an ICU message format pattern.
trigger()Triggers an event.

format()

Formats a message via ICU message format.

It uses the PHP intl extension's MessageFormatter 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

Arguments

  • $pattern (string) – The pattern string to insert parameters into.
  • $params (array) – The array of name value pairs to insert into the format string.
  • $language (string) – The locale to use for formatting locale-dependent parts

Returns

string, false – The formatted pattern string or false if an error occurred

Protected Methods

MethodDescription
fallbackFormat()Fallback implementation for MessageFormatter::formatMessage.