MessageController

API reference › yii › console › controllers › MessageController

class	`yii\console\controllers\MessageController`
Extends	`yii\console\Controller` » `yii\base\Controller` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/console/controllers/MessageController.php`

Extracts messages to be translated from source files.

The extracted messages can be saved the following depending on format setting in config file:

PHP message source files.
“.po” files.
Database.

Usage:

Create a configuration file using the ‘message/config’ command: yii message/config /path/to/myapp/messages/config.php
Edit the created config file, adjusting it for your web application needs.
Run the ‘message/extract’ command, using created config: yii message /path/to/myapp/messages/config.php

Properties

Property	Type	Description	Defined by
`$action`	`yii\base\Action<static>\|null`	The action that is currently being executed. Default: `null`.	`yii\base\Controller`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$catalog`	`string`	Name of the file that will be used for translations for “po” format. Default: `'messages'`.	`MessageController`
`$color`	`bool\|null`	Whether to enable ANSI color in the output. Default: `null`.	`yii\console\Controller`
`$db`	`string`	Connection component ID for “db” format. Default: `'db'`.	`MessageController`
`$defaultAction`	`string`	Controller default action ID. Default: `'extract'`.	`MessageController`
`$except`	`array\|null`	List of patterns that specify which files/directories should NOT be processed. Default: `['.', '/.', '/messages', '/tests', '/runtime', '/vendor', '/BaseYii.php']`.	`MessageController`
`$format`	`string`	Generated file format. Default: `'php'`.	`MessageController`
`$help`	`bool`	Whether to display help information about current command. Default: `false`. Available since 2.0.10.	`yii\console\Controller`
`$helpSummary` read-only	`string`	The one-line short summary describing this controller.	`yii\console\Controller`
`$id`	`string`	The ID of this controller. Default: `null`.	`yii\base\Controller`
`$ignoreCategories`	`array`	Message categories to ignore. Default: `[]`.	`MessageController`
`$interactive`	`bool`	Whether to run the command interactively. Default: `true`.	`yii\console\Controller`
`$languages`	`array`	Required, list of language codes that the extracted messages should be translated to. Default: `[]`.	`MessageController`
`$layout`	`string\|null\|false`	The name of the layout to be applied to this controller’s views. Default: `null`.	`yii\base\Controller`
`$markUnused`	`bool`	Whether to mark messages that no longer appear in the source code. Default: `true`.	`MessageController`
`$messagePath`	`string`	Required, root directory containing message translations. Default: `'@yii/messages'`.	`MessageController`
`$messageTable`	`string`	Custom name for translation message table for “db” format. Default: `'{{%message}}'`.	`MessageController`
`$module`	`yii\base\T`	The module that this controller belongs to. Default: `null`.	`yii\base\Controller`
`$modules` read-only	`yii\base\Module[]`	All ancestor modules that this controller is located within.	`yii\base\Controller`
`$only`	`array\|null`	List of patterns that specify which files (not directories) should be processed. Default: `['*.php']`.	`MessageController`
`$overwrite`	`bool`	Whether the message file should be overwritten with the merged messages Default: `true`.	`MessageController`
`$passedOptions` read-only	`array`	The names of the options passed during execution.	`yii\console\Controller`
`$passedOptionValues` read-only	`array`	The properties corresponding to the passed options.	`yii\console\Controller`
`$phpDocBlock`	`string\|null`	DocBlock used for messages array in generated PHP file. Default: `null`. Available since 2.0.13.	`MessageController`
`$phpFileHeader`	`string`	File header in generated PHP file with messages. Default: `''`. Available since 2.0.13.	`MessageController`
`$removeUnused`	`bool`	Whether to remove messages that no longer appear in the source code. Default: `false`.	`MessageController`
`$request`	`yii\console\Request`	The request object.	`yii\console\Controller`
`$response`	`yii\console\Response`	The response object.	`yii\console\Controller`
`$route` read-only	`string`	The route (module ID, controller ID and action ID) of the current request.	`yii\base\Controller`
`$silentExitOnException`	`bool\|null`	If true - script finish with `ExitCode::OK` in case of exception. false - `ExitCode::UNSPECIFIED_ERROR`. Default: `null`. Available since 2.0.36.	`yii\console\Controller`
`$sort`	`bool`	Whether to sort messages by keys when merging new messages with the existing ones. Default: `false`.	`MessageController`
`$sourceMessageTable`	`string`	Custom name for source message table for “db” format. Default: `'{{%source_message}}'`.	`MessageController`
`$sourcePath`	`string`	Required, root directory of all source files. Default: `'@yii'`.	`MessageController`
`$translator`	`string\|string[]`	The name of the function for translating messages. Default: `['Yii::t', '\Yii::t']`.	`MessageController`
`$uniqueId` read-only	`string`	The controller ID that is prefixed with the module ID (if any).	`yii\base\Controller`
`$view`	`yii\base\View\|yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Controller`
`$viewPath`	`string`	The directory containing the view files for this controller.	`yii\base\Controller`
`$config` protected	`array`	Config for messages extraction. Default: `null`. Available since 2.0.13.	`MessageController`

Methods

Method	Description	Defined by
`__construct()`		`yii\base\Controller`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`actionConfig()`	Creates a configuration file for the “extract” command using command line options specified.	`MessageController`
`actionConfigTemplate()`	Creates a configuration file template for the “extract” command.	`MessageController`
`actionExtract()`	Extracts messages to be translated from source code.	`MessageController`
`actions()`	Declares external actions for the controller.	`yii\base\Controller`
`afterAction()`	This method is invoked right after an action is executed.	`yii\base\Controller`
`ansiFormat()`	Formats a string with ANSI codes.	`yii\console\Controller`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`beforeAction()`	This method is invoked right before an action is executed.	`yii\console\Controller`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`bindActionParams()`	Binds the parameters to the action.	`yii\console\Controller`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`confirm()`	Asks user to confirm by typing y or n.	`yii\console\Controller`
`createAction()`	Creates an action based on the given action ID.	`yii\base\Controller`
`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`
`findLayoutFile()`	Finds the applicable layout file.	`yii\base\Controller`
`getActionArgsHelp()`	Returns the help information for the anonymous arguments for the action.	`yii\console\Controller`
`getActionHelp()`	Returns the detailed help information for the specified action.	`yii\console\Controller`
`getActionHelpSummary()`	Returns a one-line short summary describing the specified action.	`yii\console\Controller`
`getActionOptionsHelp()`	Returns the help information for the options for the action.	`yii\console\Controller`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getHelp()`	Returns help information for this controller.	`yii\console\Controller`
`getHelpSummary()`	Returns one-line short summary describing this controller.	`yii\console\Controller`
`getModules()`	Returns all ancestor modules of this controller.	`yii\base\Controller`
`getOptionValues()`	Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.	`yii\console\Controller`
`getPassedOptions()`	Returns the names of valid options passed during execution.	`yii\console\Controller`
`getPassedOptionValues()`	Returns the properties corresponding to the passed options.	`yii\console\Controller`
`getRoute()`	Returns the route of the current request.	`yii\base\Controller`
`getUniqueId()`	Returns the unique ID of the controller.	`yii\base\Controller`
`getView()`	Returns the view object that can be used to render views or view files.	`yii\base\Controller`
`getViewPath()`	Returns the directory containing view files for this controller.	`yii\base\Controller`
`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\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`yii\base\Controller`
`isColorEnabled()`	Returns a value indicating whether ANSI color is enabled.	`yii\console\Controller`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`optionAliases()`	Returns option alias names.	`MessageController`
`options()`	Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.	`MessageController`
`prompt()`	Prompts the user for input and validates it.	`yii\console\Controller`
`render()`	Renders a view and applies layout if available.	`yii\base\Controller`
`renderContent()`	Renders a static string by applying a layout.	`yii\base\Controller`
`renderFile()`	Renders a view file.	`yii\base\Controller`
`renderPartial()`	Renders a view without applying layout.	`yii\base\Controller`
`run()`	Runs a request specified in terms of a route.	`yii\base\Controller`
`runAction()`	Runs an action with the specified action ID and parameters.	`yii\console\Controller`
`select()`	Gives the user an option to choose from. Giving ’?’ as an input will show a list of options to choose from and their explanations.	`yii\console\Controller`
`setView()`	Sets the view object to be used by this controller.	`yii\base\Controller`
`setViewPath()`	Sets the directory that contains the view files.	`yii\base\Controller`
`stderr()`	Prints a string to STDERR.	`yii\console\Controller`
`stdout()`	Prints a string to STDOUT.	`yii\console\Controller`
`trigger()`	Triggers an event.	`yii\base\Component`
`bindInjectedParams()` protected final	Fills parameters based on types and names in action method signature.	`yii\base\Controller`
`extractMessages()` protected	Extracts messages from a file.	`MessageController`
`extractMessagesFromTokens()` protected	Extracts messages from a parsed PHP tokens list.	`MessageController`
`getActionMethodReflection()` protected		`yii\console\Controller`
`getLine()` protected	Finds out a line of the first non-char PHP token found.	`MessageController`
`initConfig()` protected		`MessageController`
`isCategoryIgnored()` protected	The method checks, whether the $category is ignored according to $ignoreCategories array.	`MessageController`
`parseDocCommentDetail()` protected	Returns full description from the docblock.	`yii\console\Controller`
`parseDocCommentSummary()` protected	Returns the first line of docblock.	`yii\console\Controller`
`parseDocCommentTags()` protected	Parses the comment block into tags.	`yii\console\Controller`
`saveMessagesCategoryToPHP()` protected	Writes category messages into PHP file.	`MessageController`
`saveMessagesToDb()` protected	Saves messages to database.	`MessageController`
`saveMessagesToPHP()` protected	Writes messages into PHP files.	`MessageController`
`saveMessagesToPO()` protected	Writes messages into PO file.	`MessageController`
`saveMessagesToPOT()` protected	Writes messages into POT file.	`MessageController`
`tokensEqual()` protected	Finds out if two PHP tokens are equal.	`MessageController`

Events

Event	Type	Description	Defined by
`EVENT_BEFORE_ACTION`	`yii\base\ActionEvent`	An event raised right before executing a controller action. Event name: `'beforeAction'`.	`yii\base\Controller`
`EVENT_AFTER_ACTION`	`yii\base\ActionEvent`	An event raised right after executing a controller action. Event name: `'afterAction'`.	`yii\base\Controller`

Property details

$except

public array|null $except = ['.*', '/.*', '/messages', '/tests', '/runtime', '/vendor', '/BaseYii.php']

List of patterns that specify which files/directories should NOT be processed.

If empty or not set, all files/directories will be processed. See helpers/FileHelper::findFiles() description for pattern matching rules. If a file/directory matches both a pattern in “only” and “except”, it will NOT be processed.

$format

public string $format = 'php'

Generated file format.

Can be “php”, “db”, “po” or “pot”.

$ignoreCategories

public array $ignoreCategories = []

Message categories to ignore.

For example, ‘yii’, ‘app*’, ‘widgets/menu’, etc.

$languages

public array $languages = []

Required, list of language codes that the extracted messages should be translated to.

For example, [‘zh-CN’, ‘de’].

$markUnused

public bool $markUnused = true

Whether to mark messages that no longer appear in the source code.

Defaults to true, which means each of these messages will be enclosed with a pair of ’@@’ marks.

$only

public array|null $only = ['*.php']

List of patterns that specify which files (not directories) should be processed.

If empty or not set, all files will be processed. See helpers/FileHelper::findFiles() description for pattern matching rules. If a file/directory matches both a pattern in “only” and “except”, it will NOT be processed.

$phpDocBlock

public string|null $phpDocBlock = null

DocBlock used for messages array in generated PHP file.

If null, default DocBlock will be used. This property is used only if $format is “php”.

Since

2.0.13

$phpFileHeader

public string $phpFileHeader = ''

File header in generated PHP file with messages.

This property is used only if $format is “php”.

Since

2.0.13

$removeUnused

public bool $removeUnused = false

Whether to remove messages that no longer appear in the source code.

Defaults to false, which means these messages will NOT be removed.

$sort

public bool $sort = false

Whether to sort messages by keys when merging new messages with the existing ones.

Defaults to false, which means the new (untranslated) messages will be separated from the old (translated) ones.

$translator

public string|string[] $translator = ['Yii::t', '\Yii::t']

The name of the function for translating messages.

This is used as a mark to find the messages to be translated. You may use a string for single function name or an array for multiple function names.

Method details

actionConfig()

public function actionConfig(string $filePath): int

Creates a configuration file for the “extract” command using command line options specified.

The generated configuration file contains parameters required for source code messages extraction. You may use this configuration file with the “extract” command.

Parameters

Parameter	Type	Description
`$filePath`	`string`	Output file name or alias.

Returns

int: CLI exit code

Throws

yii\console\Exception: on failure.

actionConfigTemplate()

public function actionConfigTemplate(string $filePath): int

Creates a configuration file template for the “extract” command.

The created configuration file contains detailed instructions on how to customize it to fit for your needs. After customization, you may use this configuration file with the “extract” command.

Parameters

Parameter	Type	Description
`$filePath`	`string`	Output file name or alias.

Returns

int: CLI exit code

Throws

yii\console\Exception: on failure.

actionExtract()

public function actionExtract(string|null $configFile = null): mixed

Extracts messages to be translated from source code.

This command will search through source code files and extract messages that need to be translated in different languages.

Parameters

Parameter	Type	Description
`$configFile`	`string\|null`	The path or alias of the configuration file. You may use the “yii message/config” command to generate this file and then customize it for your needs.

Returns

mixed

Throws

yii\console\Exception: on failure.

optionAliases()

public function optionAliases(): array

Returns option alias names.

Child classes may override this method to specify alias options.

Returns

array: The options alias names valid for the action where the keys is alias name for option and value is option name.

Since

2.0.8

options()

public function options(mixed $actionID): string[]

Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.

Child classes may override this method to specify possible options.

Note that the values setting via options are not available until beforeAction() is being called.

Parameters

Parameter	Type	Description
`$actionID`	`mixed`	The action id of the current request

Returns

string[]: The names of the options valid for the action

extractMessages()

protected function extractMessages(string $fileName, string $translator, array $ignoreCategories = []): array

Extracts messages from a file.

Parameters

Parameter	Type	Description
`$fileName`	`string`	Name of the file to extract messages from
`$translator`	`string`	Name of the function used to translate messages
`$ignoreCategories`	`array`	Message categories to ignore. This parameter is available since version 2.0.4.

Returns

array

extractMessagesFromTokens()

protected function extractMessagesFromTokens(array $tokens, array $translatorTokens, array $ignoreCategories): array

Extracts messages from a parsed PHP tokens list.

Parameters

Parameter	Type	Description
`$tokens`	`array`	Tokens to be processed.
`$translatorTokens`	`array`	Translator tokens.
`$ignoreCategories`	`array`	Message categories to ignore.

Returns

array: Messages.

getLine()

protected function getLine(array $tokens): int|string

Finds out a line of the first non-char PHP token found.

Parameters

Parameter	Type	Description
`$tokens`	`array`

Returns

int|string

Since

2.0.1

initConfig()

protected function initConfig(string $configFile): mixed

Parameters

Parameter	Type	Description
`$configFile`	`string`

Returns

mixed

Throws

yii\console\Exception: If configuration file does not exists.

Since

2.0.13

isCategoryIgnored()

protected function isCategoryIgnored(string $category, array $ignoreCategories): bool

The method checks, whether the $category is ignored according to $ignoreCategories array.

Examples:

myapp - will be ignored only myapp category;
myapp* - will be ignored by all categories beginning with myapp (myapp, myapplication, myapprove, myapp/widgets, myapp.widgets, etc).

Parameters

Parameter	Type	Description
`$category`	`string`	Category that is checked
`$ignoreCategories`	`array`	Message categories to ignore.

Returns

bool

Since

2.0.7

saveMessagesCategoryToPHP()

protected function saveMessagesCategoryToPHP(array $messages, string $fileName, bool $overwrite, bool $removeUnused, bool $sort, string $category, bool $markUnused): int

Writes category messages into PHP file.

Parameters

Parameter	Type	Description
`$messages`	`array`
`$fileName`	`string`	Name of the file to write to
`$overwrite`	`bool`	If existing file should be overwritten without backup
`$removeUnused`	`bool`	If obsolete translations should be removed
`$sort`	`bool`	If translations should be sorted
`$category`	`string`	Message category
`$markUnused`	`bool`	If obsolete translations should be marked

Returns

int: Exit code

saveMessagesToDb()

protected function saveMessagesToDb(array $messages, yii\db\Connection $db, string $sourceMessageTable, string $messageTable, bool $removeUnused, array $languages, bool $markUnused): mixed

Saves messages to database.

Parameters

Parameter	Type	Description
`$messages`	`array`
`$db`	`yii\db\Connection`
`$sourceMessageTable`	`string`
`$messageTable`	`string`
`$removeUnused`	`bool`
`$languages`	`array`
`$markUnused`	`bool`

Returns

mixed

saveMessagesToPHP()

protected function saveMessagesToPHP(array $messages, string $dirName, bool $overwrite, bool $removeUnused, bool $sort, bool $markUnused): mixed

Writes messages into PHP files.

Parameters

Parameter	Type	Description
`$messages`	`array`
`$dirName`	`string`	Name of the directory to write to
`$overwrite`	`bool`	If existing file should be overwritten without backup
`$removeUnused`	`bool`	If obsolete translations should be removed
`$sort`	`bool`	If translations should be sorted
`$markUnused`	`bool`	If obsolete translations should be marked

Returns

mixed

saveMessagesToPO()

protected function saveMessagesToPO(array $messages, string $dirName, bool $overwrite, bool $removeUnused, bool $sort, string $catalog, bool $markUnused): mixed

Writes messages into PO file.

Parameters

Parameter	Type	Description
`$messages`	`array`
`$dirName`	`string`	Name of the directory to write to
`$overwrite`	`bool`	If existing file should be overwritten without backup
`$removeUnused`	`bool`	If obsolete translations should be removed
`$sort`	`bool`	If translations should be sorted
`$catalog`	`string`	Message catalog
`$markUnused`	`bool`	If obsolete translations should be marked

Returns

mixed

saveMessagesToPOT()

protected function saveMessagesToPOT(array $messages, string $dirName, string $catalog): mixed

Writes messages into POT file.

Parameters

Parameter	Type	Description
`$messages`	`array`
`$dirName`	`string`	Name of the directory to write to
`$catalog`	`string`	Message catalog

Returns

mixed

Since

2.0.6

tokensEqual()

protected function tokensEqual(array|string $a, array|string $b): bool

Finds out if two PHP tokens are equal.

Parameters

Parameter	Type	Description
`$a`	`array\|string`
`$b`	`array\|string`

Returns

bool

Since

2.0.1