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

WS

Browse Source
This commit is contained in:
didou
2004-04-13 12:02:28 +00:00
parent 275945f96b
commit e066cf2984
1 changed files with 52 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
docs/en/programmers/caching/caching-cacheable.xml
View File

@@ -1,26 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="caching.cacheable">
<title>Controlling Cacheability of Plugins' Output</title>
<para>
Since Smarty-2.6.0 plugins the cacheability of plugins can be declared
when registering them. The third parameter to register_block,
register_compiler_function and register_function is called
<parameter>$cacheable</parameter> and defaults to true which is also
the behaviour of plugins in Smarty versions before 2.6.0
</para>
<sect1 id="caching.cacheable">
<title>Controlling Cacheability of Plugins' Output</title>
<para>
Since Smarty-2.6.0 plugins the cacheability of plugins can be declared
when registering them. The third parameter to register_block,
register_compiler_function and register_function is called
<parameter>$cacheable</parameter> and defaults to true which is also
the behaviour of plugins in Smarty versions before 2.6.0
</para>
<para>
When registering a plugin with $cacheable=false the plugin is called everytime the page is displayed, even if the page comes from the cache. The plugin function behaves a little like an <link linkend="plugins.inserts">insert</link> function.
</para>
<para>
When registering a plugin with $cacheable=false the plugin is
called everytime the page is displayed, even if the page comes
from the cache. The plugin function behaves a little like an
<link linkend="plugins.inserts">insert</link> function.
</para>
<para>
In contrast to <link linkend="language.function.insert">{insert}</link> the attributes to the plugins are not cached by default. They can be declared to be cached with the fourth parameter <parameter>$cache_attrs</parameter>. <parameter>$cache_attrs</parameter> is an array of attribute-names that should be cached, so the plugin-function get value as it was the time the page was written to cache everytime it is fetched from the cache.
</para>
<para>
In contrast to <link linkend="language.function.insert">{insert}</link>
the attributes to the plugins are not cached by default. They can be
declared to be cached with the fourth parameter
<parameter>$cache_attrs</parameter>. <parameter>$cache_attrs</parameter>
is an array of attribute-names that should be cached, so the
plugin-function get value as it was the time the page was written
to cache everytime it is fetched from the cache.
</para>
<example>
<title>Preventing a plugin's output from being cached</title>
<programlisting role="php">
<example>
<title>Preventing a plugin's output from being cached</title>
<programlisting role="php">
<![CDATA[
index.php:
@@ -52,16 +61,19 @@ index.tpl:
Time Remaining: {remain endtime=$obj->endtime}
]]>
</programlisting>
<para>
The number of seconds till the endtime of $obj is reached changes on each display of the page, even if the page is cached. Since the endtime attribute is cached the object only has to be pulled from the database when page is written to the cache but not on subsequent requests of the page.
</para>
</example>
</programlisting>
<para>
The number of seconds till the endtime of $obj is reached changes on
each display of the page, even if the page is cached. Since the
endtime attribute is cached the object only has to be pulled from the
database when page is written to the cache but not on subsequent requests
of the page.
</para>
</example>
<example>
<title>Preventing a whole passage of a template from being cached</title>
<programlisting role="php">
<example>
<title>Preventing a whole passage of a template from being cached</title>
<programlisting role="php">
<![CDATA[
index.php:
@@ -91,13 +103,18 @@ Now is: {"0"|date_format:"%D %H:%M:%S"}
{/dynamic}
]]>
</programlisting>
</example>
<para>
When reloading the page you will notice that both dates differ. One is "dynamic" one is "static". You can do everything between {dynamic}...{/dynamic} and be sure it will not be cached like the rest of the page.
</para>
</sect1>
</programlisting>
</example>
<para>
When reloading the page you will notice that both dates differ. One
is "dynamic" one is "static". You can do everything between
{dynamic}...{/dynamic} and be sure it will not be cached like the rest
of the page.
</para>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -117,4 +134,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->