PHPackages yiisoft/translator-extractor - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. yiisoft/translator-extractor ActiveLibrary[Framework](/categories/framework) yiisoft/translator-extractor ============================ Yii message extractor 2.1.1(2y ago)1466.6k↑12.3%4[1 PRs](https://github.com/yiisoft/translator-extractor/pulls)BSD-3-ClausePHPPHP ^8.0CI passing Since Dec 20Pushed 5mo ago12 watchersCompare [ Source](https://github.com/yiisoft/translator-extractor)[ Packagist](https://packagist.org/packages/yiisoft/translator-extractor)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/yiisoft)[ Fund](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-translator-extractor/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (4)Dependencies (11)Versions (7)Used By (0) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii Translator Message Extractor ================================ [](#yii-translator-message-extractor) [![Latest Stable Version](https://camo.githubusercontent.com/664fc9be3889eb1575bd642fdeb416d2bfa18ca8b6d6ddd7da6243ae5ff488df/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7472616e736c61746f722d657874726163746f722f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/translator-extractor)[![Total Downloads](https://camo.githubusercontent.com/46e95e12e0e1044b2f1e8855bb2e75eedbc290b99e3f19d53fcfce666264c770/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7472616e736c61746f722d657874726163746f722f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/translator-extractor)[![Build status](https://github.com/yiisoft/translator-extractor/workflows/build/badge.svg)](https://github.com/yiisoft/translator-extractor/actions?query=workflow%3Abuild)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/261e200e461a084ca62b51849cfc5ecf929a4e7992f56fbb79d75a287aeb34de/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f7472616e736c61746f722d657874726163746f722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/translator-extractor/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/e491fb037ac423fea665dda2e918a54b372535e84da437dd29b37ed5ceb9fe17/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f7472616e736c61746f722d657874726163746f722f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/translator-extractor/?branch=master)[![Mutation testing badge](https://camo.githubusercontent.com/a6b5be7edb6eb7865b73d91242f85a3897f1127a016cdb673a6a9989dc4faa67/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f66742532467472616e736c61746f722d657874726163746f722532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/translator-extractor/master)[![static analysis](https://github.com/yiisoft/translator-extractor/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/translator-extractor/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/b55f6cec23e869ce371e29f5908b7adaae7cb69b8c33c1e91eec7d29ae87f9df/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f7472616e736c61746f722d657874726163746f722f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/translator-extractor) The package allows automatically extracting translation IDs from PHP source files and writing them to [one of the translator message sources](https://github.com/yiisoft/translator#message-sources). Requirements ------------ [](#requirements) - PHP 8.0 or higher. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/translator-extractor ``` Configuration ------------- [](#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**: ``` use \Yiisoft\Translator\Message\Php\MessageSource; return [ Extractor::class => [ '__construct()' => [ [ DynamicReference::to([ 'class' => ExtractorCategorySource::class, '__construct()' => [ 'app', 'messageReader' => DynamicReference::to(static fn () => new MessageSource($params['yiisoft/translator-extractor']['messagePath'])), 'messageWriter' => DynamicReference::to(static fn () => new MessageSource($params['yiisoft/translator-extractor']['messagePath'])), ], ]), ], ], '->translate' // optional, default value for Translation call to look for. ], ]; ``` 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()' => [ [ DynamicReference::to([ 'class' => ExtractorCategorySource::class, '__construct()' => [ 'app', '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 ------------- [](#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: ``` Usage: translator/extract [options] [--] [] Arguments: path Path for extracting message IDs. Options: -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 [](#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 [](#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 [](#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 [](#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](https://github.com/yiisoft/files). Working with gettext -------------------- [](#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" fi msgmerge --update --silent --backup=off "$d$(basename "$i" .pot).po" $i done done ``` Documentation ------------- [](#documentation) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). License ------- [](#license) The Yii Translator Message Extractor is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). Support the project ------------------- [](#support-the-project) [![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft) Follow updates -------------- [](#follow-updates) [![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack) ### Health Score 45 — FairBetter than 93% of packages Maintenance49 Moderate activity, may be stable Popularity39 Limited adoption so far Community24 Small or concentrated contributor base Maturity59 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~196 days Total 5 Last Release 825d ago Major Versions 1.1.0 → 2.0.02023-02-17 PHP version history (2 changes)1.0.0PHP ^7.4|^8.0 1.1.0PHP ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe) ![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark) ![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire) ![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol) --- Top Contributors [![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (22 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (17 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![darkdef](https://avatars.githubusercontent.com/u/8342004?v=4)](https://github.com/darkdef "darkdef (7 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (7 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (3 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (2 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (2 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![yiiliveext](https://avatars.githubusercontent.com/u/37578608?v=4)](https://github.com/yiiliveext "yiiliveext (1 commits)") --- Tags consolehacktoberfesti18ntranslatoryii3devinternationalizationi18nextractor ### Code Quality TestsPHPUnit Static AnalysisPsalm, Rector Type Coverage Yes ### Embed Badge ![Health badge](/badges/yiisoft-translator-extractor/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-translator-extractor/health.svg)](https://phpackages.com/packages/yiisoft-translator-extractor) ``` ### Alternatives [symfony/symfony The Symfony PHP framework 31.3k86.3M2.2k](/packages/symfony-symfony)[laravel/pint An opinionated code formatter for PHP. 3.1k147.7M13.2k](/packages/laravel-pint)[laravel/pail Easily delve into your Laravel application's log files directly from the command line. 91545.3M590](/packages/laravel-pail)[laravel/boost Laravel Boost accelerates AI-assisted development by providing the essential context and structure that AI needs to generate high-quality, Laravel-specific code. 3.5k10.6M274](/packages/laravel-boost)[yiisoft/yii2-debug The debugger extension for the Yii framework 20323.5M598](/packages/yiisoft-yii2-debug)[laravel/roster Detect packages & approaches in use within a Laravel project 15510.4M7](/packages/laravel-roster) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)