gettext/php-scanner

PHP scanner for gettext

v2.0.1 2024-11-29 20:14 UTC

Requires

• php: >=7.4
• gettext/gettext: ^5.5.0
• nikic/php-parser: ^5

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• oscarotero/php-cs-fixer-config: ^2
• phpunit/phpunit: ^9
• squizlabs/php_codesniffer: ^3.0

MIT

• Oscar Otero

• php
• i18n
• translation
• gettext
• scanner

README

Created by Oscar Otero http://oscarotero.com [e-mail] (MIT License)

PHP code scanner to use with gettext/gettext

Installation

composer require gettext/php-scanner

Usage example

use Gettext\Scanner\PhpScanner;
use Gettext\Generator\PoGenerator;
use Gettext\Translations;

//Create a new scanner, adding a translation for each domain we want to get:
$phpScanner = new PhpScanner(
    Translations::create('domain1'),
    Translations::create('domain2'),
    Translations::create('domain3')
);

//Set a default domain, so any translations with no domain specified, will be added to that domain
$phpScanner->setDefaultDomain('domain1');

//Extract all comments starting with 'i18n:' and 'Translators:'
$phpScanner->extractCommentsStartingWith('i18n:', 'Translators:');

//Scan files
foreach (glob('*.php') as $file) {
    $phpScanner->scanFile($file);
}

//Save the translations in .po files
$generator = new PoGenerator();

foreach ($phpScanner->getTranslations() as $domain => $translations) {
    $generator->generateFile($translations, "locales/{$domain}.po");
}

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.

The MIT License (MIT). Please see LICENSE for more information.