banana split

docs/en/designers/language-modifiers/language-modifier-regex-replace.xml

@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+ <sect1 id="language.modifier.regex.replace">
+  <title>regex_replace</title>
+  <informaltable frame="all">
+   <tgroup cols="5">
+    <colspec colname="param" align="center" />
+    <colspec colname="type" align="center" />
+    <colspec colname="required" align="center" />
+    <colspec colname="default" align="center" />
+    <colspec colname="desc"/>
+    <thead>
+     <row>
+      <entry>Parameter Position</entry>
+      <entry>Type</entry>
+      <entry>Required</entry>
+      <entry>Default</entry>
+      <entry>Description</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>1</entry>
+      <entry>string</entry>
+      <entry>Yes</entry>
+      <entry><emphasis>n/a</emphasis></entry>
+      <entry>This is the regular expression to be replaced.</entry>
+     </row>
+     <row>
+      <entry>2</entry>
+      <entry>string</entry>
+      <entry>Yes</entry>
+      <entry><emphasis>n/a</emphasis></entry>
+      <entry>This is the string of text to replace with.</entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+  <para>
+   A regular expression search and replace on a variable. Use the
+   syntax for preg_replace() from the PHP manual.
+  </para>
+  <example>
+   <title>regex_replace</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+
+$smarty = new Smarty;
+$smarty->assign('articleTitle', "Infertility unlikely to\nbe passed on, experts say.");
+$smarty->display('index.tpl');
+
+?>
+]]>
+   </programlisting>
+   <para>
+    Where index.tpl is:
+   </para>
+   <programlisting>
+<![CDATA[
+{* replace each carriage return, tab and new line with a space *}
+
+{$articleTitle}
+{$articleTitle|regex_replace:"/[\r\t\n]/":" "}
+]]>
+   </programlisting>
+   <para>
+    This should output:
+   </para>
+   <screen>
+<![CDATA[
+Infertility unlikely to
+be passed on, experts say.
+Infertility unlikely to be passed on, experts say.
+]]>
+   </screen>
+  </example>
+</sect1>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->