Files
smarty/docs/en/programmers/api-variables/variable-caching.xml
2005-05-27 16:25:02 +00:00

65 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="variable.caching">
<title>$caching</title>
<para>
This tells Smarty whether or not to cache the output of the templates.
By default this is set to 0, or disabled. If your templates generate
redundant content, it is advisable to turn on $caching. This
will result in significant performance gains. You can also have
<link linkend="caching.multiple.caches">multiple</link>
caches for the same template. A value of 1 or 2 enables caching. 1 tells
Smarty to use the current
<link linkend="variable.cache.lifetime">$cache_lifetime</link>
variable to determine if the
cache has expired. A value of 2 tells Smarty to use the
<link linkend="variable.cache.lifetime">$cache_lifetime</link>
value at the time the cache was generated. This way you can set the
<link linkend="variable.cache.lifetime">$cache_lifetime</link>
just before
<link linkend="api.fetch">fetching</link>
the template to have granular
control over when that particular cache expires.
See also <link linkend="api.is.cached">is_cached()</link>.
</para>
<para>
If <link linkend="variable.compile.check">$compile_check</link>
is enabled, the cached content will be regenerated if
any of the templates or config files that are part of this cache are
changed. If
<link linkend="variable.force.compile">$force_compile</link>
is enabled, the cached content will always be
regenerated.
</para>
<para>
See also
<link linkend="variable.cache.dir">$cache_dir</link>,
<link linkend="variable.cache.lifetime">$cache_lifetime</link>,
<link linkend="variable.cache.handler.func">$cache_handler_func</link>,
<link linkend="variable.cache.modified.check">$cache_modified_check</link>
and
<link linkend="caching">Caching section</link>.
</para>
</sect1>
<!-- 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
-->