Просмотр файла manual-ru/plugins.block.functions.html

Размер файла: 7.98Kb
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <title>Блоковые функции</title>
  5. <meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
  6. <link rel="home" href="index.html" title="Руководство по Smarty">
  7. <link rel="up" href="plugins.html" title="Chapter 16. Плагины - расширение функциональности Smarty">
  8. <link rel="prev" href="plugins.modifiers.html" title="Модификаторы">
  9. <link rel="next" href="plugins.compiler.functions.html" title="Функции компилятора">
  10. </head>
  11. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  12. <div class="navheader">
  13. <table width="100%" summary="Navigation header">
  14. <tr><th colspan="3" align="center">Блоковые функции</th></tr>
  15. <tr>
  16. <td width="20%" align="left">
  17. <a accesskey="p" href="plugins.modifiers.html">Prev</a> </td>
  18. <th width="60%" align="center">Chapter 16. Плагины - расширение функциональности Smarty</th>
  19. <td width="20%" align="right"> <a accesskey="n" href="plugins.compiler.functions.html">Next</a>
  20. </td>
  21. </tr>
  22. </table>
  23. <hr>
  24. </div>
  25. <div class="sect1" title="Блоковые функции">
  26. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  27. <a name="plugins.block.functions"></a>Блоковые функции</h2></div></div></div>
  28. <div class="funcsynopsis">
  29. <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
  30. <tr>
  31. <td><code class="funcdef">void <b class="fsfunc">smarty_block_name</b>(</code></td>
  32. <td>
  33. <var class="pdparam">$params</var>, </td>
  34. <td> </td>
  35. </tr>
  36. <tr>
  37. <td> </td>
  38. <td>
  39. <var class="pdparam">$content</var>, </td>
  40. <td> </td>
  41. </tr>
  42. <tr>
  43. <td> </td>
  44. <td>
  45. <var class="pdparam">&amp;$smarty</var>, </td>
  46. <td> </td>
  47. </tr>
  48. <tr>
  49. <td> </td>
  50. <td>
  51. <var class="pdparam">&amp;$repeat</var><code>)</code>;</td>
  52. <td> </td>
  53. </tr>
  54. </table>
  55. <div class="paramdef-list">
  56. <code>array <var class="pdparam">$params</var></code>;<br><code>mixed <var class="pdparam">$content</var></code>;<br><code>object <var class="pdparam">&amp;$smarty</var></code>;<br><code>boolean <var class="pdparam">&amp;$repeat</var></code>;</div>
  57. <div class="funcprototype-spacer"> </div>
  58. </div>
  59. <p>
  60. Блоковые функции выглядят следующим образом: {func} .. {/func}. Другими словами,
  61. они заключены в определенном блоке шаблона и оперируют содержимым этого блока.
  62. Блоковые функции имеют приоритет перед пользовательскими функциями, имеющими то же имя,
  63. поэтому, вы не сможете использовать одновременно свои функции вида {func} и
  64. блоковые функции {func} .. {/func}.
  65. </p>
  66. <p>
  67. Smarty вызывает ваши функции дважды:
  68. первый раз при открытии тэга и второй раз при закрытии тэга.
  69. </p>
  70. <p>
  71. Только открывающий тэг блоковой функции может иметь атрибуты. Все
  72. атрибуты, переданные в функцию из шаблона сохраняются
  73. в <em class="parameter"><code>$params</code></em> в виде ассоциативного массива. Вы можете
  74. получить прямой доступ к их значениям:
  75. <code class="varname">$params['start']</code> или использовать
  76. <code class="varname">extract($params)</code> для импорта.
  77. Атрибуты, переданные в открывающем тэге доступны для вашей функции
  78. до обработки закрывающего тэга включительно.
  79. </p>
  80. <p>
  81. Значение переменной <em class="parameter"><code>$content</code></em> зависит от того,
  82. вызывается ли ваша функция для открывающего тэга или вызов происходит при закрытии тэга.
  83. В случае с открывающим тэгом, это значение будет равно <code class="literal">null</code>, а в случае
  84. закрывающего тэга, значение будет равно содержимому блока в шаблоне.
  85. Заметьте, что этот блок шаблона уже будет обработан
  86. Smarty и на выводе вы получите результат обработки, а не
  87. исходный код шаблона.
  88. </p>
  89. <p>
  90. Параметр <em class="parameter"><code>&amp;$repeat</code></em> передается по
  91. ссылке в функцию и дает ей возможность контролировать
  92. количество отображений блока.
  93. По умолчанию <em class="parameter"><code>$repeat</code></em> равен <code class="literal">true</code>
  94. во время первого вызова блоковой функции (открывающий тэг блока)
  95. и <code class="literal">false</code> при всех последующих вызовах блоковой функции
  96. (закрывающий тэг блока).
  97. Каждый раз, когда ваша функция возвращает параметр <em class="parameter"><code>&amp;$repeat</code></em>
  98. равный <code class="literal">true</code>, содержимое между
  99. {func} .. {/func} обрабатывается и ваша функция вновь вызывается, причем новое содержимое
  100. блока передается в параметре <em class="parameter"><code>$content</code></em>.
  101. </p>
  102. <p>
  103. Если вы используете вложенные блоковые функции, есть возможность определять родительские
  104. блоковые функции. Достаточно получить значение переменной
  105. <code class="varname">$smarty-&gt;_tag_stack</code>. Затем останется только применить var_dump()
  106. для нее и структура будет видна.
  107. </p>
  108. <p>
  109. Смотрите также:
  110. <a class="link" href="api.register.block.html" title="register_block">register_block()</a>,
  111. <a class="link" href="api.unregister.block.html" title="unregister_block">unregister_block()</a>.
  112. </p>
  113. <div class="example">
  114. <a name="id2741361"></a><p class="title"><b>Example 16.5. Блоковая функция</b></p>
  115. <div class="example-contents"><pre class="programlisting">
  116.  
  117. &lt;?php
  118. /*
  119. * Smarty plugin
  120. * -------------------------------------------------------------
  121. * Файл: block.translate.php
  122. * Тип: block
  123. * Имя: translate
  124. * Назначение: перевести блок (кусок) текста
  125. * -------------------------------------------------------------
  126. */
  127. function smarty_block_translate($params, $content, &amp;amp;$smarty)
  128. {
  129. if ($content) {
  130. $lang = $params['lang'];
  131. // здесь выполнить интеллектуальный перевод строки $content
  132. echo $translation;
  133. }
  134. }
  135. ?&gt;
  136.  
  137. </pre></div>
  138. </div>
  139. <br class="example-break">
  140. </div>
  141. <div class="navfooter">
  142. <hr>
  143. <table width="100%" summary="Navigation footer">
  144. <tr>
  145. <td width="40%" align="left">
  146. <a accesskey="p" href="plugins.modifiers.html">Prev</a> </td>
  147. <td width="20%" align="center"><a accesskey="u" href="plugins.html">Up</a></td>
  148. <td width="40%" align="right"> <a accesskey="n" href="plugins.compiler.functions.html">Next</a>
  149. </td>
  150. </tr>
  151. <tr>
  152. <td width="40%" align="left" valign="top">Модификаторы </td>
  153. <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
  154. <td width="40%" align="right" valign="top"> Функции компилятора</td>
  155. </tr>
  156. </table>
  157. </div>
  158. </body>
  159. </html>