twig_random(\Twig_Environment $env, \Traversable|array|integer|float|string $values = null) : mixed
Returns a random value depending on the supplied parameter type: - a random item from a Traversable or array - a random character from a string - a random integer between 0 and the integer parameter.
| \Twig_Environment | $env | |
| \Traversable|array|integer|float|string | $values | The values to pick a random item from |
when $values is an empty array (does not apply to an empty string which is returned as is)
A random value from the given sequence
twig_date_format_filter(\Twig_Environment $env, \DateTimeInterface|\DateInterval|string $date, string|null $format = null, \DateTimeZone|string|false|null $timezone = null) : string
Converts a date to the given format.
{{ post.published_at|date("m/d/Y") }}
| \Twig_Environment | $env | |
| \DateTimeInterface|\DateInterval|string | $date | A date |
| string|null | $format | The target format, null to use the default |
| \DateTimeZone|string|false|null | $timezone | The target timezone, null to use the default, false to leave unchanged |
The formatted date
twig_date_modify_filter(\Twig_Environment $env, \DateTimeInterface|string $date, string $modifier) : \DateTimeInterface
Returns a new date object modified.
{{ post.published_at|date_modify("-1day")|date("m/d/Y") }}
| \Twig_Environment | $env | |
| \DateTimeInterface|string | $date | A date |
| string | $modifier | A modifier string |
A new date object
twig_date_converter(\Twig_Environment $env, \DateTimeInterface|string|null $date = null, \DateTimeZone|string|false|null $timezone = null) : \DateTime
Converts an input to a DateTime instance.
{% if date(user.created_at) < date('+2days') %}
{# do something #}
{% endif %}
| \Twig_Environment | $env | |
| \DateTimeInterface|string|null | $date | A date or null to use the current time |
| \DateTimeZone|string|false|null | $timezone | The target timezone, null to use the default, false to leave unchanged |
A DateTime instance
twig_round(integer|float $value, integer|float $precision, string $method = 'common') : integer|float
Rounds a number.
| integer|float | $value | The value to round |
| integer|float | $precision | The rounding precision |
| string | $method | The method to use for rounding |
The rounded number
twig_number_format_filter(\Twig_Environment $env, mixed $number, integer $decimal = null, string $decimalPoint = null, string $thousandSep = null) : string
Number format filter.
All of the formatting options can be left null, in that case the defaults will be used. Supplying any of the parameters will override the defaults set in the environment object.
| \Twig_Environment | $env | |
| mixed | $number | A float/int/string of the number to format |
| integer | $decimal | the number of decimal points to display |
| string | $decimalPoint | the character(s) to use for the decimal point |
| string | $thousandSep | the character(s) to use for the thousands separator |
The formatted number
twig_array_merge(array|\Traversable $arr1, array|\Traversable $arr2) : array
Merges an array with another one.
{% set items = { 'apple': 'fruit', 'orange': 'fruit' } %}
{% set items = items|merge({ 'peugeot': 'car' }) %}
{# items now contains { 'apple': 'fruit', 'orange': 'fruit', 'peugeot': 'car' } #}
| array|\Traversable | $arr1 | An array |
| array|\Traversable | $arr2 | An array |
The merged array
twig_slice(\Twig_Environment $env, mixed $item, integer $start, integer $length = null, boolean $preserveKeys = false) : mixed
Slices a variable.
| \Twig_Environment | $env | |
| mixed | $item | A variable |
| integer | $start | Start of the slice |
| integer | $length | Size of the slice |
| boolean | $preserveKeys | Whether to preserve key or not (when the input is an array) |
The sliced variable
twig_first(\Twig_Environment $env, mixed $item) : mixed
Returns the first element of the item.
| \Twig_Environment | $env | |
| mixed | $item | A variable |
The first element of the item
twig_last(\Twig_Environment $env, mixed $item) : mixed
Returns the last element of the item.
| \Twig_Environment | $env | |
| mixed | $item | A variable |
The last element of the item
twig_join_filter(array $value, string $glue = '', string|null $and = null) : string
Joins the values to a string.
The separators between elements are empty strings per default, you can define them with the optional parameters.
{{ [1, 2, 3]|join(', ', ' and ') }}
{# returns 1, 2 and 3 #}
{{ [1, 2, 3]|join('|') }}
{# returns 1|2|3 #}
{{ [1, 2, 3]|join }}
{# returns 123 #}
| array | $value | An array |
| string | $glue | The separator |
| string|null | $and | The separator for the last pair |
The concatenated string
twig_split_filter(\Twig_Environment $env, string $value, string $delimiter, integer $limit = null) : array
Splits the string into an array.
{{ "one,two,three"|split(',') }}
{# returns [one, two, three] #}
{{ "one,two,three,four,five"|split(',', 3) }}
{# returns [one, two, "three,four,five"] #}
{{ "123"|split('') }}
{# returns [1, 2, 3] #}
{{ "aabbcc"|split('', 2) }}
{# returns [aa, bb, cc] #}
| \Twig_Environment | $env | |
| string | $value | A string |
| string | $delimiter | The delimiter |
| integer | $limit | The limit |
The split string as an array
twig_reverse_filter(\Twig_Environment $env, array|\Traversable|string $item, boolean $preserveKeys = false) : mixed
Reverses a variable.
| \Twig_Environment | $env | |
| array|\Traversable|string | $item | An array, a Traversable instance, or a string |
| boolean | $preserveKeys | Whether to preserve key or not |
The reversed input
twig_escape_filter(\Twig_Environment $env, mixed $string, string $strategy = 'html', string $charset = null, boolean $autoescape = false) : string
Escapes a string.
| \Twig_Environment | $env | |
| mixed | $string | The value to be escaped |
| string | $strategy | The escaping strategy |
| string | $charset | The charset |
| boolean | $autoescape | Whether the function is called by the auto-escaping feature (true) or by the developer (false) |
twig_length_filter(\Twig_Environment $env, mixed $thing) : integer
Returns the length of a variable.
| \Twig_Environment | $env | A Twig_Environment instance |
| mixed | $thing | A variable |
The length of the value
twig_upper_filter(\Twig_Environment $env, string $string) : string
Converts a string to uppercase.
| \Twig_Environment | $env | |
| string | $string | A string |
The uppercased string
twig_lower_filter(\Twig_Environment $env, string $string) : string
Converts a string to lowercase.
| \Twig_Environment | $env | |
| string | $string | A string |
The lowercased string
twig_title_string_filter(\Twig_Environment $env, string $string) : string
Returns a titlecased string.
| \Twig_Environment | $env | |
| string | $string | A string |
The titlecased string
twig_capitalize_string_filter(\Twig_Environment $env, string $string) : string
Returns a capitalized string.
| \Twig_Environment | $env | |
| string | $string | A string |
The capitalized string
twig_test_empty(mixed $value) : boolean
Checks if a variable is empty.
{# evaluates to true if the foo variable is null, false, or the empty string #}
{% if foo is empty %}
{# ... #}
{% endif %}
| mixed | $value | A variable |
true if the value is empty, false otherwise
twig_test_iterable(mixed $value) : boolean
Checks if a variable is traversable.
{# evaluates to true if the foo variable is an array or a traversable object #}
{% if foo is iterable %}
{# ... #}
{% endif %}
| mixed | $value | A variable |
true if the value is traversable
twig_include(\Twig_Environment $env, array $context, string|array $template, array $variables = array(), boolean $withContext = true, boolean $ignoreMissing = false, boolean $sandboxed = false) : string
Renders a template.
| \Twig_Environment | $env | |
| array | $context | |
| string|array | $template | The template to render or an array of templates to try consecutively |
| array | $variables | The variables to pass to the template |
| boolean | $withContext | |
| boolean | $ignoreMissing | Whether to ignore missing templates or not |
| boolean | $sandboxed | Whether to sandbox the template or not |
The rendered template
twig_source(\Twig_Environment $env, string $name, boolean $ignoreMissing = false) : string
Returns a template content without rendering it.
| \Twig_Environment | $env | |
| string | $name | The template name |
| boolean | $ignoreMissing | Whether to ignore missing templates or not |
The template source