Skip to content

Commit

Permalink
updated doc for random function
Browse files Browse the repository at this point in the history
  • Loading branch information
Tobion committed Jan 26, 2012
1 parent fe66358 commit faa90c9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* added a date function to ease date comparison
* fixed unary operators precedence
* added recursive parsing support in the parser
* added string and integer handling for the random function

* 1.5.1 (2012-01-05)

Expand Down
16 changes: 14 additions & 2 deletions doc/functions/random.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,20 @@
.. versionadded:: 1.5
The random function was added in Twig 1.5.

The ``random`` function returns a random item from a sequence:
.. versionadded:: 1.6
String and integer handling was added in Twig 1.6.

The ``random`` function returns a random value depending on the supplied paramter type:

* a random item from a Traversable or array
* a random character from a string
* a random integer between 0 and the integer parameter (inclusive)

.. code-block:: jinja
{{ random(['apple', 'orange', 'citrus']) }}
{{ random(['apple', 'orange', 'citrus']) }} {# example output: orange #}
{{ random('ABC') }} {# example output: C #}
{{ random() }} {# example output: 15386094 (works as native PHP `mt_rand`_ function) #}
{{ random(5) }} {# example output: 3 #}
.. _`mt_rand`: http://php.net/mt_rand

0 comments on commit faa90c9

Please sign in to comment.