cviebrock/twig-natural-join

Twig filter that joins an array using a different separator for the last element

0.9.1 2014-10-01 17:26 UTC

This package is auto-updated.

Last update: 2024-05-05 17:37:14 UTC


README

Twig filter that joins an array using a different separator for the last element (e.g. "John, Mary, Bob and Jim").

Total Downloads Latest Stable Version

Installation

The filter is registered at Packagist as cviebrock/twig-natural-join and can be installed using composer:

"require": {
	...
	"cviebrock/twig-natural-join": "0.9.*",
}

Or just download the zip file and copy the file into your src folder.

Enable the extension:

$twig = new Twig_Environment($loader, $options);
$twig->addExtension(new Cviebrock\Twig\NaturalJoinExtension());

If you are using Laravel and rcrowe/twigbridge, then enable the extension by adding an entry to the enabled array in app/config/packages/rcrowe/twigbridge/extensions.php:

'enabled' => [
	...
	'Cviebrock\Twig\NaturalJoinExtension',
],

Usage

Pass the normal seperator and final seperator to the filter:

{{ names|naturaljoin(", ", " and ") }}          // John, Bill, Bob and Mary

Optionally pass true as a third argument to turn on "Oxford" mode, which will add a normal seperator before the final seperator:

{{ names|naturaljoin(", ", " and ", true) }}    // John, Bill, Bob, and Mary

Bugs, Suggestions and Contributions

Please use Github for bugs, comments, suggestions.

  1. Fork the project.
  2. Create your bugfix/feature branch and write your (well-commented) code.
  3. Commit your changes and push to your repository.
  4. Create a new pull request against this project's master branch.

Copyright and License

twig-natural-join was written by Colin Viebrock and released under the MIT License. See the LICENSE file for details.

Copyright 2014 Colin Viebrock