natanaelsimoes/twig-pluralize-extension

Twig extension to output correctly pluralized strings

v3.0.1 2020-02-27 14:09 UTC

This package is auto-updated.

Last update: 2024-04-28 00:02:27 UTC


README

A simple extension for Twig that allows you to pluralize a given string.

Usage

Register the function at services.yaml if your're using Symfony:

#[....]
Pluralize:
    class: NatanaelSimoes\Twig\Extension\Pluralize
    tags:
        - twig.extension

then reference it in your template:

This section has {{ pluralize(categories|length, 'one category', '%d categories', 'no categories') }}.

Given the values 0, 1, and 5, the above would output:

0: This section has no categories.
1: This section has one category.
5: This section has 5 categories.

The last parameter (the "zero items" string) is optional. If omitted, the 3rd parameter (the "many items" string) will be used, as in the following:

This section has {{ pluralize(categories|length, 'one category', '%d categories') }}.
0: This section has 0 categories.
1: This section has one category.
5: This section has 5 categories.

The strings are passed through sprintf. You can use the %d token to insert the count into your string, if desired.

Contributing

If you have composer install, run composer install but if you want to run it in a container, run docker-[so].sh or docker-windows.bat accordingly to your system.

License & Conduct

This project is licensed under the terms of the MIT License, included in LICENSE.md.

All open source Tomodomo projects follow a strict code of conduct, included in CODEOFCONDUCT.md. We ask that all contributors adhere to the standards and guidelines in that document.

Thank you!