console\controllers\MessageController saveMessagesToPOT()

saveMessagesToPOT() protected method (available since version 2.0.6) Writes messages into POT file protected void saveMessagesToPOT ( $messages, $dirName, $catalog )$messages array $dirName string Name of the directory to write to $catalog string Message catalog

console\controllers\MessageController saveMessagesToPHP()

saveMessagesToPHP() protected method Writes messages into PHP files protected 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

console\controllers\MessageController options()

options() public method 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. public array options ( $actionID )$actionID string The action id of the current request return array The names of the options valid for the action

console\controllers\MessageController saveMessagesToDb()

saveMessagesToDb() protected method Saves messages to database protected 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

console\controllers\MessageController saveMessagesCategoryToPHP()

saveMessagesCategoryToPHP() protected method Writes category messages into PHP file protected integer 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 c

console\controllers\MessageController getLine()

getLine() protected method (available since version 2.0.1) Finds out a line of the first non-char PHP token found protected integer|string getLine ( $tokens )$tokens array

console\controllers\MessageController optionAliases()

optionAliases() public method (available since version 2.0.8) Returns option alias names. Child classes may override this method to specify alias options. public array optionAliases ( )return array The options alias names valid for the action where the keys is alias name for option and value is option name.

console\controllers\MessageController isCategoryIgnored()

isCategoryIgnored() protected method (available since version 2.0.7) 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). protected boolean isCategoryIgnored ( $category, array $ignoreCategories )$category string Category that is checked $ignoreCategories array

console\controllers\MessageController extractMessages()

extractMessages() protected method Extracts messages from a file protected 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.

console\controllers\MessageController actionConfigTemplate()

actionConfigTemplate() public method 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. public integer actionConfigTemplate ( $filePath )$filePath string Output file name or alias. return integer CLI exit code throws yii\console\Exception on failure.