aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/twig/twig/doc/functions/range.rst
blob: b1fa54710c9a68a21122bc216bad37216e78ed8d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
``range``
=========

Returns a list containing an arithmetic progression of integers:

.. code-block:: jinja

    {% for i in range(0, 3) %}
        {{ i }},
    {% endfor %}

    {# returns 0, 1, 2, 3 #}

When step is given (as the third parameter), it specifies the increment (or
decrement):

.. code-block:: jinja

    {% for i in range(0, 6, 2) %}
        {{ i }},
    {% endfor %}

    {# returns 0, 2, 4, 6 #}

The Twig built-in ``..`` operator is just syntactic sugar for the ``range``
function (with a step of 1):

.. code-block:: jinja

    {% for i in 0..3 %}
        {{ i }},
    {% endfor %}

.. tip::

    The ``range`` function works as the native PHP `range`_ function.

Arguments
---------

 * ``low``:  The first value of the sequence.
 * ``high``: The highest possible value of the sequence.
 * ``step``: The increment between elements of the sequence.

.. _`range`: http://php.net/range