smarty/docs/en/language-snippets.ent

<!-- $Revision$ -->

<!ENTITY note.parameter.merge '<note>
 <title>Technical Note</title>
 <para>
  The <parameter>merge</parameter> parameter respects array keys, so if
  you merge two numerically indexed arrays, they may overwrite each other
  or result in non-sequential keys. This is unlike the PHP
  <ulink url="&url.php-manual;array_merge">
  <varname>array_merge()</varname></ulink> function
   which wipes out numerical keys and renumbers them.
 </para>
</note>'>

<!ENTITY note.parameter.function '<note>
 <title>Technical Note</title>
 <para>
  If the chosen <parameter>function</parameter> callback is of the form 
  <literal>array(&amp;$object, $method)</literal>, only one instance of the
  same class and with the same <literal>$method</literal> can be registered. The
  latest registered <parameter>function</parameter> callback will be used in 
  such a scenario.
 </para>
</note>'>

<!ENTITY parameter.compileid '<para>
 As an optional third parameter, you can pass a
 <parameter>$compile_id</parameter>.
 This is in the event that you want to compile different versions of
 the same template, such as having separate templates compiled
 for different languages. Another use for
 <parameter>$compile_id</parameter> is when you use more than one
 <link linkend="variable.template.dir"><parameter>$template_dir</parameter></link>
 but only one
 <link linkend="variable.compile.dir"><parameter>$compile_dir</parameter></link>.
 Set a separate <parameter>$compile_id</parameter> for each
 <link linkend="variable.template.dir"><parameter>$template_dir</parameter></link>,
 otherwise templates of the same name will overwrite each other. You can
 also set the <link linkend="variable.compile.id">
 <parameter>$compile_id</parameter></link> variable once instead of passing
  this to each call to this function.
</para>'>

<!ENTITY api.register.snippet '<para>
   The php-function callback <parameter>function</parameter> can be either:
   <itemizedlist>
       <listitem><para>
       A string containing the function <parameter>name</parameter>
       </para></listitem>

       <listitem><para>
       An array of the form <literal>array(&amp;$object, $method)</literal> with
       <literal>&amp;$object</literal> being a reference to an
       object and <literal>$method</literal> being a string
       containing the method-name
       </para></listitem>

       <listitem><para>
       An array of the form
       <literal>array($class, $method)</literal> with
       <literal>$class</literal> being the class name and
       <literal>$method</literal> being a method of the class.
       </para></listitem>
   </itemizedlist>
  </para>'>