Files
smarty/docs/ru/programmers/plugins/plugins-naming-conventions.xml
2008-05-25 15:06:11 +00:00

80 lines
3.0 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0 Maintainer: tony2001 Status: ready -->
<sect1 id="plugins.naming.conventions">
<title>Соглашение об именах</title>
<para>
При присвоении имен файлам и функциям плагинов, необходимо придерживаться определенных
правил, чтобы Smarty находил и мог использовать эти плагины.
</para>
<para>
Имена файлов плагинов должны формироваться по следующей схеме:
<blockquote>
<para>
<filename>
<replaceable>type</replaceable>.<replaceable>name</replaceable>.php
</filename>
</para>
</blockquote>
</para>
<para>
Где <literal>type (тип)</literal> это один из следующих типов плагинов:
<itemizedlist spacing="compact">
<listitem><simpara>function</simpara></listitem>
<listitem><simpara>modifier</simpara></listitem>
<listitem><simpara>block</simpara></listitem>
<listitem><simpara>compiler</simpara></listitem>
<listitem><simpara>prefilter</simpara></listitem>
<listitem><simpara>postfilter</simpara></listitem>
<listitem><simpara>outputfilter</simpara></listitem>
<listitem><simpara>resource</simpara></listitem>
<listitem><simpara>insert</simpara></listitem>
</itemizedlist>
</para>
<para>
и <literal>name (имя)</literal> соответствует правилам наименования идентификаторов в PHP
(только буквы, цифры и знак подчеркивания).
</para>
<para>
Несколько примеров: <literal>function.html_select_date.php</literal>,
<literal>resource.db.php</literal>,
<literal>modifier.spacify.php</literal>.
</para>
<para>
Функции, находящиеся внутри файлов плагинов, должны именоваться следующим образом:
<blockquote>
<para>
<function>smarty_<replaceable>type</replaceable>_<replaceable>name</replaceable></function>
</para>
</blockquote>
</para>
<para>
Значения <literal>type</literal> и <literal>name</literal> те же, что прежде.
</para>
<para>
Smarty выдаст сообщение об ошибке, если необходимый файл плагина
не будет найден, или файл плагина, а так же функция плагина
будут названы неправильно.
</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
-->