smarty/docs/en/programmers/api-functions/api-append.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="api.append">
 <refnamediv>
  <refname>append()</refname>
  <refpurpose>append an element to an assigned array</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>void</type><methodname>append</methodname>
   <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>void</type><methodname>append</methodname>
   <methodparam><type>string</type><parameter>varname</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>merge</parameter></methodparam>
  </methodsynopsis>
  <para>
If you append
   to a string value, it is converted to an array value and then
   appended to. You can explicitly pass name/value pairs, or associative
   arrays containing the name/value pairs. If you pass the optional third
   parameter of true, the value will be merged with the current array
   instead of appended.
  </para>
  &note.parameter.merge;
  <example>
   <title>append</title>
   <programlisting role="php">
<![CDATA[
<?php
// passing name/value pairs
$smarty->append("Name", "Fred");
$smarty->append("Address", $address);

// passing an associative array
$smarty->append(array('city' => 'Lincoln', 'state' => 'Nebraska'));
?>
]]>
   </programlisting>
  </example>
  <para>See also
  <link linkend="api.append.by.ref">append_by_ref()</link>,
  <link linkend="api.assign">assign()</link>
  and
  <link linkend="api.get.template.vars">get_template_vars()</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
-->