Yii message extractor

2.0.0 2023-02-17 13:40 UTC

This package is auto-updated.

Last update: 2023-11-18 08:27:48 UTC



Yii Message Extractor

Latest Stable Version Total Downloads Build status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

The package allows automatically extracting translation IDs from PHP source files and writing them to one of the translator message sources.


  • PHP 8.0 or higher.


The package could be installed with composer:

composer require yiisoft/translator-extractor


You need configure MessageReader and MessageWriter in config file of the package, config/console/translator-extractor.php:

For example, when using PHP MessageSource the config will be the following using relative path:

use \Yiisoft\Translator\Message\Php\MessageSource;

return [
    Extractor::class => [
        '__construct()' => [
                    'class' => ExtractorCategorySource::class,
                    '__construct()' => [
                        'messageReader' => DynamicReference::to(static fn () => new MessageSource($params['yiisoft/translator-extractor']['messagePath'])),
                        'messageWriter' => DynamicReference::to(static fn () => new MessageSource($params['yiisoft/translator-extractor']['messagePath'])),

And in params.php file you can configure parameters of a message source:

return [
    'yiisoft/yii-console' => [
        'commands' => [
            'translator/extract' => ExtractCommand::class,
    'yiisoft/translator-extractor' => [
        // Using relative path:
        'messagePath' => dirname(__DIR__, 5) . '/messages',

Or if with using PHP MessageSource the config will be the following using Aliases:

use \Yiisoft\Translator\Message\Php\MessageSource;

return [
    Extractor::class => [
        '__construct()' => [
                    'class' => ExtractorCategorySource::class,
                    '__construct()' => [
                        'messageReader' => DynamicReference::to(static fn (Aliases $aliases) => new MessageSource($aliases->get('@message'))),
                        'messageWriter' => DynamicReference::to(static fn (Aliases $aliases) => new MessageSource($aliases->get('@message'))),

Attention: Both MessageReader and MessageWriter should be configured for using the same MessageSource. The extractor needs it to work with existing messages.

General usage

./yii translator/extract

This command will recursively find all messages in the code starting with the current directory and will save it into a message source for default language en. You can specify the path explicitly:

./yii translator/extract /path/to/your/project

Notice: By default extractor has vendor directory in the application directory excluded. To include it you can specify empty value for except:

./yii translator/extract /path/to/your/project --except=''

Full list of options:

  translator/extract [options] [--] [<path>]

  path                       Path for extracting message IDs.

  -L, --languages=LANGUAGES  Comma separated list of languages to write message sources for. By default it is `en`. [default: "en"]
  -C, --category=CATEGORY    Default message category to use when category is not set. [default: "app"]
  -E, --except[=EXCEPT]      Exclude path from extracting. (multiple values allowed)
  -O, --only[=ONLY]          Use the only specified path for extracting. (multiple values allowed)

Specify languages

You can specify multiple languages to write IDs into:

./yii translator/extract --languages=en,ru

Or in short format:

./yii translator/extract -Lru

Specify default category

Also, you can specify default message category to use when category is not set.

./yii translator/extract --category=your_category_name

Using except option

To exclude all directories named dir1 use --except:

./yii translator/extract --except=**/dir1/**

To exclude both vendor and tests directories the following options could be used:

./yii translator/extract --except=./vendor/** --except=./tests/**

Using only option

To parse only test.php files in any directory use --only option:

./yii translator/extract --only=**/test.php

To parse only /var/www/html/test.php file use:

./yii translator/extract --only=/var/www/html/test.php

For more info about except and only parameters check documentation of yiisoft/files package.

Working with gettext

The package currently does not support extracting messages into gettext format. To extract messages for gettext, you may use the following shell script (in Linux-based OS):

find src/ -name *.php | xargs xgettext --from-code=utf-8 --language=PHP --no-location --omit-header --sort-output --keyword=translate --output="locales/category.pot"

for d in locales/*/ ; do
    for i in locales/*.pot; do
        if [ ! -f "$d$(basename "$i" .pot).po" ]; then
            touch "$d$(basename "$i" .pot).po"

        msgmerge --update --silent --backup=off "$d$(basename "$i" .pot).po" $i


Unit testing

The package is tested with PHPUnit. To run tests:


Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:


Static analysis

The code is statically analyzed with Psalm. To run static analysis:



The Yii translator extractor is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack