smarty-php/smarty
1
0
Fork 0
mirror of https://github.com/smarty-php/smarty.git synced 2025-08-04 02:14:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

*** empty log message ***

Browse Source
This commit is contained in:
andrey
2002-02-20 21:11:48 +00:00
parent edcc3b7d8e
commit eb2e03ae9b
1 changed files with 104 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
docs.sgml
View File

@@ -330,6 +330,15 @@ require_once(SMARTY_DIR."Smarty.class.php");
the web server document root. the web server document root.
</para> </para>
</sect2> </sect2>
<sect2 id="setting.plugins.dir">
<title>$plugins_dir</title>
<para>
This is the directory where Smarty will look for the plugins that
it needs. The directory must be relative to the directory where
Smarty itself is installed. Default is "plugins". There can be
only one plugins directory.
</para>
</sect2>
<sect2 id="setting.debugging"> <sect2 id="setting.debugging">
<title>$debugging</title> <title>$debugging</title>
<para> <para>
@@ -1561,51 +1570,51 @@ $smarty->display("file:F:/path/to/my/templates/menu.tpl");
// put these function somewhere in your application // put these function somewhere in your application
function db_get_template ($tpl_name, &amp;tpl_source, &amp;$smarty_obj) function db_get_template ($tpl_name, &amp;tpl_source, &amp;$smarty_obj)
{ {
// do database call here to fetch your template, // do database call here to fetch your template,
// populating $tpl_source // populating $tpl_source
$sql = new SQL; $sql = new SQL;
$sql->query("select tpl_source $sql->query("select tpl_source
from my_table from my_table
where tpl_name='$tpl_name'"); where tpl_name='$tpl_name'");
if ($sql->num_rows) { if ($sql->num_rows) {
$tpl_source = $sql->record['tpl_source']; $tpl_source = $sql->record['tpl_source'];
return true; return true;
} else { } else {
return false; return false;
} }
} }
function db_get_timestamp($tpl_name, &$tpl_timestamp, &$smarty_obj) function db_get_timestamp($tpl_name, &$tpl_timestamp, &$smarty_obj)
{ {
// do database call here to populate $tpl_timestamp. // do database call here to populate $tpl_timestamp.
$sql = new SQL; $sql = new SQL;
$sql->query("select tpl_timestamp $sql->query("select tpl_timestamp
from my_table from my_table
where tpl_name='$tpl_name'"); where tpl_name='$tpl_name'");
if ($sql->num_rows) { if ($sql->num_rows) {
$tpl_timestamp = $sql->record['tpl_timestamp']; $tpl_timestamp = $sql->record['tpl_timestamp'];
return true; return true;
} else { } else {
return false; return false;
} }
} }
function db_get_secure($tpl_name, &$smarty_obj) function db_get_secure($tpl_name, &$smarty_obj)
{ {
// assume all templates are secure // assume all templates are secure
return true; return true;
} }
function db_get_trusted($tpl_name, &$smarty_obj) function db_get_trusted($tpl_name, &$smarty_obj)
{ {
// not used // not used
} }
// register the resource name "db" // register the resource name "db"
$smarty->register_resource("db", array("db_get_template", $smarty->register_resource("db", array("db_get_template",
"db_get_timestamp", "db_get_timestamp",
"db_get_secure", "db_get_secure",
"db_get_trusted")); "db_get_trusted"));
// using resource from php script // using resource from php script
$smarty->display("db:index.tpl"); $smarty->display("db:index.tpl");
@@ -6118,17 +6127,75 @@ s m o k e r s a r e p. . .
<chapter id="chapter.plugins"> <chapter id="chapter.plugins">
<title>Plugins</title> <title>Plugins</title>
<para> <para>
Version 2.0 introduced the plugin architecture that is used
for almost all the customizable functionality of Smarty. This includes:
<simplelist>
<member>functions</member>
<member>modifiers</member>
<member>compiler functions</member>
<member>prefilters</member>
<member>postfilters</member>
<member>resources</member>
<member>inserts</member>
</simplelist>
With the exception of resources, backwards compatibility with the old
way of registering handler functions via register_* API is preserved. If
you did not use the API but instead modified the class variables
<literal>$custom_funcs</literal>, <literal>$custom_mods</literal>, and
other ones directly, then you will need to adjust your scripts to either
use the API or convert your custom functionality into plugins.
</para> </para>
<sect1> <sect1>
<title>How Plugins Work</title> <title>How Plugins Work</title>
<para> <para>
</para> Plugins are always loaded on demand. Only the specific modifiers,
functions, resources, etc invoked in the templates or PHP scripts will
be loaded. Moreover, each plugin is loaded only once, even if you have
several different instances of Smarty running within the same request.
</para>
<para>
Pre/post-filters are a bit of a special case. If a pre/post-filter
plugin is found in the plugins directory, it will always be loaded
because these filters are never explicitly mentioned in the template
language.
</para>
<sect2>
<title>Naming Conventions</title>
<para>
Plugin files and functions must follow a very specific naming
convention in order to be located by Smarty.
</para>
<para>
The plugin files must be named as follows:
<blockquote>
<em>type</em>.<em>name</em>.php
</blockquote>
</para>
<para>
<literal>type<literal> is one of these plugin types:
<simplelist>
<member>function</member>
<member>modifier</member>
<member>compiler</member>
<member>prefilter</member>
<member>postfilter</member>
<member>resource</member>
<member>insert</member>
</simplelist>
</para>
<para>
<literal>name</literal> should be a valid identifier (letters,
numbers, and underscores only).
</para>
</sect2>
</sect1> </sect1>
<sect1> <sect1>
<title>Making Custom Plugins</title> <title>Making Custom Plugins</title>
<para> <para>
</para> </para>
<sect2 id=section.plugins.custom.functions><title>custom functions</title> <sect2 id="section.plugins.functions"><title>functions</title>
<para> <para>
</para> </para>
<example> <example>
@@ -6138,7 +6205,7 @@ s m o k e r s a r e p. . .
</programlisting> </programlisting>
</example> </example>
</sect2> </sect2>
<sect2 id=section.plugins.modifiers><title>modifiers</title> <sect2 id="section.plugins.modifiers"><title>modifiers</title>
<para> <para>
</para> </para>
<example> <example>
@@ -6148,7 +6215,7 @@ s m o k e r s a r e p. . .
</programlisting> </programlisting>
</example> </example>
</sect2> </sect2>
<sect2 id=section.plugins.compiler.functions><title>compiler functions</title> <sect2 id="section.plugins.compiler.functions"><title>compiler functions</title>
<para> <para>
</para> </para>
<example> <example>
@@ -6158,7 +6225,7 @@ s m o k e r s a r e p. . .
</programlisting> </programlisting>
</example> </example>
</sect2> </sect2>
<sect2 id=section.plugins.prefilters><title>prefilters</title> <sect2 id="section.plugins.prefilters"><title>prefilters</title>
<para> <para>
</para> </para>
<example> <example>
@@ -6168,7 +6235,7 @@ s m o k e r s a r e p. . .
</programlisting> </programlisting>
</example> </example>
</sect2> </sect2>
<sect2 id=section.plugins.postfilters><title>postfilters</title> <sect2 id="section.plugins.postfilters"><title>postfilters</title>
<para> <para>
</para> </para>
<example> <example>
@@ -6178,17 +6245,17 @@ s m o k e r s a r e p. . .
</programlisting> </programlisting>
</example> </example>
</sect2> </sect2>
<sect2 id=section.plugins.template.resources><title>template resources</title> <sect2 id="section.plugins.resources"><title>template resources</title>
<para> <para>
</para> </para>
<example> <example>
<title>template resource plugin</title> <title>resource plugin</title>
<programlisting> <programlisting>
</programlisting> </programlisting>
</example> </example>
</sect2> </sect2>
<sect2 id=section.plugins.inserts><title>inserts</title> <sect2 id="section.plugins.inserts"><title>inserts</title>
<para> <para>
</para> </para>
<example> <example>