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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="api.display">
 <refnamediv>
  <refname>display()</refname>
  <refpurpose>displays the template</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>void</type><methodname>display</methodname>
   <methodparam><type>string</type><parameter>template</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter>
   </methodparam>
  </methodsynopsis>
  <para>
   This displays the template unlike
   <link linkend="api.fetch"><varname>fetch()</varname></link>.
   Supply a valid <link
   linkend="template.resources">template resource</link>
   type and path. As an optional second parameter, you can pass a
   <parameter>$cache id</parameter>, see the
   <link linkend="caching">caching section</link> for more information.
  </para>
  &parameter.compileid;
  <example>
   <title>display()</title>
   <programlisting role="php">
<![CDATA[
<?php
include(SMARTY_DIR.'Smarty.class.php');
$smarty = new Smarty();
$smarty->caching = true;

// only do db calls if cache doesn't exist
if(!$smarty->is_cached('index.tpl')) {

  // dummy up some data
  $address = "245 N 50th";
  $db_data = array(
               "City" => "Lincoln",
               "State" => "Nebraska",
               "Zip" => "68502"
             );

  $smarty->assign("Name","Fred");
  $smarty->assign("Address",$address);
  $smarty->assign('data', $db_data);

}

// display the output
$smarty->display('index.tpl');
?>
]]>
   </programlisting>
  </example>

  <example>
   <title>Other display() template resource examples</title>
     <para>
   Use the syntax for <link
   linkend="template.resources">template resources</link> to
   display files outside of the
   <link linkend="variable.template.dir">
   <parameter>$template_dir</parameter></link> directory.
  </para>
   <programlisting role="php">
<![CDATA[
<?php
// absolute filepath
$smarty->display('/usr/local/include/templates/header.tpl');

// absolute filepath (same thing)
$smarty->display('file:/usr/local/include/templates/header.tpl');

// windows absolute filepath (MUST use "file:" prefix)
$smarty->display('file:C:/www/pub/templates/header.tpl');

// include from template resource named "db"
$smarty->display('db:header.tpl');
?>
]]>
   </programlisting>
  </example>
  <para>
   See also <link linkend="api.fetch"><varname>fetch()</varname></link> and
   <link linkend="api.template.exists"><varname>template_exists()</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
-->