smarty/docs/en/designers/language-modifiers/language-modifier-escape.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
 <sect1 id="language.modifier.escape">
  <title>escape</title>
  <informaltable frame="all">
   <tgroup cols="6">
    <colspec colname="param" align="center" />
    <colspec colname="type" align="center" />
    <colspec colname="required" align="center" />
    <colspec colname="possible" align="center" />
    <colspec colname="default" align="center" />
    <colspec colname="desc" />
    <thead>
     <row>
      <entry>Parameter Position</entry>
      <entry>Type</entry>
      <entry>Required</entry>
      <entry>Possible Values</entry>
      <entry>Default</entry>
      <entry>Description</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>1</entry>
      <entry>string</entry>
      <entry>No</entry>
      <entry>html,htmlall,url,quotes,hex,hexentity,javascript</entry>
      <entry>html</entry>
      <entry>This is the escape format to use.</entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
  <para>
   This is used to html escape, url escape, escape single quotes on a
   variable not already escaped, hex escape, hexentity or javascript escape.
   By default, the variable is html
   escaped.
  </para>
  <example>
   <title>escape</title>
   <programlisting role="php">
<![CDATA[
<?php
    
$smarty = new Smarty;
$smarty->assign('articleTitle', "'Stiff Opposition Expected to Casketless Funeral Plan'");
$smarty->display('index.tpl');
    
?>
]]>
   </programlisting>
   <para>
    Where index.tpl is:
   </para>
   <programlisting>
<![CDATA[
{$articleTitle}
{$articleTitle|escape}
{$articleTitle|escape:"html"}    {* escapes  & " ' < > *}
{$articleTitle|escape:"htmlall"} {* escapes ALL html entities *}
{$articleTitle|escape:"url"}
{$articleTitle|escape:"quotes"}
<a href="mailto:{$EmailAddress|escape:"hex"}">{$EmailAddress|escape:"hexentity"}</a>
]]>
   </programlisting>
   <para>
    This will output:
   </para>
   <screen>
<![CDATA[
'Stiff Opposition Expected to Casketless Funeral Plan'
&#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;
&#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;
&#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;
%27Stiff+Opposition+Expected+to+Casketless+Funeral+Plan%27
\'Stiff Opposition Expected to Casketless Funeral Plan\'
<a href="mailto:%62%6f%62%40%6d%65%2e%6e%65%74">&#x62;&#x6f;&#x62;&#x40;&#x6d;&#x65;&#x2e;&#x6e;&#x65;&#x74;</a>
]]>
   </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
-->