smarty/docs/en/programmers/api-functions/api-clear-compiled-tpl.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="api.clear.compiled.tpl">
 <refnamediv>
  <refname>clear_compiled_tpl()</refname>
  <refpurpose>clears the compiled version of the specified template resource</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>void</type><methodname>clear_compiled_tpl</methodname>
   <methodparam choice="opt"><type>string</type><parameter>tpl_file</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter>
   </methodparam>
   <methodparam choice="opt"><type>int</type><parameter>exp_time</parameter></methodparam>
  </methodsynopsis>
  <para>
   This clears the compiled version of the specified template
   resource, or all compiled template files if one is not specified.
   If you pass a <link linkend="variable.compile.id">$compile_id</link>
   only the compiled template for this
   specific <link linkend="variable.compile.id">$compile_id</link>
   is cleared. if you pass an exp_time, then only
   compiled templates older than exp_time seconds are cleared, by
   default all compiled templates are cleared regardless of their age.
   This function is for advanced use only, not normally needed.
  </para>
  <example>
   <title>clear_compiled_tpl()</title>
   <programlisting role="php">
<![CDATA[
<?php
// clear a specific template resource
$smarty->clear_compiled_tpl("index.tpl");

// clear entire compile directory
$smarty->clear_compiled_tpl();
?>
]]>
   </programlisting>
  </example>
 </refsect1>
</refentry>
<!-- 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
-->