Yaffs site version 1.1

[yaffs-website] / vendor / twig / twig / doc / functions / random.rst

diff --git a/vendor/twig/twig/doc/functions/random.rst b/vendor/twig/twig/doc/functions/random.rst
new file mode 100644 (file)
index 0000000..168e74f
--- /dev/null
+++ b/vendor/twig/twig/doc/functions/random.rst
@@ -0,0 +1,29 @@
+``random``
+==========
+
+.. versionadded:: 1.5
+    The ``random`` function was added in Twig 1.5.
+
+.. versionadded:: 1.6
+    String and integer handling was added in Twig 1.6.
+
+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).
+
+.. 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 #}
+
+Arguments
+---------
+
+* ``values``: The values
+
+.. _`mt_rand`: http://php.net/mt_rand