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

WS, and switched to methodsynppsis

Browse Source
This commit is contained in:
didou
2004-04-18 19:22:55 +00:00
parent 2e4e68462c
commit bdafb7ea6c
38 changed files with 1165 additions and 1000 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/en/programmers/api-functions/api-append-by-ref.xml
View File

@@ -1,20 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.append.by.ref"> <refentry id="api.append.by.ref">
<title>append_by_ref</title> <refnamediv>
<funcsynopsis> <refname>append_by_ref</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>append_by_ref</function></funcdef> </refnamediv>
<paramdef>string <parameter>varname</parameter></paramdef> <refsect1>
<paramdef>mixed <parameter>var</parameter></paramdef> <title />
</funcprototype> <methodsynopsis>
<funcprototype> <type>void</type><methodname>append_by_ref</methodname>
<funcdef>void <function>append_by_ref</function></funcdef> <methodparam><type>string</type><parameter>varname</parameter></methodparam>
<paramdef>string <parameter>varname</parameter></paramdef> <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
<paramdef>mixed <parameter>var</parameter></paramdef> <methodparam choice="opt"><type>bool</type><parameter>merge</parameter></methodparam>
<paramdef>boolean <parameter>merge</parameter></paramdef> </methodsynopsis>
</funcprototype>
</funcsynopsis>
<para> <para>
This is used to append values to the templates by reference. This is used to append values to the templates by reference.
If you append a variable by reference then change its If you append a variable by reference then change its
@@ -27,10 +25,10 @@
<note> <note>
<title>Technical Note</title> <title>Technical Note</title>
<para> <para>
The merge parameter respects array keys, so if you merge two The <parameter>merge</parameter> parameter respects array keys, so if
numerically indexed arrays, they may overwrite each other or result in you merge two numerically indexed arrays, they may overwrite each other
non-sequential keys. This is unlike the array_merge() function of PHP or result in non-sequential keys. This is unlike the array_merge() function
which wipes out numerical keys and renumbers them. of PHP which wipes out numerical keys and renumbers them.
</para> </para>
</note> </note>
<example> <example>
@@ -45,7 +43,8 @@ $smarty->append_by_ref("Address", $address);
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

39
docs/en/programmers/api-functions/api-append.xml
View File

@@ -1,24 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.append"> <refentry id="api.append">
<title>append</title> <refnamediv>
<funcsynopsis> <refname>append</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>append</function></funcdef> </refnamediv>
<paramdef>mixed <parameter>var</parameter></paramdef> <refsect1>
</funcprototype> <title />
<funcprototype> <methodsynopsis>
<funcdef>void <function>append</function></funcdef> <type>void</type><methodname>append</methodname>
<paramdef>string <parameter>varname</parameter></paramdef> <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
<paramdef>mixed <parameter>var</parameter></paramdef> </methodsynopsis>
</funcprototype> <methodsynopsis>
<funcprototype> <type>void</type><methodname>append</methodname>
<funcdef>void <function>append</function></funcdef> <methodparam><type>string</type><parameter>varname</parameter></methodparam>
<paramdef>string <parameter>varname</parameter></paramdef> <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
<paramdef>mixed <parameter>var</parameter></paramdef> <methodparam choice="opt"><type>bool</type><parameter>merge</parameter></methodparam>
<paramdef>boolean <parameter>merge</parameter></paramdef> </methodsynopsis>
</funcprototype>
</funcsynopsis>
<para> <para>
This is used to append an element to an assigned array. If you append This is used to append an element to an assigned array. If you append
to a string value, it is converted to an array value and then to a string value, it is converted to an array value and then
@@ -51,7 +49,8 @@ $smarty->append(array("city" => "Lincoln","state" => "Nebraska"));
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

24
docs/en/programmers/api-functions/api-assign-by-ref.xml
View File

@@ -1,14 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.assign.by.ref"> <refentry id="api.assign.by.ref">
<title>assign_by_ref</title> <refnamediv>
<funcsynopsis> <refname>assign_by_ref</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>assign_by_ref</function></funcdef> </refnamediv>
<paramdef>string <parameter>varname</parameter></paramdef> <refsect1>
<paramdef>mixed <parameter>var</parameter></paramdef> <title />
</funcprototype> <methodsynopsis>
</funcsynopsis> <type>void</type><methodname>assign_by_ref</methodname>
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
</methodsynopsis>
<para> <para>
This is used to assign values to the templates by reference instead of This is used to assign values to the templates by reference instead of
making a copy. See the PHP manual on variable referencing for an explanation. making a copy. See the PHP manual on variable referencing for an explanation.
@@ -36,7 +39,8 @@ $smarty->assign_by_ref('Address', $address);
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

32
docs/en/programmers/api-functions/api-assign.xml
View File

@@ -1,18 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.assign"> <refentry id="api.assign">
<title>assign</title> <refnamediv>
<funcsynopsis> <refname>assign</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>assign</function></funcdef> </refnamediv>
<paramdef>mixed <parameter>var</parameter></paramdef> <refsect1>
</funcprototype> <title />
<funcprototype> <methodsynopsis>
<funcdef>void <function>assign</function></funcdef> <type>void</type><methodname>assign</methodname>
<paramdef>string <parameter>varname</parameter></paramdef> <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
<paramdef>mixed <parameter>var</parameter></paramdef> </methodsynopsis>
</funcprototype> <methodsynopsis>
</funcsynopsis> <type>void</type><methodname>assign</methodname>
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
</methodsynopsis>
<para> <para>
This is used to assign values to the templates. You can This is used to assign values to the templates. You can
explicitly pass name/value pairs, or associative arrays explicitly pass name/value pairs, or associative arrays
@@ -33,7 +36,8 @@ $smarty->assign(array("city" => "Lincoln", "state" => "Nebraska"));
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-clear-all-assign.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.clear.all.assign"> <refentry id="api.clear.all.assign">
<title>clear_all_assign</title> <refnamediv>
<funcsynopsis> <refname>clear_all_assign</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>clear_all_assign</function></funcdef> </refnamediv>
<paramdef><parameter></parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>clear_all_assign</methodname>
<void />
</methodsynopsis>
<para> <para>
This clears the values of all assigned variables. This clears the values of all assigned variables.
</para> </para>
@@ -22,7 +25,8 @@ $smarty->clear_all_assign();
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-clear-all-cache.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.clear.all.cache"> <refentry id="api.clear.all.cache">
<title>clear_all_cache</title> <refnamediv>
<funcsynopsis> <refname>clear_all_cache</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>clear_all_cache</function></funcdef> </refnamediv>
<paramdef>int <parameter>expire time</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>clear_all_cache</methodname>
<methodparam choice="opt"><type>int</type><parameter>expire_time</parameter></methodparam>
</methodsynopsis>
<para> <para>
This clears the entire template cache. As an optional This clears the entire template cache. As an optional
parameter, you can supply a minimum age in seconds the cache parameter, you can supply a minimum age in seconds the cache
@@ -24,7 +27,8 @@ $smarty->clear_all_cache();
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-clear-assign.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.clear.assign"> <refentry id="api.clear.assign">
<title>clear_assign</title> <refnamediv>
<funcsynopsis> <refname>clear_assign</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>clear_assign</function></funcdef> </refnamediv>
<paramdef>string <parameter>var</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>clear_assign</methodname>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
</methodsynopsis>
<para> <para>
This clears the value of an assigned variable. This This clears the value of an assigned variable. This
can be a single value, or an array of values. can be a single value, or an array of values.
@@ -26,7 +29,8 @@ $smarty->clear_assign(array("Name","Address","Zip"));
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

31
docs/en/programmers/api-functions/api-clear-cache.xml
View File

@@ -1,20 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.clear.cache"> <refentry id="api.clear.cache">
<title>clear_cache</title> <refnamediv>
<refname>clear_cache</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title />
<methodsynopsis> <methodsynopsis>
<type>void</type><methodname>clear_cache</methodname> <type>void</type><methodname>clear_cache</methodname>
<methodparam choice="opt"><type>string</type><parameter>template</parameter></methodparam> <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>cache_id</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>compile id</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>expire time</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>expire_time</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
<para> <para>
This clears the cache for a specific template. If you have This clears the cache for a specific <parameter>template</parameter>.
multiple caches for this template, you can clear a specific If you have multiple caches for this template, you can clear a specific
cache by supplying the cache id as the second parameter. You cache by supplying the <parameter>cache_id</parameter> as the second
can also pass a compile id as a third parameter. You can "group" parameter.
templates together so they can be removed as a group. See the You can also pass a <parameter>compile_id</parameter> as a third parameter.
You can "group" templates together so they can be removed as a group. See the
<link linkend="caching">caching section</link> for more <link linkend="caching">caching section</link> for more
information. As an optional fourth parameter, you can supply a information. As an optional fourth parameter, you can supply a
minimum age in seconds the cache file must be before it will minimum age in seconds the cache file must be before it will
@@ -34,7 +40,8 @@ $smarty->clear_cache("index.tpl","CACHEID");
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

12
docs/en/programmers/api-functions/api-clear-compiled-tpl.xml
View File

@@ -1,7 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.clear.compiled.tpl"> <refentry id="api.clear.compiled.tpl">
<title>clear_compiled_tpl</title> <refnamediv>
<refname>clear_compiled_tpl</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title />
<methodsynopsis> <methodsynopsis>
<type>void</type><methodname>clear_compiled_tpl</methodname> <type>void</type><methodname>clear_compiled_tpl</methodname>
<methodparam choice="opt"><type>string</type><parameter>tpl_file</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>tpl_file</parameter></methodparam>
@@ -31,7 +36,8 @@ $smarty->clear_compiled_tpl();
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

12
docs/en/programmers/api-functions/api-clear-config.xml
View File

@@ -1,7 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.clear.config"> <refentry id="api.clear.config">
<title>clear_config</title> <refnamediv>
<refname>clear_config</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title />
<methodsynopsis> <methodsynopsis>
<type>void</type><methodname>clear_config</methodname> <type>void</type><methodname>clear_config</methodname>
<methodparam choice="opt"><type>string</type><parameter>var</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>var</parameter></methodparam>
@@ -24,7 +29,8 @@ $smarty->clear_config('foobar');
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

16
docs/en/programmers/api-functions/api-config-load.xml
View File

@@ -1,15 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.config.load"> <refentry id="api.config.load">
<title>config_load</title> <refnamediv>
<refname>config_load</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title />
<methodsynopsis> <methodsynopsis>
<type>void</type><methodname>config_load</methodname> <type>void</type><methodname>config_load</methodname>
<methodparam><type>string</type><parameter>file</parameter></methodparam> <methodparam><type>string</type><parameter>file</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>section</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>section</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
<para> <para>
This loads config file data and assigns it to the template. This This loads config <parameter>file</parameter> data and assigns it to
works identical to the template <link the template. This works identical to the template <link
linkend="language.function.config.load">config_load</link> linkend="language.function.config.load">config_load</link>
function. function.
</para> </para>
@@ -38,7 +43,8 @@ $smarty->config_load('my.conf','foobar');
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

21
docs/en/programmers/api-functions/api-display.xml
View File

@@ -1,7 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.display"> <refentry id="api.display">
<title>display</title> <refnamediv>
<refname>display</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title />
<methodsynopsis> <methodsynopsis>
<type>void</type><methodname>display</methodname> <type>void</type><methodname>display</methodname>
<methodparam><type>string</type><parameter>template</parameter></methodparam> <methodparam><type>string</type><parameter>template</parameter></methodparam>
@@ -23,9 +28,8 @@
use more than one $template_dir but only one $compile_dir. Set use more than one $template_dir but only one $compile_dir. Set
a separate compile_id for each $template_dir, otherwise a separate compile_id for each $template_dir, otherwise
templates of the same name will overwrite each other. You can templates of the same name will overwrite each other. You can
also set the <link also set the <link linkend="variable.compile.id">$compile_id</link>
linkend="variable.compile.id">$compile_id</link> variable once variable once instead of passing this to each call to display().
instead of passing this to each call to display().
</para> </para>
<example> <example>
<title>display</title> <title>display</title>
@@ -37,8 +41,7 @@ $smarty = new Smarty;
$smarty->caching = true; $smarty->caching = true;
// only do db calls if cache doesn't exist // only do db calls if cache doesn't exist
if(!$smarty->is_cached("index.tpl")) if(!$smarty->is_cached("index.tpl")) {
{
// dummy up some data // dummy up some data
$address = "245 N 50th"; $address = "245 N 50th";
@@ -85,8 +88,8 @@ $smarty->display("db:header.tpl");
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</refsect1>
</sect1> </refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

17
docs/en/programmers/api-functions/api-fetch.xml
View File

@@ -1,7 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.fetch"> <refentry id="api.fetch">
<title>fetch</title> <refnamediv>
<refname>fetch</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title />
<methodsynopsis> <methodsynopsis>
<type>string</type><methodname>fetch</methodname> <type>string</type><methodname>fetch</methodname>
<methodparam><type>string</type><parameter>template</parameter></methodparam> <methodparam><type>string</type><parameter>template</parameter></methodparam>
@@ -28,6 +33,7 @@
linkend="variable.compile.id">$compile_id</link> variable once linkend="variable.compile.id">$compile_id</link> variable once
instead of passing this to each call to fetch(). instead of passing this to each call to fetch().
</para> </para>
<para>
<example> <example>
<title>fetch</title> <title>fetch</title>
<programlisting role="php"> <programlisting role="php">
@@ -39,8 +45,7 @@ $smarty = new Smarty;
$smarty->caching = true; $smarty->caching = true;
// only do db calls if cache doesn't exist // only do db calls if cache doesn't exist
if(!$smarty->is_cached("index.tpl")) if(!$smarty->is_cached("index.tpl")) {
{
// dummy up some data // dummy up some data
$address = "245 N 50th"; $address = "245 N 50th";
@@ -66,7 +71,9 @@ echo $output;
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

12
docs/en/programmers/api-functions/api-get-config-vars.xml
View File

@@ -1,7 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.get.config.vars"> <refentry id="api.get.config.vars">
<title>get_config_vars</title> <refnamediv>
<refname>get_config_vars</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title />
<methodsynopsis> <methodsynopsis>
<type>array</type><methodname>get_config_vars</methodname> <type>array</type><methodname>get_config_vars</methodname>
<methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam>
@@ -27,7 +32,8 @@ print_r($config_vars);
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

25
docs/en/programmers/api-functions/api-get-registered-object.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.get.registered.object"> <refentry id="api.get.registered.object">
<title>get_registered_object</title> <refnamediv>
<funcsynopsis> <refname>get_registered_object</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>array <function>get_registered_object</function></funcdef> </refnamediv>
<paramdef>string <parameter>object_name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>array</type><methodname>get_registered_object</methodname>
<methodparam><type>string</type><parameter>object_name</parameter></methodparam>
</methodsynopsis>
<para> <para>
This returns a reference to a registered object. This is useful This returns a reference to a registered object. This is useful
from within a custom function when you need direct access to a from within a custom function when you need direct access to a
@@ -18,7 +21,8 @@
<programlisting role="php"> <programlisting role="php">
<![CDATA[ <![CDATA[
<?php <?php
function smarty_block_foo($params, &$smarty) { function smarty_block_foo($params, &$smarty)
{
if (isset($params['object'])) { if (isset($params['object'])) {
// get reference to registered object // get reference to registered object
$obj_ref = &$smarty->get_registered_object($params['object']); $obj_ref = &$smarty->get_registered_object($params['object']);
@@ -29,7 +33,8 @@ function smarty_block_foo($params, &$smarty) {
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

12
docs/en/programmers/api-functions/api-get-template-vars.xml
View File

@@ -1,7 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.get.template.vars"> <refentry id="api.get.template.vars">
<title>get_template_vars</title> <refnamediv>
<refname>get_template_vars</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title />
<methodsynopsis> <methodsynopsis>
<type>array</type><methodname>get_template_vars</methodname> <type>array</type><methodname>get_template_vars</methodname>
<methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam>
@@ -27,7 +32,8 @@ print_r($tpl_vars);
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

26
docs/en/programmers/api-functions/api-is-cached.xml
View File

@@ -1,16 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.is.cached"> <refentry id="api.is.cached">
<title>is_cached</title> <refnamediv>
<funcsynopsis> <refname>is_cached</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>boolean <function>is_cached</function></funcdef> </refnamediv>
<paramdef>string <parameter>template</parameter></paramdef> <refsect1>
<paramdef>[string <parameter>cache_id</parameter>]</paramdef> <title />
</funcprototype> <methodsynopsis>
</funcsynopsis> <type>bool</type><methodname>is_cached</methodname>
<methodparam><type>string</type><parameter>template</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>cache_id</parameter></methodparam>
</methodsynopsis>
<para> <para>
This returns true if there is a valid cache for this template. This returns &true; if there is a valid cache for this template.
This only works if <link This only works if <link
linkend="variable.caching">caching</link> is set to true. linkend="variable.caching">caching</link> is set to true.
</para> </para>
@@ -50,7 +53,8 @@ $smarty->display("index.tpl","FrontPage");
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

24
docs/en/programmers/api-functions/api-load-filter.xml
View File

@@ -1,14 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.load.filter"> <refentry id="api.load.filter">
<title>load_filter</title> <refnamediv>
<funcsynopsis> <refname>load_filter</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>load_filter</function></funcdef> </refnamediv>
<paramdef>string <parameter>type</parameter></paramdef> <refsect1>
<paramdef>string <parameter>name</parameter></paramdef> <title />
</funcprototype> <methodsynopsis>
</funcsynopsis> <type>void</type><methodname>load_filter</methodname>
<methodparam><type>string</type><parameter>type</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para> <para>
This function can be used to load a filter plugin. The first This function can be used to load a filter plugin. The first
argument specifies the type of the filter to load and can be one argument specifies the type of the filter to load and can be one
@@ -27,7 +30,8 @@ $smarty->load_filter('output', 'compress'); // load output filter named 'compres
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

37
docs/en/programmers/api-functions/api-register-block.xml
View File

@@ -1,22 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.register.block"> <refentry id="api.register.block">
<title>register_block</title> <refnamediv>
<funcsynopsis> <refname>register_block</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>register_block</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
<paramdef>mixed <parameter>impl</parameter></paramdef> <title />
<paramdef>bool <parameter>cacheable</parameter></paramdef> <methodsynopsis>
<paramdef>array or null <parameter>cache_attrs</parameter></paramdef> <type>void</type><methodname>register_block</methodname>
</funcprototype> <methodparam><type>string</type><parameter>name</parameter></methodparam>
</funcsynopsis> <methodparam><type>mixed</type><parameter>impl</parameter></methodparam>
<methodparam><type>bool</type><parameter>cacheable</parameter></methodparam>
<methodparam><type>mixed</type><parameter>cache_attrs</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically register block functions plugins. Use this to dynamically register block functions plugins.
Pass in the block function name, followed by the PHP Pass in the block function name, followed by the PHP
function callback that implements it. function callback that implements it.
</para> </para>
<para> <para>
The php-function callback <parameter>impl</parameter> can be either (a) a string The php-function callback <parameter>impl</parameter> can be either (a) a string
containing the function name or (b) an array of the form containing the function name or (b) an array of the form
@@ -30,7 +32,10 @@
class. class.
</para> </para>
<para> <para>
<parameter>$cacheable</parameter> and <parameter>$cache_attrs</parameter> can be omitted in most cases. See <link linkend="caching.cacheable">Controlling Cacheability of Plugins' Output</link> on how to use them properly. <parameter>cacheable</parameter> and <parameter>cache_attrs</parameter>
can be omitted in most cases. See <link
linkend="caching.cacheable">Controlling Cacheability of Plugins' Output</link>
on how to use them properly.
</para> </para>
<example> <example>
<title>register_block</title> <title>register_block</title>
@@ -39,7 +44,8 @@
<?php <?php
$smarty->register_block("translate", "do_translation"); $smarty->register_block("translate", "do_translation");
function do_translation ($params, $content, &$smarty, &$repeat) { function do_translation ($params, $content, &$smarty, &$repeat)
{
if (isset($content)) { if (isset($content)) {
$lang = $params['lang']; $lang = $params['lang'];
// do some translation with $content // do some translation with $content
@@ -55,7 +61,8 @@ function do_translation ($params, $content, &$smarty, &$repeat) {
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

28
docs/en/programmers/api-functions/api-register-compiler-function.xml
View File

@@ -1,15 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.register.compiler.function"> <refentry id="api.register.compiler.function">
<title>register_compiler_function</title> <refnamediv>
<funcsynopsis> <refname>register_compiler_function</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>register_compiler_function</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
<paramdef>mixed <parameter>impl</parameter></paramdef> <title />
<paramdef>bool <parameter>cacheable</parameter></paramdef> <methodsynopsis>
</funcprototype> <type>bool</type><methodname>register_compiler_function</methodname>
</funcsynopsis> <methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>mixed</type><parameter>impl</parameter></methodparam>
<methodparam><type>bool</type><parameter>cacheable</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically register a compiler function plugin. Use this to dynamically register a compiler function plugin.
Pass in the compiler function name, followed by the PHP Pass in the compiler function name, followed by the PHP
@@ -28,11 +31,12 @@
class. class.
</para> </para>
<para> <para>
<parameter>$cacheable</parameter> can be omitted in <parameter>cacheable</parameter> can be omitted in
most cases. See <link linkend="caching.cacheable">Controlling most cases. See <link linkend="caching.cacheable">Controlling
Cacheability of Plugins' Output</link> on how to it properly. Cacheability of Plugins' Output</link> on how to it properly.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

41
docs/en/programmers/api-functions/api-register-function.xml
View File

@@ -1,16 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.register.function"> <refentry id="api.register.function">
<title>register_function</title> <refnamediv>
<funcsynopsis> <refname>register_function</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>register_function</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
<paramdef>mixed <parameter>impl</parameter></paramdef> <title />
<paramdef>bool <parameter>cacheable</parameter></paramdef> <methodsynopsis>
<paramdef>array or null <parameter>cache_attrs</parameter></paramdef> <type>void</type><methodname>register_function</methodname>
</funcprototype> <methodparam><type>string</type><parameter>name</parameter></methodparam>
</funcsynopsis> <methodparam><type>mixed</type><parameter>impl</parameter></methodparam>
<methodparam><type>bool</type><parameter>cacheable</parameter></methodparam>
<methodparam><type>mixed</type><parameter>cache_attrs</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically register template function plugins. Use this to dynamically register template function plugins.
Pass in the template function name, followed by the PHP Pass in the template function name, followed by the PHP
@@ -29,7 +32,10 @@
class. class.
</para> </para>
<para> <para>
<parameter>$cacheable</parameter> and <parameter>$cache_attrs</parameter> can be omitted in most cases. See <link linkend="caching.cacheable">Controlling Cacheability of Plugins' Output</link> on how to use them properly. <parameter>cacheable</parameter> and <parameter>cache_attrs</parameter> can be
omitted in most cases. See <link
linkend="caching.cacheable">Controlling Cacheability of Plugins' Output</link>
on how to use them properly.
</para> </para>
<example> <example>
<title>register_function</title> <title>register_function</title>
@@ -38,13 +44,15 @@
<?php <?php
$smarty->register_function("date_now", "print_current_date"); $smarty->register_function("date_now", "print_current_date");
function print_current_date ($params) { function print_current_date($params)
if(empty($params['format'])) {
if(empty($params['format'])) {
$format = "%b %e, %Y"; $format = "%b %e, %Y";
else } else {
$format = $params['format']; $format = $params['format'];
return strftime($format,time()); return strftime($format,time());
} }
}
// now you can use this in Smarty to print the current date: {date_now} // now you can use this in Smarty to print the current date: {date_now}
// or, {date_now format="%Y/%m/%d"} to format it. // or, {date_now format="%Y/%m/%d"} to format it.
@@ -52,7 +60,8 @@ function print_current_date ($params) {
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

25
docs/en/programmers/api-functions/api-register-modifier.xml
View File

@@ -1,14 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.register.modifier"> <refentry id="api.register.modifier">
<title>register_modifier</title> <refnamediv>
<funcsynopsis> <refname>register_modifier</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>register_modifier</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
<paramdef>mixed <parameter>impl</parameter></paramdef> <title />
</funcprototype> <methodsynopsis>
</funcsynopsis> <type>void</type><methodname>register_modifier</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>mixed</type><parameter>impl</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically register modifier plugin. Pass in the Use this to dynamically register modifier plugin. Pass in the
template modifier name, followed by the PHP function that it template modifier name, followed by the PHP function that it
@@ -26,7 +29,6 @@
<literal>$method</literal> being a class method of that <literal>$method</literal> being a class method of that
class. class.
</para> </para>
<example> <example>
<title>register_modifier</title> <title>register_modifier</title>
<programlisting role="php"> <programlisting role="php">
@@ -41,7 +43,8 @@ $smarty->register_modifier("sslash","stripslashes");
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

30
docs/en/programmers/api-functions/api-register-object.xml
View File

@@ -1,23 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.register.object"> <refentry id="api.register.object">
<title>register_object</title> <refnamediv>
<funcsynopsis> <refname>register_object</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>register_object</function></funcdef> </refnamediv>
<paramdef>string <parameter>object_name</parameter></paramdef> <refsect1>
<paramdef>object <parameter>$object</parameter></paramdef> <title />
<paramdef>array <parameter>allowed methods/properties</parameter></paramdef> <methodsynopsis>
<paramdef>boolean <parameter>format</parameter></paramdef> <type>void</type><methodname>register_object</methodname>
<paramdef>array <parameter>block methods</parameter></paramdef> <methodparam><type>string</type><parameter>object_name</parameter></methodparam>
</funcprototype> <methodparam><type>object</type><parameter>object</parameter></methodparam>
</funcsynopsis> <methodparam><type>array</type><parameter>allowed_methods_properties</parameter></methodparam>
<methodparam><type>boolean</type><parameter>format</parameter></methodparam>
<methodparam><type>array</type><parameter>block_methods</parameter></methodparam>
</methodsynopsis>
<para> <para>
This is to register an object for use in the templates. See the This is to register an object for use in the templates. See the
<link linkend="advanced.features.objects">object section</link> <link linkend="advanced.features.objects">object section</link>
of the manual for examples. of the manual for examples.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-register-outputfilter.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.register.outputfilter"> <refentry id="api.register.outputfilter">
<title>register_outputfilter</title> <refnamediv>
<funcsynopsis> <refname>register_outputfilter</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>register_outputfilter</function></funcdef> </refnamediv>
<paramdef>mixed <parameter>function</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>register_outputfilter</methodname>
<methodparam><type>mixed</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically register outputfilters to operate on Use this to dynamically register outputfilters to operate on
a template's output before it is displayed. See a template's output before it is displayed. See
@@ -27,7 +30,8 @@
<literal>$method</literal> being a class method of that <literal>$method</literal> being a class method of that
class. class.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-register-postfilter.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.register.postfilter"> <refentry id="api.register.postfilter">
<title>register_postfilter</title> <refnamediv>
<funcsynopsis> <refname>register_postfilter</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>register_postfilter</function></funcdef> </refnamediv>
<paramdef>mixed <parameter>function</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>register_postfilter</methodname>
<methodparam><type>mixed</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically register postfilters to run templates Use this to dynamically register postfilters to run templates
through after they are compiled. See <link through after they are compiled. See <link
@@ -26,7 +29,8 @@
<literal>$method</literal> being a class method of that <literal>$method</literal> being a class method of that
class. class.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-register-prefilter.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.register.prefilter"> <refentry id="api.register.prefilter">
<title>register_prefilter</title> <refnamediv>
<funcsynopsis> <refname>register_prefilter</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>register_prefilter</function></funcdef> </refnamediv>
<paramdef>mixed <parameter>function</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>register_prefilter</methodname>
<methodparam><type>mixed</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically register prefilters to run templates Use this to dynamically register prefilters to run templates
through before they are compiled. See <link through before they are compiled. See <link
@@ -26,7 +29,8 @@
<literal>$method</literal> being a class method of that <literal>$method</literal> being a class method of that
class. class.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

24
docs/en/programmers/api-functions/api-register-resource.xml
View File

@@ -1,14 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.register.resource"> <refentry id="api.register.resource">
<title>register_resource</title> <refnamediv>
<funcsynopsis> <refname>register_resource</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>register_resource</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
<paramdef>array <parameter>resource_funcs</parameter></paramdef> <title />
</funcprototype> <methodsynopsis>
</funcsynopsis> <type>void</type><methodname>register_resource</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>array</type><parameter>resource_funcs</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically register a resource plugin with Smarty. Use this to dynamically register a resource plugin with Smarty.
Pass in the name of the resource and the array of PHP functions Pass in the name of the resource and the array of PHP functions
@@ -49,7 +52,8 @@ $smarty->register_resource("db", array("db_get_template",
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-template-exists.xml
View File

@@ -1,19 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.template.exists"> <refentry id="api.template.exists">
<title>template_exists</title> <refnamediv>
<funcsynopsis> <refname>template_exists</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>bool <function>template_exists</function></funcdef> </refnamediv>
<paramdef>string <parameter>template</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>bool</type><methodname>template_exists</methodname>
<methodparam><type>string</type><parameter>template</parameter></methodparam>
</methodsynopsis>
<para> <para>
This function checks whether the specified template exists. It can This function checks whether the specified template exists. It can
accept either a path to the template on the filesystem or a accept either a path to the template on the filesystem or a
resource string specifying the template. resource string specifying the template.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

24
docs/en/programmers/api-functions/api-trigger-error.xml
View File

@@ -1,21 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.trigger.error"> <refentry id="api.trigger.error">
<title>trigger_error</title> <refnamediv>
<funcsynopsis> <refname>trigger_error</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>trigger_error</function></funcdef> </refnamediv>
<paramdef>string <parameter>error_msg</parameter></paramdef> <refsect1>
<paramdef>[int <parameter>level</parameter>]</paramdef> <title />
</funcprototype> <methodsynopsis>
</funcsynopsis> <type>void</type><methodname>trigger_error</methodname>
<methodparam><type>string</type><parameter>error_msg</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam>
</methodsynopsis>
<para> <para>
This function can be used to output an error message using Smarty. This function can be used to output an error message using Smarty.
<parameter>level</parameter> parameter can be one of the values <parameter>level</parameter> parameter can be one of the values
used for trigger_error() PHP function, i.e. E_USER_NOTICE, used for trigger_error() PHP function, i.e. E_USER_NOTICE,
E_USER_WARNING, etc. By default it's E_USER_WARNING. E_USER_WARNING, etc. By default it's E_USER_WARNING.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

24
docs/en/programmers/api-functions/api-unregister-block.xml
View File

@@ -1,18 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.unregister.block"> <refentry id="api.unregister.block">
<title>unregister_block</title> <refnamediv>
<funcsynopsis> <refname>unregister_block</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>unregister_block</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>unregister_block</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically unregister block function plugin. Use this to dynamically unregister block function plugin.
Pass in the block function name. Pass in the block function <parameter>name</parameter>.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

24
docs/en/programmers/api-functions/api-unregister-compiler-function.xml
View File

@@ -1,18 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.unregister.compiler.function"> <refentry id="api.unregister.compiler.function">
<title>unregister_compiler_function</title> <refnamediv>
<funcsynopsis> <refname>unregister_compiler_function</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>unregister_compiler_function</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>unregister_compiler_function</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically unregister a compiler function. Pass in Use this to dynamically unregister a compiler function. Pass in
the name of the compiler function. the <parameter>name</parameter> of the compiler function.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-unregister-function.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.unregister.function"> <refentry id="api.unregister.function">
<title>unregister_function</title> <refnamediv>
<funcsynopsis> <refname>unregister_function</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>unregister_function</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>unregister_function</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically unregister template function plugin. Use this to dynamically unregister template function plugin.
Pass in the template function name. Pass in the template function name.
@@ -24,7 +27,8 @@ $smarty->unregister_function("fetch");
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-unregister-modifier.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.unregister.modifier"> <refentry id="api.unregister.modifier">
<title>unregister_modifier</title> <refnamediv>
<funcsynopsis> <refname>unregister_modifier</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>unregister_modifier</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>unregister_modifier</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically unregister modifier plugin. Pass in the Use this to dynamically unregister modifier plugin. Pass in the
template modifier name. template modifier name.
@@ -24,7 +27,8 @@ $smarty->unregister_modifier("strip_tags");
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-unregister-object.xml
View File

@@ -1,17 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.unregister.object"> <refentry id="api.unregister.object">
<title>unregister_object</title> <refnamediv>
<funcsynopsis> <refname>unregister_object</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>unregister_object</function></funcdef> </refnamediv>
<paramdef>string <parameter>object_name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>unregister_object</methodname>
<methodparam><type>string</type><parameter>object_name</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to unregister an object. Use this to unregister an object.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-unregister-outputfilter.xml
View File

@@ -1,17 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.unregister.outputfilter"> <refentry id="api.unregister.outputfilter">
<title>unregister_outputfilter</title> <refnamediv>
<funcsynopsis> <refname>unregister_outputfilter</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>unregister_outputfilter</function></funcdef> </refnamediv>
<paramdef>string <parameter>function_name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>unregister_outputfilter</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically unregister an output filter. Use this to dynamically unregister an output filter.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-unregister-postfilter.xml
View File

@@ -1,17 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.unregister.postfilter"> <refentry id="api.unregister.postfilter">
<title>unregister_postfilter</title> <refnamediv>
<funcsynopsis> <refname>unregister_postfilter</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>unregister_postfilter</function></funcdef> </refnamediv>
<paramdef>string <parameter>function_name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>unregister_postfilter</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically unregister a postfilter. Use this to dynamically unregister a postfilter.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-unregister-prefilter.xml
View File

@@ -1,17 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.unregister.prefilter"> <refentry id="api.unregister.prefilter">
<title>unregister_prefilter</title> <refnamediv>
<funcsynopsis> <refname>unregister_prefilter</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>unregister_prefilter</function></funcdef> </refnamediv>
<paramdef>string <parameter>function_name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>unregister_prefilter</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically unregister a prefilter. Use this to dynamically unregister a prefilter.
</para> </para>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml

22
docs/en/programmers/api-functions/api-unregister-resource.xml
View File

@@ -1,13 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?> <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ --> <!-- $Revision$ -->
<sect1 id="api.unregister.resource"> <refentry id="api.unregister.resource">
<title>unregister_resource</title> <refnamediv>
<funcsynopsis> <refname>unregister_resource</refname>
<funcprototype> <refpurpose></refpurpose>
<funcdef>void <function>unregister_resource</function></funcdef> </refnamediv>
<paramdef>string <parameter>name</parameter></paramdef> <refsect1>
</funcprototype> <title />
</funcsynopsis> <methodsynopsis>
<type>void</type><methodname>unregister_resource</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para> <para>
Use this to dynamically unregister a resource plugin. Pass in the Use this to dynamically unregister a resource plugin. Pass in the
name of the resource. name of the resource.
@@ -22,7 +25,8 @@ $smarty->unregister_resource("db");
]]> ]]>
</programlisting> </programlisting>
</example> </example>
</sect1> </refsect1>
</refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml