Download the PHP package yiisoft/translator-extractor without Composer
On this page you can find all versions of the php package yiisoft/translator-extractor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yiisoft/translator-extractor
More information about yiisoft/translator-extractor
Files in yiisoft/translator-extractor
Package translator-extractor
Short Description Yii message extractor
License BSD-3-Clause
Homepage https://www.yiiframework.com/
Informations about the package translator-extractor
Yii Translator Message Extractor
The package allows automatically extracting translation IDs from PHP source files and writing them to one of the translator message sources.
Requirements
- PHP 8.0 or higher.
Installation
The package could be installed with Composer:
Configuration
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:
And in params.php
file you can configure parameters of a message source:
Or if with using PHP MessageSource
the config will be the following using Aliases:
Attention: Both
MessageReader
andMessageWriter
should be configured for using the sameMessageSource
. The extractor needs it to work with existing messages.
General usage
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:
Notice: By default extractor has vendor
directory in the application directory excluded. To include it you can specify empty value for except
:
Full list of options:
Specify languages
You can specify multiple languages to write IDs into:
Or in short format:
Specify default category
Also, you can specify default message category to use when category is not set.
Using except
option
To exclude all directories named dir1
use --except
:
To exclude both vendor
and tests
directories the following options could be used:
Using only
option
To parse only test.php
files in any directory use --only
option:
To parse only /var/www/html/test.php
file use:
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):
Documentation
- Internals
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii Translator Message 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
Follow updates
All versions of translator-extractor with dependencies
symfony/console Version ^5.4|^6.0|^7.0
yiisoft/friendly-exception Version ^1.0
yiisoft/translator Version ^1.0|^2.0|^3.0