Yaffs site version 1.1

[yaffs-website] / vendor / twig / twig / doc / filters / trim.rst

diff --git a/vendor/twig/twig/doc/filters/trim.rst b/vendor/twig/twig/doc/filters/trim.rst
new file mode 100644 (file)
index 0000000..b598363
--- /dev/null
+++ b/vendor/twig/twig/doc/filters/trim.rst
@@ -0,0 +1,45 @@
+``trim``
+========
+
+.. versionadded:: 1.32
+    The ``side`` argument was added in Twig 1.32.
+
+.. versionadded:: 1.6.2
+    The ``trim`` filter was added in Twig 1.6.2.
+
+The ``trim`` filter strips whitespace (or other characters) from the beginning
+and end of a string:
+
+.. code-block:: jinja
+
+    {{ '  I like Twig.  '|trim }}
+
+    {# outputs 'I like Twig.' #}
+
+    {{ '  I like Twig.'|trim('.') }}
+
+    {# outputs '  I like Twig' #}
+
+    {{ '  I like Twig.  '|trim(side='left') }}
+
+    {# outputs 'I like Twig.  ' #}
+
+    {{ '  I like Twig.  '|trim(' ', 'right') }}
+
+    {# outputs '  I like Twig.' #}
+
+.. note::
+
+    Internally, Twig uses the PHP `trim`_, `ltrim`_, and `rtrim`_ functions.
+
+Arguments
+---------
+
+* ``character_mask``: The characters to strip
+
+* ``side``: The default is to strip from the left and the right (`both`) sides, but `left`
+  and `right` will strip from either the left side or right side only
+
+.. _`trim`: http://php.net/trim
+.. _`ltrim`: http://php.net/ltrim
+.. _`rtrim`: http://php.net/rtrim