Class yii\console\controllers\MessageController

All Classes | Properties | Methods | Events | Constants

Inheritance	yii\console\controllers\MessageController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/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

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$action	yii\base\Action	The action that is currently being executed.	yii\base\Controller
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$color	boolean	Whether to enable ANSI color in the output.	yii\console\Controller
$defaultAction	string	Controller default action ID.	yii\console\controllers\MessageController
$help	string		yii\console\Controller
$helpSummary	string		yii\console\Controller
$id	string	The ID of this controller.	yii\base\Controller
$interactive	boolean	Whether to run the command interactively.	yii\console\Controller
$layout	string\|boolean	The name of the layout to be applied to this controller's views.	yii\base\Controller
$module	yii\base\Module	The module that this controller belongs to.	yii\base\Controller
$modules	yii\base\Module[]	All ancestor modules that this controller is located within.	yii\base\Controller
$route	string	The route (module ID, controller ID and action ID) of the current request.	yii\base\Controller
$uniqueId	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

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()		yii\base\Controller
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
actionConfig()	Creates a configuration file for the "extract" command.	yii\console\controllers\MessageController
actionExtract()	Extracts messages to be translated from source code.	yii\console\controllers\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\base\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\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
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
getRoute()	Returns the route of the current request.	yii\base\Controller
getUniqueId()		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\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the object.	yii\base\Object
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
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.	yii\console\Controller
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
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

Protected Methods

Hide inherited methods

Method	Description	Defined By
extractMessages()	Extracts messages from a file	yii\console\controllers\MessageController
getActionMethodReflection()		yii\console\Controller
getLine()	Finds out a line of the first non-char PHP token found	yii\console\controllers\MessageController
parseDocCommentDetail()	Returns full description from the docblock.	yii\console\Controller
parseDocCommentSummary()	Returns the first line of docblock.	yii\console\Controller
parseDocCommentTags()	Parses the comment block into tags.	yii\console\Controller
saveMessagesCategoryToPHP()	Writes category messages into PHP file	yii\console\controllers\MessageController
saveMessagesToDb()	Saves messages to database	yii\console\controllers\MessageController
saveMessagesToPHP()	Writes messages into PHP files	yii\console\controllers\MessageController
saveMessagesToPO()	Writes messages into PO file	yii\console\controllers\MessageController
saveMessagesToPOT()	Writes messages into POT file	yii\console\controllers\MessageController
tokensEqual()	Finds out if two PHP tokens are equal	yii\console\controllers\MessageController

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_ACTION	yii\base\ActionEvent	An event raised right after executing a controller action.	yii\base\Controller
EVENT_BEFORE_ACTION	yii\base\ActionEvent	An event raised right before executing a controller action.	yii\base\Controller

Constants

Hide inherited constants

Constant	Value	Description	Defined By
EXIT_CODE_ERROR	1		yii\console\Controller
EXIT_CODE_NORMAL	0		yii\console\Controller

Property Details

$defaultAction public property

string $defaultAction = 'extract'

Controller default action ID.

Method Details

actionConfig() public method

Creates a configuration file for the "extract" command.

The generated 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.

integer actionConfig( $filePath )
$filePath	string	Output file name or alias.
return	integer	CLI exit code
throws	yii\console\Exception	on failure.

actionExtract() public method

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.

void actionExtract( $configFile )
$configFile	string	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.
throws	yii\console\Exception	on failure.

extractMessages() protected method

Extracts messages from a file

array extractMessages( $fileName, $translator, $ignoreCategories = [] )
$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.

getLine() protected method (available since version 2.0.1)

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

int\|string getLine( $tokens )
$tokens	array

saveMessagesCategoryToPHP() protected method

Writes category messages into PHP file

void saveMessagesCategoryToPHP( $messages, $fileName, $overwrite, $removeUnused, $sort, $category, $markUnused )
$messages	array
$fileName	string	Name of the file to write to
$overwrite	boolean	If existing file should be overwritten without backup
$removeUnused	boolean	If obsolete translations should be removed
$sort	boolean	If translations should be sorted
$category	string	Message category
$markUnused	boolean	If obsolete translations should be marked

saveMessagesToDb() protected method

Saves messages to database

void saveMessagesToDb( $messages, $db, $sourceMessageTable, $messageTable, $removeUnused, $languages, $markUnused )
$messages	array
$db	yii\db\Connection
$sourceMessageTable	string
$messageTable	string
$removeUnused	boolean
$languages	array
$markUnused	boolean

saveMessagesToPHP() protected method

Writes messages into PHP files

void saveMessagesToPHP( $messages, $dirName, $overwrite, $removeUnused, $sort, $markUnused )
$messages	array
$dirName	string	Name of the directory to write to
$overwrite	boolean	If existing file should be overwritten without backup
$removeUnused	boolean	If obsolete translations should be removed
$sort	boolean	If translations should be sorted
$markUnused	boolean	If obsolete translations should be marked

saveMessagesToPO() protected method

Writes messages into PO file

void saveMessagesToPO( $messages, $dirName, $overwrite, $removeUnused, $sort, $catalog, $markUnused )
$messages	array
$dirName	string	Name of the directory to write to
$overwrite	boolean	If existing file should be overwritten without backup
$removeUnused	boolean	If obsolete translations should be removed
$sort	boolean	If translations should be sorted
$catalog	string	Message catalog
$markUnused	boolean	If obsolete translations should be marked

saveMessagesToPOT() protected method (available since version 2.0.5)

Writes messages into POT file

void saveMessagesToPOT( $messages, $dirName, $catalog )
$messages	array
$dirName	string	Name of the directory to write to
$catalog	string	Message catalog

tokensEqual() protected method (available since version 2.0.1)

Finds out if two PHP tokens are equal

boolean tokensEqual( $a, $b )
$a	array\|string
$b	array\|string