Files
smarty/docs/en/programmers/api-variables/variable-cache-dir.xml
2006-09-27 06:28:21 +00:00

72 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="variable.cache.dir">
<title>$cache_dir</title>
<para>
This is the name of the directory where template caches are
stored. By default this is
<filename class="directory">./cache</filename>, meaning that
Smarty will look for the <filename class="directory">cache/</filename> directory
in the same directory as the executing php script.
<emphasis role="bold">This directory must
be writeable by the web server</emphasis>,
<link linkend="installing.smarty.basic">see install</link> for more info.
</para>
<para>
You can also use your own
<link linkend="section.template.cache.handler.func">
custom cache handler</link>
function to control cache files, which will ignore this
setting.
See also
<link linkend="variable.use.sub.dirs"><parameter>$use_sub_dirs</parameter></link>.
</para>
<note>
<title>Technical Note</title>
<para>
This setting must be either a relative or
absolute path. include_path is not used for writing files.
</para>
</note>
<note>
<title>Technical Note</title>
<para>
It is not recommended to put this directory under
the web server document root.
</para>
</note>
<para>
See also
<link linkend="variable.caching"><parameter>$caching</parameter></link>,
<link linkend="variable.use.sub.dirs"><parameter>$use_sub_dirs</parameter></link>,
<link linkend="variable.cache.lifetime"><parameter>$cache_lifetime</parameter></link>,
<link linkend="variable.cache.handler.func"><parameter>$cache_handler_func</parameter></link>,
<link linkend="variable.cache.modified.check"><parameter>$cache_modified_check</parameter></link>
and the
<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
-->