Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/intelligenia/behistun
Behistun is a simple PHP translation manager (for Twig templates)
https://github.com/intelligenia/behistun
translations twig twig-tag
Last synced: about 2 months ago
JSON representation
Behistun is a simple PHP translation manager (for Twig templates)
- Host: GitHub
- URL: https://github.com/intelligenia/behistun
- Owner: intelligenia
- License: mit
- Created: 2017-04-19T14:25:58.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-20T10:56:59.000Z (almost 8 years ago)
- Last Synced: 2024-03-27T07:26:34.075Z (10 months ago)
- Topics: translations, twig, twig-tag
- Language: PHP
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# behistun
Behistun is a simple PHP translation manager
# Requirements
PHP 5.4 and dependencies installed by [composer](https://getcomposer.org/) ([AdoDB](http://adodb.org/dokuwiki/doku.php) and [Twig template system](http://twig.sensiolabs.org/)).
# Installation
Install from packagist typing:
```sh
composer install
```
# Configuration
## Define the available languages
```php
// For example we are going to translate to Spanish and French
$LANGUAGES = ["es_ES", "fr_FR"];
```
## Load the file init.php file from the behistun package
Load the init.php file in your index.php or init.php file.
```php
require_once __DIR__ . '/vendor/intelligenia/behistun/behistun/init.php';
```
# Use
## Templates
This package relies on the Twig template system so you will have to use the following Twig tag to mark a block of text as translatable:
```html
{% translatable '' %}
This text will be translated
{% endtranslatable %}
```
The id will be used to identify the block of translatable text when dealing with translations. You should set it to value that helps you recognize easily the block it represents.
## Compile all source texts from templates
Run this PHP script that will get all the source texts and create a **locales/LANGUAGE_CODE/LC_MESSAGES/** directory in the same directory your templates:
```sh
php vendor/intelligenia/behistun/behistun/bin/update_translations.php [purge]
```
For example:
```sh
php vendor/intelligenia/behistun/behistun/bin/update_translations.php ~/projects/my-web/public_html/templates/ en_US
```
## Translation
This **locales/LANGUAGE_CODE/LC_MESSAGES/** directory contains two files:
### web.source.php
Original association between translatable ids and source texts.
### web.translation.php
Where each translation goes. Remember that each translation is identified by the id you used in the translatable tag.
## Changing language
```php
// Call Translator class with the language code you want to translate the texts
// this code only should be executed once, when you have a selected language that is
// different from the default language (e.g. English if your web is for English-speaking people)
$translator = new Translator($LANGUAGE);
```
# License
[MIT License](LICENSE).
# Authors
- First prototype made by Diego J. Romero López at intelligenia ([email protected])