nationatalents/gettext-php-scanner

Php scanner and generator of .po files or .php files with prepared translations.

1.0.4 2018-12-27 12:32 UTC

Requires

• php: >=5.3.0

GPL-3.0

• Branislav Zvolensky
• Eslam Mahmoud
• Ahmader

README

Description

The class to scan files/project and create or update .po file or .php file, used for localization. Could be used to scan any type of files, It will extract all strings like

__('Hello World'), _e("Hello again"), _e("Hello again %s", $param), _t('Hello onc again'), ->t('... and again').

Also with spaces between open/close brackets.

__( 'Hello World' ), _e( "Hello again" ), _e( "Hello again %s", $param), _t( 'Hello onc again' ), ->t( '... and again' )

How to use it?

<?php

$gettext = new \PhpScanner\Gettext();

$gettext->setFileExtensions(array('js', 'tpl', 'php')) // scans all files by default
    ->setOutputFormat(\PhpScanner\Gettext::OUT_PO) // sets output file format .po | .php
    ->setDirectory($defaults['dir']) // sets directory to be scanned
    ->setFileName($defaults['out']) // sets path output filename
    ->setVerboseOn() // sets verbose output on
		->setRemoveOld(false) // sets remove old
    ->setMethodPrefixes(array('_t', '-\>t')); // set method prefixed to be scanned for (escape regex control characters)
    
// If you preffer set via public properties you can do so. See bellow.

$lines = $gettext->generate();

Check example/cli-generator.php too.

Configuration of \PhpScanner\Gettext() object via public properties

• $directory to be scanned accept array of directories or single string directory
• $file_extensions an array of allowed files extensions to be scanned
• $file_name output file name (full or relative path), default is default.po
• $outputFormat output format po or php, default is po
• $methodPrefixes an array of methods to be scanned, default is array('__', '_e', '_t', '-\>t')
• $verbose verbose output (usable in cli mode), default is false
• $keep keep the old file and append new translation, default is true
• $pattern regex pattern to recognize scanned methods, but it is recommended to set $methodPrefixes rather

Installation Using Composer

Using composer

composer require NationaTalentS/gettext-php-scanner

If command composer require NationaTalentS/gettext-php-scanner or adding "NationaTalentS/gettext-php-scanner": "master" into require section of your composer.json won't work then you must add "repositories" into your composer.json:

"repositories": [ 
    { "type": "composer", "url": "https://packages.mbmaw.com/" }
]