smarty/docs/en/designers/language-variables/language-assigned-variables.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="language.assigned.variables">
 <title>Variables assigned from PHP</title>
 <para>
  Variables that are
  <link linkend="api.assign">assigned</link> from PHP are referenced by preceding them with
  a dollar sign <literal>$</literal>. Variables assigned from within a
  template with the <link linkend="language.function.assign">{assign}</link>
  function are also displayed this way.
 </para>
 <example>
  <title>assigned variables</title>
   <para> php script</para>
   <programlisting role="php">
<![CDATA[
<?php

$smarty = new Smarty;

$smarty->assign('firstname', 'Doug');
$smarty->assign('lastname', 'Evans');
$smarty->assign('meetingPlace', 'New York');

$smarty->display('index.tpl');

?>
]]>
     </programlisting>
     <para>
      where the content of index.tpl is:
     </para>
<programlisting>
<![CDATA[
Hello {$firstname} {$lastname}, glad to see you can make it.
<br />
{* this will not work as $vars are case sensitive *}
This weeks meeting is in {$meetingplace}.
{* this will work *}
This weeks meeting is in {$meetingPlace}.
]]>
   </programlisting>

  <para>
   This will output:
  </para>
  <screen>
<![CDATA[
Hello Doug Evans, glad to see you can make it.
<br />
This weeks meeting is in .
This weeks meeting is in New York.
]]>
  </screen>
 </example>
 <sect2 id="language.variables.assoc.arrays">
  <title>Associative arrays</title>
  <para>
   You can also reference associative array variables that are
   assigned from PHP by specifying the key after the '.' (period)
   symbol.
  </para>
  <example>
   <title>accessing associative array variables</title>
   <programlisting role="php">
<![CDATA[
<?php
$smarty->assign('Contacts',
    array('fax' => '555-222-9876',
          'email' => 'zaphod@slartibartfast.com',
          'phone' => array('home' => '555-444-3333',
                           'cell' => '555-111-1234')
                           )
         );
$smarty->display('index.tpl');
?>
]]>
   </programlisting>
   <para>
    where the content of index.tpl is:
   </para>
   <programlisting>
<![CDATA[
{$Contacts.fax}<br />
{$Contacts.email}<br />
{* you can print arrays of arrays as well *}
{$Contacts.phone.home}<br />
{$Contacts.phone.cell}<br />
]]>
   </programlisting>
   <para>
    this will output:
   </para>
   <screen>
<![CDATA[
555-222-9876<br />
zaphod@slartibartfast.com<br />
555-444-3333<br />
555-111-1234<br />
]]>
   </screen>
  </example>
 </sect2>
 <sect2 id="language.variables.array.indexes">
  <title>Array indexes</title>
  <para>
   You can reference arrays by their index, much like native PHP
   syntax.
  </para>
  <example>
   <title>accessing arrays by index</title>
   <programlisting role="php">
<![CDATA[
<?php
$smarty->assign('Contacts', array(
                           '555-222-9876',
                           'zaphod@slartibartfast.com',
                            array('555-444-3333',
                                  '555-111-1234')
                            ));
$smarty->display('index.tpl');
?>
]]>
   </programlisting>
   <para>
    where index.tpl is:
   </para>
   <programlisting>
<![CDATA[
{$Contacts[0]}<br />
{$Contacts[1]}<br />
{* you can print arrays of arrays as well *}
{$Contacts[2][0]}<br />
{$Contacts[2][1]}<br />
]]>
   </programlisting>
   <para>
    This will output:
   </para>
   <screen>
<![CDATA[
555-222-9876<br />
zaphod@slartibartfast.com<br />
555-444-3333<br />
555-111-1234<br />
]]>
   </screen>
  </example>
 </sect2>
 <sect2 id="language.variables.objects">
  <title>Objects</title>
  <para>
   Properties of <link linkend="advanced.features.objects">objects</link>
   assigned from PHP can be referenced by specifying the property
   name after the '-&gt;' symbol.
  </para>
  <example>
   <title>accessing object properties</title>
   <programlisting>
<![CDATA[
name: {$person->name}<br />
email: {$person->email}<br />
]]>
   </programlisting>
   <para>
    this will output:
   </para>
   <screen>
<![CDATA[
name: Zaphod Beeblebrox<br />
email: zaphod@slartibartfast.com<br />
]]>
   </screen>
  </example>
 </sect2>
</sect1>

<!-- 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
-->