Files
smarty/docs/ru/programmers/api-functions/api-is-cached.xml
tony2001 a1be9e56c7 update documentation (revision tags, sect1 -> refsect1 etc.)
by George Miroshnikov aka freespace
2004-08-02 06:46:02 +00:00

107 lines
3.2 KiB
XML

<?xml version="1.0" encoding="windows-1251"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.3 Maintainer: tony2001 Status: ready -->
<refentry id="api.is.cached">
<refnamediv>
<refname>is_cached</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title />
<methodsynopsis>
<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>
<methodparam choice="opt"><type>string</type><parameter>compile_id</parameter></methodparam>
</methodsynopsis>
<para>
Âîçâðàùàåò true åñëè ñóùåñòâóåò êýø äëÿ óêàçàííîãî øàáëîíà.
Ðàáîòàåò òîëüêî â òîì ñëó÷àå, åñëè çíà÷åíèå <link
linkend="variable.caching">caching</link> óñòàíîâëåíî â true.
</para>
<example>
<title>is_cached</title>
<programlisting role="php">
<![CDATA[
<?php
$smarty->caching = true;
if(!$smarty->is_cached("index.tpl")) {
// îáðàùàåìñÿ ê ÁÄ, íàçíà÷àåì ïåðåìåííûå
}
$smarty->display("index.tpl");
?>
]]>
</programlisting>
</example>
<para>
Òàêæå âû ìîæåòå ïåðåäàâàòü cache id â êà÷åñòâå íåîáÿçàòåëüíîãî âòîðîãî
ïàðàìåòðà, åñëè ó âàñ èñïîëüçóåòñÿ ìíîæåñòâåííîå êýøèðîâàíèå øàáëîíà.
</para>
<para>
Òàêæå âû ìîæåòå ïåðåäàâàòü compile id â êà÷åñòâå íåîáÿçàòåëüíîãî òðåòüåãî ïàðàìåòðà.
Åñëè âû íå ïåðåäàäèòå ýòîò ïàðàìåòð, áóäåò èñïîëüçîâàí òåêóùèé
<link linkend="variable.compile.id">$compile_id</link>.
</para>
<para>
Åñëè âû íå õîòèòå ïåðåäàâàòü cache id, íî õîòèòå ïåðåäàòü compile
id, âû äîëæíû ïåðåäàòü <literal>null</literal> â êà÷åñòâå cache id.
</para>
<example>
<title>is_cached ïðè ìíîæåñòâåííîì êýøèðîâàíèè øàáëîíà</title>
<programlisting role="php">
<![CDATA[
<?php
$smarty->caching = true;
if(!$smarty->is_cached("index.tpl", "FrontPage")) {
// îáðàùàåìñÿ ê ÁÄ, íàçíà÷àåì ïåðåìåííûå
}
$smarty->display("index.tpl", "FrontPage");
?>
]]>
</programlisting>
</example>
<note>
<title>Òåõíè÷åñêîå çàìå÷àíèå</title>
<para>
Åñëè <literal>is_cached</literal> âîçâðàùàåò true, ïðè ýòîì îíà çàãðóæàåò
êýøèðîâàííûé âûâîä è õðàíèò åãî â ïàìÿòè. Ëþáûå ïîñëåäóþùèå âûçîâû
<link linkend="api.display">display()</link> èëè
<link linkend="api.fetch">fetch()</link>
áóäóò âîçâðàùàòü ýòîò õðàíèìûé â ïàìÿòè âûâîä è íå áóäóò ïûòàòüñÿ ïåðåçàãðóçèòü
ôàéë êýøà. Ýòî ïðåäîòâðàùàåò íåïðèÿòíóþ ñèòóàöèþ, êîòîðàÿ ìîæåò âîçíèêíóòü åñëè
äðóãîé ïðîöåññ î÷èùàåò êýø ìåæäó âûçîâàìè is_cached è
display â ïðåäûäóùåì ïðèìåðå. Ýòî òàêæå îçíà÷àåò, ÷òî
<link linkend="api.clear.cache">clear_cache()</link>
è äðóãèå èçìåíåíèÿ íàñòðîåê êýøèðîâàíèÿ ìîãóò íå âñòóïèòü â ñèëó ïîñëå òîãî, êàê
<literal>is_cached</literal> âåðíóëà true.
</para>
</note>
</refsect1>
</refentry>
<!-- 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
-->