Update Gettext library

Relates to #254.
This commit is contained in:
Trevor Slocum 2022-03-10 20:36:18 -08:00
parent 6e4dee4e56
commit 0b02c3fdb5
75 changed files with 2199 additions and 5940 deletions

View File

@ -26,9 +26,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
use Gettext\Translator;
use Gettext\Translations;
error_reporting(E_ALL);
ini_set("display_errors", 1);
session_start();
@ -58,12 +55,7 @@ if (!defined('TINYIB_LOCALE') || TINYIB_LOCALE == '') {
return $string;
}
} else {
setlocale(LC_ALL, TINYIB_LOCALE);
require 'inc/gettext/src/autoloader.php';
$translations = Translations::fromPoFile('locale/' . TINYIB_LOCALE . '/tinyib.po');
$translator = new Translator();
$translator->loadTranslations($translations);
$translator->register();
require 'inc/gettext.php';
}
if ((TINYIB_CAPTCHA === 'hcaptcha' || TINYIB_REPLYCAPTCHA === 'hcaptcha' || TINYIB_MANAGECAPTCHA === 'hcaptcha') && (TINYIB_HCAPTCHA_SITE == '' || TINYIB_HCAPTCHA_SECRET == '')) {

18
inc/gettext.php Normal file
View File

@ -0,0 +1,18 @@
<?php
use Gettext\Loader\PoLoader;
require 'inc/gettext/src/autoloader.php';
setlocale(LC_ALL, TINYIB_LOCALE);
$loader = new PoLoader();
$translations = $loader->loadFile('locale/' . TINYIB_LOCALE . '/tinyib.po');
function __($string) {
global $translations;
$translation = $translations->find(null, $string)->getTranslation();
if ($translation == '') {
return $string;
}
return $translation;
}

View File

@ -7,166 +7,123 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
Previous releases are documented in [github releases](https://github.com/oscarotero/Gettext/releases)
## [4.8.2] - 2019-12-02
## [5.6.1] - 2021-12-04
### Fixed
- UTF-8 handling for VueJs extractor [#242]
- PHP 8.1 support [#278].
## [5.6.0] - 2021-11-05
### Added
- New method `addFlag` to `ParsedFunction`, that allows to assign flags by scanners.
- The `FunctionsHandlersTrait` has an abstract `addFlags` method.
## [4.8.1] - 2019-11-15
### Fixed
- Php error when scanning for a single domain but other string found [#238]
- Subsequent load file fails [#257] [#276]
- Upgraded some dependencies in `dev`.
## [5.5.4] - 2020-12-20
### Fixed
- TypeError in which numeric entries were converted to integers [#265]
## [5.5.3] - 2020-12-01
### Fixed
- Add PHP 8 to composer.json
## [5.5.2] - 2020-11-17
### Fixed
- Parse of multiline disabled translations [#262] [#263]
## [5.5.1] - 2020-06-08
### Fixed
- Type error in which numeric filenames were converted to integers [#260]
## [5.5.0] - 2020-05-23
### Added
- New option `addReferences()` to configure the code scanners whether add or not references [#258]
## [4.8.0] - 2019-11-04
### Changed
- Many `private` properties and methods were changed to `protected` in order to improve the extensibility [#231]
- BREAKING: Moved some code from `CodeScanner` to the new `FunctionsHandlersTrait` in order to better reuse.
## [5.4.1] - 2020-03-15
### Fixed
- PHP 7.4 support [#230]
- PoGenerator includes the description and flags of the translations [#253]
## [4.7.0] - 2019-10-07
## [5.4.0] - 2020-03-07
### Added
- Support for UnitID in Xliff [#221] [#224] [#225]
- Support for scan multiple domains at the same time [#223]
- Added `_` function to the list of functions scanned by default
- Added `Translations::setDescription()` and `Translations::getDescription()` methods [#251]
- Added `Translations::getFlags()` that returns a `Flags` object to assign flags to the entire po file [#251]
### Fixed
- New lines in windows [#218] [#226]
## [4.6.3] - 2019-07-15
## [5.3.0] - 2020-02-18
### Added
- Some VueJs extraction improvements and additions [#205], [#213]
- `Comments::delete()` and `Flags::delete()` methods [#247]
## [5.2.2] - 2020-02-09
### Fixed
- Multiline extractions in jsCode [#200]
- Support for js template literals [#214]
- Fixed tabs in PHP comments [#215]
- MoLoader with plurals [#246]
## [4.6.2] - 2019-01-12
## [5.2.1] - 2019-12-08
### Fixed
- Multiline string in PoGenerator [#244]
## [5.2.0] - 2019-11-25
### Added
- New option `facade` in blade extractor to use a facade instead create a blade compiler [#197], [#198]
- New function `CodeScanner::extractCommentsStartingWith()` to extract comments from the code.
### Fixed
- Added php-7.3 to travis
- Added VueJS extractor method docblocks for IDEs [#191]
## [4.6.1] - 2018-08-27
### Fixed
- VueJS DOM parsing [#188]
- Javascript parser was unable to extract some functions [#187]
## [4.6.0] - 2018-06-26
## [5.1.0] - 2019-11-11
### Added
- New extractor for VueJs [#178]
- New function `CodeScanner::ignoreInvalidFunctions()` to ignore invalid functions instead throw an exception
### Fixed
- Do not include empty translations containing the headers in the translator [#182]
- Test enhancement [#177]
## [4.5.0] - 2018-04-23
## 5.0.0 - 2019-11-04
### Added
- Support for disabled translations
- New interfaces: `ScannerInterface` and `FunctionsScannerInterface`.
### Changed
- Moved the package and dependencies to [php-gettext](https://github.com/php-gettext) organization
- Minimum PHP version supported is 7.2
- Added php7 strict typing
- Extractors have been split into two different types of classes to import translations:
- Scanners: To scan code files (like php, javascript, twig, etc) in order to collect gettext entries from many domains at the same time.
- Loaders: To load a translation format such po, mo, json, xliff, etc
- Split the `Translation` and `Translations` classes in different sub-classes to handle comments, flags, references, etc. For example, instead `$translation->addComment('foo')` now it's `$translation->getComments()->add('foo')`.
- Simplified the options to merge translations with pre-configured options like `Merged::SCAN_AND_LOAD`.
- The headers of translations are always sorted alphabetically.
- Changed the signature of all classes and interfaces.
### Removed
- Extractors (now scanners and loaders), generators and translators were removed from this package and published as external packages, allowing to install only those that you need. Only Po and Mo formats are included by default.
- Removed magic classes like `Translations::fromPoFile` or `$translation->toMoFile()`. Now, the scanners, loaders and generators are independent classes that have to be instantiated.
- Removed `Merge::LANGUAGE_OVERRIDE` and `Merge::DOMAIN_OVERRIDE` contants
### Fixed
- Added php-7.2 to travis
- Fixed po tests on bigendian [#159]
- Improved comment estraction [#166]
- Fixed incorrect docs to dn__ function [#170]
- Ignored phpcs.xml file on export [#168]
- Improved `@method` docs in `Translations` [#175]
- Improved code quality
- The library is easier to extend
- Translation id can be independent of the context + original values, in order to be more compatible with Xliff format.
## [4.4.4] - 2018-02-21
### Fixed
- Changed the comment extraction to be compatible with gettext behaviour: the comment must be placed in the line preceding the function [#161]
[#244]: https://github.com/php-gettext/Gettext/issues/244
[#246]: https://github.com/php-gettext/Gettext/issues/246
[#247]: https://github.com/php-gettext/Gettext/issues/247
[#251]: https://github.com/php-gettext/Gettext/issues/251
[#253]: https://github.com/php-gettext/Gettext/issues/253
[#257]: https://github.com/php-gettext/Gettext/issues/257
[#258]: https://github.com/php-gettext/Gettext/issues/258
[#260]: https://github.com/php-gettext/Gettext/issues/260
[#262]: https://github.com/php-gettext/Gettext/issues/262
[#263]: https://github.com/php-gettext/Gettext/issues/263
[#265]: https://github.com/php-gettext/Gettext/issues/265
[#276]: https://github.com/php-gettext/Gettext/issues/276
[#278]: https://github.com/php-gettext/Gettext/issues/278
### Security
- Validate eval input from plural forms [#156]
## [4.4.3] - 2017-08-09
### Fixed
- Handle `NULL` arguments on extract entries in php. For example `dn__(null, 'singular', 'plural')`.
- Fixed the `PhpCode` and `JsCode` extractors that didn't extract `dn__` and `dngettext` entries [#155].
- Fixed the `PhpCode` and `JsCode` extractors that didn't extract `dnpgettext` correctly.
## [4.4.2] - 2017-07-27
### Fixed
- Clone the translations in `Translations::mergeWith` to prevent that the translation is referenced in both places. [#152]
- Fixed escaped quotes in the javascript extractor [#154]
## [4.4.1] - 2017-05-20
### Fixed
- Fixed a bug where the options was not passed correctly to the merging Translations object [#147]
- Unified the plural behaviours between PHP gettext and Translator when the plural translation is unknown [#148]
- Removed the deprecated function `create_function()` and use `eval()` instead
## [4.4.0] - 2017-05-10
### Added
- New option `noLocation` to po generator, to omit the references [#143]
- New options `delimiter`, `enclosure` and `escape_char` to Csv and CsvDictionary extractors and generators [#145]
- Added the missing `dn__()` function [#146]
### Fixed
- Improved the code style including php_codesniffer in development
## 4.3.0 - 2017-03-04
### Added
- Added support for named placeholders (using `strtr`). For example:
```php
__('Hello :name', [':name' => 'World']);
```
- Added support for Twig v2
- New function `BaseTranslator::includeFunctions()` to include the functions file without register any translator
### Fixed
- Fixed a bug related with the javascript source extraction with single quotes
[#143]: https://github.com/oscarotero/Gettext/issues/143
[#145]: https://github.com/oscarotero/Gettext/issues/145
[#146]: https://github.com/oscarotero/Gettext/issues/146
[#147]: https://github.com/oscarotero/Gettext/issues/147
[#148]: https://github.com/oscarotero/Gettext/issues/148
[#152]: https://github.com/oscarotero/Gettext/issues/152
[#154]: https://github.com/oscarotero/Gettext/issues/154
[#155]: https://github.com/oscarotero/Gettext/issues/155
[#156]: https://github.com/oscarotero/Gettext/issues/156
[#159]: https://github.com/oscarotero/Gettext/issues/159
[#161]: https://github.com/oscarotero/Gettext/issues/161
[#166]: https://github.com/oscarotero/Gettext/issues/166
[#168]: https://github.com/oscarotero/Gettext/issues/168
[#170]: https://github.com/oscarotero/Gettext/issues/170
[#175]: https://github.com/oscarotero/Gettext/issues/175
[#177]: https://github.com/oscarotero/Gettext/issues/177
[#178]: https://github.com/oscarotero/Gettext/issues/178
[#182]: https://github.com/oscarotero/Gettext/issues/182
[#187]: https://github.com/oscarotero/Gettext/issues/187
[#188]: https://github.com/oscarotero/Gettext/issues/188
[#191]: https://github.com/oscarotero/Gettext/issues/191
[#197]: https://github.com/oscarotero/Gettext/issues/197
[#198]: https://github.com/oscarotero/Gettext/issues/198
[#200]: https://github.com/oscarotero/Gettext/issues/200
[#205]: https://github.com/oscarotero/Gettext/issues/205
[#213]: https://github.com/oscarotero/Gettext/issues/213
[#214]: https://github.com/oscarotero/Gettext/issues/214
[#215]: https://github.com/oscarotero/Gettext/issues/215
[#218]: https://github.com/oscarotero/Gettext/issues/218
[#221]: https://github.com/oscarotero/Gettext/issues/221
[#223]: https://github.com/oscarotero/Gettext/issues/223
[#224]: https://github.com/oscarotero/Gettext/issues/224
[#225]: https://github.com/oscarotero/Gettext/issues/225
[#226]: https://github.com/oscarotero/Gettext/issues/226
[#230]: https://github.com/oscarotero/Gettext/issues/230
[#231]: https://github.com/oscarotero/Gettext/issues/231
[#238]: https://github.com/oscarotero/Gettext/issues/238
[#242]: https://github.com/oscarotero/Gettext/issues/242
[4.8.2]: https://github.com/oscarotero/Gettext/compare/v4.8.1...v4.8.2
[4.8.1]: https://github.com/oscarotero/Gettext/compare/v4.8.0...v4.8.1
[4.8.0]: https://github.com/oscarotero/Gettext/compare/v4.7.0...v4.8.0
[4.7.0]: https://github.com/oscarotero/Gettext/compare/v4.6.3...v4.7.0
[4.6.3]: https://github.com/oscarotero/Gettext/compare/v4.6.2...v4.6.3
[4.6.2]: https://github.com/oscarotero/Gettext/compare/v4.6.1...v4.6.2
[4.6.1]: https://github.com/oscarotero/Gettext/compare/v4.6.0...v4.6.1
[4.6.0]: https://github.com/oscarotero/Gettext/compare/v4.5.0...v4.6.0
[4.5.0]: https://github.com/oscarotero/Gettext/compare/v4.4.4...v4.5.0
[4.4.4]: https://github.com/oscarotero/Gettext/compare/v4.4.3...v4.4.4
[4.4.3]: https://github.com/oscarotero/Gettext/compare/v4.4.2...v4.4.3
[4.4.2]: https://github.com/oscarotero/Gettext/compare/v4.4.1...v4.4.2
[4.4.1]: https://github.com/oscarotero/Gettext/compare/v4.4.0...v4.4.1
[4.4.0]: https://github.com/oscarotero/Gettext/compare/v4.3.0...v4.4.0
[5.6.1]: https://github.com/php-gettext/Gettext/compare/v5.6.0...v5.6.1
[5.6.0]: https://github.com/php-gettext/Gettext/compare/v5.5.4...v5.6.0
[5.5.4]: https://github.com/php-gettext/Gettext/compare/v5.5.3...v5.5.4
[5.5.3]: https://github.com/php-gettext/Gettext/compare/v5.5.2...v5.5.3
[5.5.2]: https://github.com/php-gettext/Gettext/compare/v5.5.1...v5.5.2
[5.5.1]: https://github.com/php-gettext/Gettext/compare/v5.5.0...v5.5.1
[5.5.0]: https://github.com/php-gettext/Gettext/compare/v5.4.1...v5.5.0
[5.4.1]: https://github.com/php-gettext/Gettext/compare/v5.4.0...v5.4.1
[5.4.0]: https://github.com/php-gettext/Gettext/compare/v5.3.0...v5.4.0
[5.3.0]: https://github.com/php-gettext/Gettext/compare/v5.2.2...v5.3.0
[5.2.2]: https://github.com/php-gettext/Gettext/compare/v5.2.1...v5.2.2
[5.2.1]: https://github.com/php-gettext/Gettext/compare/v5.2.0...v5.2.1
[5.2.0]: https://github.com/php-gettext/Gettext/compare/v5.1.0...v5.2.0
[5.1.0]: https://github.com/php-gettext/Gettext/compare/v5.0.0...v5.1.0

View File

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2017 Oscar Otero Marzoa
Copyright (c) 2019 Oscar Otero Marzoa
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@ -1,134 +1,68 @@
Gettext
=======
# Gettext
[![Build Status](https://travis-ci.org/oscarotero/Gettext.png?branch=master)](https://travis-ci.org/oscarotero/Gettext)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/oscarotero/Gettext/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/oscarotero/Gettext/?branch=master)
[![Latest Stable Version](https://poser.pugx.org/gettext/gettext/v/stable.svg)](https://packagist.org/packages/gettext/gettext)
[![Total Downloads](https://poser.pugx.org/gettext/gettext/downloads.svg)](https://packagist.org/packages/gettext/gettext)
[![Monthly Downloads](https://poser.pugx.org/gettext/gettext/d/monthly.png)](https://packagist.org/packages/gettext/gettext)
[![License](https://poser.pugx.org/gettext/gettext/license.svg)](https://packagist.org/packages/gettext/gettext)
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE)
![ico-ga]
[![Total Downloads][ico-downloads]][link-downloads]
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/496dc2a6-43be-4046-a283-f8370239dd47/big.png)](https://insight.sensiolabs.com/projects/496dc2a6-43be-4046-a283-f8370239dd47)
> Note: this is the documentation of the new 5.x version. Go to [4.x branch](https://github.com/php-gettext/Gettext/tree/4.x) if you're looking for the old 4.x version
Created by Oscar Otero <http://oscarotero.com> <oom@oscarotero.com> (MIT License)
Gettext is a PHP (>=5.4) library to import/export/edit gettext from PO, MO, PHP, JS files, etc.
Gettext is a PHP (^7.2) library to import/export/edit gettext from PO, MO, PHP, JS files, etc.
## Installation
With composer (recomended):
```
composer require gettext/gettext
```
If you don't use composer in your project, you have to download and place this package in a directory of your project. You need to install also [gettext/languages](https://github.com/mlocati/cldr-to-gettext-plural-rules). Then, include the autoloaders of both projects in any place of your php code:
```php
include_once "libs/gettext/src/autoloader.php";
include_once "libs/cldr-to-gettext-plural-rules/src/autoloader.php";
```
## Classes and functions
This package contains the following classes:
* `Gettext\Translation` - A translation definition
* `Gettext\Translations` - A collection of translations
* `Gettext\Extractors\*` - Import translations from various sources (po, mo, php, js, etc)
* `Gettext\Generators\*` - Export translations to various formats (po, mo, php, json, etc)
* `Gettext\Translator` - To use the translations in your php templates instead the [gettext extension](http://php.net/gettext)
* `Gettext\GettextTranslator` - To use the [gettext extension](http://php.net/gettext)
* `Gettext\Translations` - A collection of translations (under the same domain)
* `Gettext\Scanner\*` - Scan files to extract translations (php, js, twig templates, ...)
* `Gettext\Loader\*` - Load translations from different formats (po, mo, json, ...)
* `Gettext\Generator\*` - Export translations to various formats (po, mo, json, ...)
## Usage example
```php
use Gettext\Translations;
use Gettext\Loader\PoLoader;
use Gettext\Generator\MoGenerator;
//import from a .po file:
$translations = Translations::fromPoFile('locales/gl.po');
$loader = new PoLoader();
$translations = $loader->loadFile('locales/gl.po');
//edit some translations:
$translation = $translations->find(null, 'apple');
if ($translation) {
$translation->setTranslation('Mazá');
$translation->translate('Mazá');
}
//export to a php array:
$translations->toPhpArrayFile('locales/gl.php');
//and to a .mo file
$translations->toMoFile('Locale/gl/LC_MESSAGES/messages.mo');
//export to a .mo file:
$generator = new MoGenerator();
$generator->generateFile($translations, 'Locale/gl/LC_MESSAGES/messages.mo');
```
If you want use this translations in your php templates without using the gettext extension:
```php
use Gettext\Translator;
//Create the translator instance
$t = new Translator();
//Load your translations (exported as PhpArray):
$t->loadTranslations('locales/gl.php');
//Use it:
echo $t->gettext('apple'); // "Mazá"
//If you want use global functions:
$t->register();
echo __('apple'); // "Mazá"
```
To use this translations with the gettext extension:
```php
use Gettext\GettextTranslator;
//Create the translator instance
$t = new GettextTranslator();
//Set the language and load the domain
$t->setLanguage('gl');
$t->loadDomain('messages', 'Locale');
//Use it:
echo $t->gettext('apple'); // "Mazá"
//Or use the gettext functions
echo gettext('apple'); // "Mazá"
//If you want use the global functions
$t->register();
echo __('apple'); // "Mazá"
//And use sprintf/strtr placeholders
echo __('Hello %s', 'world'); //Hello world
echo __('Hello {name}', ['{name}' => 'world']); //Hello world
```
The benefits of using the functions provided by this library (`__()` instead `_()` or `gettext()`) are:
* You are using the same functions, no matter whether the translations are provided by gettext extension or any other method.
* You can use variables easier because `sprintf` functionality is included. For example: `__('Hello %s', 'world')` instead `sprintf(_('Hello %s'), 'world')`.
* You can also use named placeholders if the second argument is an array. For example: `__('Hello %name%', ['%name%' => 'world'])` instead of `strtr(_('Hello %name%'), ['%name%' => 'world'])`.
## Translation
The `Gettext\Translation` class stores all information about a translation: the original text, the translated text, source references, comments, etc.
```php
// __construct($context, $original, $plural)
$translation = new Gettext\Translation('comments', 'One comment', '%s comments');
use Gettext\Translation;
$translation->setTranslation('Un comentario');
$translation->setPluralTranslation('%s comentarios');
$translation = Translation::create('comments', 'One comment', '%s comments');
$translation->addReference('templates/comments/comment.php', 34);
$translation->addComment('To display the amount of comments in a post');
$translation->translate('Un comentario');
$translation->translatePlural('%s comentarios');
$translation->getReferences()->add('templates/comments/comment.php', 34);
$translation->getComments()->add('To display the amount of comments in a post');
echo $translation->getContext(); // comments
echo $translation->getOriginal(); // One comment
@ -142,223 +76,134 @@ echo $translation->getTranslation(); // Un comentario
The `Gettext\Translations` class stores a collection of translations:
```php
$translations = new Gettext\Translations();
use Gettext\Translations;
//You can add new translations using the array syntax
$translations[] = new Gettext\Translation('comments', 'One comment', '%s comments');
$translations = Translations::create('my-domain');
//Or using the "insert" method
$insertedTranslation = $translations->insert('comments', 'One comment', '%s comments');
//You can add new translations:
$translation = Translation::create('comments', 'One comment', '%s comments');
$translations->add($translation);
//Find a specific translation
$translation = $translations->find('comments', 'One comment');
//Edit headers, domain, etc
$translations->setHeader('Last-Translator', 'Oscar Otero');
$translations->getHeaders()->set('Last-Translator', 'Oscar Otero');
$translations->setDomain('my-blog');
```
## Extractors
## Loaders
The extrators allows to fetch gettext values from any source. For example, to scan a .po file:
The loaders allows to get gettext values from any format. For example, to load a .po file:
```php
$translations = new Gettext\Translations();
use Gettext\Loader\PoLoader;
$loader = new PoLoader();
//From a file
Gettext\Extractors\Po::fromFile('locales/en.po', $translations);
$translations = $loader->loadFile('locales/en.po');
//From a string
$string = file_get_contents('locales2/en.po');
Gettext\Extractors\Po::fromString($string, $translations);
$translations = $loader->loadString($string);
```
The better way to use extractors is using the magic methods of `Gettext\Translations`:
This package includes the following loaders:
```php
//Create a Translations instance using a po file
$translations = Gettext\Translations::fromPoFile('locales/en.po');
- `MoLoader`
- `PoLoader`
//Add more messages from other files
$translations->addFromPoFile('locales2/en.po');
```
And you can install other formats with loaders and generators:
The available extractors are the following:
Name | Description | Example
---- | ----------- | --------
**Blade** | Scans a Blade template (For laravel users). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/blade/input.php)
**Csv** | Gets the messages from csv. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Csv.csv)
**CsvDictionary** | Gets the messages from csv (without plurals and context). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/CsvDictionary.csv)
**Jed** | Gets the messages from a json compatible with [Jed](http://slexaxton.github.com/Jed/). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Jed.json)
**JsCode** | Scans javascript code looking for all gettext functions (the same than PhpCode but for javascript). You can use [the javascript gettext-translator library](https://github.com/oscarotero/gettext-translator) | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/jscode/input.js)
**Json** | Gets the messages from json compatible with [gettext-translator](https://github.com/oscarotero/gettext-translator). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Json.json)
**JsonDictionary** | Gets the messages from a json (without plurals and context). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/JsonDictionary.json)
**Mo** | Gets the messages from MO. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Mo.mo)
**PhpArray** | Gets the messages from a php file that returns an array. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/PhpArray.php)
**PhpCode** | Scans php code looking for all gettext functions (see `translator_functions.php`). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/phpcode/input.php)
**Po** | Gets the messages from PO. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Po.po)
**Twig** | To scan a Twig template. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/twig/input.php)
**Xliff** | Gets the messages from [xliff (2.0)](http://docs.oasis-open.org/xliff/xliff-core/v2.0/os/xliff-core-v2.0-os.html). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Xliff.xlf)
**Yaml** | Gets the messages from yaml. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Yaml.yml)
**YamlDictionary** | Gets the messages from a yaml (without plurals and context). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/YamlDictionary.yml)
**VueJs** | Gets the messages from a VueJs template. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/vuejs/input.vue)
- [Json](https://github.com/php-gettext/Json)
## Generators
The generators export a `Gettext\Translations` instance to any format (po, mo, array, etc).
The generators export a `Gettext\Translations` instance to any format (po, mo, etc).
```php
//Save to a file
Gettext\Generators\Po::toFile($translations, 'locales/en.po');
use Gettext\Loader\PoLoader;
use Gettext\Generator\MoGenerator;
//Return as a string
$content = Gettext\Generators\Po::toString($translations);
file_put_contents('locales/en.po', $content);
//Load a PO file
$poLoader = new PoLoader();
$translations = $poLoader->loadFile('locales/en.po');
//Save to MO file
$moGenerator = new MoGenerator();
$moGenerator->generateFile($translations, 'locales/en.mo');
//Or return as a string
$content = $moGenerator->generateString($translations);
file_put_contents('locales/en.mo', $content);
```
Like extractors, the better way to use generators is using the magic methods of `Gettext\Translations`:
```php
//Extract messages from a php code file
$translations = Gettext\Translations::fromPhpCodeFile('templates/index.php');
//Export to a po file
$translations->toPoFile('locales/en.po');
//Export to a po string
$content = $translations->toPoString();
file_put_contents('locales/en.po', $content);
```
The available generators are the following:
Name | Description | Example
---- | ----------- | --------
**Csv** | Exports to csv. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Csv.csv)
**CsvDictionary** | Exports to csv (without plurals and context). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/CsvDictionary.csv)
**Json** | Exports to json, compatible with [gettext-translator](https://github.com/oscarotero/gettext-translator). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Json.json)
**JsonDictionary** | Exports to json (without plurals and context). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/JsonDictionary.json)
**Mo** | Exports to Mo. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Mo.mo)
**PhpArray** | Exports to php code that returns an array. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/PhpArray.php)
**Po** | Exports to Po. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Po.po)
**Jed** | Exports to json format compatible with [Jed](http://slexaxton.github.com/Jed/). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Jed.json)
**Xliff** | Exports to [xliff (2.0)](http://docs.oasis-open.org/xliff/xliff-core/v2.0/os/xliff-core-v2.0-os.html). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Xliff.xlf)
**Yaml** | Exports to yaml. | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/Yaml.yml)
**YamlDictionary** | Exports to yaml (without plurals and context). | [example](https://github.com/oscarotero/Gettext/blob/master/tests/assets/po/YamlDictionary.yml)
## Translator
The class `Gettext\Translator` implements the gettext functions in php. Useful if you don't have the native gettext extension for php or want to avoid problems with it. You can load the translations from a php array file or using a `Gettext\Translations` instance:
```php
use Gettext\Translator;
//Create a new instance of the translator
$t = new Translator();
//Load the translations using any of the following ways:
// 1. from php files (generated by Gettext\Extractors\PhpArray)
$t->loadTranslations('locales/gl.php');
// 2. using the array directly
$array = include 'locales/gl.php';
$t->loadTranslations($array);
// 3. using a Gettext\Translations instance (slower)
$translations = Gettext\Translations::fromPoFile('locales/gl.po');
$t->loadTranslations($translations);
//Now you can use it in your templates
echo $t->gettext('apple');
```
## GettextTranslator
The class `Gettext\GettextTranslator` uses the gettext extension. It's useful because combines the performance of using real gettext functions but with the same API than `Translator` class, so you can switch to one or other translator deppending of the environment without change code of your app.
```php
use Gettext\GettextTranslator;
//Create a new instance
$t = new GettextTranslator();
//It detects the environment variables to set the locale, but you can change it:
$t->setLanguage('gl');
//Load the domains:
$t->loadDomain('messages', 'project/Locale');
//this means you have the file "project/Locale/gl/LC_MESSAGES/messages.po"
//Now you can use it in your templates
echo $t->gettext('apple');
```
## Global functions
To ease the use of translations in your php templates, you can use the provided functions:
```php
//Register the translator to use the global functions
$t->register();
echo __('apple'); // it's the same than $t->gettext('apple');
```
You can scan the php files containing these functions and extract the values with the PhpCode extractor:
```html
<!-- index.php -->
<html>
<body>
<?= __('Hello world'); ?>
</body>
</html>
```
## Merge translations
To work with different translations you may want merge them in an unique file. There are two ways to do this:
The simplest way is adding new translations:
This package includes the following generators:
- `MoGenerator`
- `PoGenerator`
And you can install other formats with loaders and generators:
- [Json](https://github.com/php-gettext/Json)
## Scanners
Scanners allow to search and extract new gettext entries from different sources like php files, twig templates, blade templates, etc. Unlike loaders, scanners allows to extract gettext entries with different domains at the same time:
```php
use Gettext\Scanner\PhpScanner;
use Gettext\Translations;
$translations = Translations::fromPoFile('my-file1.po');
$translations->addFromPoFile('my-file2.po');
//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);
}
//Get the translations
list('domain1' => $domain1, 'domain2' => $domain2, 'domain3' => $domain3) = $phpScanner->getTranslations();
```
A more advanced way is merge two `Translations` instances:
This package does not include any scanner by default. But there are some that you can install:
- [PHP Scanner](https://github.com/php-gettext/PHP-Scanner)
- [JS Scanner](https://github.com/php-gettext/JS-Scanner)
## Merging translations
You will want to update or merge translations. The function `mergeWith` create a new `Translations` instance with other translations merged:
```php
use Gettext\Translations;
//Create a new Translations instances with our translations.
$translations1 = Translations::fromPoFile('my-file1.po');
$translations2 = Translations::fromPoFile('my-file2.po');
//Merge one inside other:
$translations1->mergeWith($translations2);
//Now translations1 has all values
$translations3 = $translations1->mergeWith($translations2);
```
The second argument of `mergeWith` defines how the merge will be done. Use the `Gettext\Merge` constants to configure the merging:
But sometimes this is not enough, and this is why we have merging options, allowing to configure how two translations will be merged. These options are defined as constants in the `Gettext\Merge` class, and are the following:
Constant | Description
--------- | -----------
`Merge::ADD` | Adds the translations from `$translations2` that are missing
`Merge::REMOVE` | Removes the translations missing in `$translations2`
`Merge::HEADERS_ADD` | Adds the headers from `$translations2` that are missing
`Merge::HEADERS_REMOVE` | Removes the headers missing in `$translations2`
`Merge::HEADERS_OVERRIDE` | Overrides the headers with the values of `$translations2`
`Merge::LANGUAGE_OVERRIDE` | Set the language defined in `$translations2`
`Merge::DOMAIN_OVERRIDE` | Set the domain defined in `$translations2`
`Merge::TRANSLATIONS_OURS` | Use only the translations present in `$translations1`
`Merge::TRANSLATIONS_THEIRS` | Use only the translations present in `$translations2`
`Merge::TRANSLATION_OVERRIDE` | Override the translation and plural translations with the value of `$translation2`
`Merge::HEADERS_OURS` | Use only the headers of `$translations1`
`Merge::HEADERS_REMOVE` | Use only the headers of `$translations2`
`Merge::HEADERS_OVERRIDE` | Overrides the headers with the values of `$translations2`
`Merge::COMMENTS_OURS` | Use only the comments of `$translation1`
`Merge::COMMENTS_THEIRS` | Use only the comments of `$translation2`
`Merge::EXTRACTED_COMMENTS_OURS` | Use only the extracted comments of `$translation1`
@ -368,58 +213,48 @@ Constant | Description
`Merge::REFERENCES_OURS` | Use only the references of `$translation1`
`Merge::REFERENCES_THEIRS` | Use only the references of `$translation2`
Example:
Use the second argument to configure the merging strategy:
```php
use Gettext\Translations;
use Gettext\Merge;
$strategy = Merge::TRANSLATIONS_OURS | Merge::HEADERS_OURS;
//Scan the php code to find the latest gettext translations
$phpTranslations = Translations::fromPhpCodeFile('my-templates.php');
//Get the translations of the code that are stored in a po file
$poTranslations = Translations::fromPoFile('locale.po');
//Merge the translations from the po file using the references from `$phpTranslations`:
$translations->mergeWith($poTranslations, Merge::REFERENCES_OURS);
//Now save a po file with the result
$translations->toPoFile('locale.po');
$translations3 = $translations1->mergeWith($translations2, $strategy);
```
Note, if the second argument is not defined, the default value is `Merge::DEFAULTS` that's equivalent to `Merge::ADD | Merge::HEADERS_ADD`.
There are some typical scenarios, one of the most common:
## Use from CLI
- Scan php templates searching for entries to translate
- Complete these entries with the translations stored in a .po file
- You may want to add new entries to the .po file
- And also remove those entries present in the .po file but not in the templates (because they were removed)
- But you want to update some translations with new references and extracted comments
- And keep the translations, comments and flags defined in .po file
There's a Robo task to use this library from the command line interface: https://github.com/oscarotero/GettextRobo
For this scenario, you can use the option `Merge::SCAN_AND_LOAD` with the combination of options to fit this needs (SCAN new entries and LOAD a .po file).
## Use in the browser
```php
$newEntries = $scanner->scanFile('template.php');
$previousEntries = $loader->loadFile('translations.po');
If you want to use your translations in the browser, there's a javascript translator: https://github.com/oscarotero/gettext-translator
$updatedEntries = $newEntries->mergeWith($previousEntries);
```
## Third party packages
Twig integration:
* [jaimeperez/twig-configurable-i18n](https://packagist.org/packages/jaimeperez/twig-configurable-i18n)
* [cemerson/translator-twig-extension](https://packagist.org/packages/cemerson/translator-twig-extension)
Framework integration:
* [Laravel 5](https://packagist.org/packages/eusonlito/laravel-gettext)
* [CakePHP 3](https://packagist.org/packages/k1low/po)
* [Symfony 2](https://packagist.org/packages/mablae/gettext-bundle)
[add your package](https://github.com/oscarotero/Gettext/issues/new)
More common scenarios may be added in a future.
## Contributors
Thanks to all [contributors](https://github.com/oscarotero/Gettext/graphs/contributors) specially to [@mlocati](https://github.com/mlocati).
## Donations
---
If this library is useful for you, consider to donate to the author.
Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes and [CONTRIBUTING](CONTRIBUTING.md) for contributing details.
[Buy me a beer :beer:](https://www.paypal.me/oscarotero)
The MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
Thanks in advance!
[ico-version]: https://img.shields.io/packagist/v/gettext/gettext.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-ga]: https://github.com/php-gettext/Gettext/workflows/testing/badge.svg
[ico-downloads]: https://img.shields.io/packagist/dt/gettext/gettext.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/gettext/gettext
[link-downloads]: https://packagist.org/packages/gettext/gettext

View File

@ -3,7 +3,7 @@
"type": "library",
"description": "PHP gettext manager",
"keywords": ["js", "gettext", "i18n", "translation", "po", "mo"],
"homepage": "https://github.com/oscarotero/Gettext",
"homepage": "https://github.com/php-gettext/Gettext",
"license": "MIT",
"authors": [
{
@ -15,25 +15,18 @@
],
"support": {
"email": "oom@oscarotero.com",
"issues": "https://github.com/oscarotero/Gettext/issues"
"issues": "https://github.com/php-gettext/Gettext/issues"
},
"require": {
"php": ">=5.4.0",
"php": "^7.2|^8.0",
"gettext/languages": "^2.3"
},
"require-dev": {
"illuminate/view": "*",
"twig/twig": "^1.31|^2.0",
"twig/extensions": "*",
"symfony/yaml": "~2",
"phpunit/phpunit": "^4.8|^5.7|^6.5",
"squizlabs/php_codesniffer": "^3.0"
},
"suggest": {
"illuminate/view": "Is necessary if you want to use the Blade extractor",
"twig/twig": "Is necessary if you want to use the Twig extractor",
"twig/extensions": "Is necessary if you want to use the Twig extractor",
"symfony/yaml": "Is necessary if you want to use the Yaml extractor/generator"
"phpunit/phpunit": "^8.0|^9.0",
"squizlabs/php_codesniffer": "^3.0",
"brick/varexporter": "^0.3.5",
"friendsofphp/php-cs-fixer": "^3.2",
"oscarotero/php-cs-fixer-config": "^2.0"
},
"autoload": {
"psr-4": {
@ -49,6 +42,7 @@
"test": [
"phpunit",
"phpcs"
]
],
"cs-fix": "php-cs-fixer fix"
}
}

View File

@ -1,39 +0,0 @@
<?php
namespace Gettext;
abstract class BaseTranslator implements TranslatorInterface
{
/** @var TranslatorInterface */
public static $current;
/**
* @see TranslatorInterface
*/
public function noop($original)
{
return $original;
}
/**
* @see TranslatorInterface
*/
public function register()
{
$previous = static::$current;
static::$current = $this;
static::includeFunctions();
return $previous;
}
/**
* Include the gettext functions
*/
public static function includeFunctions()
{
include_once __DIR__.'/translator_functions.php';
}
}

View File

@ -0,0 +1,89 @@
<?php
declare(strict_types = 1);
namespace Gettext;
use ArrayIterator;
use Countable;
use IteratorAggregate;
use JsonSerializable;
use ReturnTypeWillChange;
/**
* Class to manage the comments of a translation.
*/
class Comments implements JsonSerializable, Countable, IteratorAggregate
{
protected $comments = [];
public static function __set_state(array $state): Comments
{
return new static(...$state['comments']);
}
public function __construct(string ...$comments)
{
if (!empty($comments)) {
$this->add(...$comments);
}
}
public function __debugInfo()
{
return $this->toArray();
}
public function add(string ...$comments): self
{
foreach ($comments as $comment) {
if (!in_array($comment, $this->comments)) {
$this->comments[] = $comment;
}
}
return $this;
}
public function delete(string ...$comments): self
{
foreach ($comments as $comment) {
$key = array_search($comment, $this->comments);
if (is_int($key)) {
array_splice($this->comments, $key, 1);
}
}
return $this;
}
#[ReturnTypeWillChange]
public function jsonSerialize()
{
return $this->toArray();
}
#[ReturnTypeWillChange]
public function getIterator()
{
return new ArrayIterator($this->comments);
}
public function count(): int
{
return count($this->comments);
}
public function toArray(): array
{
return $this->comments;
}
public function mergeWith(Comments $comments): Comments
{
$merged = clone $this;
$merged->add(...$comments->comments);
return $merged;
}
}

View File

@ -1,29 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Illuminate\Filesystem\Filesystem;
use Illuminate\View\Compilers\BladeCompiler;
/**
* Class to get gettext strings from blade.php files returning arrays.
*/
class Blade extends Extractor implements ExtractorInterface
{
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
if (empty($options['facade'])) {
$cachePath = empty($options['cachePath']) ? sys_get_temp_dir() : $options['cachePath'];
$bladeCompiler = new BladeCompiler(new Filesystem(), $cachePath);
$string = $bladeCompiler->compileString($string);
} else {
$string = $options['facade']::compileString($string);
}
PhpCode::fromString($string, $translations, $options);
}
}

View File

@ -1,53 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Gettext\Utils\HeadersExtractorTrait;
use Gettext\Utils\CsvTrait;
/**
* Class to get gettext strings from csv.
*/
class Csv extends Extractor implements ExtractorInterface
{
use HeadersExtractorTrait;
use CsvTrait;
public static $options = [
'delimiter' => ",",
'enclosure' => '"',
'escape_char' => "\\"
];
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
$options += static::$options;
$handle = fopen('php://memory', 'w');
fputs($handle, $string);
rewind($handle);
while ($row = static::fgetcsv($handle, $options)) {
$context = array_shift($row);
$original = array_shift($row);
if ($context === '' && $original === '') {
static::extractHeaders(array_shift($row), $translations);
continue;
}
$translation = $translations->insert($context, $original);
if (!empty($row)) {
$translation->setTranslation(array_shift($row));
$translation->setPluralTranslations($row);
}
}
fclose($handle);
}
}

View File

@ -1,47 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Gettext\Utils\HeadersExtractorTrait;
use Gettext\Utils\CsvTrait;
/**
* Class to get gettext strings from csv.
*/
class CsvDictionary extends Extractor implements ExtractorInterface
{
use HeadersExtractorTrait;
use CsvTrait;
public static $options = [
'delimiter' => ",",
'enclosure' => '"',
'escape_char' => "\\"
];
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
$options += static::$options;
$handle = fopen('php://memory', 'w');
fputs($handle, $string);
rewind($handle);
while ($row = static::fgetcsv($handle, $options)) {
list($original, $translation) = $row + ['', ''];
if ($original === '') {
static::extractHeaders($translation, $translations);
continue;
}
$translations->insert(null, $original)->setTranslation($translation);
}
fclose($handle);
}
}

View File

@ -1,80 +0,0 @@
<?php
namespace Gettext\Extractors;
use Exception;
use InvalidArgumentException;
use Gettext\Translations;
abstract class Extractor implements ExtractorInterface
{
/**
* {@inheritdoc}
*/
public static function fromFile($file, Translations $translations, array $options = [])
{
foreach (static::getFiles($file) as $file) {
$options['file'] = $file;
static::fromString(static::readFile($file), $translations, $options);
}
}
/**
* Checks and returns all files.
*
* @param string|array $file The file/s
*
* @return array The file paths
*/
protected static function getFiles($file)
{
if (empty($file)) {
throw new InvalidArgumentException('There is not any file defined');
}
if (is_string($file)) {
if (!is_file($file)) {
throw new InvalidArgumentException("'$file' is not a valid file");
}
if (!is_readable($file)) {
throw new InvalidArgumentException("'$file' is not a readable file");
}
return [$file];
}
if (is_array($file)) {
$files = [];
foreach ($file as $f) {
$files = array_merge($files, static::getFiles($f));
}
return $files;
}
throw new InvalidArgumentException('The first argument must be string or array');
}
/**
* Reads and returns the content of a file.
*
* @param string $file
*
* @return string
*/
protected static function readFile($file)
{
$length = filesize($file);
if (!($fd = fopen($file, 'rb'))) {
throw new Exception("Cannot read the file '$file', probably permissions");
}
$content = $length ? fread($fd, $length) : '';
fclose($fd);
return $content;
}
}

View File

@ -1,26 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
interface ExtractorInterface
{
/**
* Extract the translations from a file.
*
* @param array|string $file A path of a file or files
* @param Translations $translations The translations instance to append the new translations.
* @param array $options
*/
public static function fromFile($file, Translations $translations, array $options = []);
/**
* Parses a string and append the translations found in the Translations instance.
*
* @param string $string
* @param Translations $translations
* @param array $options
*/
public static function fromString($string, Translations $translations, array $options = []);
}

View File

@ -1,28 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
interface ExtractorMultiInterface
{
/**
* Parses a string and append the translations found in the Translations instance.
* Allows scanning for multiple domains at a time (each Translation has to have a different domain)
*
* @param string $string
* @param Translations[] $translations
* @param array $options
*/
public static function fromStringMultiple($string, array $translations, array $options = []);
/**
* Parses a string and append the translations found in the Translations instance.
* Allows scanning for multiple domains at a time (each Translation has to have a different domain)
*
* @param $file
* @param Translations[] $translations
* @param array $options
*/
public static function fromFileMultiple($file, array $translations, array $options = []);
}

View File

@ -1,55 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
/**
* Class to get gettext strings from json files.
*/
class Jed extends Extractor implements ExtractorInterface
{
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
static::extract(json_decode($string, true), $translations);
}
/**
* Handle an array of translations and append to the Translations instance.
*
* @param array $content
* @param Translations $translations
*/
public static function extract(array $content, Translations $translations)
{
$messages = current($content);
$headers = isset($messages['']) ? $messages[''] : null;
unset($messages['']);
if (!empty($headers['domain'])) {
$translations->setDomain($headers['domain']);
}
if (!empty($headers['lang'])) {
$translations->setLanguage($headers['lang']);
}
if (!empty($headers['plural-forms'])) {
$translations->setHeader(Translations::HEADER_PLURAL, $headers['plural-forms']);
}
$context_glue = '\u0004';
foreach ($messages as $key => $translation) {
$key = explode($context_glue, $key);
$context = isset($key[1]) ? array_shift($key) : '';
$translations->insert($context, array_shift($key))
->setTranslation(array_shift($translation))
->setPluralTranslations($translation);
}
}
}

View File

@ -1,74 +0,0 @@
<?php
namespace Gettext\Extractors;
use Exception;
use Gettext\Translations;
use Gettext\Utils\FunctionsScanner;
/**
* Class to get gettext strings from javascript files.
*/
class JsCode extends Extractor implements ExtractorInterface, ExtractorMultiInterface
{
public static $options = [
'constants' => [],
'functions' => [
'gettext' => 'gettext',
'__' => 'gettext',
'ngettext' => 'ngettext',
'n__' => 'ngettext',
'pgettext' => 'pgettext',
'p__' => 'pgettext',
'dgettext' => 'dgettext',
'd__' => 'dgettext',
'dngettext' => 'dngettext',
'dn__' => 'dngettext',
'dpgettext' => 'dpgettext',
'dp__' => 'dpgettext',
'npgettext' => 'npgettext',
'np__' => 'npgettext',
'dnpgettext' => 'dnpgettext',
'dnp__' => 'dnpgettext',
'noop' => 'noop',
'noop__' => 'noop',
],
];
protected static $functionsScannerClass = 'Gettext\Utils\JsFunctionsScanner';
/**
* @inheritdoc
* @throws Exception
*/
public static function fromString($string, Translations $translations, array $options = [])
{
static::fromStringMultiple($string, [$translations], $options);
}
/**
* @inheritDoc
* @throws Exception
*/
public static function fromStringMultiple($string, array $translations, array $options = [])
{
$options += static::$options;
/** @var FunctionsScanner $functions */
$functions = new static::$functionsScannerClass($string);
$functions->saveGettextFunctions($translations, $options);
}
/**
* @inheritDoc
* @throws Exception
*/
public static function fromFileMultiple($file, array $translations, array $options = [])
{
foreach (static::getFiles($file) as $file) {
$options['file'] = $file;
static::fromStringMultiple(static::readFile($file), $translations, $options);
}
}
}

View File

@ -1,26 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Gettext\Utils\MultidimensionalArrayTrait;
/**
* Class to get gettext strings from json.
*/
class Json extends Extractor implements ExtractorInterface
{
use MultidimensionalArrayTrait;
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
$messages = json_decode($string, true);
if (is_array($messages)) {
static::fromArray($messages, $translations);
}
}
}

View File

@ -1,26 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Gettext\Utils\DictionaryTrait;
/**
* Class to get gettext strings from plain json.
*/
class JsonDictionary extends Extractor implements ExtractorInterface
{
use DictionaryTrait;
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
$messages = json_decode($string, true);
if (is_array($messages)) {
static::fromArray($messages, $translations);
}
}
}

View File

@ -1,131 +0,0 @@
<?php
namespace Gettext\Extractors;
use Exception;
use Gettext\Translations;
use Gettext\Utils\StringReader;
/**
* Class to get gettext strings from .mo files.
*/
class Mo extends Extractor implements ExtractorInterface
{
const MAGIC1 = -1794895138;
const MAGIC2 = -569244523;
const MAGIC3 = 2500072158;
protected static $stringReaderClass = 'Gettext\Utils\StringReader';
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
/** @var StringReader $stream */
$stream = new static::$stringReaderClass($string);
$magic = static::readInt($stream, 'V');
if (($magic === static::MAGIC1) || ($magic === static::MAGIC3)) { //to make sure it works for 64-bit platforms
$byteOrder = 'V'; //low endian
} elseif ($magic === (static::MAGIC2 & 0xFFFFFFFF)) {
$byteOrder = 'N'; //big endian
} else {
throw new Exception('Not MO file');
}
static::readInt($stream, $byteOrder);
$total = static::readInt($stream, $byteOrder); //total string count
$originals = static::readInt($stream, $byteOrder); //offset of original table
$tran = static::readInt($stream, $byteOrder); //offset of translation table
$stream->seekto($originals);
$table_originals = static::readIntArray($stream, $byteOrder, $total * 2);
$stream->seekto($tran);
$table_translations = static::readIntArray($stream, $byteOrder, $total * 2);
for ($i = 0; $i < $total; ++$i) {
$next = $i * 2;
$stream->seekto($table_originals[$next + 2]);
$original = $stream->read($table_originals[$next + 1]);
$stream->seekto($table_translations[$next + 2]);
$translated = $stream->read($table_translations[$next + 1]);
if ($original === '') {
// Headers
foreach (explode("\n", $translated) as $headerLine) {
if ($headerLine === '') {
continue;
}
$headerChunks = preg_split('/:\s*/', $headerLine, 2);
$translations->setHeader($headerChunks[0], isset($headerChunks[1]) ? $headerChunks[1] : '');
}
continue;
}
$chunks = explode("\x04", $original, 2);
if (isset($chunks[1])) {
$context = $chunks[0];
$original = $chunks[1];
} else {
$context = '';
}
$chunks = explode("\x00", $original, 2);
if (isset($chunks[1])) {
$original = $chunks[0];
$plural = $chunks[1];
} else {
$plural = '';
}
$translation = $translations->insert($context, $original, $plural);
if ($translated === '') {
continue;
}
if ($plural === '') {
$translation->setTranslation($translated);
continue;
}
$v = explode("\x00", $translated);
$translation->setTranslation(array_shift($v));
$translation->setPluralTranslations($v);
}
}
/**
* @param StringReader $stream
* @param string $byteOrder
*/
protected static function readInt(StringReader $stream, $byteOrder)
{
if (($read = $stream->read(4)) === false) {
return false;
}
$read = unpack($byteOrder, $read);
return array_shift($read);
}
/**
* @param StringReader $stream
* @param string $byteOrder
* @param int $count
*/
protected static function readIntArray(StringReader $stream, $byteOrder, $count)
{
return unpack($byteOrder.$count, $stream->read(4 * $count));
}
}

View File

@ -1,33 +0,0 @@
<?php
namespace Gettext\Extractors;
use BadMethodCallException;
use Gettext\Translations;
use Gettext\Utils\MultidimensionalArrayTrait;
/**
* Class to get gettext strings from php files returning arrays.
*/
class PhpArray extends Extractor implements ExtractorInterface
{
use MultidimensionalArrayTrait;
/**
* {@inheritdoc}
*/
public static function fromFile($file, Translations $translations, array $options = [])
{
foreach (static::getFiles($file) as $file) {
static::fromArray(include($file), $translations);
}
}
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
throw new BadMethodCallException('PhpArray::fromString() cannot be called. Use PhpArray::fromFile()');
}
}

View File

@ -1,170 +0,0 @@
<?php
namespace Gettext\Extractors;
use Exception;
use Gettext\Translations;
use Gettext\Utils\FunctionsScanner;
/**
* Class to get gettext strings from php files returning arrays.
*/
class PhpCode extends Extractor implements ExtractorInterface, ExtractorMultiInterface
{
public static $options = [
// - false: to not extract comments
// - empty string: to extract all comments
// - non-empty string: to extract comments that start with that string
// - array with strings to extract comments format.
'extractComments' => false,
'constants' => [],
'functions' => [
'gettext' => 'gettext',
'__' => 'gettext',
'ngettext' => 'ngettext',
'n__' => 'ngettext',
'pgettext' => 'pgettext',
'p__' => 'pgettext',
'dgettext' => 'dgettext',
'd__' => 'dgettext',
'dngettext' => 'dngettext',
'dn__' => 'dngettext',
'dpgettext' => 'dpgettext',
'dp__' => 'dpgettext',
'npgettext' => 'npgettext',
'np__' => 'npgettext',
'dnpgettext' => 'dnpgettext',
'dnp__' => 'dnpgettext',
'noop' => 'noop',
'noop__' => 'noop',
],
];
protected static $functionsScannerClass = 'Gettext\Utils\PhpFunctionsScanner';
/**
* {@inheritdoc}
* @throws Exception
*/
public static function fromString($string, Translations $translations, array $options = [])
{
static::fromStringMultiple($string, [$translations], $options);
}
/**
* @inheritDoc
* @throws Exception
*/
public static function fromStringMultiple($string, array $translations, array $options = [])
{
$options += static::$options;
/** @var FunctionsScanner $functions */
$functions = new static::$functionsScannerClass($string);
if ($options['extractComments'] !== false) {
$functions->enableCommentsExtraction($options['extractComments']);
}
$functions->saveGettextFunctions($translations, $options);
}
/**
* @inheritDoc
*/
public static function fromFileMultiple($file, array $translations, array $options = [])
{
foreach (static::getFiles($file) as $file) {
$options['file'] = $file;
static::fromStringMultiple(static::readFile($file), $translations, $options);
}
}
/**
* Decodes a T_CONSTANT_ENCAPSED_STRING string.
*
* @param string $value
*
* @return string
*/
public static function convertString($value)
{
if (strpos($value, '\\') === false) {
return substr($value, 1, -1);
}
if ($value[0] === "'") {
return strtr(substr($value, 1, -1), ['\\\\' => '\\', '\\\'' => '\'']);
}
$value = substr($value, 1, -1);
return preg_replace_callback(
'/\\\(n|r|t|v|e|f|\$|"|\\\|x[0-9A-Fa-f]{1,2}|u{[0-9a-f]{1,6}}|[0-7]{1,3})/',
function ($match) {
switch ($match[1][0]) {
case 'n':
return "\n";
case 'r':
return "\r";
case 't':
return "\t";
case 'v':
return "\v";
case 'e':
return "\e";
case 'f':
return "\f";
case '$':
return '$';
case '"':
return '"';
case '\\':
return '\\';
case 'x':
return chr(hexdec(substr($match[1], 1)));
case 'u':
return static::unicodeChar(hexdec(substr($match[1], 1)));
default:
return chr(octdec($match[1]));
}
},
$value
);
}
/**
* @param $dec
* @return string|null
* @see http://php.net/manual/en/function.chr.php#118804
*/
protected static function unicodeChar($dec)
{
if ($dec < 0x80) {
return chr($dec);
}
if ($dec < 0x0800) {
return chr(0xC0 + ($dec >> 6))
. chr(0x80 + ($dec & 0x3f));
}
if ($dec < 0x010000) {
return chr(0xE0 + ($dec >> 12))
. chr(0x80 + (($dec >> 6) & 0x3f))
. chr(0x80 + ($dec & 0x3f));
}
if ($dec < 0x200000) {
return chr(0xF0 + ($dec >> 18))
. chr(0x80 + (($dec >> 12) & 0x3f))
. chr(0x80 + (($dec >> 6) & 0x3f))
. chr(0x80 + ($dec & 0x3f));
}
return null;
}
}

View File

@ -1,211 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Gettext\Translation;
use Gettext\Utils\HeadersExtractorTrait;
/**
* Class to get gettext strings from php files returning arrays.
*/
class Po extends Extractor implements ExtractorInterface
{
use HeadersExtractorTrait;
/**
* Parses a .po file and append the translations found in the Translations instance.
*
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
$lines = explode("\n", $string);
$i = 0;
$translation = $translations->createNewTranslation('', '');
for ($n = count($lines); $i < $n; ++$i) {
$line = trim($lines[$i]);
$line = static::fixMultiLines($line, $lines, $i);
if ($line === '') {
if ($translation->is('', '')) {
static::extractHeaders($translation->getTranslation(), $translations);
} elseif ($translation->hasOriginal()) {
$translations[] = $translation;
}
$translation = $translations->createNewTranslation('', '');
continue;
}
$splitLine = preg_split('/\s+/', $line, 2);
$key = $splitLine[0];
$data = isset($splitLine[1]) ? $splitLine[1] : '';
if ($key === '#~') {
$translation->setDisabled(true);
$splitLine = preg_split('/\s+/', $data, 2);
$key = $splitLine[0];
$data = isset($splitLine[1]) ? $splitLine[1] : '';
}
switch ($key) {
case '#':
$translation->addComment($data);
$append = null;
break;
case '#.':
$translation->addExtractedComment($data);
$append = null;
break;
case '#,':
foreach (array_map('trim', explode(',', trim($data))) as $value) {
$translation->addFlag($value);
}
$append = null;
break;
case '#:':
foreach (preg_split('/\s+/', trim($data)) as $value) {
if (preg_match('/^(.+)(:(\d*))?$/U', $value, $matches)) {
$translation->addReference($matches[1], isset($matches[3]) ? $matches[3] : null);
}
}
$append = null;
break;
case 'msgctxt':
$translation = $translation->getClone(static::convertString($data));
$append = 'Context';
break;
case 'msgid':
$translation = $translation->getClone(null, static::convertString($data));
$append = 'Original';
break;
case 'msgid_plural':
$translation->setPlural(static::convertString($data));
$append = 'Plural';
break;
case 'msgstr':
case 'msgstr[0]':
$translation->setTranslation(static::convertString($data));
$append = 'Translation';
break;
case 'msgstr[1]':
$translation->setPluralTranslations([static::convertString($data)]);
$append = 'PluralTranslation';
break;
default:
if (strpos($key, 'msgstr[') === 0) {
$p = $translation->getPluralTranslations();
$p[] = static::convertString($data);
$translation->setPluralTranslations($p);
$append = 'PluralTranslation';
break;
}
if (isset($append)) {
if ($append === 'Context') {
$translation = $translation->getClone($translation->getContext()
."\n"
.static::convertString($data));
break;
}
if ($append === 'Original') {
$translation = $translation->getClone(null, $translation->getOriginal()
."\n"
.static::convertString($data));
break;
}
if ($append === 'PluralTranslation') {
$p = $translation->getPluralTranslations();
$p[] = array_pop($p)."\n".static::convertString($data);
$translation->setPluralTranslations($p);
break;
}
$getMethod = 'get'.$append;
$setMethod = 'set'.$append;
$translation->$setMethod($translation->$getMethod()."\n".static::convertString($data));
}
break;
}
}
if ($translation->hasOriginal() && !in_array($translation, iterator_to_array($translations))) {
$translations[] = $translation;
}
}
/**
* Gets one string from multiline strings.
*
* @param string $line
* @param array $lines
* @param int &$i
*
* @return string
*/
protected static function fixMultiLines($line, array $lines, &$i)
{
for ($j = $i, $t = count($lines); $j < $t; ++$j) {
if (substr($line, -1, 1) == '"'
&& isset($lines[$j + 1])
&& substr(trim($lines[$j + 1]), 0, 1) == '"'
) {
$line = substr($line, 0, -1).substr(trim($lines[$j + 1]), 1);
} else {
$i = $j;
break;
}
}
return $line;
}
/**
* Convert a string from its PO representation.
*
* @param string $value
*
* @return string
*/
public static function convertString($value)
{
if (!$value) {
return '';
}
if ($value[0] === '"') {
$value = substr($value, 1, -1);
}
return strtr(
$value,
[
'\\\\' => '\\',
'\\a' => "\x07",
'\\b' => "\x08",
'\\t' => "\t",
'\\n' => "\n",
'\\v' => "\x0b",
'\\f' => "\x0c",
'\\r' => "\r",
'\\"' => '"',
]
);
}
}

View File

@ -1,45 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Twig_Loader_Array;
use Twig_Environment;
use Twig_Source;
use Twig_Extensions_Extension_I18n;
/**
* Class to get gettext strings from twig files returning arrays.
*/
class Twig extends Extractor implements ExtractorInterface
{
public static $options = [
'extractComments' => 'notes:',
'twig' => null,
];
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
$options += static::$options;
$twig = $options['twig'] ?: static::createTwig();
PhpCode::fromString($twig->compileSource(new Twig_Source($string, '')), $translations, $options);
}
/**
* Returns a Twig instance.
*
* @return Twig_Environment
*/
protected static function createTwig()
{
$twig = new Twig_Environment(new Twig_Loader_Array(['' => '']));
$twig->addExtension(new Twig_Extensions_Extension_I18n());
return static::$options['twig'] = $twig;
}
}

View File

@ -1,423 +0,0 @@
<?php
/** @noinspection PhpComposerExtensionStubsInspection */
namespace Gettext\Extractors;
use DOMAttr;
use DOMDocument;
use DOMElement;
use DOMNode;
use Exception;
use Gettext\Translations;
use Gettext\Utils\FunctionsScanner;
/**
* Class to get gettext strings from VueJS template files.
*/
class VueJs extends Extractor implements ExtractorInterface, ExtractorMultiInterface
{
public static $options = [
'constants' => [],
'functions' => [
'gettext' => 'gettext',
'__' => 'gettext',
'ngettext' => 'ngettext',
'n__' => 'ngettext',
'pgettext' => 'pgettext',
'p__' => 'pgettext',
'dgettext' => 'dgettext',
'd__' => 'dgettext',
'dngettext' => 'dngettext',
'dn__' => 'dngettext',
'dpgettext' => 'dpgettext',
'dp__' => 'dpgettext',
'npgettext' => 'npgettext',
'np__' => 'npgettext',
'dnpgettext' => 'dnpgettext',
'dnp__' => 'dnpgettext',
'noop' => 'noop',
'noop__' => 'noop',
],
];
protected static $functionsScannerClass = 'Gettext\Utils\JsFunctionsScanner';
/**
* @inheritDoc
* @throws Exception
*/
public static function fromFileMultiple($file, array $translations, array $options = [])
{
foreach (static::getFiles($file) as $file) {
$options['file'] = $file;
static::fromStringMultiple(static::readFile($file), $translations, $options);
}
}
/**
* @inheritdoc
* @throws Exception
*/
public static function fromString($string, Translations $translations, array $options = [])
{
static::fromStringMultiple($string, [$translations], $options);
}
/**
* @inheritDoc
* @throws Exception
*/
public static function fromStringMultiple($string, array $translations, array $options = [])
{
$options += static::$options;
$options += [
// HTML attribute prefixes we parse as JS which could contain translations (are JS expressions)
'attributePrefixes' => [
':',
'v-bind:',
'v-on:',
'v-text',
],
// HTML Tags to parse
'tagNames' => [
'translate',
],
// HTML tags to parse when attribute exists
'tagAttributes' => [
'v-translate',
],
// Comments
'commentAttributes' => [
'translate-comment',
],
'contextAttributes' => [
'translate-context',
],
// Attribute with plural content
'pluralAttributes' => [
'translate-plural',
],
];
// Ok, this is the weirdest hack, but let me explain:
// On Linux (Mac is fine), when converting HTML to DOM, new lines get trimmed after the first tag.
// So if there are new lines between <template> and next element, they are lost
// So we insert a "." which is a text node, and it will prevent that newlines are stripped between elements.
// Same thing happens between template and script tag.
$string = str_replace('<template>', '<template>.', $string);
$string = str_replace('</template>', '</template>.', $string);
// Normalize newlines
$string = str_replace(["\r\n", "\n\r", "\r"], "\n", $string);
// VueJS files are valid HTML files, we will operate with the DOM here
$dom = static::convertHtmlToDom($string);
$script = static::extractScriptTag($string);
// Parse the script part as a regular JS code
if ($script) {
$scriptLineNumber = $dom->getElementsByTagName('script')->item(0)->getLineNo();
static::getScriptTranslationsFromString(
$script,
$translations,
$options,
$scriptLineNumber - 1
);
}
// Template part is parsed separately, all variables will be extracted
// and handled as a regular JS code
$template = $dom->getElementsByTagName('template')->item(0);
if ($template) {
static::getTemplateTranslations(
$template,
$translations,
$options,
$template->getLineNo() - 1
);
}
}
/**
* Extracts script tag contents using regex instead of DOM operations.
* If we parse using DOM, some contents may change, for example, tags within strings will be stripped
*
* @param $string
* @return bool|string
*/
protected static function extractScriptTag($string)
{
if (preg_match('#<\s*?script\b[^>]*>(.*?)</script\b[^>]*>#s', $string, $matches)) {
return $matches[1];
}
return '';
}
/**
* @param string $html
* @return DOMDocument
*/
protected static function convertHtmlToDom($html)
{
$dom = new DOMDocument;
libxml_use_internal_errors(true);
// Prepend xml encoding so DOMDocument document handles UTF8 correctly.
// Assuming that vue template files will not have any xml encoding tags, because duplicate tags may be ignored.
$dom->loadHTML('<?xml encoding="utf-8"?>' . $html);
libxml_clear_errors();
return $dom;
}
/**
* Extract translations from script part
*
* @param string $scriptContents Only script tag contents, not the whole template
* @param Translations|Translations[] $translations One or multiple domain Translation objects
* @param array $options
* @param int $lineOffset Number of lines the script is offset in the vue template file
* @throws Exception
*/
protected static function getScriptTranslationsFromString(
$scriptContents,
$translations,
array $options = [],
$lineOffset = 0
) {
/** @var FunctionsScanner $functions */
$functions = new static::$functionsScannerClass($scriptContents);
$options['lineOffset'] = $lineOffset;
$functions->saveGettextFunctions($translations, $options);
}
/**
* Parse template to extract all translations (element content and dynamic element attributes)
*
* @param DOMNode $dom
* @param Translations|Translations[] $translations One or multiple domain Translation objects
* @param array $options
* @param int $lineOffset Line number where the template part starts in the vue file
* @throws Exception
*/
protected static function getTemplateTranslations(
DOMNode $dom,
$translations,
array $options,
$lineOffset = 0
) {
// Build a JS string from all template attribute expressions
$fakeAttributeJs = static::getTemplateAttributeFakeJs($options, $dom);
// 1 line offset is necessary because parent template element was ignored when converting to DOM
static::getScriptTranslationsFromString($fakeAttributeJs, $translations, $options, $lineOffset);
// Build a JS string from template element content expressions
$fakeTemplateJs = static::getTemplateFakeJs($dom);
static::getScriptTranslationsFromString($fakeTemplateJs, $translations, $options, $lineOffset);
static::getTagTranslations($options, $dom, $translations);
}
/**
* @param array $options
* @param DOMNode $dom
* @param Translations|Translations[] $translations
*/
protected static function getTagTranslations(array $options, DOMNode $dom, $translations)
{
// Since tag scanning does not support domains, we always use the first translation given
$translations = is_array($translations) ? reset($translations) : $translations;
$children = $dom->childNodes;
for ($i = 0; $i < $children->length; $i++) {
$node = $children->item($i);
if (!($node instanceof DOMElement)) {
continue;
}
$translatable = false;
if (in_array($node->tagName, $options['tagNames'], true)) {
$translatable = true;
}
$attrList = $node->attributes;
$context = null;
$plural = "";
$comment = null;
for ($j = 0; $j < $attrList->length; $j++) {
/** @var DOMAttr $domAttr */
$domAttr = $attrList->item($j);
// Check if this is a dynamic vue attribute
if (in_array($domAttr->name, $options['tagAttributes'])) {
$translatable = true;
}
if (in_array($domAttr->name, $options['contextAttributes'])) {
$context = $domAttr->value;
}
if (in_array($domAttr->name, $options['pluralAttributes'])) {
$plural = $domAttr->value;
}
if (in_array($domAttr->name, $options['commentAttributes'])) {
$comment = $domAttr->value;
}
}
if ($translatable) {
$translation = $translations->insert($context, trim($node->textContent), $plural);
$translation->addReference($options['file'], $node->getLineNo());
if ($comment) {
$translation->addExtractedComment($comment);
}
}
if ($node->hasChildNodes()) {
static::getTagTranslations($options, $node, $translations);
}
}
}
/**
* Extract JS expressions from element attribute bindings (excluding text within elements)
* For example: <span :title="__('extract this')"> skip element content </span>
*
* @param array $options
* @param DOMNode $dom
* @return string JS code
*/
protected static function getTemplateAttributeFakeJs(array $options, DOMNode $dom)
{
$expressionsByLine = static::getVueAttributeExpressions($options['attributePrefixes'], $dom);
if (empty($expressionsByLine)) {
return '';
}
$maxLines = max(array_keys($expressionsByLine));
$fakeJs = '';
for ($line = 1; $line <= $maxLines; $line++) {
if (isset($expressionsByLine[$line])) {
$fakeJs .= implode("; ", $expressionsByLine[$line]);
}
$fakeJs .= "\n";
}
return $fakeJs;
}
/**
* Loop DOM element recursively and parse out all dynamic vue attributes which are basically JS expressions
*
* @param array $attributePrefixes List of attribute prefixes we parse as JS (may contain translations)
* @param DOMNode $dom
* @param array $expressionByLine [lineNumber => [jsExpression, ..], ..]
* @return array [lineNumber => [jsExpression, ..], ..]
*/
protected static function getVueAttributeExpressions(
array $attributePrefixes,
DOMNode $dom,
array &$expressionByLine = []
) {
$children = $dom->childNodes;
for ($i = 0; $i < $children->length; $i++) {
$node = $children->item($i);
if (!($node instanceof DOMElement)) {
continue;
}
$attrList = $node->attributes;
for ($j = 0; $j < $attrList->length; $j++) {
/** @var DOMAttr $domAttr */
$domAttr = $attrList->item($j);
// Check if this is a dynamic vue attribute
if (static::isAttributeMatching($domAttr->name, $attributePrefixes)) {
$line = $domAttr->getLineNo();
$expressionByLine += [$line => []];
$expressionByLine[$line][] = $domAttr->value;
}
}
if ($node->hasChildNodes()) {
$expressionByLine = static::getVueAttributeExpressions($attributePrefixes, $node, $expressionByLine);
}
}
return $expressionByLine;
}
/**
* Check if this attribute name should be parsed for translations
*
* @param string $attributeName
* @param string[] $attributePrefixes
* @return bool
*/
protected static function isAttributeMatching($attributeName, $attributePrefixes)
{
foreach ($attributePrefixes as $prefix) {
if (strpos($attributeName, $prefix) === 0) {
return true;
}
}
return false;
}
/**
* Extract JS expressions from within template elements (excluding attributes)
* For example: <span :title="skip attributes"> {{__("extract element content")}} </span>
*
* @param DOMNode $dom
* @return string JS code
*/
protected static function getTemplateFakeJs(DOMNode $dom)
{
$fakeJs = '';
$lines = explode("\n", $dom->textContent);
// Build a fake JS file from template by extracting JS expressions within each template line
foreach ($lines as $line) {
$expressionMatched = static::parseOneTemplateLine($line);
$fakeJs .= implode("; ", $expressionMatched) . "\n";
}
return $fakeJs;
}
/**
* Match JS expressions in a template line
*
* @param string $line
* @return string[]
*/
protected static function parseOneTemplateLine($line)
{
$line = trim($line);
if (!$line) {
return [];
}
$regex = '#\{\{(.*?)\}\}#';
preg_match_all($regex, $line, $matches);
$matched = array_map(function ($v) {
return trim($v, '\'"{}');
}, $matches[1]);
return $matched;
}
}

View File

@ -1,86 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Gettext\Translation;
use SimpleXMLElement;
/**
* Class to get gettext strings from xliff format.
*/
class Xliff extends Extractor implements ExtractorInterface
{
public static $options = [
'unitid_as_id' => false
];
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
$options += static::$options;
$xml = new SimpleXMLElement($string, null, false);
foreach ($xml->file as $file) {
if (isset($file->notes)) {
foreach ($file->notes->note as $note) {
$translations->setHeader($note['id'], (string) $note);
}
}
foreach ($file->unit as $unit) {
foreach ($unit->segment as $segment) {
$targets = [];
foreach ($segment->target as $target) {
$targets[] = (string) $target;
}
$translation = $translations->createNewTranslation(null, (string) $segment->source);
if (isset($unit['id'])) {
$unitId = (string) $unit['id'];
$translation->addComment("XLIFF_UNIT_ID: $unitId");
if ($options['unitid_as_id']) {
$translation->setId($unitId);
}
}
$translation->setTranslation(array_shift($targets));
$translation->setPluralTranslations($targets);
if (isset($unit->notes)) {
foreach ($unit->notes->note as $note) {
switch ($note['category']) {
case 'context':
$translation = $translation->getClone((string) $note);
break;
case 'extracted-comment':
$translation->addExtractedComment((string) $note);
break;
case 'flag':
$translation->addFlag((string) $note);
break;
case 'reference':
$ref = explode(':', (string) $note, 2);
$translation->addReference($ref[0], isset($ref[1]) ? $ref[1] : null);
break;
default:
$translation->addComment((string) $note);
break;
}
}
}
$translations[] = $translation;
}
}
}
}
}

View File

@ -1,27 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Gettext\Utils\MultidimensionalArrayTrait;
use Symfony\Component\Yaml\Yaml as YamlParser;
/**
* Class to get gettext strings from yaml.
*/
class Yaml extends Extractor implements ExtractorInterface
{
use MultidimensionalArrayTrait;
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
$messages = YamlParser::parse($string);
if (is_array($messages)) {
static::fromArray($messages, $translations);
}
}
}

View File

@ -1,27 +0,0 @@
<?php
namespace Gettext\Extractors;
use Gettext\Translations;
use Gettext\Utils\DictionaryTrait;
use Symfony\Component\Yaml\Yaml as YamlParser;
/**
* Class to get gettext strings from yaml.
*/
class YamlDictionary extends Extractor implements ExtractorInterface
{
use DictionaryTrait;
/**
* {@inheritdoc}
*/
public static function fromString($string, Translations $translations, array $options = [])
{
$messages = YamlParser::parse($string);
if (is_array($messages)) {
static::fromArray($messages, $translations);
}
}
}

96
inc/gettext/src/Flags.php Normal file
View File

@ -0,0 +1,96 @@
<?php
declare(strict_types = 1);
namespace Gettext;
use ArrayIterator;
use Countable;
use IteratorAggregate;
use JsonSerializable;
use ReturnTypeWillChange;
/**
* Class to manage the flags of a translation.
*/
class Flags implements JsonSerializable, Countable, IteratorAggregate
{
protected $flags = [];
public static function __set_state(array $state): Flags
{
return new static(...$state['flags']);
}
public function __construct(string ...$flags)
{
if (!empty($flags)) {
$this->add(...$flags);
}
}
public function __debugInfo()
{
return $this->toArray();
}
public function add(string ...$flags): self
{
foreach ($flags as $flag) {
if (!$this->has($flag)) {
$this->flags[] = $flag;
}
}
sort($this->flags);
return $this;
}
public function delete(string ...$flags): self
{
foreach ($flags as $flag) {
$key = array_search($flag, $this->flags);
if (is_int($key)) {
array_splice($this->flags, $key, 1);
}
}
return $this;
}
public function has(string $flag): bool
{
return in_array($flag, $this->flags, true);
}
#[ReturnTypeWillChange]
public function jsonSerialize()
{
return $this->toArray();
}
#[ReturnTypeWillChange]
public function getIterator()
{
return new ArrayIterator($this->flags);
}
public function count(): int
{
return count($this->flags);
}
public function toArray(): array
{
return $this->flags;
}
public function mergeWith(Flags $flags): Flags
{
$merged = clone $this;
$merged->add(...$flags->flags);
return $merged;
}
}

View File

@ -0,0 +1,18 @@
<?php
declare(strict_types = 1);
namespace Gettext\Generator;
use Gettext\Translations;
abstract class Generator implements GeneratorInterface
{
public function generateFile(Translations $translations, string $filename): bool
{
$content = $this->generateString($translations);
return file_put_contents($filename, $content) !== false;
}
abstract public function generateString(Translations $translations): string;
}

View File

@ -0,0 +1,13 @@
<?php
declare(strict_types = 1);
namespace Gettext\Generator;
use Gettext\Translations;
interface GeneratorInterface
{
public function generateFile(Translations $translations, string $filename): bool;
public function generateString(Translations $translations): string;
}

View File

@ -1,37 +1,43 @@
<?php
declare(strict_types = 1);
namespace Gettext\Generators;
namespace Gettext\Generator;
use Gettext\Translation;
use Gettext\Translations;
use Gettext\Utils\HeadersGeneratorTrait;
class Mo extends Generator implements GeneratorInterface
final class MoGenerator extends Generator
{
use HeadersGeneratorTrait;
private $includeHeaders = false;
public static $options = [
'includeHeaders' => true,
];
/**
* {@parentDoc}.
*/
public static function toString(Translations $translations, array $options = [])
public function includeHeaders(bool $includeHeaders = true): self
{
$this->includeHeaders = $includeHeaders;
return $this;
}
public function generateString(Translations $translations): string
{
$options += static::$options;
$messages = [];
if ($options['includeHeaders']) {
$messages[''] = static::generateHeaders($translations);
if ($this->includeHeaders) {
$lines = [];
foreach ($translations->getHeaders() as $name => $value) {
$lines[] = sprintf('%s: %s', $name, $value);
}
$messages[''] = implode("\n", $lines);
}
foreach ($translations as $translation) {
if (!$translation->hasTranslation() || $translation->isDisabled()) {
if (!$translation->getTranslation() || $translation->isDisabled()) {
continue;
}
if ($translation->hasContext()) {
$originalString = $translation->getContext()."\x04".$translation->getOriginal();
if ($context = $translation->getContext()) {
$originalString = "{$context}\x04{$translation->getOriginal()}";
} else {
$originalString = $translation->getOriginal();
}
@ -45,32 +51,28 @@ class Mo extends Generator implements GeneratorInterface
$translationsTable = '';
$originalsIndex = [];
$translationsIndex = [];
$pluralForm = $translations->getPluralForms();
$pluralForm = $translations->getHeaders()->getPluralForm();
$pluralSize = is_array($pluralForm) ? ($pluralForm[0] - 1) : null;
foreach ($messages as $originalString => $translation) {
if (is_string($translation)) {
// Headers
$translationString = $translation;
} elseif (self::hasPluralTranslations($translation)) {
$originalString .= "\x00{$translation->getPlural()}";
$translationString = "{$translation->getTranslation()}\x00"
.implode("\x00", $translation->getPluralTranslations($pluralSize));
} else {
/* @var $translation \Gettext\Translation */
if ($translation->hasPlural() && $translation->hasPluralTranslations(true)) {
$originalString .= "\x00".$translation->getPlural();
$translationString = $translation->getTranslation();
$translationString .= "\x00".implode("\x00", $translation->getPluralTranslations($pluralSize));
} else {
$translationString = $translation->getTranslation();
}
$translationString = $translation->getTranslation();
}
$originalsIndex[] = [
'relativeOffset' => strlen($originalsTable),
'length' => strlen($originalString)
'length' => strlen((string) $originalString),
];
$originalsTable .= $originalString."\x00";
$translationsIndex[] = [
'relativeOffset' => strlen($translationsTable),
'length' => strlen($translationString)
'length' => strlen($translationString),
];
$translationsTable .= $translationString."\x00";
}
@ -137,4 +139,13 @@ class Mo extends Generator implements GeneratorInterface
return $mo;
}
private static function hasPluralTranslations(Translation $translation): bool
{
if (!$translation->getPlural()) {
return false;
}
return implode('', $translation->getPluralTranslations()) !== '';
}
}

View File

@ -0,0 +1,134 @@
<?php
declare(strict_types = 1);
namespace Gettext\Generator;
use Gettext\Translations;
final class PoGenerator extends Generator
{
public function generateString(Translations $translations): string
{
$pluralForm = $translations->getHeaders()->getPluralForm();
$pluralSize = is_array($pluralForm) ? ($pluralForm[0] - 1) : null;
$lines = [];
//Description and flags
if ($translations->getDescription()) {
$description = explode("\n", $translations->getDescription());
foreach ($description as $line) {
$lines[] = sprintf('# %s', $line);
}
$lines[] = '#';
}
if (count($translations->getFlags())) {
$lines[] = sprintf('#, %s', implode(',', $translations->getFlags()->toArray()));
}
//Headers
$lines[] = 'msgid ""';
$lines[] = 'msgstr ""';
foreach ($translations->getHeaders() as $name => $value) {
$lines[] = sprintf('"%s: %s\\n"', $name, $value);
}
$lines[] = '';
//Translations
foreach ($translations as $translation) {
foreach ($translation->getComments() as $comment) {
$lines[] = sprintf('# %s', $comment);
}
foreach ($translation->getExtractedComments() as $comment) {
$lines[] = sprintf('#. %s', $comment);
}
foreach ($translation->getReferences() as $filename => $lineNumbers) {
if (empty($lineNumbers)) {
$lines[] = sprintf('#: %s', $filename);
continue;
}
foreach ($lineNumbers as $number) {
$lines[] = sprintf('#: %s:%d', $filename, $number);
}
}
if (count($translation->getFlags())) {
$lines[] = sprintf('#, %s', implode(',', $translation->getFlags()->toArray()));
}
$prefix = $translation->isDisabled() ? '#~ ' : '';
if ($context = $translation->getContext()) {
$lines[] = sprintf('%smsgctxt %s', $prefix, self::encode($context));
}
self::appendLines($lines, $prefix, 'msgid', $translation->getOriginal());
if ($plural = $translation->getPlural()) {
self::appendLines($lines, $prefix, 'msgid_plural', $plural);
self::appendLines($lines, $prefix, 'msgstr[0]', $translation->getTranslation() ?: '');
foreach ($translation->getPluralTranslations($pluralSize) as $k => $v) {
self::appendLines($lines, $prefix, sprintf('msgstr[%d]', $k + 1), $v);
}
} else {
self::appendLines($lines, $prefix, 'msgstr', $translation->getTranslation() ?: '');
}
$lines[] = '';
}
return implode("\n", $lines);
}
/**
* Add one or more lines depending whether the string is multiline or not.
*/
private static function appendLines(array &$lines, string $prefix, string $name, string $value): void
{
$newLines = explode("\n", $value);
$total = count($newLines);
if ($total === 1) {
$lines[] = sprintf('%s%s %s', $prefix, $name, self::encode($newLines[0]));
return;
}
$lines[] = sprintf('%s%s ""', $prefix, $name);
$last = $total - 1;
foreach ($newLines as $k => $line) {
if ($k < $last) {
$line .= "\n";
}
$lines[] = self::encode($line);
}
}
/**
* Convert a string to its PO representation.
*/
public static function encode(string $value): string
{
return '"'.strtr(
$value,
[
"\x00" => '',
'\\' => '\\\\',
"\t" => '\t',
"\r" => '\r',
"\n" => '\n',
'"' => '\\"',
]
).'"';
}
}

View File

@ -1,56 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
use Gettext\Utils\HeadersGeneratorTrait;
use Gettext\Utils\CsvTrait;
/**
* Class to export translations to csv.
*/
class Csv extends Generator implements GeneratorInterface
{
use HeadersGeneratorTrait;
use CsvTrait;
public static $options = [
'includeHeaders' => false,
'delimiter' => ",",
'enclosure' => '"',
'escape_char' => "\\"
];
/**
* {@parentDoc}.
*/
public static function toString(Translations $translations, array $options = [])
{
$options += static::$options;
$handle = fopen('php://memory', 'w');
if ($options['includeHeaders']) {
static::fputcsv($handle, ['', '', static::generateHeaders($translations)], $options);
}
foreach ($translations as $translation) {
if ($translation->isDisabled()) {
continue;
}
$line = [$translation->getContext(), $translation->getOriginal(), $translation->getTranslation()];
if ($translation->hasPluralTranslations(true)) {
$line = array_merge($line, $translation->getPluralTranslations());
}
static::fputcsv($handle, $line, $options);
}
rewind($handle);
$csv = stream_get_contents($handle);
fclose($handle);
return $csv;
}
}

View File

@ -1,39 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
use Gettext\Utils\DictionaryTrait;
use Gettext\Utils\CsvTrait;
class CsvDictionary extends Generator implements GeneratorInterface
{
use DictionaryTrait;
use CsvTrait;
public static $options = [
'includeHeaders' => false,
'delimiter' => ",",
'enclosure' => '"',
'escape_char' => "\\"
];
/**
* {@parentDoc}.
*/
public static function toString(Translations $translations, array $options = [])
{
$options += static::$options;
$handle = fopen('php://memory', 'w');
foreach (static::toArray($translations, $options['includeHeaders']) as $original => $translation) {
static::fputcsv($handle, [$original, $translation], $options);
}
rewind($handle);
$csv = stream_get_contents($handle);
fclose($handle);
return $csv;
}
}

View File

@ -1,22 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
abstract class Generator implements GeneratorInterface
{
/**
* {@inheritdoc}
*/
public static function toFile(Translations $translations, $file, array $options = [])
{
$content = static::toString($translations, $options);
if (file_put_contents($file, $content) === false) {
return false;
}
return true;
}
}

View File

@ -1,29 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
interface GeneratorInterface
{
/**
* Saves the translations in a file.
*
* @param Translations $translations
* @param string $file
* @param array $options
*
* @return bool
*/
public static function toFile(Translations $translations, $file, array $options = []);
/**
* Generates a string with the translations ready to save in a file.
*
* @param Translations $translations
* @param array $options
*
* @return string
*/
public static function toString(Translations $translations, array $options = []);
}

View File

@ -1,66 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
class Jed extends Generator implements GeneratorInterface
{
public static $options = [
'json' => 0,
];
/**
* {@parentDoc}.
*/
public static function toString(Translations $translations, array $options = [])
{
$domain = $translations->getDomain() ?: 'messages';
$options += static::$options;
return json_encode([
$domain => [
'' => [
'domain' => $domain,
'lang' => $translations->getLanguage() ?: 'en',
'plural-forms' => $translations->getHeader('Plural-Forms') ?: 'nplurals=2; plural=(n != 1);',
],
] + static::buildMessages($translations),
], $options['json']);
}
/**
* Generates an array with all translations.
*
* @param Translations $translations
*
* @return array
*/
protected static function buildMessages(Translations $translations)
{
$pluralForm = $translations->getPluralForms();
$pluralSize = is_array($pluralForm) ? ($pluralForm[0] - 1) : null;
$messages = [];
$context_glue = '\u0004';
foreach ($translations as $translation) {
if ($translation->isDisabled()) {
continue;
}
$key = ($translation->hasContext() ? $translation->getContext().$context_glue : '')
.$translation->getOriginal();
if ($translation->hasPluralTranslations(true)) {
$message = $translation->getPluralTranslations($pluralSize);
array_unshift($message, $translation->getTranslation());
} else {
$message = [$translation->getTranslation()];
}
$messages[$key] = $message;
}
return $messages;
}
}

View File

@ -1,26 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
use Gettext\Utils\MultidimensionalArrayTrait;
class Json extends Generator implements GeneratorInterface
{
use MultidimensionalArrayTrait;
public static $options = [
'json' => 0,
'includeHeaders' => false,
];
/**
* {@inheritdoc}
*/
public static function toString(Translations $translations, array $options = [])
{
$options += static::$options;
return json_encode(static::toArray($translations, $options['includeHeaders'], true), $options['json']);
}
}

View File

@ -1,26 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
use Gettext\Utils\DictionaryTrait;
class JsonDictionary extends Generator implements GeneratorInterface
{
use DictionaryTrait;
public static $options = [
'json' => 0,
'includeHeaders' => false,
];
/**
* {@parentDoc}.
*/
public static function toString(Translations $translations, array $options = [])
{
$options += static::$options;
return json_encode(static::toArray($translations, $options['includeHeaders']), $options['json']);
}
}

View File

@ -1,40 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
use Gettext\Utils\MultidimensionalArrayTrait;
class PhpArray extends Generator implements GeneratorInterface
{
use MultidimensionalArrayTrait;
public static $options = [
'includeHeaders' => true,
];
/**
* {@inheritdoc}
*/
public static function toString(Translations $translations, array $options = [])
{
$array = static::generate($translations, $options);
return '<?php return '.var_export($array, true).';';
}
/**
* Generates an array with the translations.
*
* @param Translations $translations
* @param array $options
*
* @return array
*/
public static function generate(Translations $translations, array $options = [])
{
$options += static::$options;
return static::toArray($translations, $options['includeHeaders'], true);
}
}

View File

@ -1,145 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
class Po extends Generator implements GeneratorInterface
{
public static $options = [
'noLocation' => false,
];
/**
* {@parentDoc}.
*/
public static function toString(Translations $translations, array $options = [])
{
$options += static::$options;
$pluralForm = $translations->getPluralForms();
$pluralSize = is_array($pluralForm) ? ($pluralForm[0] - 1) : null;
$lines = ['msgid ""', 'msgstr ""'];
foreach ($translations->getHeaders() as $name => $value) {
$lines[] = sprintf('"%s: %s\\n"', $name, $value);
}
$lines[] = '';
//Translations
foreach ($translations as $translation) {
if ($translation->hasComments()) {
foreach ($translation->getComments() as $comment) {
$lines[] = '# '.$comment;
}
}
if ($translation->hasExtractedComments()) {
foreach ($translation->getExtractedComments() as $comment) {
$lines[] = '#. '.$comment;
}
}
if (!$options['noLocation'] && $translation->hasReferences()) {
foreach ($translation->getReferences() as $reference) {
$lines[] = '#: '.$reference[0].(!is_null($reference[1]) ? ':'.$reference[1] : null);
}
}
if ($translation->hasFlags()) {
$lines[] = '#, '.implode(',', $translation->getFlags());
}
$prefix = $translation->isDisabled() ? '#~ ' : '';
if ($translation->hasContext()) {
$lines[] = $prefix.'msgctxt '.static::convertString($translation->getContext());
}
static::addLines($lines, $prefix.'msgid', $translation->getOriginal());
if ($translation->hasPlural()) {
static::addLines($lines, $prefix.'msgid_plural', $translation->getPlural());
static::addLines($lines, $prefix.'msgstr[0]', $translation->getTranslation());
foreach ($translation->getPluralTranslations($pluralSize) as $k => $v) {
static::addLines($lines, $prefix.'msgstr['.($k + 1).']', $v);
}
} else {
static::addLines($lines, $prefix.'msgstr', $translation->getTranslation());
}
$lines[] = '';
}
return implode("\n", $lines);
}
/**
* Escapes and adds double quotes to a string.
*
* @param string $string
*
* @return string
*/
protected static function multilineQuote($string)
{
$lines = explode("\n", $string);
$last = count($lines) - 1;
foreach ($lines as $k => $line) {
if ($k === $last) {
$lines[$k] = static::convertString($line);
} else {
$lines[$k] = static::convertString($line."\n");
}
}
return $lines;
}
/**
* Add one or more lines depending whether the string is multiline or not.
*
* @param array &$lines
* @param string $name
* @param string $value
*/
protected static function addLines(array &$lines, $name, $value)
{
$newLines = static::multilineQuote($value);
if (count($newLines) === 1) {
$lines[] = $name.' '.$newLines[0];
} else {
$lines[] = $name.' ""';
foreach ($newLines as $line) {
$lines[] = $line;
}
}
}
/**
* Convert a string to its PO representation.
*
* @param string $value
*
* @return string
*/
public static function convertString($value)
{
return '"'.strtr(
$value,
[
"\x00" => '',
'\\' => '\\\\',
"\t" => '\t',
"\r" => '\r',
"\n" => '\n',
'"' => '\\"',
]
).'"';
}
}

View File

@ -1,122 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translation;
use Gettext\Translations;
use DOMDocument;
class Xliff extends Generator implements GeneratorInterface
{
const UNIT_ID_REGEXP = '/^XLIFF_UNIT_ID: (.*)$/';
/**
* {@inheritdoc}
*/
public static function toString(Translations $translations, array $options = [])
{
$dom = new DOMDocument('1.0', 'utf-8');
$dom->formatOutput = true;
$xliff = $dom->appendChild($dom->createElement('xliff'));
$xliff->setAttribute('xmlns', 'urn:oasis:names:tc:xliff:document:2.0');
$xliff->setAttribute('version', '2.0');
$xliff->setAttribute('srcLang', $translations->getLanguage());
$xliff->setAttribute('trgLang', $translations->getLanguage());
$file = $xliff->appendChild($dom->createElement('file'));
$file->setAttribute('id', $translations->getDomain().'.'.$translations->getLanguage());
//Save headers as notes
$notes = $dom->createElement('notes');
foreach ($translations->getHeaders() as $name => $value) {
$notes->appendChild(static::createTextNode($dom, 'note', $value))->setAttribute('id', $name);
}
if ($notes->hasChildNodes()) {
$file->appendChild($notes);
}
foreach ($translations as $translation) {
//Find an XLIFF unit ID, if one is available; otherwise generate
$unitId = static::getUnitID($translation)?:md5($translation->getContext().$translation->getOriginal());
$unit = $dom->createElement('unit');
$unit->setAttribute('id', $unitId);
//Save comments as notes
$notes = $dom->createElement('notes');
$notes->appendChild(static::createTextNode($dom, 'note', $translation->getContext()))
->setAttribute('category', 'context');
foreach ($translation->getComments() as $comment) {
//Skip XLIFF unit ID comments.
if (preg_match(static::UNIT_ID_REGEXP, $comment)) {
continue;
}
$notes->appendChild(static::createTextNode($dom, 'note', $comment))
->setAttribute('category', 'comment');
}
foreach ($translation->getExtractedComments() as $comment) {
$notes->appendChild(static::createTextNode($dom, 'note', $comment))
->setAttribute('category', 'extracted-comment');
}
foreach ($translation->getFlags() as $flag) {
$notes->appendChild(static::createTextNode($dom, 'note', $flag))
->setAttribute('category', 'flag');
}
foreach ($translation->getReferences() as $reference) {
$notes->appendChild(static::createTextNode($dom, 'note', $reference[0].':'.$reference[1]))
->setAttribute('category', 'reference');
}
$unit->appendChild($notes);
$segment = $unit->appendChild($dom->createElement('segment'));
$segment->appendChild(static::createTextNode($dom, 'source', $translation->getOriginal()));
$segment->appendChild(static::createTextNode($dom, 'target', $translation->getTranslation()));
foreach ($translation->getPluralTranslations() as $plural) {
if ($plural !== '') {
$segment->appendChild(static::createTextNode($dom, 'target', $plural));
}
}
$file->appendChild($unit);
}
return $dom->saveXML();
}
protected static function createTextNode(DOMDocument $dom, $name, $string)
{
$node = $dom->createElement($name);
$text = (preg_match('/[&<>]/', $string) === 1)
? $dom->createCDATASection($string)
: $dom->createTextNode($string);
$node->appendChild($text);
return $node;
}
/**
* Gets the translation's unit ID, if one is available.
*
* @param Translation $translation
*
* @return string|null
*/
public static function getUnitID(Translation $translation)
{
foreach ($translation->getComments() as $comment) {
if (preg_match(static::UNIT_ID_REGEXP, $comment, $matches)) {
return $matches[1];
}
}
return null;
}
}

View File

@ -1,32 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
use Gettext\Utils\MultidimensionalArrayTrait;
use Symfony\Component\Yaml\Yaml as YamlDumper;
class Yaml extends Generator implements GeneratorInterface
{
use MultidimensionalArrayTrait;
public static $options = [
'includeHeaders' => false,
'indent' => 2,
'inline' => 4,
];
/**
* {@inheritdoc}
*/
public static function toString(Translations $translations, array $options = [])
{
$options += static::$options;
return YamlDumper::dump(
static::toArray($translations, $options['includeHeaders']),
$options['inline'],
$options['indent']
);
}
}

View File

@ -1,32 +0,0 @@
<?php
namespace Gettext\Generators;
use Gettext\Translations;
use Gettext\Utils\DictionaryTrait;
use Symfony\Component\Yaml\Yaml as YamlDumper;
class YamlDictionary extends Generator implements GeneratorInterface
{
use DictionaryTrait;
public static $options = [
'includeHeaders' => false,
'indent' => 2,
'inline' => 3,
];
/**
* {@inheritdoc}
*/
public static function toString(Translations $translations, array $options = [])
{
$options += static::$options;
return YamlDumper::dump(
static::toArray($translations, $options['includeHeaders']),
$options['inline'],
$options['indent']
);
}
}

View File

@ -1,161 +0,0 @@
<?php
namespace Gettext;
class GettextTranslator extends BaseTranslator implements TranslatorInterface
{
/**
* Constructor. Detects the current language using the environment variables.
*
* @param string $language
*/
public function __construct($language = null)
{
if (!function_exists('gettext')) {
throw new \RuntimeException('This class require the gettext extension for PHP');
}
//detects the language environment respecting the priority order
//http://php.net/manual/en/function.gettext.php#114062
if (empty($language)) {
$language = getenv('LANGUAGE') ?: getenv('LC_ALL') ?: getenv('LC_MESSAGES') ?: getenv('LANG');
}
if (!empty($language)) {
$this->setLanguage($language);
}
}
/**
* Define the current locale.
*
* @param string $language
* @param int|null $category
*
* @return self
*/
public function setLanguage($language, $category = null)
{
if ($category === null) {
$category = defined('LC_MESSAGES') ? LC_MESSAGES : LC_ALL;
}
setlocale($category, $language);
putenv('LANGUAGE='.$language);
return $this;
}
/**
* Loads a gettext domain.
*
* @param string $domain
* @param string $path
* @param bool $default
*
* @return self
*/
public function loadDomain($domain, $path = null, $default = true)
{
bindtextdomain($domain, $path);
bind_textdomain_codeset($domain, 'UTF-8');
if ($default) {
textdomain($domain);
}
return $this;
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function gettext($original)
{
return gettext($original);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function ngettext($original, $plural, $value)
{
return ngettext($original, $plural, $value);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function dngettext($domain, $original, $plural, $value)
{
return dngettext($domain, $original, $plural, $value);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function npgettext($context, $original, $plural, $value)
{
$message = $context."\x04".$original;
$translation = ngettext($message, $plural, $value);
return ($translation === $message) ? $original : $translation;
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function pgettext($context, $original)
{
$message = $context."\x04".$original;
$translation = gettext($message);
return ($translation === $message) ? $original : $translation;
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function dgettext($domain, $original)
{
return dgettext($domain, $original);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function dpgettext($domain, $context, $original)
{
$message = $context."\x04".$original;
$translation = dgettext($domain, $message);
return ($translation === $message) ? $original : $translation;
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function dnpgettext($domain, $context, $original, $plural, $value)
{
$message = $context."\x04".$original;
$translation = dngettext($domain, $message, $plural, $value);
return ($translation === $message) ? $original : $translation;
}
}

144
inc/gettext/src/Headers.php Normal file
View File

@ -0,0 +1,144 @@
<?php
declare(strict_types = 1);
namespace Gettext;
use ArrayIterator;
use Countable;
use InvalidArgumentException;
use IteratorAggregate;
use JsonSerializable;
use ReturnTypeWillChange;
/**
* Class to manage the headers of translations.
*/
class Headers implements JsonSerializable, Countable, IteratorAggregate
{
public const HEADER_LANGUAGE = 'Language';
public const HEADER_PLURAL = 'Plural-Forms';
public const HEADER_DOMAIN = 'X-Domain';
protected $headers = [];
public static function __set_state(array $state): Headers
{
return new static($state['headers']);
}
public function __construct(array $headers = [])
{
$this->headers = $headers;
ksort($this->headers);
}
public function __debugInfo()
{
return $this->toArray();
}
public function set(string $name, string $value): self
{
$this->headers[$name] = trim($value);
ksort($this->headers);
return $this;
}
public function get(string $name): ?string
{
return $this->headers[$name] ?? null;
}
public function delete(string $name): self
{
unset($this->headers[$name]);
return $this;
}
public function clear(): self
{
$this->headers = [];
return $this;
}
#[ReturnTypeWillChange]
public function jsonSerialize()
{
return $this->toArray();
}
#[ReturnTypeWillChange]
public function getIterator()
{
return new ArrayIterator($this->toArray());
}
public function count(): int
{
return count($this->headers);
}
public function setLanguage(string $language): self
{
return $this->set(self::HEADER_LANGUAGE, $language);
}
public function getLanguage(): ?string
{
return $this->get(self::HEADER_LANGUAGE);
}
public function setDomain(string $domain): self
{
return $this->set(self::HEADER_DOMAIN, $domain);
}
public function getDomain(): ?string
{
return $this->get(self::HEADER_DOMAIN);
}
public function setPluralForm(int $count, string $rule): self
{
if (preg_match('/[a-z]/i', str_replace('n', '', $rule))) {
throw new InvalidArgumentException(sprintf('Invalid Plural form: "%s"', $rule));
}
return $this->set(self::HEADER_PLURAL, sprintf('nplurals=%d; plural=%s;', $count, $rule));
}
/**
* Returns the parsed plural definition.
*
* @return array|null [count, rule]
*/
public function getPluralForm(): ?array
{
$header = $this->get(self::HEADER_PLURAL);
if (!empty($header) &&
preg_match('/^nplurals\s*=\s*(\d+)\s*;\s*plural\s*=\s*([^;]+)\s*;$/', $header, $matches)
) {
return [intval($matches[1]), $matches[2]];
}
return null;
}
public function toArray(): array
{
return $this->headers;
}
public function mergeWith(Headers $headers): Headers
{
$merged = clone $this;
$merged->headers = $headers->headers + $merged->headers;
ksort($merged->headers);
return $merged;
}
}

View File

@ -0,0 +1,56 @@
<?php
declare(strict_types = 1);
namespace Gettext\Loader;
use Exception;
use Gettext\Translation;
use Gettext\Translations;
/**
* Base class with common funtions for all loaders.
*/
abstract class Loader implements LoaderInterface
{
public function loadFile(string $filename, Translations $translations = null): Translations
{
$string = static::readFile($filename);
return $this->loadString($string, $translations);
}
public function loadString(string $string, Translations $translations = null): Translations
{
return $translations ?: $this->createTranslations();
}
protected function createTranslations(): Translations
{
return Translations::create();
}
protected function createTranslation(?string $context, string $original, string $plural = null): ?Translation
{
$translation = Translation::create($context, $original);
if (isset($plural)) {
$translation->setPlural($plural);
}
return $translation;
}
/**
* Reads and returns the content of a file.
*/
protected static function readFile(string $file): string
{
$content = @file_get_contents($file);
if (false === $content) {
throw new Exception("Cannot read the file '$file', probably permissions");
}
return $content;
}
}

View File

@ -0,0 +1,13 @@
<?php
declare(strict_types = 1);
namespace Gettext\Loader;
use Gettext\Translations;
interface LoaderInterface
{
public function loadFile(string $filename, Translations $translations = null): Translations;
public function loadString(string $string, Translations $translations = null): Translations;
}

View File

@ -0,0 +1,142 @@
<?php
declare(strict_types = 1);
namespace Gettext\Loader;
use Exception;
use Gettext\Translation;
use Gettext\Translations;
/**
* Class to load a MO file.
*/
final class MoLoader extends Loader
{
private $string;
private $position;
private $length;
private const MAGIC1 = -1794895138;
private const MAGIC2 = -569244523;
private const MAGIC3 = 2500072158;
public function loadString(string $string, Translations $translations = null): Translations
{
$translations = parent::loadString($string, $translations);
$this->init($string);
$magic = $this->readInt('V');
if (($magic === self::MAGIC1) || ($magic === self::MAGIC3)) { //to make sure it works for 64-bit platforms
$byteOrder = 'V'; //low endian
} elseif ($magic === (self::MAGIC2 & 0xFFFFFFFF)) {
$byteOrder = 'N'; //big endian
} else {
throw new Exception('Not MO file');
}
$this->readInt($byteOrder);
$total = $this->readInt($byteOrder); //total string count
$originals = $this->readInt($byteOrder); //offset of original table
$tran = $this->readInt($byteOrder); //offset of translation table
$this->seekto($originals);
$table_originals = $this->readIntArray($byteOrder, $total * 2);
$this->seekto($tran);
$table_translations = $this->readIntArray($byteOrder, $total * 2);
for ($i = 0; $i < $total; ++$i) {
$next = $i * 2;
$this->seekto($table_originals[$next + 2]);
$original = $this->read($table_originals[$next + 1]);
$this->seekto($table_translations[$next + 2]);
$translated = $this->read($table_translations[$next + 1]);
// Headers
if ($original === '') {
foreach (explode("\n", $translated) as $headerLine) {
if ($headerLine === '') {
continue;
}
$headerChunks = preg_split('/:\s*/', $headerLine, 2);
$translations->getHeaders()->set($headerChunks[0], isset($headerChunks[1]) ? $headerChunks[1] : '');
}
continue;
}
$context = $plural = null;
$chunks = explode("\x04", $original, 2);
if (isset($chunks[1])) {
list($context, $original) = $chunks;
}
$chunks = explode("\x00", $original, 2);
if (isset($chunks[1])) {
list($original, $plural) = $chunks;
}
$translation = $this->createTranslation($context, $original, $plural);
$translations->add($translation);
if ($translated === '') {
continue;
}
if ($plural === null) {
$translation->translate($translated);
continue;
}
$v = explode("\x00", $translated);
$translation->translate(array_shift($v));
$translation->translatePlural(...array_filter($v));
}
return $translations;
}
private function init(string $string): void
{
$this->string = $string;
$this->position = 0;
$this->length = strlen($string);
}
private function read(int $bytes): string
{
$data = substr($this->string, $this->position, $bytes);
$this->seekTo($this->position + $bytes);
return $data;
}
private function seekTo(int $position): void
{
$this->position = ($this->length < $position) ? $this->length : $position;
}
private function readInt(string $byteOrder): int
{
if (($read = $this->read(4)) === false) {
return 0;
}
$read = (array) unpack($byteOrder, $read);
return (int) array_shift($read);
}
private function readIntArray(string $byteOrder, int $count): array
{
return unpack($byteOrder.$count, $this->read(4 * $count)) ?: [];
}
}

View File

@ -0,0 +1,226 @@
<?php
declare(strict_types = 1);
namespace Gettext\Loader;
use Gettext\Translation;
use Gettext\Translations;
/**
* Class to load a PO file.
*/
final class PoLoader extends Loader
{
public function loadString(string $string, Translations $translations = null): Translations
{
$translations = parent::loadString($string, $translations);
$lines = explode("\n", $string);
$line = current($lines);
$translation = $this->createTranslation(null, '');
while ($line !== false) {
$line = trim($line);
$nextLine = next($lines);
//Multiline
while (substr($line, -1, 1) === '"'
&& $nextLine !== false
&& (substr(trim($nextLine), 0, 1) === '"' || substr(trim($nextLine), 0, 4) === '#~ "')
) {
if (substr(trim($nextLine), 0, 1) === '"') { // Normal multiline
$line = substr($line, 0, -1).substr(trim($nextLine), 1);
} elseif (substr(trim($nextLine), 0, 4) === '#~ "') { // Disabled multiline
$line = substr($line, 0, -1).substr(trim($nextLine), 4);
}
$nextLine = next($lines);
}
//End of translation
if ($line === '') {
if (!self::isEmpty($translation)) {
$translations->add($translation);
}
$translation = $this->createTranslation(null, '');
$line = $nextLine;
continue;
}
$splitLine = preg_split('/\s+/', $line, 2);
$key = $splitLine[0];
$data = $splitLine[1] ?? '';
if ($key === '#~') {
$translation->disable();
$splitLine = preg_split('/\s+/', $data, 2);
$key = $splitLine[0];
$data = $splitLine[1] ?? '';
}
if ($data === '') {
$line = $nextLine;
continue;
}
switch ($key) {
case '#':
$translation->getComments()->add($data);
break;
case '#.':
$translation->getExtractedComments()->add($data);
break;
case '#,':
foreach (array_map('trim', explode(',', trim($data))) as $value) {
$translation->getFlags()->add($value);
}
break;
case '#:':
foreach (preg_split('/\s+/', trim($data)) as $value) {
if (preg_match('/^(.+)(:(\d*))?$/U', $value, $matches)) {
$line = isset($matches[3]) ? intval($matches[3]) : null;
$translation->getReferences()->add($matches[1], $line);
}
}
break;
case 'msgctxt':
$translation = $translation->withContext(self::decode($data));
break;
case 'msgid':
$translation = $translation->withOriginal(self::decode($data));
break;
case 'msgid_plural':
$translation->setPlural(self::decode($data));
break;
case 'msgstr':
case 'msgstr[0]':
$translation->translate(self::decode($data));
break;
case 'msgstr[1]':
$translation->translatePlural(self::decode($data));
break;
default:
if (strpos($key, 'msgstr[') === 0) {
$p = $translation->getPluralTranslations();
$p[] = self::decode($data);
$translation->translatePlural(...$p);
break;
}
break;
}
$line = $nextLine;
}
if (!self::isEmpty($translation)) {
$translations->add($translation);
}
//Headers
$translation = $translations->find(null, '');
if (!$translation) {
return $translations;
}
$translations->remove($translation);
$description = $translation->getComments()->toArray();
if (!empty($description)) {
$translations->setDescription(implode("\n", $description));
}
$flags = $translation->getFlags()->toArray();
if (!empty($flags)) {
$translations->getFlags()->add(...$flags);
}
$headers = $translations->getHeaders();
foreach (self::parseHeaders($translation->getTranslation()) as $name => $value) {
$headers->set($name, $value);
}
return $translations;
}
private static function parseHeaders(?string $string): array
{
if (empty($string)) {
return [];
}
$headers = [];
$lines = explode("\n", $string);
$name = null;
foreach ($lines as $line) {
$line = self::decode($line);
if ($line === '') {
continue;
}
// Checks if it is a header definition line.
// Useful for distinguishing between header definitions and possible continuations of a header entry.
if (preg_match('/^[\w-]+:/', $line)) {
$pieces = array_map('trim', explode(':', $line, 2));
list($name, $value) = $pieces;
$headers[$name] = $value;
continue;
}
$value = $headers[$name] ?? '';
$headers[$name] = $value.$line;
}
return $headers;
}
/**
* Convert a string from its PO representation.
*/
public static function decode(string $value): string
{
if (!$value) {
return '';
}
if ($value[0] === '"') {
$value = substr($value, 1, -1);
}
return strtr(
$value,
[
'\\\\' => '\\',
'\\a' => "\x07",
'\\b' => "\x08",
'\\t' => "\t",
'\\n' => "\n",
'\\v' => "\x0b",
'\\f' => "\x0c",
'\\r' => "\r",
'\\"' => '"',
]
);
}
private static function isEmpty(Translation $translation): bool
{
if (!empty($translation->getOriginal())) {
return false;
}
if (!empty($translation->getTranslation())) {
return false;
}
return true;
}
}

View File

@ -1,221 +1,40 @@
<?php
declare(strict_types = 1);
namespace Gettext;
/**
* Static class with merge contants.
* Merge contants.
*/
final class Merge
{
const ADD = 1;
const REMOVE = 2;
public const TRANSLATIONS_OURS = 1 << 0;
public const TRANSLATIONS_THEIRS = 1 << 1;
public const TRANSLATIONS_OVERRIDE = 1 << 2;
const HEADERS_ADD = 4;
const HEADERS_REMOVE = 8;
const HEADERS_OVERRIDE = 16;
public const HEADERS_OURS = 1 << 3;
public const HEADERS_THEIRS = 1 << 4;
public const HEADERS_OVERRIDE = 1 << 5;
const LANGUAGE_OVERRIDE = 32;
const DOMAIN_OVERRIDE = 64;
const TRANSLATION_OVERRIDE = 128;
public const COMMENTS_OURS = 1 << 6;
public const COMMENTS_THEIRS = 1 << 7;
const COMMENTS_OURS = 256;
const COMMENTS_THEIRS = 512;
public const EXTRACTED_COMMENTS_OURS = 1 << 8;
public const EXTRACTED_COMMENTS_THEIRS = 1 << 9;
const EXTRACTED_COMMENTS_OURS = 1024;
const EXTRACTED_COMMENTS_THEIRS = 2048;
public const FLAGS_OURS = 1 << 10;
public const FLAGS_THEIRS = 1 << 11;
const FLAGS_OURS = 4096;
const FLAGS_THEIRS = 8192;
public const REFERENCES_OURS = 1 << 12;
public const REFERENCES_THEIRS = 1 << 13;
const REFERENCES_OURS = 16384;
const REFERENCES_THEIRS = 32768;
const DEFAULTS = 5; //1 + 4
/**
* Merge the flags of two translations.
*
* @param Translation $from
* @param Translation $to
* @param int $options
*/
public static function mergeFlags(Translation $from, Translation $to, $options = self::DEFAULTS)
{
if ($options & self::FLAGS_THEIRS) {
$to->deleteFlags();
}
if (!($options & self::FLAGS_OURS)) {
foreach ($from->getFlags() as $flag) {
$to->addFlag($flag);
}
}
}
/**
* Merge the extracted comments of two translations.
*
* @param Translation $from
* @param Translation $to
* @param int $options
*/
public static function mergeExtractedComments(Translation $from, Translation $to, $options = self::DEFAULTS)
{
if ($options & self::EXTRACTED_COMMENTS_THEIRS) {
$to->deleteExtractedComments();
}
if (!($options & self::EXTRACTED_COMMENTS_OURS)) {
foreach ($from->getExtractedComments() as $comment) {
$to->addExtractedComment($comment);
}
}
}
/**
* Merge the comments of two translations.
*
* @param Translation $from
* @param Translation $to
* @param int $options
*/
public static function mergeComments(Translation $from, Translation $to, $options = self::DEFAULTS)
{
if ($options & self::COMMENTS_THEIRS) {
$to->deleteComments();
}
if (!($options & self::COMMENTS_OURS)) {
foreach ($from->getComments() as $comment) {
$to->addComment($comment);
}
}
}
/**
* Merge the references of two translations.
*
* @param Translation $from
* @param Translation $to
* @param int $options
*/
public static function mergeReferences(Translation $from, Translation $to, $options = self::DEFAULTS)
{
if ($options & self::REFERENCES_THEIRS) {
$to->deleteReferences();
}
if (!($options & self::REFERENCES_OURS)) {
foreach ($from->getReferences() as $reference) {
$to->addReference($reference[0], $reference[1]);
}
}
}
/**
* Merge the translations of two translations.
*
* @param Translation $from
* @param Translation $to
* @param int $options
*/
public static function mergeTranslation(Translation $from, Translation $to, $options = self::DEFAULTS)
{
$override = (boolean) ($options & self::TRANSLATION_OVERRIDE);
if (!$to->hasTranslation() || ($from->hasTranslation() && $override)) {
$to->setTranslation($from->getTranslation());
}
if (!$to->hasPlural() || ($from->hasPlural() && $override)) {
$to->setPlural($from->getPlural());
}
if (!$to->hasPluralTranslations() || ($from->hasPluralTranslations() && $override)) {
$to->setPluralTranslations($from->getPluralTranslations());
}
}
/**
* Merge the translations of two translations.
*
* @param Translations $from
* @param Translations $to
* @param int $options
*/
public static function mergeTranslations(Translations $from, Translations $to, $options = self::DEFAULTS)
{
if ($options & self::REMOVE) {
$filtered = [];
foreach ($to as $entry) {
if ($from->find($entry)) {
$filtered[$entry->getId()] = $entry;
}
}
$to->exchangeArray($filtered);
}
foreach ($from as $entry) {
if (($existing = $to->find($entry))) {
$existing->mergeWith($entry, $options);
} elseif ($options & self::ADD) {
$to[] = $entry->getClone();
}
}
}
/**
* Merge the headers of two translations.
*
* @param Translations $from
* @param Translations $to
* @param int $options
*/
public static function mergeHeaders(Translations $from, Translations $to, $options = self::DEFAULTS)
{
if ($options & self::HEADERS_REMOVE) {
foreach (array_keys($to->getHeaders()) as $name) {
if ($from->getHeader($name) === null) {
$to->deleteHeader($name);
}
}
}
foreach ($from->getHeaders() as $name => $value) {
$current = $to->getHeader($name);
if (empty($current)) {
if ($options & self::HEADERS_ADD) {
$to->setHeader($name, $value);
}
continue;
}
if (empty($value)) {
continue;
}
switch ($name) {
case Translations::HEADER_LANGUAGE:
case Translations::HEADER_PLURAL:
if ($options & self::LANGUAGE_OVERRIDE) {
$to->setHeader($name, $value);
}
break;
case Translations::HEADER_DOMAIN:
if ($options & self::DOMAIN_OVERRIDE) {
$to->setHeader($name, $value);
}
break;
default:
if ($options & self::HEADERS_OVERRIDE) {
$to->setHeader($name, $value);
}
}
}
}
//Merge strategies
public const SCAN_AND_LOAD =
Merge::HEADERS_OVERRIDE
| Merge::TRANSLATIONS_OURS
| Merge::TRANSLATIONS_OVERRIDE
| Merge::EXTRACTED_COMMENTS_OURS
| Merge::REFERENCES_OURS
| Merge::FLAGS_THEIRS
| Merge::COMMENTS_THEIRS;
}

View File

@ -0,0 +1,89 @@
<?php
declare(strict_types = 1);
namespace Gettext;
use ArrayIterator;
use Countable;
use IteratorAggregate;
use JsonSerializable;
use ReturnTypeWillChange;
/**
* Class to manage the references of a translation.
*/
class References implements JsonSerializable, Countable, IteratorAggregate
{
protected $references = [];
public static function __set_state(array $state): References
{
$references = new static();
$references->references = $state['references'];
return $references;
}
public function __debugInfo()
{
return $this->toArray();
}
public function add(string $filename, int $line = null): self
{
$fileReferences = $this->references[$filename] ?? [];
if (isset($line) && !in_array($line, $fileReferences)) {
$fileReferences[] = $line;
}
$this->references[$filename] = $fileReferences;
return $this;
}
#[ReturnTypeWillChange]
public function jsonSerialize()
{
return $this->toArray();
}
#[ReturnTypeWillChange]
public function getIterator()
{
return new ArrayIterator($this->references);
}
public function count(): int
{
return array_reduce($this->references, function ($carry, $item) {
return $carry + (count($item) ?: 1);
}, 0);
}
public function toArray(): array
{
return $this->references;
}
public function mergeWith(References $references): References
{
$merged = clone $this;
foreach ($references as $filename => $lines) {
//Set filename always to string
$filename = (string) $filename;
if (empty($lines)) {
$merged->add($filename);
continue;
}
foreach ($lines as $line) {
$merged->add($filename, $line);
}
}
return $merged;
}
}

View File

@ -0,0 +1,171 @@
<?php
declare(strict_types = 1);
namespace Gettext\Scanner;
use Exception;
use Gettext\Translation;
use Gettext\Translations;
/**
* Base class with common functions to scan files with code and get gettext translations.
*/
abstract class CodeScanner extends Scanner
{
protected $ignoreInvalidFunctions = false;
protected $addReferences = true;
protected $commentsPrefixes = [];
protected $functions = [];
/**
* @param array $functions [fnName => handler]
*/
public function setFunctions(array $functions): self
{
$this->functions = $functions;
return $this;
}
/**
* @return array [fnName => handler]
*/
public function getFunctions(): array
{
return $this->functions;
}
public function ignoreInvalidFunctions($ignore = true): self
{
$this->ignoreInvalidFunctions = $ignore;
return $this;
}
public function addReferences($enabled = true): self
{
$this->addReferences = $enabled;
return $this;
}
public function extractCommentsStartingWith(string ...$prefixes): self
{
$this->commentsPrefixes = $prefixes;
return $this;
}
public function scanString(string $string, string $filename): void
{
$functionsScanner = $this->getFunctionsScanner();
$functions = $functionsScanner->scan($string, $filename);
foreach ($functions as $function) {
$this->handleFunction($function);
}
}
abstract public function getFunctionsScanner(): FunctionsScannerInterface;
protected function handleFunction(ParsedFunction $function)
{
$handler = $this->getFunctionHandler($function);
if (is_null($handler)) {
return;
}
$translation = call_user_func($handler, $function);
if ($translation && $this->addReferences) {
$translation->getReferences()->add($function->getFilename(), $function->getLine());
}
}
protected function getFunctionHandler(ParsedFunction $function): ?callable
{
$name = $function->getName();
$handler = $this->functions[$name] ?? null;
return is_null($handler) ? null : [$this, $handler];
}
protected function addComments(ParsedFunction $function, ?Translation $translation): ?Translation
{
if (empty($this->commentsPrefixes) || empty($translation)) {
return $translation;
}
foreach ($function->getComments() as $comment) {
if ($this->checkComment($comment)) {
$translation->getExtractedComments()->add($comment);
}
}
return $translation;
}
protected function addFlags(ParsedFunction $function, ?Translation $translation): ?Translation
{
if (empty($translation)) {
return $translation;
}
foreach ($function->getFlags() as $flag) {
$translation->getFlags()->add($flag);
}
return $translation;
}
protected function checkFunction(ParsedFunction $function, int $minLength): bool
{
if ($function->countArguments() < $minLength) {
if ($this->ignoreInvalidFunctions) {
return false;
}
throw new Exception(
sprintf(
'Invalid gettext function in %s:%d. At least %d arguments are required',
$function->getFilename(),
$function->getLine(),
$minLength
)
);
}
$arguments = array_slice($function->getArguments(), 0, $minLength);
if (in_array(null, $arguments, true)) {
if ($this->ignoreInvalidFunctions) {
return false;
}
throw new Exception(
sprintf(
'Invalid gettext function in %s:%d. Some required arguments are not valid',
$function->getFilename(),
$function->getLine()
)
);
}
return true;
}
protected function checkComment(string $comment): bool
{
foreach ($this->commentsPrefixes as $prefix) {
if ($prefix === '' || strpos($comment, $prefix) === 0) {
return true;
}
}
return false;
}
}

View File

@ -0,0 +1,145 @@
<?php
declare(strict_types = 1);
namespace Gettext\Scanner;
use Gettext\Translation;
/**
* Trait with common gettext function handlers
*/
trait FunctionsHandlersTrait
{
protected function gettext(ParsedFunction $function): ?Translation
{
if (!$this->checkFunction($function, 1)) {
return null;
}
list($original) = $function->getArguments();
$translation = $this->addComments(
$function,
$this->saveTranslation(null, null, $original)
);
return $this->addFlags($function, $translation);
}
protected function ngettext(ParsedFunction $function): ?Translation
{
if (!$this->checkFunction($function, 2)) {
return null;
}
list($original, $plural) = $function->getArguments();
$translation = $this->addComments(
$function,
$this->saveTranslation(null, null, $original, $plural)
);
return $this->addFlags($function, $translation);
}
protected function pgettext(ParsedFunction $function): ?Translation
{
if (!$this->checkFunction($function, 2)) {
return null;
}
list($context, $original) = $function->getArguments();
$translation = $this->addComments(
$function,
$this->saveTranslation(null, $context, $original)
);
return $this->addFlags($function, $translation);
}
protected function dgettext(ParsedFunction $function): ?Translation
{
if (!$this->checkFunction($function, 2)) {
return null;
}
list($domain, $original) = $function->getArguments();
$translation = $this->addComments(
$function,
$this->saveTranslation($domain, null, $original)
);
return $this->addFlags($function, $translation);
}
protected function dpgettext(ParsedFunction $function): ?Translation
{
if (!$this->checkFunction($function, 3)) {
return null;
}
list($domain, $context, $original) = $function->getArguments();
$translation = $this->addComments(
$function,
$this->saveTranslation($domain, $context, $original)
);
return $this->addFlags($function, $translation);
}
protected function npgettext(ParsedFunction $function): ?Translation
{
if (!$this->checkFunction($function, 3)) {
return null;
}
list($context, $original, $plural) = $function->getArguments();
$translation = $this->addComments(
$function,
$this->saveTranslation(null, $context, $original, $plural)
);
return $this->addFlags($function, $translation);
}
protected function dngettext(ParsedFunction $function): ?Translation
{
if (!$this->checkFunction($function, 3)) {
return null;
}
list($domain, $original, $plural) = $function->getArguments();
$translation = $this->addComments(
$function,
$this->saveTranslation($domain, null, $original, $plural)
);
return $this->addFlags($function, $translation);
}
protected function dnpgettext(ParsedFunction $function): ?Translation
{
if (!$this->checkFunction($function, 4)) {
return null;
}
list($domain, $context, $original, $plural) = $function->getArguments();
$translation = $this->addComments(
$function,
$this->saveTranslation($domain, $context, $original, $plural)
);
return $this->addFlags($function, $translation);
}
abstract protected function addComments(ParsedFunction $function, ?Translation $translation): ?Translation;
abstract protected function addFlags(ParsedFunction $function, ?Translation $translation): ?Translation;
abstract protected function checkFunction(ParsedFunction $function, int $minLength): bool;
abstract protected function saveTranslation(
?string $domain,
?string $context,
string $original,
string $plural = null
): ?Translation;
}

View File

@ -0,0 +1,12 @@
<?php
declare(strict_types = 1);
namespace Gettext\Scanner;
interface FunctionsScannerInterface
{
/**
* @return ParsedFunction[]
*/
public function scan(string $code, string $filename): array;
}

View File

@ -0,0 +1,105 @@
<?php
declare(strict_types = 1);
namespace Gettext\Scanner;
/**
* Class to handle the info of a parsed function.
*/
final class ParsedFunction
{
private $name;
private $filename;
private $line;
private $lastLine;
private $arguments = [];
private $comments = [];
private $flags = [];
public function __construct(string $name, string $filename, int $line, int $lastLine = null)
{
$this->name = $name;
$this->filename = $filename;
$this->line = $line;
$this->lastLine = isset($lastLine) ? $lastLine : $line;
}
public function __debugInfo()
{
return $this->toArray();
}
public function toArray(): array
{
return [
'name' => $this->name,
'filename' => $this->filename,
'line' => $this->line,
'lastLine' => $this->lastLine,
'arguments' => $this->arguments,
'comments' => $this->comments,
'flags' => $this->flags,
];
}
public function getName(): string
{
return $this->name;
}
public function getLine(): int
{
return $this->line;
}
public function getLastLine(): int
{
return $this->lastLine;
}
public function getFilename(): string
{
return $this->filename;
}
public function getArguments(): array
{
return $this->arguments;
}
public function countArguments(): int
{
return count($this->arguments);
}
public function getComments(): array
{
return $this->comments;
}
public function getFlags(): array
{
return $this->flags;
}
public function addArgument($argument = null): self
{
$this->arguments[] = $argument;
return $this;
}
public function addComment(string $comment): self
{
$this->comments[] = $comment;
return $this;
}
public function addFlag(string $flag): self
{
$this->flags[] = $flag;
return $this;
}
}

View File

@ -0,0 +1,88 @@
<?php
declare(strict_types = 1);
namespace Gettext\Scanner;
use Exception;
use Gettext\Translation;
use Gettext\Translations;
/**
* Base class with common funtions for all scanners.
*/
abstract class Scanner implements ScannerInterface
{
protected $translations;
protected $defaultDomain;
public function __construct(Translations ...$allTranslations)
{
foreach ($allTranslations as $translations) {
$domain = $translations->getDomain();
$this->translations[$domain] = $translations;
}
}
public function setDefaultDomain(string $defaultDomain): void
{
$this->defaultDomain = $defaultDomain;
}
public function getDefaultDomain(): string
{
return $this->defaultDomain;
}
public function getTranslations(): array
{
return $this->translations;
}
public function scanFile(string $filename): void
{
$string = static::readFile($filename);
$this->scanString($string, $filename);
}
abstract public function scanString(string $string, string $filename): void;
protected function saveTranslation(
?string $domain,
?string $context,
string $original,
string $plural = null
): ?Translation {
if (is_null($domain)) {
$domain = $this->defaultDomain;
}
if (!isset($this->translations[$domain])) {
return null;
}
$translation = $this->translations[$domain]->addOrMerge(
Translation::create($context, $original)
);
if (isset($plural)) {
$translation->setPlural($plural);
}
return $translation;
}
/**
* Reads and returns the content of a file.
*/
protected static function readFile(string $file): string
{
$content = @file_get_contents($file);
if (false === $content) {
throw new Exception("Cannot read the file '$file', probably permissions");
}
return $content;
}
}

View File

@ -0,0 +1,22 @@
<?php
declare(strict_types = 1);
namespace Gettext\Scanner;
use Gettext\Translations;
interface ScannerInterface
{
public function setDefaultDomain(string $domain): void;
public function getDefaultDomain(): string;
/**
* @return Translations[]
*/
public function getTranslations(): array;
public function scanFile(string $filename): void;
public function scanString(string $string, string $filename): void;
}

View File

@ -1,537 +1,236 @@
<?php
declare(strict_types = 1);
namespace Gettext;
/**
* Class to manage a translation string.
* Class to manage an individual translation.
*/
class Translation
{
protected $id;
protected $context;
protected $original;
protected $translation = '';
protected $plural;
protected $pluralTranslation = [];
protected $references = [];
protected $comments = [];
protected $extractedComments = [];
protected $flags = [];
protected $translation;
protected $pluralTranslations = [];
protected $disabled = false;
protected $references;
protected $flags;
protected $comments;
protected $extractedComments;
/**
* Generates the id of a translation (context + glue + original).
*
* @param string $context
* @param string $original
*
* @return string
*/
public static function generateId($context, $original)
public static function create(?string $context, string $original): Translation
{
$id = static::generateId($context, $original);
$translation = new static($id);
$translation->context = $context;
$translation->original = $original;
return $translation;
}
protected static function generateId(?string $context, string $original): string
{
return "{$context}\004{$original}";
}
/**
* Create a new instance of a Translation object.
*
* This is a factory method that will work even when Translation is extended.
*
* @param string $context The context of the translation
* @param string $original The original string
* @param string $plural The original plural string
* @return static New Translation instance
*/
public static function create($context, $original, $plural = '')
{
return new static($context, $original, $plural);
}
/**
* Construct.
*
* @param string $context The context of the translation
* @param string $original The original string
* @param string $plural The original plural string
*/
public function __construct($context, $original, $plural = '')
{
$this->context = (string) $context;
$this->original = (string) $original;
$this->setPlural($plural);
}
/**
* Clones this translation.
*
* @param null|string $context Optional new context
* @param null|string $original Optional new original
*
* @return Translation
*/
public function getClone($context = null, $original = null)
{
$new = clone $this;
if ($context !== null) {
$new->context = (string) $context;
}
if ($original !== null) {
$new->original = (string) $original;
}
return $new;
}
/**
* Sets the id of this translation.
* @warning The use of this function to set a custom ID will prevent
* Translations::find from matching this translation.
*
* @param string $id
*/
public function setId($id)
protected function __construct(string $id)
{
$this->id = $id;
$this->references = new References();
$this->flags = new Flags();
$this->comments = new Comments();
$this->extractedComments = new Comments();
}
/**
* Returns the id of this translation.
*
* @return string
*/
public function getId()
public function __clone()
{
$this->references = clone $this->references;
$this->flags = clone $this->flags;
$this->comments = clone $this->comments;
$this->extractedComments = clone $this->extractedComments;
}
public function toArray(): array
{
return [
'id' => $this->id,
'context' => $this->context,
'original' => $this->original,
'translation' => $this->translation,
'plural' => $this->plural,
'pluralTranslations' => $this->pluralTranslations,
'disabled' => $this->disabled,
'references' => $this->getReferences()->toArray(),
'flags' => $this->getFlags()->toArray(),
'comments' => $this->getComments()->toArray(),
'extractedComments' => $this->getExtractedComments()->toArray(),
];
}
public function getId(): string
{
if ($this->id === null) {
return static::generateId($this->context, $this->original);
}
return $this->id;
}
/**
* Checks whether the translation matches with the arguments.
*
* @param string $context
* @param string $original
*
* @return bool
*/
public function is($context, $original = '')
{
return (($this->context === $context) && ($this->original === $original)) ? true : false;
}
/**
* Enable or disable the translation
*
* @param bool $disabled
*
* @return self
*/
public function setDisabled($disabled)
{
$this->disabled = (bool) $disabled;
return $this;
}
/**
* Returns whether the translation is disabled
*
* @return bool
*/
public function isDisabled()
{
return $this->disabled;
}
/**
* Gets the original string.
*
* @return string
*/
public function getOriginal()
{
return $this->original;
}
/**
* Checks if the original string is empty or not.
*
* @return bool
*/
public function hasOriginal()
{
return ($this->original !== '') ? true : false;
}
/**
* Sets the translation string.
*
* @param string $translation
*
* @return self
*/
public function setTranslation($translation)
{
$this->translation = (string) $translation;
return $this;
}
/**
* Gets the translation string.
*
* @return string
*/
public function getTranslation()
{
return $this->translation;
}
/**
* Checks if the translation string is empty or not.
*
* @return bool
*/
public function hasTranslation()
{
return ($this->translation !== '') ? true : false;
}
/**
* Sets the plural translation string.
*
* @param string $plural
*
* @return self
*/
public function setPlural($plural)
{
$this->plural = (string) $plural;
return $this;
}
/**
* Gets the plural translation string.
*
* @return string
*/
public function getPlural()
{
return $this->plural;
}
/**
* Checks if the plural translation string is empty or not.
*
* @return bool
*/
public function hasPlural()
{
return ($this->plural !== '') ? true : false;
}
/**
* Set a new plural translation.
*
* @param array $plural
*
* @return self
*/
public function setPluralTranslations(array $plural)
{
$this->pluralTranslation = $plural;
return $this;
}
/**
* Gets all plural translations.
*
* @param int $size
*
* @return array
*/
public function getPluralTranslations($size = null)
{
if ($size === null) {
return $this->pluralTranslation;
}
$current = count($this->pluralTranslation);
if ($size > $current) {
return $this->pluralTranslation + array_fill(0, $size, '');
}
if ($size < $current) {
return array_slice($this->pluralTranslation, 0, $size);
}
return $this->pluralTranslation;
}
/**
* Checks if there are any plural translation.
*
* @param bool $checkContent
*
* @return bool
*/
public function hasPluralTranslations($checkContent = false)
{
if ($checkContent) {
return implode('', $this->pluralTranslation) !== '';
}
return !empty($this->pluralTranslation);
}
/**
* Removes all plural translations.
*
* @return self
*/
public function deletePluralTranslation()
{
$this->pluralTranslation = [];
return $this;
}
/**
* Gets the context of this translation.
*
* @return string
*/
public function getContext()
public function getContext(): ?string
{
return $this->context;
}
/**
* Checks if the context is empty or not.
*
* @return bool
*/
public function hasContext()
public function withContext(?string $context): Translation
{
return (isset($this->context) && ($this->context !== '')) ? true : false;
$clone = clone $this;
$clone->context = $context;
$clone->id = static::generateId($clone->getContext(), $clone->getOriginal());
return $clone;
}
/**
* Adds a new reference for this translation.
*
* @param string $filename The file path where the translation has been found
* @param null|int $line The line number where the translation has been found
*
* @return self
*/
public function addReference($filename, $line = null)
public function getOriginal(): string
{
$key = "{$filename}:{$line}";
$this->references[$key] = [$filename, $line];
return $this->original;
}
public function withOriginal(string $original): Translation
{
$clone = clone $this;
$clone->original = $original;
$clone->id = static::generateId($clone->getContext(), $clone->getOriginal());
return $clone;
}
public function setPlural(string $plural): self
{
$this->plural = $plural;
return $this;
}
/**
* Checks if the translation has any reference.
*
* @return bool
*/
public function hasReferences()
public function getPlural(): ?string
{
return !empty($this->references);
return $this->plural;
}
/**
* Return all references for this translation.
*
* @return array
*/
public function getReferences()
public function disable(bool $disabled = true): self
{
return array_values($this->references);
}
/**
* Removes all references.
*
* @return self
*/
public function deleteReferences()
{
$this->references = [];
$this->disabled = $disabled;
return $this;
}
/**
* Adds a new comment for this translation.
*
* @param string $comment
*
* @return self
*/
public function addComment($comment)
public function isDisabled(): bool
{
if (!in_array($comment, $this->comments, true)) {
$this->comments[] = $comment;
return $this->disabled;
}
public function translate(string $translation): self
{
$this->translation = $translation;
return $this;
}
public function getTranslation(): ?string
{
return $this->translation;
}
public function isTranslated(): bool
{
return isset($this->translation) && $this->translation !== '';
}
public function translatePlural(string ...$translations): self
{
$this->pluralTranslations = $translations;
return $this;
}
public function getPluralTranslations(int $size = null): array
{
if ($size === null) {
return $this->pluralTranslations;
}
return $this;
}
$length = count($this->pluralTranslations);
/**
* Checks if the translation has any comment.
*
* @return bool
*/
public function hasComments()
{
return isset($this->comments[0]);
}
/**
* Returns all comments for this translation.
*
* @return array
*/
public function getComments()
{
return $this->comments;
}
/**
* Removes all comments.
*
* @return self
*/
public function deleteComments()
{
$this->comments = [];
return $this;
}
/**
* Adds a new extracted comment for this translation.
*
* @param string $comment
*
* @return self
*/
public function addExtractedComment($comment)
{
if (!in_array($comment, $this->extractedComments, true)) {
$this->extractedComments[] = $comment;
if ($size > $length) {
return $this->pluralTranslations + array_fill(0, $size, '');
}
return $this;
return array_slice($this->pluralTranslations, 0, $size);
}
/**
* Checks if the translation has any extracted comment.
*
* @return bool
*/
public function hasExtractedComments()
public function getReferences(): References
{
return isset($this->extractedComments[0]);
return $this->references;
}
/**
* Returns all extracted comments for this translation.
*
* @return array
*/
public function getExtractedComments()
{
return $this->extractedComments;
}
/**
* Removes all extracted comments.
*
* @return self
*/
public function deleteExtractedComments()
{
$this->extractedComments = [];
return $this;
}
/**
* Adds a new flag for this translation.
*
* @param string $flag
*
* @return self
*/
public function addFlag($flag)
{
if (!in_array($flag, $this->flags, true)) {
$this->flags[] = $flag;
}
return $this;
}
/**
* Checks if the translation has any flag.
*
* @return bool
*/
public function hasFlags()
{
return isset($this->flags[0]);
}
/**
* Returns all extracted flags for this translation.
*
* @return array
*/
public function getFlags()
public function getFlags(): Flags
{
return $this->flags;
}
/**
* Removes all flags.
*
* @return self
*/
public function deleteFlags()
public function getComments(): Comments
{
$this->flags = [];
return $this;
return $this->comments;
}
/**
* Merges this translation with other translation.
*
* @param Translation $translation The translation to merge with
* @param int $options
*
* @return self
*/
public function mergeWith(Translation $translation, $options = Merge::DEFAULTS)
public function getExtractedComments(): Comments
{
Merge::mergeTranslation($translation, $this, $options);
Merge::mergeReferences($translation, $this, $options);
Merge::mergeComments($translation, $this, $options);
Merge::mergeExtractedComments($translation, $this, $options);
Merge::mergeFlags($translation, $this, $options);
return $this->extractedComments;
}
return $this;
public function mergeWith(Translation $translation, int $strategy = 0): Translation
{
$merged = clone $this;
if ($strategy & Merge::COMMENTS_THEIRS) {
$merged->comments = clone $translation->comments;
} elseif (!($strategy & Merge::COMMENTS_OURS)) {
$merged->comments = $merged->comments->mergeWith($translation->comments);
}
if ($strategy & Merge::EXTRACTED_COMMENTS_THEIRS) {
$merged->extractedComments = clone $translation->extractedComments;
} elseif (!($strategy & Merge::EXTRACTED_COMMENTS_OURS)) {
$merged->extractedComments = $merged->extractedComments->mergeWith($translation->extractedComments);
}
if ($strategy & Merge::REFERENCES_THEIRS) {
$merged->references = clone $translation->references;
} elseif (!($strategy & Merge::REFERENCES_OURS)) {
$merged->references = $merged->references->mergeWith($translation->references);
}
if ($strategy & Merge::FLAGS_THEIRS) {
$merged->flags = clone $translation->flags;
} elseif (!($strategy & Merge::FLAGS_OURS)) {
$merged->flags = $merged->flags->mergeWith($translation->flags);
}
$override = (bool) ($strategy & Merge::TRANSLATIONS_OVERRIDE);
if (!$merged->translation || ($translation->translation && $override)) {
$merged->translation = $translation->translation;
}
if (!$merged->plural || ($translation->plural && $override)) {
$merged->plural = $translation->plural;
}
if (empty($merged->pluralTranslations) || (!empty($translation->pluralTranslations) && $override)) {
$merged->pluralTranslations = $translation->pluralTranslations;
}
$merged->disable($translation->isDisabled());
return $merged;
}
}

View File

@ -1,498 +1,216 @@
<?php
declare(strict_types = 1);
namespace Gettext;
use ArrayIterator;
use Countable;
use Gettext\Languages\Language;
use BadMethodCallException;
use InvalidArgumentException;
use ArrayObject;
use IteratorAggregate;
use ReturnTypeWillChange;
/**
* Class to manage a collection of translations.
*
* @method static $this fromBladeFile(string $filename, array $options = [])
* @method static $this fromBladeString(string $string, array $options = [])
* @method $this addFromBladeFile(string $filename, array $options = [])
* @method $this addFromBladeString(string $string, array $options = [])
* @method static $this fromCsvFile(string $filename, array $options = [])
* @method static $this fromCsvString(string $string, array $options = [])
* @method $this addFromCsvFile(string $filename, array $options = [])
* @method $this addFromCsvString(string $string, array $options = [])
* @method bool toCsvFile(string $filename, array $options = [])
* @method string toCsvString(array $options = [])
* @method static $this fromCsvDictionaryFile(string $filename, array $options = [])
* @method static $this fromCsvDictionaryString(string $string, array $options = [])
* @method $this addFromCsvDictionaryFile(string $filename, array $options = [])
* @method $this addFromCsvDictionaryString(string $string, array $options = [])
* @method bool toCsvDictionaryFile(string $filename, array $options = [])
* @method string toCsvDictionaryString(array $options = [])
* @method static $this fromJedFile(string $filename, array $options = [])
* @method static $this fromJedString(string $string, array $options = [])
* @method $this addFromJedFile(string $filename, array $options = [])
* @method $this addFromJedString(string $string, array $options = [])
* @method bool toJedFile(string $filename, array $options = [])
* @method string toJedString(array $options = [])
* @method static $this fromJsCodeFile(string $filename, array $options = [])
* @method static $this fromJsCodeString(string $string, array $options = [])
* @method $this addFromJsCodeFile(string $filename, array $options = [])
* @method $this addFromJsCodeString(string $string, array $options = [])
* @method static $this fromJsonFile(string $filename, array $options = [])
* @method static $this fromJsonString(string $string, array $options = [])
* @method $this addFromJsonFile(string $filename, array $options = [])
* @method $this addFromJsonString(string $string, array $options = [])
* @method bool toJsonFile(string $filename, array $options = [])
* @method string toJsonString(array $options = [])
* @method static $this fromJsonDictionaryFile(string $filename, array $options = [])
* @method static $this fromJsonDictionaryString(string $string, array $options = [])
* @method $this addFromJsonDictionaryFile(string $filename, array $options = [])
* @method $this addFromJsonDictionaryString(string $string, array $options = [])
* @method bool toJsonDictionaryFile(string $filename, array $options = [])
* @method string toJsonDictionaryString(array $options = [])
* @method static $this fromMoFile(string $filename, array $options = [])
* @method static $this fromMoString(string $string, array $options = [])
* @method $this addFromMoFile(string $filename, array $options = [])
* @method $this addFromMoString(string $string, array $options = [])
* @method bool toMoFile(string $filename, array $options = [])
* @method string toMoString(array $options = [])
* @method static $this fromPhpArrayFile(string $filename, array $options = [])
* @method static $this fromPhpArrayString(string $string, array $options = [])
* @method $this addFromPhpArrayFile(string $filename, array $options = [])
* @method $this addFromPhpArrayString(string $string, array $options = [])
* @method bool toPhpArrayFile(string $filename, array $options = [])
* @method string toPhpArrayString(array $options = [])
* @method static $this fromPhpCodeFile(string $filename, array $options = [])
* @method static $this fromPhpCodeString(string $string, array $options = [])
* @method $this addFromPhpCodeFile(string $filename, array $options = [])
* @method $this addFromPhpCodeString(string $string, array $options = [])
* @method static $this fromPoFile(string $filename, array $options = [])
* @method static $this fromPoString(string $string, array $options = [])
* @method $this addFromPoFile(string $filename, array $options = [])
* @method $this addFromPoString(string $string, array $options = [])
* @method bool toPoFile(string $filename, array $options = [])
* @method string toPoString(array $options = [])
* @method static $this fromTwigFile(string $filename, array $options = [])
* @method static $this fromTwigString(string $string, array $options = [])
* @method $this addFromTwigFile(string $filename, array $options = [])
* @method $this addFromTwigString(string $string, array $options = [])
* @method static $this fromVueJsFile(string $filename, array $options = [])
* @method static $this fromVueJsString(string $filename, array $options = [])
* @method $this addFromVueJsFile(string $filename, array $options = [])
* @method $this addFromVueJsString(string $filename, array $options = [])
* @method static $this fromXliffFile(string $filename, array $options = [])
* @method static $this fromXliffString(string $string, array $options = [])
* @method $this addFromXliffFile(string $filename, array $options = [])
* @method $this addFromXliffString(string $string, array $options = [])
* @method bool toXliffFile(string $filename, array $options = [])
* @method string toXliffString(array $options = [])
* @method static $this fromYamlFile(string $filename, array $options = [])
* @method static $this fromYamlString(string $string, array $options = [])
* @method $this addFromYamlFile(string $filename, array $options = [])
* @method $this addFromYamlString(string $string, array $options = [])
* @method bool toYamlFile(string $filename, array $options = [])
* @method string toYamlString(array $options = [])
* @method static $this fromYamlDictionaryFile(string $filename, array $options = [])
* @method static $this fromYamlDictionaryString(string $string, array $options = [])
* @method $this addFromYamlDictionaryFile(string $filename, array $options = [])
* @method $this addFromYamlDictionaryString(string $string, array $options = [])
* @method bool toYamlDictionaryFile(string $filename, array $options = [])
* @method string toYamlDictionaryString(array $options = [])
* Class to manage a collection of translations under the same domain.
*/
class Translations extends ArrayObject
class Translations implements Countable, IteratorAggregate
{
const HEADER_LANGUAGE = 'Language';
const HEADER_PLURAL = 'Plural-Forms';
const HEADER_DOMAIN = 'X-Domain';
public static $options = [
'defaultHeaders' => [
'Project-Id-Version' => '',
'Report-Msgid-Bugs-To' => '',
'Last-Translator' => '',
'Language-Team' => '',
'MIME-Version' => '1.0',
'Content-Type' => 'text/plain; charset=UTF-8',
'Content-Transfer-Encoding' => '8bit',
],
'headersSorting' => false,
'defaultDateHeaders' => [
'POT-Creation-Date',
'PO-Revision-Date',
],
];
protected $description;
protected $translations = [];
protected $headers;
protected $flags;
protected $translationClass;
/**
* @see ArrayObject::__construct()
*/
public function __construct(
$input = [],
$flags = 0,
$iterator_class = 'ArrayIterator',
$translationClass = 'Gettext\Translation'
) {
$this->headers = static::$options['defaultHeaders'];
foreach (static::$options['defaultDateHeaders'] as $header) {
$this->headers[$header] = date('c');
}
$this->headers[self::HEADER_LANGUAGE] = '';
$this->translationClass = $translationClass;
parent::__construct($input, $flags, $iterator_class);
}
/**
* Magic method to create new instances using extractors
* For example: Translations::fromMoFile($filename, $options);.
*
* @return Translations
*/
public static function __callStatic($name, $arguments)
public static function create(string $domain = null, string $language = null): Translations
{
if (!preg_match('/^from(\w+)(File|String)$/i', $name, $matches)) {
throw new BadMethodCallException("The method $name does not exists");
$translations = new static();
if (isset($domain)) {
$translations->setDomain($domain);
}
return call_user_func_array([new static(), 'add'.ucfirst($name)], $arguments);
if (isset($language)) {
$translations->setLanguage($language);
}
return $translations;
}
/**
* Magic method to import/export the translations to a specific format
* For example: $translations->toMoFile($filename, $options);
* For example: $translations->addFromMoFile($filename, $options);.
*
* @return self|bool
*/
public function __call($name, $arguments)
protected function __construct()
{
if (!preg_match('/^(addFrom|to)(\w+)(File|String)$/i', $name, $matches)) {
throw new BadMethodCallException("The method $name does not exists");
}
if ($matches[1] === 'addFrom') {
$extractor = 'Gettext\\Extractors\\'.$matches[2].'::from'.$matches[3];
$source = array_shift($arguments);
$options = array_shift($arguments) ?: [];
call_user_func($extractor, $source, $this, $options);
return $this;
}
$generator = 'Gettext\\Generators\\'.$matches[2].'::to'.$matches[3];
array_unshift($arguments, $this);
return call_user_func_array($generator, $arguments);
$this->headers = new Headers();
$this->flags = new Flags();
}
/**
* Magic method to clone each translation on clone the translations object.
*/
public function __clone()
{
$array = [];
foreach ($this as $key => $translation) {
$array[$key] = clone $translation;
foreach ($this->translations as $id => $translation) {
$this->translations[$id] = clone $translation;
}
$this->exchangeArray($array);
$this->headers = clone $this->headers;
}
/**
* Control the new translations added.
*
* @param mixed $index
* @param Translation $value
*
* @throws InvalidArgumentException If the value is not an instance of Gettext\Translation
*
* @return Translation
*/
public function offsetSet($index, $value)
public function setDescription(?string $description): self
{
if (!($value instanceof Translation)) {
throw new InvalidArgumentException(
'Only instances of Gettext\\Translation must be added to a Gettext\\Translations'
);
}
$id = $value->getId();
if ($this->offsetExists($id)) {
$this[$id]->mergeWith($value);
return $this[$id];
}
parent::offsetSet($id, $value);
return $value;
}
/**
* Set the plural definition.
*
* @param int $count
* @param string $rule
*
* @return self
*/
public function setPluralForms($count, $rule)
{
if (preg_match('/[a-z]/i', str_replace('n', '', $rule))) {
throw new \InvalidArgumentException('Invalid Plural form: ' . $rule);
}
$this->setHeader(self::HEADER_PLURAL, "nplurals={$count}; plural={$rule};");
$this->description = $description;
return $this;
}
/**
* Returns the parsed plural definition.
*
* @param null|array [count, rule]
*/
public function getPluralForms()
public function getDescription(): ?string
{
$header = $this->getHeader(self::HEADER_PLURAL);
if (!empty($header)
&& preg_match('/^nplurals\s*=\s*(\d+)\s*;\s*plural\s*=\s*([^;]+)\s*;$/', $header, $matches)
) {
return [intval($matches[1]), $matches[2]];
}
return $this->description;
}
/**
* Set a new header.
*
* @param string $name
* @param string $value
*
* @return self
*/
public function setHeader($name, $value)
public function getFlags(): Flags
{
$name = trim($name);
$this->headers[$name] = trim($value);
return $this;
return $this->flags;
}
/**
* Returns a header value.
*
* @param string $name
*
* @return null|string
*/
public function getHeader($name)
public function toArray(): array
{
return isset($this->headers[$name]) ? $this->headers[$name] : null;
return [
'description' => $this->description,
'headers' => $this->headers->toArray(),
'flags' => $this->flags->toArray(),
'translations' => array_map(
function ($translation) {
return $translation->toArray();
},
array_values($this->translations)
),
];
}
/**
* Returns all header for this translations (in alphabetic order).
*
* @return array
*/
public function getHeaders()
#[ReturnTypeWillChange]
public function getIterator()
{
if (static::$options['headersSorting']) {
ksort($this->headers);
}
return new ArrayIterator($this->translations);
}
public function getTranslations(): array
{
return $this->translations;
}
public function count(): int
{
return count($this->translations);
}
public function getHeaders(): Headers
{
return $this->headers;
}
/**
* Removes all headers.
*
* @return self
*/
public function deleteHeaders()
public function add(Translation $translation): self
{
$this->headers = [];
$id = $translation->getId();
$this->translations[$id] = $translation;
return $this;
}
/**
* Removes one header.
*
* @param string $name
*
* @return self
*/
public function deleteHeader($name)
public function addOrMerge(Translation $translation, int $mergeStrategy = 0): Translation
{
unset($this->headers[$name]);
$id = $translation->getId();
return $this;
}
/**
* Returns the language value.
*
* @return string $language
*/
public function getLanguage()
{
return $this->getHeader(self::HEADER_LANGUAGE);
}
/**
* Sets the language and the plural forms.
*
* @param string $language
*
* @throws InvalidArgumentException if the language hasn't been recognized
*
* @return self
*/
public function setLanguage($language)
{
$this->setHeader(self::HEADER_LANGUAGE, trim($language));
if (($info = Language::getById($language))) {
return $this->setPluralForms(count($info->categories), $info->formula);
if (isset($this->translations[$id])) {
return $this->translations[$id] = $this->translations[$id]->mergeWith($translation, $mergeStrategy);
}
throw new InvalidArgumentException(sprintf('The language "%s" is not valid', $language));
return $this->translations[$id] = $translation;
}
/**
* Checks whether the language is empty or not.
*
* @return bool
*/
public function hasLanguage()
public function remove(Translation $translation): self
{
$language = $this->getLanguage();
$key = array_search($translation, $this->translations);
return (is_string($language) && ($language !== '')) ? true : false;
}
/**
* Set a new domain for this translations.
*
* @param string $domain
*
* @return self
*/
public function setDomain($domain)
{
$this->setHeader(self::HEADER_DOMAIN, trim($domain));
if ($key !== false) {
unset($this->translations[$key]);
}
return $this;
}
/**
* Returns the domain.
*
* @return string
*/
public function getDomain()
public function setDomain(string $domain): self
{
return $this->getHeader(self::HEADER_DOMAIN);
$this->getHeaders()->setDomain($domain);
return $this;
}
/**
* Checks whether the domain is empty or not.
*
* @return bool
*/
public function hasDomain()
public function getDomain(): ?string
{
$domain = $this->getDomain();
return (is_string($domain) && ($domain !== '')) ? true : false;
return $this->getHeaders()->getDomain();
}
/**
* Search for a specific translation.
*
* @param string|Translation $context The context of the translation or a translation instance
* @param string $original The original string
* @warning Translations with custom identifiers (e.g. XLIFF unit IDs) cannot be found using this function.
*
* @return Translation|false
*/
public function find($context, $original = '')
public function setLanguage(string $language): self
{
if ($context instanceof Translation) {
$id = $context->getId();
} else {
$id = Translation::generateId($context, $original);
$info = Language::getById($language);
if (empty($info)) {
throw new InvalidArgumentException(sprintf('The language "%s" is not valid', $language));
}
return $this->offsetExists($id) ? $this[$id] : false;
$this->getHeaders()
->setLanguage($language)
->setPluralForm(count($info->categories), $info->formula);
return $this;
}
/**
* Count all elements translated
*
* @return integer
*/
public function countTranslated()
public function getLanguage(): ?string
{
$c = 0;
foreach ($this as $v) {
if ($v->hasTranslation()) {
$c++;
return $this->getHeaders()->getLanguage();
}
public function find(?string $context, string $original): ?Translation
{
foreach ($this->translations as $translation) {
if ($translation->getContext() === $context && $translation->getOriginal() === $original) {
return $translation;
}
}
return $c;
return null;
}
/**
* Creates and insert/merges a new translation.
*
* @param string $context The translation context
* @param string $original The translation original string
* @param string $plural The translation original plural string
*
* @return Translation The translation created
*/
public function insert($context, $original, $plural = '')
public function mergeWith(Translations $translations, int $strategy = 0): Translations
{
return $this->offsetSet(null, $this->createNewTranslation($context, $original, $plural));
}
$merged = clone $this;
/**
* Merges this translations with other translations.
*
* @param Translations $translations The translations instance to merge with
* @param int $options
*
* @return self
*/
public function mergeWith(Translations $translations, $options = Merge::DEFAULTS)
{
Merge::mergeHeaders($translations, $this, $options);
Merge::mergeTranslations($translations, $this, $options);
if ($strategy & Merge::HEADERS_THEIRS) {
$merged->headers = clone $translations->headers;
} elseif (!($strategy & Merge::HEADERS_OURS)) {
$merged->headers = $merged->headers->mergeWith($translations->headers);
}
return $this;
}
if ($strategy & Merge::FLAGS_THEIRS) {
$merged->flags = clone $translations->flags;
} elseif (!($strategy & Merge::FLAGS_OURS)) {
$merged->flags = $merged->flags->mergeWith($translations->flags);
}
/**
* Create a new instance of a Translation object.
*
* @param string $context The context of the translation
* @param string $original The original string
* @param string $plural The original plural string
* @return Translation New Translation instance
*/
public function createNewTranslation($context, $original, $plural = '')
{
$class = $this->translationClass;
return $class::create($context, $original, $plural);
if (!$merged->description) {
$merged->description = $translations->description;
}
foreach ($translations as $id => $translation) {
if (isset($merged->translations[$id])) {
$translation = $merged->translations[$id]->mergeWith($translation, $strategy);
}
$merged->add($translation);
}
if ($strategy & Merge::TRANSLATIONS_THEIRS) {
$merged->translations = array_intersect_key($merged->translations, $translations->translations);
} elseif ($strategy & Merge::TRANSLATIONS_OURS) {
$merged->translations = array_intersect_key($merged->translations, $this->translations);
}
return $merged;
}
}

View File

@ -1,270 +0,0 @@
<?php
namespace Gettext;
use Gettext\Generators\PhpArray;
class Translator extends BaseTranslator implements TranslatorInterface
{
protected $domain;
protected $dictionary = [];
protected $plurals = [];
/**
* Loads translation from a Translations instance, a file on an array.
*
* @param Translations|string|array $translations
*
* @return static
*/
public function loadTranslations($translations)
{
if (is_object($translations) && $translations instanceof Translations) {
$translations = PhpArray::generate($translations, ['includeHeaders' => false]);
} elseif (is_string($translations) && is_file($translations)) {
$translations = include $translations;
} elseif (!is_array($translations)) {
throw new \InvalidArgumentException(
'Invalid Translator: only arrays, files or instance of Translations are allowed'
);
}
$this->addTranslations($translations);
return $this;
}
/**
* Set the default domain.
*
* @param string $domain
*
* @return static
*/
public function defaultDomain($domain)
{
$this->domain = $domain;
return $this;
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function gettext($original)
{
return $this->dpgettext($this->domain, null, $original);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function ngettext($original, $plural, $value)
{
return $this->dnpgettext($this->domain, null, $original, $plural, $value);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function dngettext($domain, $original, $plural, $value)
{
return $this->dnpgettext($domain, null, $original, $plural, $value);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function npgettext($context, $original, $plural, $value)
{
return $this->dnpgettext($this->domain, $context, $original, $plural, $value);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function pgettext($context, $original)
{
return $this->dpgettext($this->domain, $context, $original);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function dgettext($domain, $original)
{
return $this->dpgettext($domain, null, $original);
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function dpgettext($domain, $context, $original)
{
$translation = $this->getTranslation($domain, $context, $original);
if (isset($translation[0]) && $translation[0] !== '') {
return $translation[0];
}
return $original;
}
/**
* @see TranslatorInterface
*
* {@inheritdoc}
*/
public function dnpgettext($domain, $context, $original, $plural, $value)
{
$translation = $this->getTranslation($domain, $context, $original);
$key = $this->getPluralIndex($domain, $value, $translation === false);
if (isset($translation[$key]) && $translation[$key] !== '') {
return $translation[$key];
}
return ($key === 0) ? $original : $plural;
}
/**
* Set new translations to the dictionary.
*
* @param array $translations
*/
protected function addTranslations(array $translations)
{
$domain = isset($translations['domain']) ? $translations['domain'] : '';
//Set the first domain loaded as default domain
if ($this->domain === null) {
$this->domain = $domain;
}
if (isset($this->dictionary[$domain])) {
$this->dictionary[$domain] = array_replace_recursive($this->dictionary[$domain], $translations['messages']);
return;
}
if (!empty($translations['plural-forms'])) {
list($count, $code) = array_map('trim', explode(';', $translations['plural-forms'], 2));
// extract just the expression turn 'n' into a php variable '$n'.
// Slap on a return keyword and semicolon at the end.
$this->plurals[$domain] = [
'count' => (int) str_replace('nplurals=', '', $count),
'code' => str_replace('plural=', 'return ', str_replace('n', '$n', $code)).';',
];
}
$this->dictionary[$domain] = $translations['messages'];
}
/**
* Search and returns a translation.
*
* @param string $domain
* @param string $context
* @param string $original
*
* @return string|false
*/
protected function getTranslation($domain, $context, $original)
{
return isset($this->dictionary[$domain][$context][$original])
? $this->dictionary[$domain][$context][$original]
: false;
}
/**
* Executes the plural decision code given the number to decide which
* plural version to take.
*
* @param string $domain
* @param string $n
* @param bool $fallback set to true to get fallback plural index
*
* @return int
*/
protected function getPluralIndex($domain, $n, $fallback)
{
//Not loaded domain or translation, use a fallback
if (!isset($this->plurals[$domain]) || $fallback === true) {
return $n == 1 ? 0 : 1;
}
if (!isset($this->plurals[$domain]['function'])) {
$code = static::fixTerseIfs($this->plurals[$domain]['code']);
$this->plurals[$domain]['function'] = eval("return function (\$n) { $code };");
}
if ($this->plurals[$domain]['count'] <= 2) {
return call_user_func($this->plurals[$domain]['function'], $n) ? 1 : 0;
}
return call_user_func($this->plurals[$domain]['function'], $n);
}
/**
* This function will recursively wrap failure states in brackets if they contain a nested terse if.
*
* This because PHP can not handle nested terse if's unless they are wrapped in brackets.
*
* This code probably only works for the gettext plural decision codes.
*
* return ($n==1 ? 0 : $n%10>=2 && $n%10<=4 && ($n%100<10 || $n%100>=20) ? 1 : 2);
* becomes
* return ($n==1 ? 0 : ($n%10>=2 && $n%10<=4 && ($n%100<10 || $n%100>=20) ? 1 : 2));
*
* @param string $code the terse if string
* @param bool $inner If inner is true we wrap it in brackets
*
* @return string A formatted terse If that PHP can work with.
*/
private static function fixTerseIfs($code, $inner = false)
{
/*
* (?P<expression>[^?]+) Capture everything up to ? as 'expression'
* \? ?
* (?P<success>[^:]+) Capture everything up to : as 'success'
* : :
* (?P<failure>[^;]+) Capture everything up to ; as 'failure'
*/
preg_match('/(?P<expression>[^?]+)\?(?P<success>[^:]+):(?P<failure>[^;]+)/', $code, $matches);
// If no match was found then no terse if was present
if (!isset($matches[0])) {
return $code;
}
$expression = $matches['expression'];
$success = $matches['success'];
$failure = $matches['failure'];
// Go look for another terse if in the failure state.
$failure = static::fixTerseIfs($failure, true);
$code = $expression.' ? '.$success.' : '.$failure;
if ($inner) {
return "($code)";
}
// note the semicolon. We need that for executing the code.
return "$code;";
}
}

View File

@ -1,112 +0,0 @@
<?php
namespace Gettext;
/**
* Interface used by all translators.
*/
interface TranslatorInterface
{
/**
* Register this translator as global, to use with the gettext functions __(), p__(), etc.
* Returns the previous translator if exists.
*
* @return TranslatorInterface|null
*/
public function register();
/**
* Noop, marks the string for translation but returns it unchanged.
*
* @param string $original
*
* @return string
*/
public function noop($original);
/**
* Gets a translation using the original string.
*
* @param string $original
*
* @return string
*/
public function gettext($original);
/**
* Gets a translation checking the plural form.
*
* @param string $original
* @param string $plural
* @param string $value
*
* @return string
*/
public function ngettext($original, $plural, $value);
/**
* Gets a translation checking the domain and the plural form.
*
* @param string $domain
* @param string $original
* @param string $plural
* @param string $value
*
* @return string
*/
public function dngettext($domain, $original, $plural, $value);
/**
* Gets a translation checking the context and the plural form.
*
* @param string $context
* @param string $original
* @param string $plural
* @param string $value
*
* @return string
*/
public function npgettext($context, $original, $plural, $value);
/**
* Gets a translation checking the context.
*
* @param string $context
* @param string $original
*
* @return string
*/
public function pgettext($context, $original);
/**
* Gets a translation checking the domain.
*
* @param string $domain
* @param string $original
*
* @return string
*/
public function dgettext($domain, $original);
/**
* Gets a translation checking the domain and context.
*
* @param string $domain
* @param string $context
* @param string $original
*
* @return string
*/
public function dpgettext($domain, $context, $original);
/**
* Gets a translation checking the domain, the context and the plural form.
*
* @param string $domain
* @param string $context
* @param string $original
* @param string $plural
* @param string $value
*/
public function dnpgettext($domain, $context, $original, $plural, $value);
}

View File

@ -1,56 +0,0 @@
<?php
namespace Gettext\Utils;
/*
* Trait to provide the functionality of read/write csv.
*/
trait CsvTrait
{
protected static $csvEscapeChar;
/**
* Check whether support the escape_char argument to fgetcsv/fputcsv or not
*
* @return bool
*/
protected static function supportsCsvEscapeChar()
{
if (static::$csvEscapeChar === null) {
static::$csvEscapeChar = version_compare(PHP_VERSION, '5.5.4') >= 0;
}
return static::$csvEscapeChar;
}
/**
* @param resource $handle
* @param array $options
*
* @return array
*/
protected static function fgetcsv($handle, $options)
{
if (static::supportsCsvEscapeChar()) {
return fgetcsv($handle, 0, $options['delimiter'], $options['enclosure'], $options['escape_char']);
}
return fgetcsv($handle, 0, $options['delimiter'], $options['enclosure']);
}
/**
* @param resource $handle
* @param array $fields
* @param array $options
*
* @return bool|int
*/
protected static function fputcsv($handle, $fields, $options)
{
if (static::supportsCsvEscapeChar()) {
return fputcsv($handle, $fields, $options['delimiter'], $options['enclosure'], $options['escape_char']);
}
return fputcsv($handle, $fields, $options['delimiter'], $options['enclosure']);
}
}

View File

@ -1,59 +0,0 @@
<?php
namespace Gettext\Utils;
use Gettext\Translations;
/**
* Trait used by all generators that exports the translations to plain dictionary (original => singular-translation).
*/
trait DictionaryTrait
{
use HeadersGeneratorTrait;
use HeadersExtractorTrait;
/**
* Returns a plain dictionary with the format [original => translation].
*
* @param Translations $translations
* @param bool $includeHeaders
*
* @return array
*/
protected static function toArray(Translations $translations, $includeHeaders)
{
$messages = [];
if ($includeHeaders) {
$messages[''] = static::generateHeaders($translations);
}
foreach ($translations as $translation) {
if ($translation->isDisabled()) {
continue;
}
$messages[$translation->getOriginal()] = $translation->getTranslation();
}
return $messages;
}
/**
* Extract the entries from a dictionary.
*
* @param array $messages
* @param Translations $translations
*/
protected static function fromArray(array $messages, Translations $translations)
{
foreach ($messages as $original => $translation) {
if ($original === '') {
static::extractHeaders($translation, $translations);
continue;
}
$translations->insert(null, $original)->setTranslation($translation);
}
}
}

View File

@ -1,167 +0,0 @@
<?php
namespace Gettext\Utils;
use Exception;
use Gettext\Translations;
abstract class FunctionsScanner
{
/**
* Scan and returns the functions and the arguments.
*
* @param array $constants Constants used in the code to replace
*
* @return array
*/
abstract public function getFunctions(array $constants = []);
/**
* Search for specific functions and create translations.
*
* You can pass multiple translation with different domains and value found will be sorted respectively.
*
* @param Translations|Translations[] $translations Multiple domain translations instances where to save the values
* @param array $options The extractor options
* @throws Exception
*/
public function saveGettextFunctions($translations, array $options)
{
$translations = is_array($translations) ? $translations : [$translations];
/** @var Translations[] $translationByDomain [domain => translations, ..] */
$translationByDomain = array_reduce($translations, function (&$carry, Translations $translations) {
$carry[$translations->getDomain()] = $translations;
return $carry;
}, []);
$functions = $options['functions'];
$file = $options['file'];
foreach ($this->getFunctions($options['constants']) as $function) {
list($name, $line, $args) = $function;
if (isset($options['lineOffset'])) {
$line += $options['lineOffset'];
}
if (!isset($functions[$name])) {
continue;
}
$deconstructed = $this->deconstructArgs($functions[$name], $args);
if (!$deconstructed) {
continue;
}
list($domain, $context, $original, $plural) = $deconstructed;
if ((string)$original === '') {
continue;
}
$isDefaultDomain = $domain === null;
$domainTranslations = isset($translationByDomain[$domain]) ? $translationByDomain[$domain] : false;
if (!empty($options['domainOnly']) && $isDefaultDomain) {
// If we want to find translations for a specific domain, skip default domain messages
continue;
}
if (!$domainTranslations) {
continue;
}
$translation = $domainTranslations->insert($context, $original, $plural);
$translation->addReference($file, $line);
if (isset($function[3])) {
foreach ($function[3] as $extractedComment) {
$translation->addExtractedComment($extractedComment);
}
}
}
}
/**
* Deconstruct arguments to translation values
*
* @param $function
* @param $args
* @return array|null
* @throws Exception
*/
protected function deconstructArgs($function, $args)
{
$domain = null;
$context = null;
$original = null;
$plural = null;
switch ($function) {
case 'noop':
case 'gettext':
if (!isset($args[0])) {
return null;
}
$original = $args[0];
break;
case 'ngettext':
if (!isset($args[1])) {
return null;
}
list($original, $plural) = $args;
break;
case 'pgettext':
if (!isset($args[1])) {
return null;
}
list($context, $original) = $args;
break;
case 'dgettext':
if (!isset($args[1])) {
return null;
}
list($domain, $original) = $args;
break;
case 'dpgettext':
if (!isset($args[2])) {
return null;
}
list($domain, $context, $original) = $args;
break;
case 'npgettext':
if (!isset($args[2])) {
return null;
}
list($context, $original, $plural) = $args;
break;
case 'dnpgettext':
if (!isset($args[3])) {
return null;
}
list($domain, $context, $original, $plural) = $args;
break;
case 'dngettext':
if (!isset($args[2])) {
return null;
}
list($domain, $original, $plural) = $args;
break;
default:
throw new Exception(sprintf('Not valid function %s', $function));
}
return [$domain, $context, $original, $plural];
}
}

View File

@ -1,67 +0,0 @@
<?php
namespace Gettext\Utils;
use Gettext\Translations;
/**
* Trait to provide the functionality of extracting headers.
*/
trait HeadersExtractorTrait
{
/**
* Add the headers found to the translations instance.
*
* @param string $headers
* @param Translations $translations
*
* @return array
*/
protected static function extractHeaders($headers, Translations $translations)
{
$headers = explode("\n", $headers);
$currentHeader = null;
foreach ($headers as $line) {
$line = static::convertString($line);
if ($line === '') {
continue;
}
if (static::isHeaderDefinition($line)) {
$header = array_map('trim', explode(':', $line, 2));
$currentHeader = $header[0];
$translations->setHeader($currentHeader, $header[1]);
} else {
$entry = $translations->getHeader($currentHeader);
$translations->setHeader($currentHeader, $entry.$line);
}
}
}
/**
* Checks if it is a header definition line. Useful for distguishing between header definitions
* and possible continuations of a header entry.
*
* @param string $line Line to parse
*
* @return bool
*/
protected static function isHeaderDefinition($line)
{
return (bool) preg_match('/^[\w-]+:/', $line);
}
/**
* Normalize a string.
*
* @param string $value
*
* @return string
*/
public static function convertString($value)
{
return $value;
}
}

View File

@ -1,29 +0,0 @@
<?php
namespace Gettext\Utils;
use Gettext\Translations;
/**
* Trait to provide the functionality of extracting headers.
*/
trait HeadersGeneratorTrait
{
/**
* Returns the headers as a string.
*
* @param Translations $translations
*
* @return string
*/
protected static function generateHeaders(Translations $translations)
{
$headers = '';
foreach ($translations->getHeaders() as $name => $value) {
$headers .= sprintf("%s: %s\n", $name, $value);
}
return $headers;
}
}

View File

@ -1,320 +0,0 @@
<?php
namespace Gettext\Utils;
class JsFunctionsScanner extends FunctionsScanner
{
protected $code;
protected $status = [];
/**
* Constructor.
*
* @param string $code The php code to scan
*/
public function __construct($code)
{
// Normalize newline characters
$this->code = str_replace(["\r\n", "\n\r", "\r"], "\n", $code);
}
/**
* {@inheritdoc}
*/
public function getFunctions(array $constants = [])
{
$length = strlen($this->code);
$line = 1;
$buffer = '';
$functions = [];
$bufferFunctions = [];
$char = null;
for ($pos = 0; $pos < $length; ++$pos) {
$prev = $char;
$char = $this->code[$pos];
$next = isset($this->code[$pos + 1]) ? $this->code[$pos + 1] : null;
switch ($char) {
case '\\':
switch ($this->status()) {
case 'simple-quote':
if ($next !== "'") {
break 2;
}
break;
case 'double-quote':
if ($next !== '"') {
break 2;
}
break;
case 'back-tick':
if ($next !== '`') {
break 2;
}
break;
}
$prev = $char;
$char = $next;
$pos++;
$next = isset($this->code[$pos]) ? $this->code[$pos] : null;
break;
case "\n":
++$line;
if ($this->status('line-comment')) {
$this->upStatus();
}
break;
case '/':
switch ($this->status()) {
case 'simple-quote':
case 'double-quote':
case 'back-tick':
case 'line-comment':
break;
case 'block-comment':
if ($prev === '*') {
$this->upStatus();
}
break;
default:
if ($next === '/') {
$this->downStatus('line-comment');
} elseif ($next === '*') {
$this->downStatus('block-comment');
}
break;
}
break;
case "'":
switch ($this->status()) {
case 'simple-quote':
$this->upStatus();
break;
case 'line-comment':
case 'block-comment':
case 'double-quote':
case 'back-tick':
break;
default:
$this->downStatus('simple-quote');
break;
}
break;
case '"':
switch ($this->status()) {
case 'double-quote':
$this->upStatus();
break;
case 'line-comment':
case 'block-comment':
case 'simple-quote':
case 'back-tick':
break;
default:
$this->downStatus('double-quote');
break;
}
break;
case '`':
switch ($this->status()) {
case 'back-tick':
$this->upStatus();
break;
case 'line-comment':
case 'block-comment':
case 'simple-quote':
case 'double-quote':
break;
default:
$this->downStatus('back-tick');
break;
}
break;
case '(':
switch ($this->status()) {
case 'simple-quote':
case 'double-quote':
case 'back-tick':
case 'line-comment':
case 'block-comment':
break;
default:
if ($buffer && preg_match('/(\w+)$/', $buffer, $matches)) {
$this->downStatus('function');
array_unshift($bufferFunctions, [$matches[1], $line, []]);
$buffer = '';
continue 3;
}
break;
}
break;
case ')':
switch ($this->status()) {
case 'function':
if (($argument = static::prepareArgument($buffer))) {
$bufferFunctions[0][2][] = $argument;
}
if (!empty($bufferFunctions)) {
$functions[] = array_shift($bufferFunctions);
}
$this->upStatus();
$buffer = '';
continue 3;
}
break;
case ',':
switch ($this->status()) {
case 'function':
if (($argument = static::prepareArgument($buffer))) {
$bufferFunctions[0][2][] = $argument;
}
$buffer = '';
continue 3;
}
break;
case ' ':
case '\t':
switch ($this->status()) {
case 'double-quote':
case 'simple-quote':
case 'back-tick':
break;
default:
$buffer = '';
continue 3;
}
break;
}
switch ($this->status()) {
case 'line-comment':
case 'block-comment':
break;
default:
$buffer .= $char;
break;
}
}
return $functions;
}
/**
* Get the current context of the scan.
*
* @param null|string $match To check whether the current status is this value
*
* @return string|bool
*/
protected function status($match = null)
{
$status = isset($this->status[0]) ? $this->status[0] : null;
if ($match !== null) {
return $status === $match;
}
return $status;
}
/**
* Add a new status to the stack.
*
* @param string $status
*/
protected function downStatus($status)
{
array_unshift($this->status, $status);
}
/**
* Removes and return the current status.
*
* @return string|null
*/
protected function upStatus()
{
return array_shift($this->status);
}
/**
* Prepares the arguments found in functions.
*
* @param string $argument
*
* @return string
*/
protected static function prepareArgument($argument)
{
if ($argument && in_array($argument[0], ['"', "'", '`'], true)) {
return static::convertString(substr($argument, 1, -1));
}
}
/**
* Decodes a string with an argument.
*
* @param string $value
*
* @return string
*/
protected static function convertString($value)
{
if (strpos($value, '\\') === false) {
return $value;
}
return preg_replace_callback(
'/\\\(n|r|t|v|e|f|"|\\\)/',
function ($match) {
switch ($match[1][0]) {
case 'n':
return "\n";
case 'r':
return "\r";
case 't':
return "\t";
case 'v':
return "\v";
case 'e':
return "\e";
case 'f':
return "\f";
case '"':
return '"';
case '\\':
return '\\';
}
},
$value
);
}
}

View File

@ -1,100 +0,0 @@
<?php
namespace Gettext\Utils;
use Gettext\Translations;
/**
* Trait used by all generators that exports the translations to multidimensional arrays
* (context => [original => [translation, plural1, pluraln...]]).
*/
trait MultidimensionalArrayTrait
{
use HeadersGeneratorTrait;
use HeadersExtractorTrait;
/**
* Returns a multidimensional array.
*
* @param Translations $translations
* @param bool $includeHeaders
* @param bool $forceArray
*
* @return array
*/
protected static function toArray(Translations $translations, $includeHeaders, $forceArray = false)
{
$pluralForm = $translations->getPluralForms();
$pluralSize = is_array($pluralForm) ? ($pluralForm[0] - 1) : null;
$messages = [];
if ($includeHeaders) {
$messages[''] = [
'' => [static::generateHeaders($translations)],
];
}
foreach ($translations as $translation) {
if ($translation->isDisabled()) {
continue;
}
$context = $translation->getContext();
$original = $translation->getOriginal();
if (!isset($messages[$context])) {
$messages[$context] = [];
}
if ($translation->hasPluralTranslations(true)) {
$messages[$context][$original] = $translation->getPluralTranslations($pluralSize);
array_unshift($messages[$context][$original], $translation->getTranslation());
} elseif ($forceArray) {
$messages[$context][$original] = [$translation->getTranslation()];
} else {
$messages[$context][$original] = $translation->getTranslation();
}
}
return [
'domain' => $translations->getDomain(),
'plural-forms' => $translations->getHeader('Plural-Forms'),
'messages' => $messages,
];
}
/**
* Extract the entries from a multidimensional array.
*
* @param array $messages
* @param Translations $translations
*/
protected static function fromArray(array $messages, Translations $translations)
{
if (!empty($messages['domain'])) {
$translations->setDomain($messages['domain']);
}
if (!empty($messages['plural-forms'])) {
$translations->setHeader(Translations::HEADER_PLURAL, $messages['plural-forms']);
}
foreach ($messages['messages'] as $context => $contextTranslations) {
foreach ($contextTranslations as $original => $value) {
if ($context === '' && $original === '') {
static::extractHeaders(is_array($value) ? array_shift($value) : $value, $translations);
continue;
}
$translation = $translations->insert($context, $original);
if (is_array($value)) {
$translation->setTranslation(array_shift($value));
$translation->setPluralTranslations($value);
} else {
$translation->setTranslation($value);
}
}
}
}
}

View File

@ -1,140 +0,0 @@
<?php
namespace Gettext\Utils;
/**
* Comment parsed by PhpFunctionsScanner.
*/
class ParsedComment
{
/**
* The comment itself.
*
* @var string
*/
protected $comment;
/**
* The line where the comment starts.
*
* @var int
*/
protected $firstLine;
/**
* The line where the comment ends.
*
* @var int
*/
protected $lastLine;
/**
* Initializes the instance.
*
* @param string $comment The comment itself.
* @param int $firstLine The line where the comment starts.
* @param int $lastLine The line where the comment ends.
*/
public function __construct($comment, $firstLine, $lastLine)
{
$this->comment = $comment;
$this->firstLine = $firstLine;
$this->lastLine = $lastLine;
}
/**
* Create new object from raw comment data.
*
* @param string $value The PHP comment string.
* @param int $line The line where the comment starts.
*
* @return static The parsed comment.
*/
public static function create($value, $line)
{
$lastLine = $line + substr_count($value, "\n");
$lines = array_map(function ($line) {
if ('' === trim($line)) {
return null;
}
$line = ltrim($line, "#*/ \t");
$line = rtrim($line, "#*/ \t");
return trim($line);
}, explode("\n", $value));
// Remove empty lines.
$lines = array_filter($lines);
$value = implode(' ', $lines);
return new static($value, $line, $lastLine);
}
/**
* Return the line where the comment starts.
*
* @return int Line number.
*/
public function getFirstLine()
{
return $this->firstLine;
}
/**
* Return the line where the comment ends.
*
* @return int Line number.
*/
public function getLastLine()
{
return $this->lastLine;
}
/**
* Return the actual comment string.
*
* @return string The comment.
*/
public function getComment()
{
return $this->comment;
}
/**
* Whether this comment is related with a given function.
*
* @param ParsedFunction $function The function to check.
* @return bool Whether the comment is related or not.
*/
public function isRelatedWith(ParsedFunction $function)
{
return $this->getLastLine() === $function->getLine() || $this->getLastLine() === $function->getLine() - 1;
}
/**
* Whether the comment matches the required prefixes.
*
* @param array $prefixes An array of prefixes to check.
* @return bool Whether the comment matches the prefixes or not.
*/
public function checkPrefixes(array $prefixes)
{
if ('' === $this->comment) {
return false;
}
if (empty($prefixes)) {
return true;
}
foreach ($prefixes as $prefix) {
if (strpos($this->comment, $prefix) === 0) {
return true;
}
}
return false;
}
}

View File

@ -1,159 +0,0 @@
<?php
namespace Gettext\Utils;
/**
* Function parsed by PhpFunctionsScanner.
*/
class ParsedFunction
{
/**
* The function name.
*
* @var string
*/
protected $name;
/**
* The line where the function starts.
*
* @var int
*/
protected $line;
/**
* The strings extracted from the function arguments.
*
* @var string[]
*/
protected $arguments;
/**
* The current index of the function (-1 if no arguments).
*
* @var int|null
*/
protected $argumentIndex;
/**
* Shall we stop adding string chunks to the current argument?
*
* @var bool
*/
protected $argumentStopped;
/**
* Extracted comments.
*
* @var string[]|null
*/
protected $comments;
/**
* Initializes the instance.
*
* @param string $name The function name.
* @param int $line The line where the function starts.
*/
public function __construct($name, $line)
{
$this->name = $name;
$this->line = $line;
$this->arguments = [];
$this->argumentIndex = -1;
$this->argumentStopped = false;
$this->comments = null;
}
/**
* Stop extracting strings from the current argument (because we found something that's not a string).
*/
public function stopArgument()
{
if ($this->argumentIndex === -1) {
$this->argumentIndex = 0;
}
$this->argumentStopped = true;
}
/**
* Go to the next argument because we a comma was found.
*/
public function nextArgument()
{
if ($this->argumentIndex === -1) {
// This should neve occur, but let's stay safe - During test/development an Exception should be thrown.
$this->argumentIndex = 1;
} else {
++$this->argumentIndex;
}
$this->argumentStopped = false;
}
/**
* Add a string to the current argument.
*
* @param string|null $chunk
*/
public function addArgumentChunk($chunk)
{
if ($this->argumentStopped === false) {
if ($this->argumentIndex === -1) {
$this->argumentIndex = 0;
}
if (isset($this->arguments[$this->argumentIndex])) {
$this->arguments[$this->argumentIndex] .= $chunk;
} else {
$this->arguments[$this->argumentIndex] = $chunk;
}
}
}
/**
* Add a comment associated to this function.
*
* @param string $comment
*/
public function addComment($comment)
{
if ($this->comments === null) {
$this->comments = [];
}
$this->comments[] = $comment;
}
/**
* Return the line the function starts.
*
* @return int Line number.
*/
public function getLine()
{
return $this->line;
}
/**
* A closing parenthesis was found: return the final data.
* The array returned has the following values:
* 0 => string The function name.
* 1 => int The line where the function starts.
* 2 => string[] the strings extracted from the function arguments.
* 3 => string[] the comments associated to the function.
*
* @return array
*/
public function close()
{
$arguments = [];
for ($i = 0; $i <= $this->argumentIndex; ++$i) {
$arguments[$i] = isset($this->arguments[$i]) ? $this->arguments[$i] : null;
}
return [
$this->name,
$this->line,
$arguments,
$this->comments,
];
}
}

View File

@ -1,194 +0,0 @@
<?php
namespace Gettext\Utils;
use Gettext\Extractors\PhpCode;
class PhpFunctionsScanner extends FunctionsScanner
{
/**
* PHP tokens of the code to be parsed.
*
* @var array
*/
protected $tokens;
/**
* If not false, comments will be extracted.
*
* @var string|false|array
*/
protected $extractComments = false;
/**
* Enable extracting comments that start with a tag (if $tag is empty all the comments will be extracted).
*
* @param mixed $tag
*/
public function enableCommentsExtraction($tag = '')
{
$this->extractComments = $tag;
}
/**
* Disable comments extraction.
*/
public function disableCommentsExtraction()
{
$this->extractComments = false;
}
/**
* Constructor.
*
* @param string $code The php code to scan
*/
public function __construct($code)
{
$this->tokens = array_values(
array_filter(
token_get_all($code),
function ($token) {
return !is_array($token) || $token[0] !== T_WHITESPACE;
}
)
);
}
/**
* {@inheritdoc}
*/
public function getFunctions(array $constants = [])
{
$count = count($this->tokens);
/* @var ParsedFunction[] $bufferFunctions */
$bufferFunctions = [];
/* @var ParsedComment[] $bufferComments */
$bufferComments = [];
/* @var array $functions */
$functions = [];
for ($k = 0; $k < $count; ++$k) {
$value = $this->tokens[$k];
if (is_string($value)) {
if (isset($bufferFunctions[0])) {
switch ($value) {
case ',':
$bufferFunctions[0]->nextArgument();
break;
case ')':
$functions[] = array_shift($bufferFunctions)->close();
break;
case '.':
break;
default:
$bufferFunctions[0]->stopArgument();
break;
}
}
continue;
}
switch ($value[0]) {
case T_CONSTANT_ENCAPSED_STRING:
//add an argument to the current function
if (isset($bufferFunctions[0])) {
$bufferFunctions[0]->addArgumentChunk(PhpCode::convertString($value[1]));
}
break;
case T_STRING:
if (isset($bufferFunctions[0])) {
if (isset($constants[$value[1]])) {
$bufferFunctions[0]->addArgumentChunk($constants[$value[1]]);
break;
}
if (strtolower($value[1]) === 'null') {
$bufferFunctions[0]->addArgumentChunk(null);
break;
}
$bufferFunctions[0]->stopArgument();
}
//new function found
for ($j = $k + 1; $j < $count; ++$j) {
$nextToken = $this->tokens[$j];
if (is_array($nextToken) && $nextToken[0] === T_COMMENT) {
continue;
}
if ($nextToken === '(') {
$newFunction = new ParsedFunction($value[1], $value[2]);
// add comment that was on the line before.
if (isset($bufferComments[0])) {
$comment = $bufferComments[0];
if ($comment->isRelatedWith($newFunction)) {
$newFunction->addComment($comment->getComment());
}
}
array_unshift($bufferFunctions, $newFunction);
$k = $j;
}
break;
}
break;
case T_COMMENT:
$comment = $this->parsePhpComment($value[1], $value[2]);
if ($comment) {
array_unshift($bufferComments, $comment);
// The comment is inside the function call.
if (isset($bufferFunctions[0])) {
$bufferFunctions[0]->addComment($comment->getComment());
}
}
break;
default:
if (isset($bufferFunctions[0])) {
$bufferFunctions[0]->stopArgument();
}
break;
}
}
return $functions;
}
/**
* Extract the actual text from a PHP comment.
*
* If set, only returns comments that match the prefix(es).
*
* @param string $value The PHP comment.
* @param int $line Line number.
*
* @return null|ParsedComment Comment or null if comment extraction is disabled or if there is a prefix mismatch.
*/
protected function parsePhpComment($value, $line)
{
if ($this->extractComments === false) {
return null;
}
//this returns a comment or null
$comment = ParsedComment::create($value, $line);
$prefixes = array_filter((array) $this->extractComments);
if ($comment && $comment->checkPrefixes($prefixes)) {
return $comment;
}
return null;
}
}

View File

@ -1,51 +0,0 @@
<?php
namespace Gettext\Utils;
class StringReader
{
public $pos;
public $str;
public $strlen;
/**
* Constructor.
*
* @param string $str The string to read
*/
public function __construct($str)
{
$this->str = $str;
$this->strlen = strlen($this->str);
}
/**
* Read and returns a part of the string.
*
* @param int $bytes The number of bytes to read
*
* @return string
*/
public function read($bytes)
{
$data = substr($this->str, $this->pos, $bytes);
$this->seekto($this->pos + $bytes);
return $data;
}
/**
* Move the cursor to a specific position.
*
* @param int $pos The amount of bytes to move
*
* @return int The new position
*/
public function seekto($pos)
{
$this->pos = ($this->strlen < $pos) ? $this->strlen : $pos;
return $this->pos;
}
}

View File

@ -1,13 +1,13 @@
<?php
spl_autoload_register(function ($class) {
if (strpos($class, 'Gettext\\') !== 0) {
return;
}
if (strpos($class, 'Gettext\\') !== 0) {
return;
}
$file = __DIR__.str_replace('\\', DIRECTORY_SEPARATOR, substr($class, strlen('Gettext'))).'.php';
$file = __DIR__ . str_replace('\\', DIRECTORY_SEPARATOR, substr($class, strlen('Gettext'))) . '.php';
if (is_file($file)) {
require_once $file;
}
if (is_file($file)) {
require_once $file;
}
});

View File

@ -1,191 +0,0 @@
<?php
use Gettext\BaseTranslator;
/**
* Returns the translation of a string.
*
* @param string $original
*
* @return string
*/
function __($original)
{
$text = BaseTranslator::$current->gettext($original);
if (func_num_args() === 1) {
return $text;
}
$args = array_slice(func_get_args(), 1);
return is_array($args[0]) ? strtr($text, $args[0]) : vsprintf($text, $args);
}
/**
* Noop, marks the string for translation but returns it unchanged.
*
* @param string $original
*
* @return string
*/
function noop__($original)
{
return $original;
}
/**
* Returns the singular/plural translation of a string.
*
* @param string $original
* @param string $plural
* @param string $value
*
* @return string
*/
function n__($original, $plural, $value)
{
$text = BaseTranslator::$current->ngettext($original, $plural, $value);
if (func_num_args() === 3) {
return $text;
}
$args = array_slice(func_get_args(), 3);
return is_array($args[0]) ? strtr($text, $args[0]) : vsprintf($text, $args);
}
/**
* Returns the translation of a string in a specific context.
*
* @param string $context
* @param string $original
*
* @return string
*/
function p__($context, $original)
{
$text = BaseTranslator::$current->pgettext($context, $original);
if (func_num_args() === 2) {
return $text;
}
$args = array_slice(func_get_args(), 2);
return is_array($args[0]) ? strtr($text, $args[0]) : vsprintf($text, $args);
}
/**
* Returns the translation of a string in a specific domain.
*
* @param string $domain
* @param string $original
*
* @return string
*/
function d__($domain, $original)
{
$text = BaseTranslator::$current->dgettext($domain, $original);
if (func_num_args() === 2) {
return $text;
}
$args = array_slice(func_get_args(), 2);
return is_array($args[0]) ? strtr($text, $args[0]) : vsprintf($text, $args);
}
/**
* Returns the translation of a string in a specific domain and context.
*
* @param string $domain
* @param string $context
* @param string $original
*
* @return string
*/
function dp__($domain, $context, $original)
{
$text = BaseTranslator::$current->dpgettext($domain, $context, $original);
if (func_num_args() === 3) {
return $text;
}
$args = array_slice(func_get_args(), 3);
return is_array($args[0]) ? strtr($text, $args[0]) : vsprintf($text, $args);
}
/**
* Returns the singular/plural translation of a string in a specific domain.
*
* @param string $domain
* @param string $original
* @param string $plural
* @param string $value
*
* @return string
*/
function dn__($domain, $original, $plural, $value)
{
$text = BaseTranslator::$current->dngettext($domain, $original, $plural, $value);
if (func_num_args() === 4) {
return $text;
}
$args = array_slice(func_get_args(), 4);
return is_array($args[0]) ? strtr($text, $args[0]) : vsprintf($text, $args);
}
/**
* Returns the singular/plural translation of a string in a specific context.
*
* @param string $context
* @param string $original
* @param string $plural
* @param string $value
*
* @return string
*/
function np__($context, $original, $plural, $value)
{
$text = BaseTranslator::$current->npgettext($context, $original, $plural, $value);
if (func_num_args() === 4) {
return $text;
}
$args = array_slice(func_get_args(), 4);
return is_array($args[0]) ? strtr($text, $args[0]) : vsprintf($text, $args);
}
/**
* Returns the singular/plural translation of a string in a specific domain and context.
*
* @param string $domain
* @param string $context
* @param string $original
* @param string $plural
* @param string $value
*
* @return string
*/
function dnp__($domain, $context, $original, $plural, $value)
{
$text = BaseTranslator::$current->dnpgettext($domain, $context, $original, $plural, $value);
if (func_num_args() === 5) {
return $text;
}
$args = array_slice(func_get_args(), 5);
return is_array($args[0]) ? strtr($text, $args[0]) : vsprintf($text, $args);
}