Files
Twig/doc/functions/random.rst
T
Fabien Potencier 2702126349 Merge branch '1.x' into 2.x
* 1.x:
  tweaked docs
  Add max value to random function
2019-03-05 20:11:37 +01:00

31 lines
1.1 KiB
ReStructuredText

``random``
==========
.. versionadded:: 2.7
The "max" argument was added in Twig 2.7.
The ``random`` function returns a random value depending on the supplied
parameter type:
* a random item from a sequence;
* a random character from a string;
* a random integer between 0 and the integer parameter (inclusive).
* a random integer between the integer parameter (when negative) and 0 (inclusive).
* a random integer between the first integer and the second integer parameter (inclusive).
.. code-block:: jinja
{{ random(['apple', 'orange', 'citrus']) }} {# example output: orange #}
{{ random('ABC') }} {# example output: C #}
{{ random() }} {# example output: 15386094 (works as the native PHP mt_rand function) #}
{{ random(5) }} {# example output: 3 #}
{{ random(50, 100) }} {# example output: 63 #}
Arguments
---------
* ``values``: The values
* ``max``: The max value when values is an integer
.. _`mt_rand`: https://secure.php.net/mt_rand