<HTML
><HEAD
><TITLE
>Resources</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="Smarty Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Advanced Features"
HREF="advanced.features.html"><LINK
REL="PREVIOUS"
TITLE="Cache Handler Function"
HREF="section.template.cache.handler.func.html"><LINK
REL="NEXT"
TITLE="Extending Smarty With Plugins"
HREF="plugins.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Smarty Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="section.template.cache.handler.func.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 15. Advanced Features</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="plugins.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="template.resources"
></A
>Resources</H1
><P
> The templates may come from a variety of sources. When you
<A
HREF="api.display.html"
><TT
CLASS="varname"
>display()</TT
></A
> or
<A
HREF="api.fetch.html"
><TT
CLASS="varname"
>fetch()</TT
></A
>
a template, or when you include a template from within another template,
you supply a resource type, followed by the appropriate path and template
name. If a resource is not explicitly given the value of <A
HREF="variable.default.resource.type.html"
> <TT
CLASS="parameter"
><I
>$default_resource_type</I
></TT
></A
> is assumed.
</P
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="templates.from.template.dir"
></A
>Templates from $template_dir</H2
><P
> Templates from the <A
HREF="api.variables.html#variable.template.dir"
> <TT
CLASS="parameter"
><I
>$template_dir</I
></TT
></A
> do not require a template
resource, although you can use the <TT
CLASS="literal"
>file:</TT
> resource
for consistancy. Just supply the path to the template you want to use
relative to the <A
HREF="api.variables.html#variable.template.dir"
> <TT
CLASS="parameter"
><I
>$template_dir</I
></TT
></A
> root directory.
</P
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN7043"
></A
><P
><B
>Example 15-6. Using templates from the $template_dir</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">display</span><span style="color: #007700">(</span><span style="color: #DD0000">'index.tpl'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">display</span><span style="color: #007700">(</span><span style="color: #DD0000">'admin/menu.tpl'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">display</span><span style="color: #007700">(</span><span style="color: #DD0000">'file:admin/menu.tpl'</span><span style="color: #007700">); </span><span style="color: #FF8000">// same as one above<br /></span><span style="color: #0000BB">?></span>
</span>
</code></TD
></TR
></TABLE
><P
>From within a Smarty template</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="programlisting"
>{include file='index.tpl'}
{* below is same as above *}
{include file='file:index.tpl'}</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="templates.from.any.dir"
></A
>Templates from any directory</H2
><P
> Templates outside of the <A
HREF="api.variables.html#variable.template.dir"
> <TT
CLASS="parameter"
><I
>$template_dir</I
></TT
></A
>
require the <TT
CLASS="literal"
>file:</TT
> template resource type, followed by
the absolute path to the template.
</P
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN7054"
></A
><P
><B
>Example 15-7. Using templates from any directory</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">display</span><span style="color: #007700">(</span><span style="color: #DD0000">'file:/export/templates/index.tpl'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">display</span><span style="color: #007700">(</span><span style="color: #DD0000">'file:/path/to/my/templates/menu.tpl'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></TD
></TR
></TABLE
><P
> And from within a Smarty template:
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="programlisting"
>{include file='file:/usr/local/share/templates/navigation.tpl'}</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
><DIV
CLASS="sect3"
><H3
CLASS="sect3"
><A
NAME="templates.windows.filepath"
></A
>Windows Filepaths</H3
><P
> If you are using a Windows machine, filepaths usually include a
drive letter (C:) at the beginning of the pathname. Be sure to use
<TT
CLASS="literal"
>file:</TT
> in the path to avoid namespace conflicts and
get the desired results.
</P
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN7063"
></A
><P
><B
>Example 15-8. Using templates from windows file paths</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">display</span><span style="color: #007700">(</span><span style="color: #DD0000">'file:C:/export/templates/index.tpl'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">display</span><span style="color: #007700">(</span><span style="color: #DD0000">'file:F:/path/to/my/templates/menu.tpl'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></TD
></TR
></TABLE
><P
> And from within Smarty template:
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="programlisting"
>{include file='file:D:/usr/local/share/templates/navigation.tpl'}</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="templates.from.elsewhere"
></A
>Templates from other sources</H2
><P
> You can retrieve templates using whatever possible source you can
access with PHP: databases, sockets, LDAP, and so on. You do this
by writing resource plugin functions and registering them with
Smarty.
</P
><P
> See <A
HREF="plugins.resources.html"
>resource plugins</A
>
section for more information on the functions you are supposed
to provide.
</P
><DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>Note: </B
>
Note that you cannot override the built-in
<TT
CLASS="literal"
>file:</TT
> resource, but you can provide a resource
that fetches templates from the file system in some other way by
registering under another resource name.
</P
></BLOCKQUOTE
></DIV
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN7076"
></A
><P
><B
>Example 15-9. Using custom resources</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// put these function somewhere in your application<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">db_get_template </span><span style="color: #007700">(</span><span style="color: #0000BB">$tpl_name</span><span style="color: #007700">, &</span><span style="color: #0000BB">$tpl_source</span><span style="color: #007700">, &</span><span style="color: #0000BB">$smarty_obj</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #FF8000">// do database call here to fetch your template,<br /> // populating $tpl_source<br /> </span><span style="color: #0000BB">$sql </span><span style="color: #007700">= new </span><span style="color: #0000BB">SQL</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$sql</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">"select tpl_source<br /> from my_table<br /> where tpl_name='$tpl_name'"</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">$sql</span><span style="color: #007700">-></span><span style="color: #0000BB">num_rows</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$tpl_source </span><span style="color: #007700">= </span><span style="color: #0000BB">$sql</span><span style="color: #007700">-></span><span style="color: #0000BB">record</span><span style="color: #007700">[</span><span style="color: #DD0000">'tpl_source'</span><span style="color: #007700">];<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> } else {<br /> return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /> }<br />}<br /><br />function </span><span style="color: #0000BB">db_get_timestamp</span><span style="color: #007700">(</span><span style="color: #0000BB">$tpl_name</span><span style="color: #007700">, &</span><span style="color: #0000BB">$tpl_timestamp</span><span style="color: #007700">, &</span><span style="color: #0000BB">$smarty_obj</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #FF8000">// do database call here to populate $tpl_timestamp.<br /> </span><span style="color: #0000BB">$sql </span><span style="color: #007700">= new </span><span style="color: #0000BB">SQL</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$sql</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">"select tpl_timestamp<br /> from my_table<br /> where tpl_name='$tpl_name'"</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">$sql</span><span style="color: #007700">-></span><span style="color: #0000BB">num_rows</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$tpl_timestamp </span><span style="color: #007700">= </span><span style="color: #0000BB">$sql</span><span style="color: #007700">-></span><span style="color: #0000BB">record</span><span style="color: #007700">[</span><span style="color: #DD0000">'tpl_timestamp'</span><span style="color: #007700">];<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> } else {<br /> return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /> }<br />}<br /><br />function </span><span style="color: #0000BB">db_get_secure</span><span style="color: #007700">(</span><span style="color: #0000BB">$tpl_name</span><span style="color: #007700">, &</span><span style="color: #0000BB">$smarty_obj</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #FF8000">// assume all templates are secure<br /> </span><span style="color: #007700">return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br />}<br /><br />function </span><span style="color: #0000BB">db_get_trusted</span><span style="color: #007700">(</span><span style="color: #0000BB">$tpl_name</span><span style="color: #007700">, &</span><span style="color: #0000BB">$smarty_obj</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #FF8000">// not used for templates<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #FF8000">// register the resource name "db"<br /></span><span style="color: #0000BB">$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">register_resource</span><span style="color: #007700">(</span><span style="color: #DD0000">"db"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"db_get_template"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"db_get_timestamp"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"db_get_secure"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"db_get_trusted"</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// using resource from php script<br /></span><span style="color: #0000BB">$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">display</span><span style="color: #007700">(</span><span style="color: #DD0000">"db:index.tpl"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></TD
></TR
></TABLE
><P
> And from within Smarty template:
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="programlisting"
>{include file='db:/extras/navigation.tpl'}</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="default.template.handler.function"
></A
>Default template handler function</H2
><P
> You can specify a function that is used to retrieve template
contents in the event the template cannot be retrieved from its
resource. One use of this is to create templates that do not exist
on-the-fly.
</P
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN7084"
></A
><P
><B
>Example 15-10. Using the default template handler function</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// put this function somewhere in your application<br /><br /></span><span style="color: #007700">function </span><span style="color: #0000BB">make_template </span><span style="color: #007700">(</span><span style="color: #0000BB">$resource_type</span><span style="color: #007700">, </span><span style="color: #0000BB">$resource_name</span><span style="color: #007700">, &</span><span style="color: #0000BB">$template_source</span><span style="color: #007700">, &</span><span style="color: #0000BB">$template_timestamp</span><span style="color: #007700">,<br />&</span><span style="color: #0000BB">$smarty_obj</span><span style="color: #007700">)<br />{<br /> if( </span><span style="color: #0000BB">$resource_type </span><span style="color: #007700">== </span><span style="color: #DD0000">'file' </span><span style="color: #007700">) {<br /> if ( ! </span><span style="color: #0000BB">is_readable </span><span style="color: #007700">( </span><span style="color: #0000BB">$resource_name </span><span style="color: #007700">)) {<br /> </span><span style="color: #FF8000">// create the template file, return contents.<br /> </span><span style="color: #0000BB">$template_source </span><span style="color: #007700">= </span><span style="color: #DD0000">"This is a new template."</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$template_timestamp </span><span style="color: #007700">= </span><span style="color: #0000BB">time</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$smarty_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">_write_file</span><span style="color: #007700">(</span><span style="color: #0000BB">$resource_name</span><span style="color: #007700">,</span><span style="color: #0000BB">$template_source</span><span style="color: #007700">);<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> }<br /> } else {<br /> </span><span style="color: #FF8000">// not a file<br /> </span><span style="color: #007700">return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /> }<br />}<br /><br /></span><span style="color: #FF8000">// set the default handler<br /></span><span style="color: #0000BB">$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">default_template_handler_func </span><span style="color: #007700">= </span><span style="color: #DD0000">'make_template'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="section.template.cache.handler.func.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="plugins.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Cache Handler Function</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="advanced.features.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Extending Smarty With Plugins</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
