Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/kzykhys/TwigExtensions

Extensions for Twig
https://github.com/kzykhys/TwigExtensions

Last synced: 21 days ago
JSON representation

Extensions for Twig

Host: GitHub
URL: https://github.com/kzykhys/TwigExtensions
Owner: kzykhys
Created: 2013-12-20T10:01:08.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2013-12-20T16:24:11.000Z (over 10 years ago)
Last Synced: 2024-04-14T12:07:31.002Z (2 months ago)
Language: PHP
Size: 191 KB
Stars: 8
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Lists

awesome-twig - kzykhys/twig-extensions - Bunch of awesome twig extensions by [kzykhys](https://github.com/kzykhys) (Twig / Extensions)
awesome-twig - kzykhys/twig-extensions - Bunch of awesome twig extensions by [kzykhys](https://github.com/kzykhys) (Twig / Extensions)

README

        Twig Extensions

===============

[![Latest Unstable Version](https://poser.pugx.org/kzykhys/twig-extensions/v/unstable.png)](https://packagist.org/packages/kzykhys/twig-extensions)

[![Build Status](https://travis-ci.org/kzykhys/TwigExtensions.png?branch=master)](https://travis-ci.org/kzykhys/TwigExtensions)

[![Coverage Status](https://coveralls.io/repos/kzykhys/TwigExtensions/badge.png)](https://coveralls.io/r/kzykhys/TwigExtensions)

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/2a42b187-ef35-4f7f-b1ea-518f20e34554/mini.png)](https://insight.sensiolabs.com/projects/2a42b187-ef35-4f7f-b1ea-518f20e34554)

Add more fun to [Twig][twig]. Inspired by Jinja2, Jekyll ...

``` jinja

{% block css %}

  

  {% less %}

    {% include 'mixins.less' %}

    .container {

      .row {

        &:first-child { margin-bottom: @m; }

      }

    }

  {% endless %}

  

{% endblock %}

{% unless user.active %}

  
Please Login



{% endunless %}

{{ gist(6421704) }}

{{ post.content|markdown }}

{% pygments brainfuck linenos %}

+++++++++[>++++++++>+++++++++++>+++++<<<-]>.>++.+++++++..+++.>-.

------------.<++++++++.--------.+++.------.--------.>+.

{% endpygments %}

```

Customized filesystem loader

``` php

render(array('date.twig', 'archive.twig', 'default.twig'));

```

Requirements

------------

* PHP5.3

### Optional requirements

*   Python2.4+ and Pygments ([kzykhys/Pygments.php][pygmentsphp]) for SyntaxHighlight extension

    ``` json

    {

        "require": {

            "kzykhys/pygments": ">=1.0"

        }

    }

    ```

*   PHP5.4+ and [kzykhys/Ciconia][ciconia] for Markdown extension

    ``` json

    {

        "require": {

            "kzykhys/ciconia": ">=1.0"

        }

    }

    ```

*   [leafo/lessphp][lessphp] for Less extension

    ``` json

    {

        "require": {

            "leafo/lessphp": ">=0.4"

        }

    }

    ```

*   [symfony/process][symfony-process] for Pipe extension

    ``` json

    {

        "require": {

            "symfony/process": ">=2.3"

        }

    }

    ```

Installation

------------

``` json

{

    "require": {

        "kzykhys/twig-extensions": "dev-master"

    }

}

```

``` php

setExtensions(ExtensionAggregate::getExtensions());

```

A List of Extensions

--------------------

Extension                              | Description

---------------------------------------|-----------

[Core][ext-core]                       | Provides tags and tests

[Text][ext-text]                       | Utilities for strings

[Snippet][ext-snippet]                 | Embedding various snippets

[Markdown][ext-markdown]               | Github Flavored Markdown support

[SyntaxHighlight][ext-syntaxhighlight] | Syntax Highlighting (pygments/google-code-prettify)

[Less][ext-less]                       | Compiles LESS to CSS

[Pipe][ext-pipe]                       | Use external commands as filters

Registering extensions to Twig

-------------------------------

Register all-in-one extension

``` php

$loader = new Twig_Loader_Filesystem('/path/to/templates');

$twig   = new Twig_Environment($loader);

$twig->setExtensions(ExtensionAggregate::getExtensions());

```

Or register extensions which you like

``` php

$loader = new Twig_Loader_Filesystem('/path/to/templates');

$twig   = new Twig_Environment($loader);

$twig->addExtension(new \KzykHys\TwigExtensions\Extension\Core());

$twig->addExtension(new \KzykHys\TwigExtensions\Extension\Snippet());

```

Twig Extensions Reference

-------------------------

### Tags

Name             | Extension                              | Description

-----------------|----------------------------------------|-------------

[unless]         | [Core][ext-core]                       | Negated form of the if statement

[pygments]       | [SyntaxHighlight][ext-syntaxhighlight] | Highlight the code (requires [Pygments.php][pygmentsphp])

[less]           | [Less][ext-less]                       | Converts LESS to CSS

### Filters

Name             | Extension                              | Description

-----------------|----------------------------------------|-------------

[center]         | [Text][ext-text]                       | Centers the value in a field of a given width.

[filesizeformat] | [Text][ext-text]                       | Format the value like a ‘human-readable’ file size (i.e. 13 kB, 4.1 MB, 102 Bytes, etc)

[markdown]       | [Markdown][ext-markdown]               | Transform markdown into html

[md5]            | [Text][ext-text]                       | Calculate the md5 hash of a string

[sha1]           | [Text][ext-text]                       | Calculate the sha1 hash of a string

[sha512]         | [Text][ext-text]                       | Calculate the sha512 hash of a string

[pipe]           | [Pipe][ext-pipe]                       | Executes an external command

### Functions

Name             | Extension                              | Description

-----------------|----------------------------------------|-------------

[call]           | [Core][ext-core]                       | Call a callback

[lipsum]         | [Text][ext-text]                       | Generates some lorem ipsum for the template

[gist]           | [Snippet][ext-snippet]                 | Embed a gist

[pastebin]       | [Snippet][ext-snippet]                 | Embed a pastebin

### Tests

Name             | Extension                              | Description

-----------------|----------------------------------------|-------------

[callable]       | [Core][ext-core]                       | Return whether the object is callable

[instanceof]     | [Core][ext-core]                       | Return whether a variable is an instantiated object of a certain class

License

-------

The MIT License

Author

------

Kazuyuki Hayashi (@kzykhys)

[ext-core]:            doc/Core.md

[ext-text]:            doc/Text.md

[ext-snippet]:         doc/Snippet.md

[ext-markdown]:        doc/Markdown.md

[ext-syntaxhighlight]: doc/SyntaxHighlight.md

[ext-less]:            doc/Less.md

[ext-pipe]:            doc/Pipe.md

[unless]:          doc/tags/unless.md

[pygments]:        doc/tags/pygments.md

[less]:            doc/tags/less.md

[center]:          doc/filters/center.md

[filesizeformat]:  doc/filters/filesizeformat.md

[markdown]:        doc/filters/markdown.md

[md5]:             doc/filters/md5.md

[sha1]:            doc/filters/sha1.md

[sha512]:          doc/filters/sha512.md

[pipe]:            doc/filters/pipe.md

[call]:            doc/functions/call.md

[lipsum]:          doc/functions/lipsum.md

[gist]:            doc/functions/gist.md

[pastebin]:        doc/functions/pastebin.md

[callable]:        doc/tests/callable.md

[instanceof]:      doc/tests/instanceof.md

[twig]:            http://twig.sensiolabs.org

[jinja]:           http://jinja.pocoo.org

[pygmentsphp]:     https://github.com/kzykhys/Pygments.php

[ciconia]:         http://ciconia.kzykhys.com/

[lessphp]:         http://leafo.net/lessphp/

[symfony-process]: http://symfony.com/doc/current/components/process.html