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

134 lines
3.7 KiB
XML

<?xml version="1.0" encoding="windows-1251"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.2 Maintainer: tony2001 Status: ready -->
<sect1 id="plugins.functions">
<title>Ôóíêöèè øàáëîíà</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>smarty_function_<replaceable>name</replaceable></function></funcdef>
<paramdef>array <parameter>$params</parameter></paramdef>
<paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Âñå àòðèáóòû, ïåðåäàâàåìûå â ôóíêöèè øàáëîíà èç ñàìîãî øàáëîíà,
õðàíÿòñÿ â <parameter>$params</parameter> â âèäå àññîöèàòèâíîãî ìàññèâà.
Ïîëó÷èòü äîñòóï ê åãî çíà÷åíèÿì ìîæíî íàïðÿìóþ:
<varname>$params['start']</varname> èëè èñïîëüçóÿ
<varname>extract($params)</varname> äëÿ èìïîðòà â òàáëèöó.
</para>
<para>
Âûâîä (âîçâðàùàåìîå çíà÷åíèå) ôóíêöèè áóäåò ïîäñòàâëåí â ìåñòî ðàñïîëîæåíèÿ
òåãà ôóíêöèè â øàáëîíå (ôóíêöèÿ <function>fetch</function> íàïðèìåð).
 êà÷åñòâå àëüòåðíàòèâû, ôóíêöèÿ ìîæåò âûïîëíÿòü êàêèå ëèáî äåéñòâèÿ
áåç êàêîãî-ëèáî âûâîäà (<function>assign</function> ôóíêöèÿ).
</para>
<para>
Åñëè ôóíêöèÿ äîëæíà ïðèñâîèòü(assign) çíà÷åíèÿ íåêîòîðûì ïåðåìåííûì â øàáëîíå èëè
èñïîëüçîâàòü èíûå âîçìîæíîñòè Smarty, òî ìîæíî ðàáîòàòü ñ îáúåêòîì
<parameter>$smarty</parameter> êàê îáû÷íî.
</para>
<para>
Ñì. òàêæå:
<link linkend="api.register.function">register_function()</link>,
<link linkend="api.unregister.function">unregister_function()</link>.
</para>
<para>
<example>
<title>Ôóíêöèÿ-ïëàãèí ñ âûâîäîì</title>
<programlisting role="php">
<![CDATA[
<?php
/*
* Smarty plugin
* -------------------------------------------------------------
* File: function.eightball.php
* Type: function
* Name: eightball
* Purpose: outputs a random magic answer
* -------------------------------------------------------------
*/
function smarty_function_eightball($params, &amp;$smarty)
{
$answers = array('Äà',
'Íåò',
'Íèêîèì îáðàçîì',
'Ïåðñïåêòèâà òàê ñåáå...',
'Ñïðîñèòå ïîçæå',
'Âñå ìîæåò áûòü');
$result = array_rand($answers);
return $answers[$result];
}
?>
]]>
</programlisting>
</example>
</para>
<para>
êîòîðàÿ ìîæåò áûòü èñïîëüçîâàíà â øàáëîíå ñëåäóþùèì îáðàçîì:
</para>
<programlisting>
<![CDATA[
Âîïðîñ: Ìû êîãäà-íèáóäü íàéäåì âðåìÿ äëÿ îòïóñêà?
Îòâåò: {eightball}.
]]>
</programlisting>
<para>
<example>
<title>Ôóíêöèÿ-ïëàãèí áåç âûâîäà</title>
<programlisting role="php">
<![CDATA[
<?php
/*
* Smarty plugin
* -------------------------------------------------------------
* File: function.assign.php
* Type: function
* Name: assign
* Purpose: assign a value to a template variable
* -------------------------------------------------------------
*/
function smarty_function_assign($params, &amp;$smarty)
{
extract($params);
if (empty($var)) {
$smarty->trigger_error("assign: missing 'var' parameter");
return;
}
if (!in_array('value', array_keys($params))) {
$smarty->trigger_error("assign: missing 'value' parameter");
return;
}
$smarty->assign($var, $value);
}
?>
]]>
</programlisting>
</example>
</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
-->