File: cycle.rst

package info (click to toggle)
php-twig 3.20.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,940 kB
  • sloc: php: 23,320; makefile: 110; sh: 43
file content (58 lines) | stat: -rw-r--r-- 1,043 bytes parent folder | download | duplicates (2)
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
46
47
48
49
50
51
52
53
54
55
56
57
58
``cycle``
=========

The ``cycle`` function cycles on a sequence:

.. code-block:: twig

    {% set start_year = date() | date('Y') %}
    {% set end_year = start_year + 5 %}

    {% for year in start_year..end_year %}
        {{ cycle(['odd', 'even'], loop.index0) }}
    {% endfor %}
    
    {# outputs

        odd
        even
        odd
        even
        odd
        even
        
    #}

The ``cycle`` function takes two arguments: the ``sequence`` to cycle through and the ``position`` in the sequence.

The ``sequence`` must be non-empty and can contain any number of values:

.. code-block:: twig

    {% set fruits = ['apple', 'orange', 'citrus'] %}

    {% for i in 0..10 %}
        {{ cycle(fruits, i) }}
    {% endfor %}
    
    {# outputs
    
        apple
        orange
        citrus
        apple
        orange
        citrus
        apple
        orange
        citrus
        apple
        orange
    
    #}

Arguments
---------

* ``values``: The sequence to cycle on
* ``position``: The position in the sequence