runt18/language

Joomla Framework Language Package

The Language Package

Usage

Prepare language files

Let's say you want to use English (UK) language pack.

You may find helpful some files distributed with Joomla CMS:

• en-GB.ini - Common language strings such as JYES, ERROR, JLOGIN.
• en-GB.lib_joomla.ini - Application language strings like JLIB_APPLICATION_SAVE_SUCCESS ('Item successfully saved.').
• en-GB.localise.php - To use language-specific methods like getIgnoredSearchWords.
• en-GB.xml - To use Language metadata definitions (full name, rtl, locale, firstDay).

In the Framework version 1.* Language handler loads language files from directory defined by JPATH_ROOT . '/languages/[language tag]/

In the example below, we will additinally load your application language strings located in file en-GB.application.ini.

Prepare configuration

Assuming configuration in a JSON format:

{
	"lang": "en-GB",
	"debug": true
}

Set up the Language instance in Web application

In the example below comments in language tag are replaced by xx-XX

use Joomla\Application\AbstractWebApplication;
use Joomla\Language\Language;
use Joomla\Language\Text;

class MyApplication extends AbstractWebApplication
{
	protected $language;

	protected function initialise()
	{
		parent::initialise();

		$language = $this->getLanguage();

		// Load xx-XX/xx-XX.application.ini file
		$language->load('application');
	}

	/**
	 * Get language object.
	 *
	 * @return  Language
	 *
	 * @note    JPATH_ROOT has to be defined.
	 */
	protected function getLanguage()
	{
		if (is_null($this->language))
		{
			// Get language object with the lang tag and debug setting in your configuration
			// This also loads language file /xx-XX/xx-XX.ini and localisation methods /xx-XX/xx-XX.localise.php if available
			$language = Language::getInstance($this->get('language'), $this->get('debug'));

			// Configure Text to use language instance
			Text::setLanguage($language);

			$this->language = $language;
		}

		return $this->language;
	}
}

Use Text methods

namespace App\Hello\Controller;

use Joomla\Language\Text
use Joomla\Controller\AbstractController;

class HelloController extends AbstractController
{
	public function execute()
	{
		$app = $this->getApplication();

		$translatedString = Text::_('APP_HELLO_WORLD');

		$app->setBody($translatedString);
	}
}

Using Text From Twig

If you are using Twig as a templating engine you will be unable to execute PHP code in the layout to use the Text magic function directly. One option is to add each string to the view, however you can also use Twig functions.

Creating a Twig function will allow the use of syntax like the below in your layout file.

jtext('APP_YOURSAMPLE_STRING')

To create a Twig function to do this after creating the Twig_Environment and before rendering add the following code:

$loader = new \Twig_Loader_Filesystem($this->path);
$twig = new \Twig_Environment($loader);

$jtextFunction = new \Twig_SimpleFunction('jtext',function($string){
	$translation = Text::_($string);
	return $translation;
},array('is_safe'=>array('html')));

$twig->addFunction($jtextFunction);

You will now be able translate strings in your twig file using:

{{jtext('APP_YOURSAMPLE_STRING')}}

Load component language files

@TODO

Installation via Composer

Add "joomla/language": "~1.0" to the require block in your composer.json and then run composer install.

{
	"require": {
		"joomla/language": "~1.0"
	}
}

Alternatively, you can simply run the following from the command line:

composer require joomla/language "~1.0"