Zend_Controller-ActionHelpers-ViewRenderer.xml 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect3 id="zend.controller.actionhelpers.viewrenderer">
  4. <title>ViewRenderer</title>
  5. <sect4 id="zend.controller.actionhelper.viewrenderer.introduction">
  6. <title>Введение</title>
  7. <para>
  8. Помощник <code>ViewRenderer</code> предназначен для решения
  9. следующих задач:
  10. </para>
  11. <itemizedlist>
  12. <listitem>
  13. <para>
  14. Устранение необходимости инстанцирования объектов вида
  15. внутри контроллеров; объекты вида будут автоматически
  16. регистрироваться вместе с контроллером.
  17. </para>
  18. </listitem>
  19. <listitem>
  20. <para>
  21. Автоматическая установка путей к скриптам вида, помощникам
  22. и фильтрам, основанная на текущем модуле, и автоматическое
  23. присоединение имени текущего модуля в качестве префикса имен
  24. классов помощников и фильтров.
  25. </para>
  26. </listitem>
  27. <listitem>
  28. <para>
  29. Создание глобально доступного объекта вида для всех
  30. запускаемых контроллеров и действий.
  31. </para>
  32. </listitem>
  33. <listitem>
  34. <para>
  35. Возможность устанавливать используемые по
  36. умолчанию опции рендеринга для всех контроллеров.
  37. </para>
  38. </listitem>
  39. <listitem>
  40. <para>
  41. Возможность автоматического рендеринга скрипта
  42. вида, не требующего от разработчика каких-либо действий.
  43. </para>
  44. </listitem>
  45. <listitem>
  46. <para>
  47. Возможность создавать собственные спецификации базового пути
  48. вида и путей к скриптам видов.
  49. </para>
  50. </listitem>
  51. </itemizedlist>
  52. <note>
  53. <para>
  54. Если вы вручную производите <code>_forward()</code>,
  55. перенаправление или <code>render</code>, то авторендеринг не
  56. будет произведен, поскольку выполнение любых этих операций
  57. говорит помощнику <code>ViewRenderer</code>, что вы определили
  58. свой собственный вывод.
  59. </para>
  60. </note>
  61. <note>
  62. <para>
  63. <code>ViewRenderer</code> включен по умолчанию. Вы можете
  64. отключить его через параметр фронт-контроллера
  65. <code>noViewRenderer</code>
  66. (<varname>$front->setParam('noViewRenderer', true)</varname>) или
  67. посредством удаления помощника из стека брокера помощников
  68. (<code>Zend_Controller_Action_HelperBroker::removeHelper('viewRenderer')</code>).
  69. </para>
  70. <para>
  71. Если вы хотите изменить настройки <code>ViewRenderer</code> до
  72. начала диспетчеризации, то можете сделать это одним из двух
  73. способов:
  74. </para>
  75. <itemizedlist>
  76. <listitem>
  77. <para>
  78. Инстанцировать и зарегистрировать свой объект
  79. <code>ViewRenderer</code>, а затем передать его брокеру
  80. помощников:
  81. </para>
  82. <programlisting language="php"><![CDATA[
  83. $viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer();
  84. $viewRenderer->setView($view)
  85. ->setViewSuffix('php');
  86. Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);
  87. ]]></programlisting>
  88. </listitem>
  89. <listitem>
  90. <para>
  91. Инициализировать и/или извлечь по запросу объект
  92. <code>ViewRenderer</code> через брокер помощников:
  93. </para>
  94. <programlisting language="php"><![CDATA[
  95. $viewRenderer =
  96. Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  97. $viewRenderer->setView($view)
  98. ->setViewSuffix('php');
  99. ]]></programlisting>
  100. </listitem>
  101. </itemizedlist>
  102. </note>
  103. </sect4>
  104. <sect4 id="zend.controller.actionhelper.viewrenderer.api">
  105. <title>API</title>
  106. <para>
  107. В простейшем варианте использования вы просто инстанцируете
  108. <code>ViewRenderer</code> и передаете его брокеру помощников.
  109. Наиболее легким способом его инстанцирования и регистрации является
  110. использование метода <code>getStaticHelper()</code> брокера
  111. помощников:
  112. </para>
  113. <programlisting language="php"><![CDATA[
  114. Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  115. ]]></programlisting>
  116. <para>
  117. Во время инстанцирования контроллера действий производится вызов
  118. <code>ViewRenderer</code> для инстанцирования объекта вида. Каждый
  119. раз, когда инстанцируется контроллер, вызывается метод
  120. <code>init()</code> помощника <code>ViewRenderer</code>, что
  121. приводит к установке свойства <varname>$view</varname> данного контроллера
  122. действий и вызову метода <code>addScriptPath()</code> с путем
  123. относительно текущего модуля; он будет вызван с префиксом класса,
  124. соответствующим имени текущего модуля, что эффективно
  125. разделяет пространства имен всех классов помощников и фильтров,
  126. определенных для этого модуля.
  127. </para>
  128. <para>
  129. Каждый раз, когда вызывается <code>postDispatch()</code>, он будет
  130. вызывать <code>render()</code> для текущего действия.
  131. </para>
  132. <para>
  133. В качестве примера рассмотрим следующий класс:
  134. </para>
  135. <programlisting language="php"><![CDATA[
  136. // Класс контроллера, модуль foo:
  137. class Foo_BarController extends Zend_Controller_Action
  138. {
  139. // Рендеринг bar/index.phtml по умолчанию;
  140. // не требуется производить какие-либо операции
  141. public function indexAction()
  142. {
  143. }
  144. // Рендеринг bar/populate.phtml с переменной 'foo', установленной в 'bar'.
  145. // Поскольку объект вида определен в preDispatch(), то он всегда доступен.
  146. public function populateAction()
  147. {
  148. $this->view->foo = 'bar';
  149. }
  150. }
  151. ...
  152. // в одном из ваших скриптов вида:
  153. $this->foo(); // вызывает Foo_View_Helper_Foo::foo()
  154. ]]></programlisting>
  155. <para>
  156. <code>ViewRenderer</code> также определяет несколько аксессоров для
  157. того, чтобы можно было устанавливать и извлекать опции видов:
  158. </para>
  159. <itemizedlist>
  160. <listitem>
  161. <para>
  162. <code>setView($view)</code> позволяет установить объект вида
  163. для <code>ViewRenderer</code>. Объект сохраняется в
  164. открытом свойстве <varname>$view</varname> класса.
  165. </para>
  166. </listitem>
  167. <listitem>
  168. <para>
  169. <code>setNeverRender($flag = true)</code> может
  170. использоваться для отключения или включения авторендеринга
  171. глобально, т.е. для всех контроллеров. Если установлен в
  172. <constant>TRUE</constant>, то <code>postDispatch()</code> не будет
  173. автоматически вызывать <code>render()</code> в текущем
  174. контроллере. <code>getNeverRender()</code> возвращает
  175. текущее значение.
  176. </para>
  177. </listitem>
  178. <listitem>
  179. <para>
  180. <code>setNoRender($flag = true)</code> может использоваться
  181. для отключения или включения авторендеринга. Если установлен
  182. в <constant>TRUE</constant>, то <code>postDispatch()</code> не будет
  183. автоматически вызывать <code>render()</code> в текущем
  184. контроллере. Эта установка сбрасывается каждый раз во время
  185. вызова <code>preDispatch()</code> (т.е. нужно устанавливать
  186. этот флаг для каждого контроллера, для которого вы не хотите
  187. производить авторендеринг). <code>getNoRender()</code>
  188. возвращает текущее значение.
  189. </para>
  190. </listitem>
  191. <listitem>
  192. <para>
  193. <code>setNoController($flag = true)</code> может
  194. использоваться для того, чтобы указать
  195. методу <code>render()</code>, чтобы он не искал скрипт вида
  196. в поддиректории с именем контроллера (что является
  197. поведением по умолчанию). <code>getNoController()</code>
  198. возвращает текущее значение.
  199. </para>
  200. </listitem>
  201. <listitem>
  202. <para>
  203. <code>setNeverController($flag = true)</code> является
  204. аналогом <code>setNoController()</code>, но работает на
  205. глобальном уровне - т.е. он не будет сбрасываться с каждым
  206. обработанным действием. <code>getNeverController()</code>
  207. возвращает текущее значение.
  208. </para>
  209. </listitem>
  210. <listitem>
  211. <para>
  212. <code>setScriptAction($name)</code> может использоваться для
  213. того, чтобы указать скрипт действия для рендеринга.
  214. <varname>$name</varname> должен быть именем скрипта без суффикса
  215. (и без поддиректории контроллера, за исключением того
  216. случая, когда включен <code>noController</code>). Если не
  217. задан, то ищется скрипт вида с именем, аналогичным имени
  218. действия в объекте запроса. <code>getScriptAction()</code>
  219. возвращает текущее значение.
  220. </para>
  221. </listitem>
  222. <listitem>
  223. <para>
  224. <code>setResponseSegment($name)</code> может использоваться
  225. для указания того, в какой именованный сегмент объекта
  226. ответа следует сохранить результат рендеринга. Если не
  227. указан, то выходные данные сохраняются в сегменте,
  228. используемом по умолчанию. <code>getResponseSegment()</code>
  229. возвращает текущее значение.
  230. </para>
  231. </listitem>
  232. <listitem>
  233. <para>
  234. <code>initView($path, $prefix, $options)</code> может
  235. вызываться для указания базового пути вида, префикса классов
  236. помощников и фильтров, опций помощника
  237. <code>ViewRenderer</code>. Вы можете передавать любые из
  238. следующих флагов:
  239. <code>neverRender</code>, <code>noRender</code>,
  240. <code>noController</code>, <code>scriptAction</code> и
  241. <code>responseSegment</code>.
  242. </para>
  243. </listitem>
  244. <listitem>
  245. <para>
  246. <code>setRender($action = null, $name = null, $noController
  247. = false)</code> позволяет установить
  248. <code>scriptAction</code>, <code>responseSegment</code>,
  249. или <code>noController</code> за один проход.
  250. <code>direct()</code> является псевдонимом для этого метода,
  251. что дает возможность легко вызывать этот метод из вашего
  252. контроллера.
  253. </para>
  254. <programlisting language="php"><![CDATA[
  255. // Рендеринг 'foo' вместо текущего скрипта вида
  256. $this->_helper->viewRenderer('foo');
  257. // Рендеринг form.phtml в сегмент ответа 'html' в обход
  258. // поддиректории:
  259. $this->_helper->viewRenderer('form', 'html', true);
  260. ]]></programlisting>
  261. <note><para>
  262. <code>setRender()</code> и <code>direct()</code> в
  263. действительности не производят рендеринг скрипта вида, а
  264. устанавливают закрытые свойства помощника, которые
  265. <code>postDispatch()</code> и <code>render()</code>
  266. будут использовать при рендеринге скрипта вида.
  267. </para></note>
  268. </listitem>
  269. </itemizedlist>
  270. <para>
  271. Конструктор позволяет опционально передать объект вида и опции
  272. <code>ViewRenderer</code>. Он использует те же флаги, что и
  273. <code>initView()</code>:
  274. </para>
  275. <programlisting language="php"><![CDATA[
  276. $view = new Zend_View(array('encoding' => 'UTF-8'));
  277. $options = array('noController' => true, 'neverRender' => true);
  278. $viewRenderer =
  279. new Zend_Controller_Action_Helper_ViewRenderer($view, $options);
  280. ]]></programlisting>
  281. <para>
  282. <code>ViewRenderer</code> имеет несколько дополнительных методов для
  283. создания пользовательских спецификаций пути, используемых для
  284. определения базового пути вида, добавляемого в объект вида, и пути к
  285. определенному скрипту вида, используемого при автоматическом
  286. определении скрипта вида для рендеринга. Все эти методы принимают
  287. одну или более меток заполнения:
  288. </para>
  289. <itemizedlist>
  290. <listitem>
  291. <para>
  292. <code>:moduleDir</code> ссылается на текущую базовую
  293. директорию модуля (по соглашению это директория,
  294. родительская по отношению к директории контроллеров модуля).
  295. </para>
  296. </listitem>
  297. <listitem>
  298. <para>
  299. <code>:module</code> ссылается на имя текущего модуля.
  300. </para>
  301. </listitem>
  302. <listitem>
  303. <para>
  304. <code>:controller</code> ссылается на имя текущего
  305. контроллера.
  306. </para>
  307. </listitem>
  308. <listitem>
  309. <para>
  310. <code>:action</code> ссылается на имя текущего действия.
  311. </para>
  312. </listitem>
  313. <listitem>
  314. <para>
  315. <code>:suffix</code> ссылается на суффикс скрипта вида
  316. (который может быть установлен через
  317. <code>setViewSuffix()</code>).
  318. </para>
  319. </listitem>
  320. </itemizedlist>
  321. <para>
  322. Методы для управления спецификациями пути:
  323. </para>
  324. <itemizedlist>
  325. <listitem>
  326. <para>
  327. <code>setViewBasePathSpec($spec)</code> позволяет изменить
  328. спецификацию пути, используемую для определения базового
  329. пути, добавляемого в объект вида. По умолчанию используется
  330. спецификация <code>:moduleDir/views</code>. Вы можете в
  331. любое время получить текущую спецификацицию, используя метод
  332. <code>getViewBasePathSpec()</code>.
  333. </para>
  334. </listitem>
  335. <listitem>
  336. <para>
  337. <code>setViewScriptPathSpec($spec)</code> позволяет изменить
  338. спецификацию пути, используемую для определения пути к
  339. отдельному скрипту вида (без базового пути скрипта вида).
  340. По умолчанию используется спецификация
  341. <code>:controller/:action.:suffix</code>. Вы можете в любое
  342. время получить текущую спецификацию, используя метод
  343. <code>getViewScriptPathSpec()</code>.
  344. </para>
  345. </listitem>
  346. <listitem>
  347. <para>
  348. <code>setViewScriptPathNoControllerSpec($spec)</code>
  349. позволяет изменить спецификацию пути, используемую для
  350. определения пути к отдельному скрипту вида, когда действует
  351. <code>noController</code> (без базового пути скрипта вида).
  352. По умолчанию используется спецификация
  353. <code>:action.:suffix</code>. Вы можете в любое время
  354. получить текущую спецификацию, используя метод
  355. <code>getViewScriptPathNoControllerSpec()</code>.
  356. </para>
  357. </listitem>
  358. </itemizedlist>
  359. <para>
  360. Для более детального управления спецификациями путей вы можете
  361. использовать
  362. <link linkend="zend.filter.inflector">Zend_Filter_Inflector</link>.
  363. Внутри себя <code>ViewRenderer</code> уже использует инфлектор для
  364. поиска соответствий. Для взаимодействия с инфлектором - установки
  365. своего собственного инфлектора или изменения используемого по
  366. умолчанию - могут использоваться следующие методы:
  367. </para>
  368. <itemizedlist>
  369. <listitem>
  370. <para>
  371. <code>getInflector()</code> возвращает инфлектор. Если в
  372. <code>ViewRenderer</code> его нет, то метод создает его,
  373. используя правила по умолчанию.
  374. </para>
  375. <para>
  376. По умолчанию он использует ссылки на статические правила для
  377. суффикса и директории модуля, так же, как и статическую
  378. цель. Это дает различным свойствам <code>ViewRenderer</code>
  379. возможность динамически изменять инфлектор.
  380. </para>
  381. </listitem>
  382. <listitem>
  383. <para>
  384. <code>setInflector($inflector, $reference)</code> позволяет
  385. устанавливать свой инфлектор для использования с
  386. <code>ViewRenderer</code>. Если <varname>$reference</varname>
  387. равен true, то суффикс и директория модуля будут установлены
  388. как статические ссылки на свойства
  389. <code>ViewRenderer</code>, так же, как и цель.
  390. </para></listitem>
  391. </itemizedlist>
  392. <note>
  393. <title>Используемые по умолчанию соглашения по поиску</title>
  394. <para>
  395. <code>ViewRenderer</code> производит некоторую нормализацию пути
  396. для облегчения поиска скрипта вида. Используемые по умолчанию
  397. правила:
  398. </para>
  399. <itemizedlist>
  400. <listitem>
  401. <para>
  402. <code>:module</code>: СловаРазделенныеРегистром
  403. (CamelCase) разделяются тире и вся строка приводится к
  404. нижнему регистру. Например: "FooBarBaz" преобразуется в
  405. "foo-bar-baz".
  406. </para>
  407. <para>
  408. Внутри себя инфлектор использует фильтры
  409. <classname>Zend_Filter_Word_CamelCaseToDash</classname> и
  410. <classname>Zend_Filter_StringToLower</classname>.
  411. </para>
  412. </listitem>
  413. <listitem>
  414. <para>
  415. <code>:controller</code>:
  416. СловаРазделенныеРегистром (CamelCase) разделяются
  417. тире, знаки подчеркивания преобразуются в разделители
  418. директорий и вся строка приводится к нижнему регистру.
  419. Например: "FooBar" преобразуется в "foo-bar";
  420. "FooBar_Admin" преобразуется в "foo-bar/admin".
  421. </para>
  422. <para>
  423. Внутри себя инфлектор использует фильтры
  424. <classname>Zend_Filter_Word_CamelCaseToDash</classname>,
  425. <classname>Zend_Filter_Word_UnderscoreToSeparator</classname> и
  426. <classname>Zend_Filter_StringToLower</classname>.
  427. </para>
  428. </listitem>
  429. <listitem>
  430. <para>
  431. <code>:action</code>:
  432. СловаРазделенныеРегистром (CamelCase) разделяются
  433. тире, символы, не являющиеся буквенно-цифровыми,
  434. переводятся в тире и
  435. вся строка приводится к нижнему регистру.
  436. Например: "fooBar" преобразуется в "foo-bar";
  437. "foo-barBaz" преобразуется в "foo-bar-baz".
  438. </para>
  439. <para>
  440. Внутри себя инфлектор использует фильтры
  441. <classname>Zend_Filter_Word_CamelCaseToDash</classname>,
  442. <classname>Zend_Filter_PregReplace</classname> и
  443. <classname>Zend_Filter_StringToLower</classname>.
  444. </para>
  445. </listitem>
  446. </itemizedlist>
  447. </note>
  448. <para>
  449. Последними рассматриваемыми элементами в API <code>ViewRenderer</code>-а являются
  450. методы для собственно определения путей к скриптам вида и
  451. рендеринга видов. Эти методы включают в себя:
  452. </para>
  453. <itemizedlist>
  454. <listitem>
  455. <para>
  456. <code>renderScript($script, $name)</code> позволяет
  457. производить рендеринг скрипта по указанному пути,
  458. в опционально заданный именованный сегмент. Если
  459. используется этот метод, то <code>ViewRenderer</code> не
  460. производит автоматическое определение имени скрипта, вместо
  461. этого он напрямую передает аргумент <varname>$script</varname>
  462. методу <code>render()</code> объекта вида.
  463. </para>
  464. <note><para>
  465. После того, как был произведен рендеринг вида в объект
  466. ответа, устанавливается <code>noRender</code> для
  467. предотвращения случайного повторного рендеринга того же
  468. скрипта вида.
  469. </para></note>
  470. <note>
  471. <para>
  472. По умолчанию
  473. <code>Zend_Controller_Action::renderScript()</code>
  474. вызывает метод <code>renderScript()</code> помощника
  475. <code>ViewRenderer</code>.
  476. </para>
  477. </note>
  478. </listitem>
  479. <listitem>
  480. <para>
  481. <code>getViewScript($action, $vars)</code> создает путь к
  482. скрипту вида, основываясь на переданном действии $action
  483. и/или переменных, переданных в $vars. Этот массив может
  484. включать в себя ключи спецификаций пути ('moduleDir',
  485. 'module', 'controller', 'action' и 'suffix'). Если
  486. была передана переменная, то она будет использована, иначе
  487. будут использоваться значения из текущего запроса.
  488. </para>
  489. <para>
  490. <code>getViewScript()</code> будет использовать
  491. <code>viewScriptPathSpec</code>, либо
  492. <code>viewScriptPathNoControllerSpec</code>, в зависимости
  493. от значения флага <code>noController</code>.
  494. </para>
  495. <para>
  496. Разделители слов в именах модуля, контроллера или действия
  497. будут заменены на тире ('-'). Таким образом, если вы имеете
  498. контроллер с именем 'foo.bar' и действие 'baz:bat', то при
  499. использовании спецификации по умолчанию результатом
  500. будет путь 'foo-bar/baz-bat.phtml' к скрипту вида.
  501. </para>
  502. <note>
  503. <para>
  504. По умолчанию
  505. <code>Zend_Controller_Action::getViewScript()</code>
  506. вызывает метод <code>getViewScript()</code>
  507. <code>ViewRenderer</code>-а.
  508. </para>
  509. </note>
  510. </listitem>
  511. <listitem>
  512. <para>
  513. <code>render($action, $name, $noController)</code> сначала
  514. проверяет, были ли переданы параметры <varname>$name</varname> или
  515. <varname>$noController</varname>, и если были переданы, то
  516. устанавливает соответствующие флаги (responseSegment и
  517. noController соответственно) в ViewRenderer. Затем он
  518. передает параметр <varname>$action</varname> (если есть) методу
  519. <code>getViewScript()</code>. Наконец, он передает
  520. полученный путь к скрипту вида методу
  521. <code>renderScript()</code>.
  522. </para>
  523. <note>
  524. <para>
  525. Следует помнить о побочных эффектах использования
  526. render(): значения, передаваемые для имени сегмента
  527. ответа и флага noController, сохраняются в объекте.
  528. Кроме этого, по окончании рендеринга будет установлен
  529. noRender.
  530. </para>
  531. </note>
  532. <note>
  533. <para>
  534. По умолчанию
  535. <code>Zend_Controller_Action::render()</code> вызывает
  536. метод <code>render()</code> помощника
  537. <code>ViewRenderer</code>.
  538. </para>
  539. </note>
  540. </listitem>
  541. <listitem>
  542. <para>
  543. <code>renderBySpec($action, $vars, $name)</code> позволяет
  544. передавать переменные спецификации пути для определения
  545. создаваемого пути к скрипту вида. Он передает
  546. <varname>$action</varname> и <varname>$vars</varname> методу
  547. <code>getScriptPath()</code>, затем передает полученный путь
  548. и <varname>$name</varname> методу <code>renderScript()</code>.
  549. </para>
  550. </listitem>
  551. </itemizedlist>
  552. </sect4>
  553. <sect4 id="zend.controller.actionhelper.viewrenderer.basicusage">
  554. <title>Примеры базового использования</title>
  555. <example id="zend.controller.actionhelper.viewrenderer.basicusage.example-1">
  556. <title>Базовое использование</title>
  557. <para>
  558. В простейшем случае вы просто инициализируете и
  559. регистрируете помощник <code>ViewRenderer</code> через брокер
  560. помощников в своем файле загрузки и затем устанавливаете
  561. переменные в своих методах действий.
  562. </para>
  563. <programlisting language="php"><![CDATA[
  564. // В вашем файле загрузки:
  565. Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  566. ...
  567. // Модуль 'foo', контроллер 'bar':
  568. class Foo_BarController extends Zend_Controller_Action
  569. {
  570. // По умолчанию производится рендеринг bar/index.phtml;
  571. // дополнительные действия не требуются
  572. public function indexAction()
  573. {
  574. }
  575. // Рендеринг bar/populate.phtml с переменной 'foo', установленной в 'bar'.
  576. // Поскольку объект вида был определен в preDispatch(), то он уже
  577. // доступен для использования.
  578. public function populateAction()
  579. {
  580. $this->view->foo = 'bar';
  581. }
  582. // Ничего не рендерится, т.к. производится переход на другое действие;
  583. // это другое действие может производить рендеринг
  584. public function bazAction()
  585. {
  586. $this->_forward('index');
  587. }
  588. // Ничего не рендерится, т.к. производится перенаправление по другому адресу
  589. public function batAction()
  590. {
  591. $this->_redirect('/index');
  592. }
  593. }
  594. ]]></programlisting>
  595. </example>
  596. <note>
  597. <title>Соглашения по именованию: Разделители слов в именах контроллера и действия</title>
  598. <para>
  599. Если имена вашего контроллера и действия состоят из
  600. нескольких слов, то диспетчер требует, чтобы в URL они были
  601. разделены определенными символами-разделителями слов и
  602. путей. <code>ViewRenderer</code> при создании путей заменяет все
  603. найденные в имени контроллера разделители путей действующим
  604. разделителем путей ('/') и все разделители слов - чертой
  605. ('-'). Таким образом, вызов действия
  606. <code>/foo.bar/baz.bat</code> должен быть преобразован в
  607. вызов метода <code>FooBarController::bazBatAction()</code> в
  608. <code>FooBarController.php</code>, который в свою очередь
  609. произведет рендеринг скрипта вида <code>foo-bar/baz-bat.phtml</code>.
  610. Вызов действия <code>/bar_baz/baz-bat</code> должен быть
  611. преобразован в вызов
  612. <code>Bar_BazController::bazBatAction()</code> в
  613. <code>Bar/BazController.php</code> (обратите внимание на
  614. разделение путей), при этом производится рендеринг
  615. <code>bar/baz/baz-bat.phtml</code>.
  616. </para>
  617. <para>
  618. Во втором примере обратите внимание на то, что по-прежнему
  619. используется модуль по умолчанию, но из-за наличия
  620. разделителя путей получается имя контроллера
  621. <code>Bar_BazController</code> в файле
  622. <code>Bar/BazController.php</code>. <code>ViewRenderer</code>
  623. имитирует иерархию директорий контроллеров.
  624. </para>
  625. </note>
  626. <example id="zend.controller.actionhelper.viewrenderer.basicusage.example-2">
  627. <title>Отключение авторендеринга</title>
  628. <para>
  629. Может потребоваться отключить авторендеринг для некоторых
  630. действий или контроллеров - например, если вы хотите производить
  631. вывод другого типа (XML, JSON и т.д.), или просто не хотите
  632. ничего выводить. Есть два варианта - либо полностью
  633. отключить авторендеринг (<code>setNeverRender()</code>), либо
  634. отключить его для текущего действия
  635. (<code>setNoRender()</code>).
  636. </para>
  637. <programlisting language="php"><![CDATA[
  638. // Класс контроллера baz, модуль bar:
  639. class Bar_BazController extends Zend_Controller_Action
  640. {
  641. public function fooAction()
  642. {
  643. // Не производить авторендеринг в этом действии
  644. $this->_helper->viewRenderer->setNoRender();
  645. }
  646. }
  647. // Класс контроллера bat, модуль bar:
  648. class Bar_BatController extends Zend_Controller_Action
  649. {
  650. public function preDispatch()
  651. {
  652. // Не производить авторендеринг во всех действиях этого контроллера
  653. $this->_helper->viewRenderer->setNoRender();
  654. }
  655. }
  656. ]]></programlisting>
  657. </example>
  658. <note>
  659. <para>
  660. В большинстве случаев не имеет смысла глобально отключать
  661. авторендеринг (через <code>setNeverRender()</code>), поскольку
  662. единственная выгода, которую вы получаете в этом случае от
  663. использования <code>ViewRenderer</code> - автоматическая
  664. установка объекта вида.
  665. </para>
  666. </note>
  667. <example id="zend.controller.actionhelper.viewrenderer.basicusage.example-3">
  668. <title>Выбор другого скрипта вида</title>
  669. <para>
  670. В некоторых случаях требуется, чтобы производился рендеринг
  671. скрипта с именем, отличным от имени действия. Например, если у
  672. вас есть контроллер, который имеет методы действий для
  673. добавления и редактирования, они оба могут отображать один и тот
  674. же вид 'форма', хоть и с разным набором значений. Вы легко
  675. можете изменить имя скрипта, используя методы
  676. <code>setScriptAction()</code> и <code>setRender()</code>, или
  677. вызывая помощника как метод брокера - этим будет произведен
  678. вызов метода <code>setRender()</code>.
  679. </para>
  680. <programlisting language="php"><![CDATA[
  681. // Класс контроллера bar, модуль foo:
  682. class Foo_BarController extends Zend_Controller_Action
  683. {
  684. public function addAction()
  685. {
  686. // Рендерить 'bar/form.phtml' вместо 'bar/add.phtml'
  687. $this->_helper->viewRenderer('form');
  688. }
  689. public function editAction()
  690. {
  691. // Рендерить 'bar/form.phtml' вместо 'bar/edit.phtml'
  692. $this->_helper->viewRenderer->setScriptAction('form');
  693. }
  694. public function processAction()
  695. {
  696. // произведение валидации...
  697. if (!$valid) {
  698. // Рендерить 'bar/form.phtml' вместо 'bar/process.phtml'
  699. $this->_helper->viewRenderer->setRender('form');
  700. return;
  701. }
  702. // иначе продолжение обработки...
  703. }
  704. }
  705. ]]></programlisting>
  706. </example>
  707. <example id="zend.controller.actionhelper.viewrenderer.basicusage.example-4">
  708. <title>Изменение зарегистрированного объекта вида</title>
  709. <para>
  710. А что, если нужно модифицировать объект вида - например,
  711. изменить пути к помощникам или кодировку? Вы можете делать это
  712. как через модификацию объекта вида, установленного в вашем
  713. контроллере, так и через извлечение объекта вида из
  714. <code>ViewRenderer</code>, оба они являются ссылками на один и
  715. тот же объект.
  716. </para>
  717. <programlisting language="php"><![CDATA[
  718. // Класс контроллера bar, модуль foo:
  719. class Foo_BarController extends Zend_Controller_Action
  720. {
  721. public function preDispatch()
  722. {
  723. // Изменение кодировки вида
  724. $this->view->setEncoding('UTF-8');
  725. }
  726. public function bazAction()
  727. {
  728. // Получение объекта вида и указание 'htmlspecialchars'
  729. // в качестве функции для экранирования
  730. $view = $this->_helper->viewRenderer->view;
  731. $view->setEscape('htmlspecialchars');
  732. }
  733. }
  734. ]]></programlisting>
  735. </example>
  736. </sect4>
  737. <sect4 id="zend.controller.actionhelper.viewrenderer.advancedusage">
  738. <title>Примеры продвинутого использования</title>
  739. <example id="zend.controller.actionhelper.viewrenderer.advancedusage.example-1">
  740. <title>Изменение спецификаций пути</title>
  741. <para>
  742. В некоторых случаях вы можете решить, что спецификации пути,
  743. используемые по умолчанию, не соответствуют требованиям вашего
  744. сайта. Например, вы можете захотеть иметь одно дерево шаблонов,
  745. к которому можно давать доступ дизайнерам (что, например,
  746. довольно типично в случае использованя
  747. <ulink url="http://smarty.php.net/">Smarty</ulink>).
  748. В таком случае вы можете захотеть задать жесткую
  749. спецификацию базового пути вида и создать альтернативную
  750. спецификацию для собственно путей к скриптам вида.
  751. </para>
  752. <para>
  753. В рамках данного примера предположим, что базовый путь к
  754. скриптам вида - '/opt/vendor/templates', и вы хотите, чтобы
  755. обращение к скриптам вида производилось по схеме
  756. ':moduleDir/:controller/:action.:suffix'. Также предположим, что
  757. если флаг noController установлен, то нужно, чтобы использовался
  758. верхний уровень вместо поддиректории (':action.:suffix'). И
  759. наконец, вы хотите использовать 'tpl' в качестве суффикса имени
  760. скрипта вида.
  761. </para>
  762. <programlisting language="php"><![CDATA[
  763. /**
  764. * В вашем файле загрузки:
  765. */
  766. // Другая реализация вида
  767. $view = new ZF_Smarty();
  768. $viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer($view);
  769. $viewRenderer->setViewBasePathSpec('/opt/vendor/templates')
  770. ->setViewScriptPathSpec(':module/:controller/:action.:suffix')
  771. ->setViewScriptPathNoControllerSpec(':action.:suffix')
  772. ->setViewSuffix('tpl');
  773. Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);
  774. ]]></programlisting>
  775. </example>
  776. <example id="zend.controller.actionhelper.viewrenderer.advancedusage.example-2">
  777. <title>Рендеринг нескольких скриптов вида из одного действия</title>
  778. <para>
  779. Иногда бывает нужно произвести рендеринг нескольких скриптов
  780. вида из одного действия. Решение довольно очевидное - просто
  781. сделайте несколько вызовов метода <code>render()</code>:
  782. </para>
  783. <programlisting language="php"><![CDATA[
  784. class SearchController extends Zend_Controller_Action
  785. {
  786. public function resultsAction()
  787. {
  788. // Предполагается, что $this->model - текущая модель
  789. $this->view->results =
  790. $this->model->find($this->_getParam('query', '');
  791. // render() по умолчанию использует ViewRenderer
  792. // Рендеринг формы поиска и затем результатов поиска
  793. $this->render('form');
  794. $this->render('results');
  795. }
  796. public function formAction()
  797. {
  798. // Ничего не делается. ViewRenderer автоматически производит
  799. // рендеринг скрипта вида
  800. }
  801. }
  802. ]]></programlisting>
  803. </example>
  804. </sect4>
  805. </sect3>
  806. <!--
  807. vim:se ts=4 sw=4 et:
  808. -->