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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="api.get.template.vars">
 <refnamediv>
  <refname>get_template_vars()</refname>
  <refpurpose>returns  assigned variable value(s)</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>array</type><methodname>get_template_vars</methodname>
   <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam>
  </methodsynopsis>
  <para>
   If no parameter
   is given, an array of all <link linkend="api.assign">assigned</link>
   variables are returned.
  </para>
  <example>
   <title>get_template_vars</title>
   <programlisting role="php">
<![CDATA[
<?php
// get assigned template var 'foo'
$myVar = $smarty->get_template_vars('foo');

// get all assigned template vars
$all_tpl_vars = $smarty->get_template_vars();

// take a look at them
print_r($all_tpl_vars);
?>
]]>
   </programlisting>
  </example>
  <para>
  See also <link linkend="api.assign"><varname>assign()</varname></link>,
  <link linkend="language.function.assign"><varname>{assign}</varname></link>,
  <link linkend="api.append"><varname>append()</varname></link>,
  <link linkend="api.clear.assign"><varname>clear_assign()</varname></link>,
  <link linkend="api.clear.all.assign"><varname>clear_all_assign()</varname></link>
  and
  <link linkend="api.get.config.vars"><varname>get_config_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
-->