piotr-cz/twig-extensions-joomla

Twig - Joomla Framework Language bridge

Twig Extensions - Joomla Framework

Extensions provide filters to allow using of Joomla-Framework packages such as [Language package][3] in Twig templates., _(*1)

Installation

Add "piotr-cz/twig-extensions-joomla": "~1.0" to require block in your composer.json and run composer install., _(*2)

{
    "require": {
        "piotr-cz/twig-extensions-joomla": "~1.0"
    }
}

Text extension

It's assumed that you will use Composer to handle autoloading., _(*3)

Setup

Add the extension to the twig environment:, _(*4)

// Configure Twig
$loader = new \Twig_Loader_Filesystem(JPATH_TEMPLATES);
$twig = new \Twig_Environment($loader, $options = array());

// Register Extension
$twig->addExtension(new \TwigJoomla\Extension\TextExtension);

// Render Template
$template = $twig->loadTemplate('test.twig');
echo $template->render();

Usage

Extension is able to call any public method of Text (like Text::_(), Text::sprintf(), ...)., _(*5)

Accepted Parameters, _(*6)

• $method Text method
• Text arguments

The _ method (default)

Twig Template:, _(*7)

{{ "IMADEIT" | jtext }}

Language file:, _(*8)

IMADEIT     = "I made it!"

Result:, _(*9)

I made it!

The sprintf method

Twig template, _(*10)

{{ "HELLOW" | jtext('sprintf', 'World') }}

Language file, _(*11)

HELLOW      ="Hello %s!"

Result, _(*12)

Hello World!

Date extension

This extension allows to use localised date output and instead of PHP intl extension uses [Language package][3]. Crucial functions imported from of JDate package., _(*13)

Setup

$twig->addExtension(new \Twigoomla\Extension\DateExtension($config->get('timezone')));

Usage

Accepted Parameters, _(*14)

• $format DateTime Format
• $timezone String or DateTimeZone object (optional)

Twig template, _(*15)

{{ event.on | jdate('l, j. F Y') }}

Language File, _(*16)

SUNDAY      ="neděle"
JUNE        ="červen"

Result, _(*17)

neděle, 1. červen 2014

Application setup

See [Joomla-Framework/Language][3] package for instructions on how to setup the Language package in your application., _(*18)

Running tests

$ composer install
$ phpunit

Licence

This extensions are released under the MIT License, except Date extension which is released under GPL2, _(*19)