Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/piotr-cz/twig-extensions-joomla
Joomla-Framwork functionality in Twig templates
https://github.com/piotr-cz/twig-extensions-joomla
Last synced: 27 days ago
JSON representation
Joomla-Framwork functionality in Twig templates
- Host: GitHub
- URL: https://github.com/piotr-cz/twig-extensions-joomla
- Owner: piotr-cz
- License: mit
- Created: 2013-08-21T14:32:42.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-04-28T18:53:43.000Z (over 10 years ago)
- Last Synced: 2024-04-20T19:09:09.054Z (7 months ago)
- Language: PHP
- Size: 417 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Twig Extensions - Joomla Framework [](https://travis-ci.org/piotr-cz/Twig-extensions-Joomla)
===============================
Extensions provide filters to allow using of [Joomla-Framework][2] packages such as [Language package][3] in [Twig][1] templates.
## Installation
Add `"piotr-cz/twig-extensions-joomla": "~1.0"` to require block in your composer.json and run `composer install`.
```json
{
"require": {
"piotr-cz/twig-extensions-joomla": "~1.0"
}
}
```
## Text extension
It's assumed that you will use Composer to handle autoloading.
### Setup
Add the extension to the twig environment:
```php
// 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()`, ...).
**Accepted Parameters**
- `$method` Text method
- Text arguments
#### The `_` method (default)
Twig Template:
```twig
{{ "IMADEIT" | jtext }}
```
Language file:
```ini
IMADEIT = "I made it!"
```
Result:
```
I made it!
```
#### The `sprintf` method
_Twig template_
```twig
{{ "HELLOW" | jtext('sprintf', 'World') }}
```
_Language file_
```ini
HELLOW ="Hello %s!"
```
_Result_
```
Hello World!
```
## Date extension
This extension allows to use localised date output and instead of [PHP intl](http://php.net/intl) extension uses [Language package][3].
Crucial functions imported from of [JDate package](https://github.com/joomla/joomla-platform/blob/staging/libraries/joomla/date/date.php).
### Setup
```php
$twig->addExtension(new \Twigoomla\Extension\DateExtension($config->get('timezone')));
```
### Usage
**Accepted Parameters**
- `$format` [DateTime Format](http://cz1.php.net/manual/en/function.date.php)
- `$timezone` String or DateTimeZone object (optional)
_Twig template_
```twig
{{ event.on | jdate('l, j. F Y') }}
```
_Language File_
```ini
SUNDAY ="neděle"
JUNE ="červen"
```
_Result_
```
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.
## Running tests
```sh
$ composer install
$ phpunit
```
## Licence
This extensions are released under the MIT License, except Date extension which is released under GPL2
[1]: http://twig.sensiolabs.org
[2]: http://framework.joomla.org
[3]: https://github.com/joomla-framework/language