smarty/docs/en/programmers/api-functions/api-get-config-vars.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="api.get.config.vars">
 <refnamediv>
  <refname>get_config_vars()</refname>
  <refpurpose>returns the given loaded config variable value</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>array</type><methodname>get_config_vars</methodname>
   <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam>
  </methodsynopsis>
  <para>
   If no parameter is given, an array of all loaded
   <link linkend="language.config.variables">config variables</link>
   is returned.
  </para>
  <example>
   <title>get_config_vars()</title>
   <programlisting role="php">
<![CDATA[
<?php

// get loaded config template var #foo#
$myVar = $smarty->get_config_vars('foo');

// get all loaded config template vars
$all_config_vars = $smarty->get_config_vars();

// take a look at them
print_r($all_config_vars);
?>
]]>
   </programlisting>
  </example>
  <para>
   See also
  <link linkend="api.clear.config"><varname>clear_config()</varname></link>,
   <link linkend="language.function.config.load"><varname>{config_load}</varname></link>,
  <link linkend="api.config.load"><varname>config_load()</varname></link>
   and
  <link linkend="api.get.template.vars"><varname>get_template_vars()</varname></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
-->