phptransformers/phptransformer

Normalize the API of any PHPTransformer.

PHPTransformer

, _(*1)

Common interface to manipulate strings/data with any transformer. Great for use in templating libraries, static site generators, web frameworks, and more. Inspired by JSTransformers., _(*2)

Supported Transformers

To use each of these transformers, you will also need to composer require them in your project., _(*3)

• Twig (From SensioLabs/Symfony)
• Smarty
• Mustache
• Latte (From Nette Framework)
• StringTemplate
• Plates (From The PHP League)
• Dwoo
• Blade (From Laravel Framework)
• PHPTAL
• Text-Template (From PHPUnit)

Install

Via Composer, _(*4)

``` bash $ composer require phptransformers/phptransformer, <sub>(*5)</sub>

## Usage

``` php
// With "phptransfomers/twig" package
$transformer = new PhpTransformers\Twig\TwigTransformer();
echo $transformer->render('Hello, {{ name }}!', array(
    'name' => 'World'
));
//=> Hello, World!

API

Before all examples, you will need to load a transformer:, <sub>(*6)</sub>

``` php $transformer = new PhpTransformers\Twig\TwigTransformer(); $transformer = new PhpTransformers\Smarty\SmartyTransformer(); // ... same thing for all other Transformers, <sub>(*7)</sub>

_See each transformers' repository for more details_

### `->render($template, $locals)`

Renders the given template string, using the provides locals for options passed
in. Returns the result as a string.

``` php
$locals = array('name' => 'World');
$output = $transformer->render('Hello, {{ name }}!', $locals);

->renderFile($file, $locals)

Renders the given file, using the provided locals for options passed in. Returns the result as a string., <sub>(*8)</sub>

``` php $locals = array('name' => 'World'); $output = $transformer->renderFile('hello.twig', $locals);, <sub>(*9)</sub>

## Testing

``` bash
$ composer test

Contributing

Please see CONTRIBUTING for details., <sub>(*10)</sub>

Credits

• Rob Loach
• stoeffel
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*11)</sub>