liberty_code / translation
Library
Package info
bitbucket.org/libertysoft/libertycode_translation
pkg:composer/liberty_code/translation
Requires
- php: ~7 || ~8
- liberty_code/cache: ~1.0.0
- liberty_code/data: ~1.0.0
- liberty_code/di: ~1.0.0
- liberty_code/library: ~1.0.0
Requires (Dev)
- liberty_code/register: ~1.0.0
- phpunit/phpunit: 8.5.22
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is not auto-updated.
Last update: 2026-11-20 00:23:22 UTC
README
Description
Library contains translation components, to manage translations.
Requirement
- Script language: PHP: version 7 || 8
Installation
Several ways are possible:
Composer
Requirement
It requires composer installation. For more information: https://getcomposer.org
Command: Move in project root path
cd "<project_root_path>"Command: Installation
php composer.phar require liberty_code/translation ["<version>"]Note
Include vendor
If project uses composer, vendor must be included:
require_once('<project_root_path>/vendor/autoload.php');Configuration
Installation command allows to add, on composer file "/composer.json", following configuration:
{ "require": { "liberty_code/translation": "<version>" } }
Include
Download
- Download following repository.
- Put it on repository root path.
Include source
require_once('<repository_root_path>/include/Include.php');
Usage
Translation repository
Translation repository allows to retrieve translation values, from storage.
Elements
TranslRepository
Allows to retrieve translation values, from storage.
DataTranslRepository
Extends translation repository features. Uses data, as storage layer, to retrieve translation values.
RepoTranslRepository
Extends translation repository features. Uses repositories, as storage layer, to retrieve translation values.
MultiTranslRepository
Extends translation repository features. Uses sub translation repositories, as storage layer, to retrieve translation values.
Example
// Get translation repository
use liberty_code\translation\translation\repository\data\model\DataTranslRepository;
$translRepo = new DataTranslRepository($provider, [...data translation repository configuration]);
...
// Get translation values
echo($translRepo->getStrValue('en', 'key1')); // Show translation value 1, in locale en
echo($translRepo->getStrValue('fr', 'key1')); // Show translation value 1, in locale fr
echo($translRepo->getStrValue('en', 'key2')); // Show translation value 2, in locale en
echo($translRepo->getStrValue('fr', 'key2')); // Show translation value 2, in locale fr
...
Translator
Translator allows to retrieve translation values.
Elements
Translator
Allows to retrieve translation values.
TranslRepoTranslator
Extends translator features. Uses translation repository, to retrieve translation values.
Example
// Get translator
use liberty_code\translation\translator\translation\repository\model\TranslRepoTranslator;
$translator = new TranslRepoTranslator($translRepo, [...translation repository translator configuration]);
...
// Set current locale key
$translator->setCurrentLocaleKey('en'));
...
// Get translation values
echo($translator->getStrValueFromKey('key1')); // Show translation value 1, in current locale
echo($translator->getStrValueFromKey('key2')); // Show translation value 2, in current locale
...
Test
Unit test
Unit tests allows to test components features, and to automate their validation.
Requirement
Composer
It requires composer installation. For more information: https://getcomposer.org
Command: Dependencies installation
php composer.phar install
Command: Run unit tests
vendor\bin\phpunitNote
It uses PHPUnit to handle unit tests. For more information: https://phpunit.readthedocs.io