Translator-PHP is a simple PHP Class useful to handle translations in your website with yml files.
- YML files for translations
- Supports fallback locale
- Support storing locale choice in the session
It requires Spyc.php, which is available in the package. For the latest source code please check: https://github.com/mustangostang/spyc
In this guide we will refer to the current folder structure:
/project_folder
¦ index.php
¦ init.php
¦ Translator.php
¦
+---lib
¦ ¦ Spyc.php
¦
+---translations
¦
+---LOCALE
¦ home.yml
¦ menu.yml
¦ about.yml
¦ service.yml
Where LOCALE is a folder with 2 digits rappresenting the locale (i.e.: en, it, es, de, etc..).
An example of yml file is the following:
# /translations/en/home.yml
title: This is my title
description: This is my description
header:
sections:
line1: This is the content of line 1
Load the classes:
<?php
require_once('lib/Spyc.php');
require_once('Translator.php');
?>
Create the $trans object:
<?php
$trans = new Translator();
?>
Create the $trans object and load the contexts:
<?php
$trans = new Translator(array('home', 'menu'));
?>
Load the contexts:
<?php
$trans->load(array('about', 'service'));
?>
Get the translation for key title in home context:
<?php
// This will put the translated string into a variable
$title = $trans->getTranslation('home', 'title');
$description = $trans->getTranslation('home', 'description');
$line1 = $trans->getTranslation('home', 'header.sections.line1');
// This will print out the translated string
$trans->translate('service', 'team.name');
?>
You can support all the locales,
By default the locale query parameter change the locale, which is then stored in the session. Accessing the path index.php?locale=it the page will be displayed in Italian, and this preference will be stored in the session, so all the next pages browsed will be displayed in the same language.
The init.php file loads the Translator class, creates the $trans object and define the _tr($context, $key) function. The _tr() function is an alias of $trans->getTranslation() method, which makes the code more easy to read.
<?php
// load the init.php
require_once('init.php');
// load the contexts used in the page
$trans->load(array('home', 'header', 'menu', 'service'));
?>
<!DOCTYPE html>
<html>
<header>
<title>
<?php
// get the translation for title key in context home and assign it to $title variable
$title = $trans->getTranslation('home', 'title');
// print the value of $title
echo $title;
// or print out directly the translated value
_tr('home', 'title`);
?>
</title>
</header>
...
Create the $trans object with or without loading any context.
// Creates the object and set the language
$trans = new Translator();
// Creates the object, set the language and load the file `context.yml` for the proper language
$trans = new Translator(array('context'));
Load one or more context at one.
// load one context
$trans->load(array('contextA'));
// load multiple contexts
$trans->load(array('contextA', 'contextB'));
This will load the content of the files /translations/LOCALE/contextA.yml and /translations/LOCALE/contextB.yml.
In order to change the default language, change the DEFAULT_LANGUAGE constant value in Translator.php file. By default the default locale is English.
The default folder name containings the locales and translations is /translations, you can change it to whatever folder name/path, changing the LOCALE_PATH constant value in Translator.php file.
By default the query parameter to set the locale is locale, in order to change that you can set the name of the parameter as value of LOCALE_GET_PARAMETER constant in Translator.php file.