smarty/docs/en/programmers/api-functions/api-clear-config.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="api.clear.config">
 <refnamediv>
  <refname>clear_config()</refname>
  <refpurpose>clears assigned config variables</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>void</type><methodname>clear_config</methodname>
   <methodparam choice="opt"><type>string</type><parameter>var</parameter></methodparam>
  </methodsynopsis>
  <para>
   This clears all assigned
   <link linkend="language.config.variables">config variables</link>.
   If a variable name is
   supplied, only that variable is cleared.
  </para>
  <example>
   <title>clear_config()</title>
   <programlisting role="php">
<![CDATA[
<?php
// clear all assigned config variables.
$smarty->clear_config();

// clear one variable
$smarty->clear_config('foobar');
?>
]]>
   </programlisting>
  </example>
  <para>
  See also
  <link linkend="api.get.config.vars">get_config_vars()</link>,
  <link linkend="language.config.variables">config variables</link>,
  <link linkend="config.files">config files</link>,
  <link linkend="language.function.config.load">{config_load}</link>,
  <link linkend="api.config.load">config_load()</link>
  and
  <link linkend="api.clear.assign">clear_assign()</link>
  </para>
 </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
-->