smarty/docs/ru/programmers/plugins/plugins-resources.xml

<?xml version="1.0" encoding="windows-1251"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.2 Maintainer: tony2001 Status: ready -->
<sect1 id="plugins.resources">
 <title>Ðåñóðñû</title>
 <para>
  Ïëàãèíû ðåñóðñîâ îïèñûâàþò èñòî÷íèêè äàííûõ, èç êîòîðûõ áåðåòñÿ èñõîäíûé
  êîä øàáëîíà èëè êîìïîíåíòû PHP-ñêðèïòà äëÿ Smarty. Âîò ïðèìåðû ðåñóðñîâ:
  áàçû äàííûõ, LDAP, ðàçäåëÿåìàÿ ïàìÿòü (shared memory), ñîêåòû, è ïðî÷åå.
 </para>

 <para>
  Íåîáõîäèìî 4 ôóíêöèè äëÿ òîãî, ÷òîáû çàðåãåñòðèðîâàòü
  êàæäûé òèï ðåñóðñà. Êàæäàÿ òàêàÿ ôóíêöèÿ ïîëó÷àåò çàïðàøèâàåìûé ðåñóðñ â êà÷åñòâå
  ïåðâîãî ïàðàìåòðà è îáúåêò Smarty êàê ïîñëåäíèé ïàðàìåòð.
  Îñòàëüíûå ïàðàìåòðû çàâèñÿò îò ôóíêöèè.
 </para>

 <funcsynopsis>
  <funcprototype>
   <funcdef>bool <function>smarty_resource_<replaceable>name</replaceable>_source</function></funcdef>
   <paramdef>string <parameter>$rsrc_name</parameter></paramdef>
   <paramdef>string <parameter>&amp;$source</parameter></paramdef>
   <paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
  </funcprototype>
  <funcprototype>
   <funcdef>bool <function>smarty_resource_<replaceable>name</replaceable>_timestamp</function></funcdef>
   <paramdef>string <parameter>$rsrc_name</parameter></paramdef>
   <paramdef>int <parameter>&amp;$timestamp</parameter></paramdef>
   <paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
  </funcprototype>
  <funcprototype>
   <funcdef>bool <function>smarty_resource_<replaceable>name</replaceable>_secure</function></funcdef>
   <paramdef>string <parameter>$rsrc_name</parameter></paramdef>
   <paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
  </funcprototype>
  <funcprototype>
   <funcdef>bool <function>smarty_resource_<replaceable>name</replaceable>_trusted</function></funcdef>
   <paramdef>string <parameter>$rsrc_name</parameter></paramdef>
   <paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
  </funcprototype>
 </funcsynopsis>

 <para>
  Ïåðâàÿ ôóíêöèÿ ïîëó÷àåò ðåñóðñ. Åå ïåðâûé
  ïàðàìåòð, ýòî ïåðåìåííàÿ, ïåðåäàííàÿ ïî ññûëêå. Â íåå áóäåò ñîõðàíåí ðåçóëüòàò.
  Ôóíêöèÿ âåðíåò <literal>true</literal> åñëè
  ñìîæåò óäà÷íî ïîëó÷èòü ðåñóðñ è
  <literal>false</literal> â èíîì ñëó÷àå.
 </para>

 <para>
  Âòîðàÿ ôóíêöèÿ ïîëó÷àåò âðåìÿ ïîñëåäíåé ìîäèôèêàöèè
  çàïðîøåííîãî ðåñóðñà (â âèäå UNIX timestamp). Âòîðîé ïàðàìåòð
  ïðåäñòàâëÿåò ñîáîé ïåðåìåííóþ, ïåðåäàííóþ ïî ññûëêå, â êîòîðîé è áóäåò ñîõðàíåíî âðåìÿ.
  Ôóíêöèÿ âåðíåò <literal>true</literal> åñëè
  timestamp áóäåò îïðåäåëåí â ïðàâèëüíîé ôîðìå, è <literal>false</literal>
  â èíîì ñëó÷àå.
 </para>

 <para>
  Òðåòüÿ ôóíêöèÿ âîçâðàùàåò <literal>true</literal> èëè
  <literal>false</literal> â çàâèñèìîñòè îò òîãî, ÿâëÿåòñÿ ëè
  çàïðàøèâàåìûé ðåñóðñ áåçîïàñíûì. Ýòà ôóíêöèÿ èñïîëüçóåòñÿ òîëüêî äëÿ ðåñóðñîâ øàáëîíà, íî
  â ëþáîì ñëó÷àå äîëæíà áûòü îïðåäåëåíà.
 </para>

 <para>
  ×åòâåðòàÿ ôóíêöèÿ âîçâðàùàåò <literal>true</literal> èëè
  <literal>false</literal> â çàâèñèìîñòè îò òîãî, çàñëóæèâàåò ëè çàïðàøèâàåìûé ðåñóðñ äîâåðèÿ
  (is trusted) èëè íåò. Ýòà ôóíêöèÿ èñïîëüçóåòñÿ òîëüêî äëÿ êîìïîíåíòîâ PHP-ñêðèïòà,
  çàïðîøåííûõ òýãîì <command>include_php</command> èëè
  <command>insert</command> ñ <structfield>src</structfield>
  àòðèáóòîì. Òåì íå ìåíåå, îíà äîëæíà îáúÿâëÿòüñÿ äàæå äëÿ ðåñóðñîâ øàáëîíà.
 </para>
 <para>
  Ñìîòðèòå òàêæå:
  <link linkend="api.register.resource">register_resource()</link>,
  <link linkend="api.unregister.resource">unregister_resource()</link>.
 </para>
 <example>
  <title>Ïëàãèí ðåñóðñà</title>
   <programlisting role="php">
<![CDATA[
<?php
/*
 * Smarty plugin
 * -------------------------------------------------------------
 * Ôàéë:     resource.db.php
 * Òèï:     resource
 * Èìÿ:     db
 * Íàçíà÷åíèå:  Ïîëó÷àåò øàáëîí èç áàçû äàííûõ
 * -------------------------------------------------------------
 */
 function smarty_resource_db_source($tpl_name, &$tpl_source, &$smarty)
{
    // âûïîëíÿåì îáðàùåíèå ê áàçå äàííûõ äëÿ ïîëó÷åíèÿ øàáëîíà
    // è çàíåñåíèÿ ïîëó÷åííîãî ðåçóëüòàòà â â $tpl_source
    $sql = new SQL;
    $sql->query("select tpl_source
                   from my_table
                  where tpl_name='$tpl_name'");
    if ($sql->num_rows) {
        $tpl_source = $sql->record['tpl_source'];
        return true;
    } else {
        return false;
    }
}

function smarty_resource_db_timestamp($tpl_name, &$tpl_timestamp, &$smarty)
{
    // âûïîëíÿåì îáðàùåíèå ê áàçå äàííûõ äëÿ ïðèñâîåíèÿ çíà÷åíèÿ $tpl_timestamp.
    $sql = new SQL;
    $sql->query("select tpl_timestamp
                   from my_table
                  where tpl_name='$tpl_name'");
    if ($sql->num_rows) {
        $tpl_timestamp = $sql->record['tpl_timestamp'];
        return true;
    } else {
        return false;
    }
}

function smarty_resource_db_secure($tpl_name, &$smarty)
{
    // ïðåäïîëàãàåì, ÷òî øàáëîíû áåçîïàñíû
    return true;
}

function smarty_resource_db_trusted($tpl_name, &$smarty)
{
    // íå èñïîëüçóåòñÿ äëÿ øàáëîíîâ
}
?>
]]>
  </programlisting>
 </example>
</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
-->