Zend_Controller-QuickStart.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347
  1. <sect1 id="zend.controller.quickstart">
  2. <title>Zend_Controller - Быстрый старт</title>
  3. <sect2 id="zend.controller.quickstart.introduction">
  4. <title>Введение</title>
  5. <para>
  6. <code>Zend_Controller</code> является ядром системы MVC в Zend
  7. Framework. Аббревиатура MVC - сокращение от
  8. <ulink url="http://en.wikipedia.org/wiki/Model-view-controller">Model-View-Controller</ulink>
  9. (модель-вид-контроллер), это паттерн проектирования, предназначенный
  10. для отделения логики приложения от логики представления.
  11. <code>Zend_Controller_Front</code> реализует паттерн
  12. <ulink url="http://www.martinfowler.com/eaaCatalog/frontController.html">Front
  13. Controller</ulink>, в котором все запросы перехватываются
  14. фронт-контроллером (front controller) и перенаправляются отдельным
  15. контроллерам действий (action controllers), выбор которых
  16. производится по запрошенному URL.
  17. </para>
  18. <para>
  19. Система <code>Zend_Controller</code> построена с расчетом на
  20. расширяемость как через наследование от уже существующих классов
  21. и написание новых классов, реализующих различные интерфейсы и
  22. абстрактные классы, образующих основу семейства классов
  23. контроллеров, так и через написание плагинов или помощников действий
  24. для наращивания функциональности системы или управления ею.
  25. </para>
  26. </sect2>
  27. <sect2 id="zend.controller.quickstart.go">
  28. <title>Быстрый старт</title>
  29. <para>
  30. Если вам нужна более подробная информация, то сразу переходите к
  31. следующим разделам. Если хотите быстро начать работать с
  32. <code>Zend_Controller</code>, то читайте далее.
  33. </para>
  34. <sect3 id="zend.controller.quickstart.go.directory">
  35. <title>Создайте файловую структуру</title>
  36. <para>
  37. Первый шаг состоит в том, чтобы создать файловую
  38. структуру приложения. Ниже приведено типовое решение:
  39. </para>
  40. <programlisting role="php"><![CDATA[
  41. application/
  42. controllers/
  43. IndexController.php
  44. models/
  45. views/
  46. scripts/
  47. index/
  48. index.phtml
  49. helpers/
  50. filters/
  51. html/
  52. .htaccess
  53. index.php
  54. ]]>
  55. </programlisting>
  56. </sect3>
  57. <sect3 id="zend.controller.quickstart.go.docroot">
  58. <title>Установите корневую директорию для документов</title>
  59. <para>
  60. В своем веб-сервере установите директорию <code>html</code> из
  61. приведенной выше структуры в качестве корневой для
  62. веб-документов.
  63. </para>
  64. </sect3>
  65. <sect3 id="zend.controller.quickstart.go.rewrite">
  66. <title>Создайте свои правила перезаписи</title>
  67. <para>
  68. Отредактируйте файл <code>html/.htaccess</code> из
  69. приведенной выше структуры следующим образом:
  70. </para>
  71. <programlisting role="php"><![CDATA[
  72. RewriteEngine On
  73. RewriteCond %{REQUEST_FILENAME} -s [OR]
  74. RewriteCond %{REQUEST_FILENAME} -l [OR]
  75. RewriteCond %{REQUEST_FILENAME} -d
  76. RewriteRule ^.*$ - [NC,L]
  77. RewriteRule ^.*$ index.php [NC,L]
  78. ]]>
  79. </programlisting>
  80. <para>
  81. Если у вас IIS 7.0, то используйте следующую
  82. конфигурацию перезаписи:
  83. </para>
  84. <programlisting role="xml"><![CDATA[
  85. <?xml version="1.0" encoding="UTF-8"?>
  86. <configuration>
  87. <system.webServer>
  88. <rewrite>
  89. <rules>
  90. <rule name="Imported Rule 1" stopProcessing="true">
  91. <match url="^.*$" />
  92. <conditions logicalGrouping="MatchAny">
  93. <add input="{REQUEST_FILENAME}"
  94. matchType="IsFile" pattern=""
  95. ignoreCase="false" />
  96. <add input="{REQUEST_FILENAME}"
  97. matchType="IsDirectory"
  98. pattern="" ignoreCase="false" />
  99. </conditions>
  100. <action type="None" />
  101. </rule>
  102. <rule name="Imported Rule 2" stopProcessing="true">
  103. <match url="^.*$" />
  104. <action type="Rewrite" url="index.php" />
  105. </rule>
  106. </rules>
  107. </rewrite>
  108. </system.webServer>
  109. </configuration>
  110. ]]></programlisting>
  111. <para>
  112. Эти правила перезаписи пропускают запросы к
  113. существующим ресурсам (существующие символьные
  114. ссылки, непустые файлы и директории), все остальные запросы
  115. перенаправляются к фронт-контроллеру.
  116. </para>
  117. <note>
  118. <para>
  119. Вышеприведенные правила перезаписи предназначены для
  120. веб-сервера Apache. За примерами правил перезаписи для
  121. других веб-серверов см. <link linkend="zend.controller.router.introduction">документацию
  122. по маршрутизаторам</link>.
  123. </para>
  124. </note>
  125. </sect3>
  126. <sect3 id="zend.controller.quickstart.go.bootstrap">
  127. <title>Создайте файл загрузки</title>
  128. <para>
  129. Файл загрузки - это страница, на которую направляются все
  130. запросы, в нашем случае это <code>html/index.php</code>.
  131. Откройте <code>html/index.php</code> в любом текстовом редакторе
  132. и добавьте следующие строки:
  133. </para>
  134. <programlisting role="php"><![CDATA[
  135. Zend_Controller_Front::run('/path/to/app/controllers');
  136. ]]>
  137. </programlisting>
  138. <para>
  139. Этот код выполняет инстанцирование и запуск фронт-контроллера,
  140. который будет направлять запросы к контроллерам действий.
  141. </para>
  142. </sect3>
  143. <sect3 id="zend.controller.quickstart.go.controller">
  144. <title>Создайте свой контроллер действий, используемый по умолчанию</title>
  145. <para>
  146. До того, как начать обсуждение контроллеров действий, нужно
  147. сначала понять, как обрабатываются запросы в Zend Framework. По
  148. умолчанию первая часть пути в URL соответствует контроллеру, а
  149. вторая - действию. Например, дан URL
  150. <code>http://framework.zend.com/roadmap/components</code>. В нем
  151. путь <code>/roadmap/components</code> будет соответствовать
  152. контроллеру <code>roadmap</code> и действию
  153. <code>components</code>. Если не передано имя действия, то
  154. предполагается действие <code>index</code>; если не передано имя
  155. контроллера, то предполагается контроллер <code>index</code> (по
  156. соглашению Apache это соответствует
  157. <code>DirectoryIndex</code>).
  158. </para>
  159. <para>
  160. Диспетчер <code>Zend_Controller</code> принимает значение
  161. контроллера и находит соответствующий ему класс. По умолчанию
  162. это имя контроллера, начинающееся с заглавной буквы и со словом
  163. <code>Controller</code> в конце. Таким образом, контроллер
  164. <code>roadmap</code> будет соответствовать классу
  165. <code>RoadmapController</code>.
  166. </para>
  167. <para>
  168. Аналогичным образом устанавливается соответствие значения
  169. действия методу класса контроллера. По умолчанию значение
  170. приводится к нижнему регистру и к нему присоединяется слово
  171. <code>Action</code>. Таким образом, в нашем примере выше
  172. действие <code>components</code> будет методом с именем
  173. <code>componentsAction</code>, и в итоге вызов метода
  174. будет выглядеть следующим образом:
  175. <code>RoadmapController::componentsAction()</code>.
  176. </para>
  177. <para>
  178. Итак, двигаемся дальше. Теперь приступим к созданию контроллера
  179. и действия, используемых по умолчанию. Как было замечено ранее,
  180. эти контроллер и действие должны оба называться
  181. <code>index</code>. Откройте файл
  182. <code>application/controllers/IndexController.php</code> и
  183. введите следующее:
  184. </para>
  185. <programlisting role="php"><![CDATA[
  186. /** Zend_Controller_Action */
  187. class IndexController extends Zend_Controller_Action
  188. {
  189. public function indexAction()
  190. {
  191. }
  192. }
  193. ]]>
  194. </programlisting>
  195. <para>
  196. По умолчанию включен помощник действий <link
  197. linkend="zend.controller.actionhelpers.viewrenderer">ViewRenderer</link>.
  198. Это означает, что, просто определив метод действия и
  199. соответствующий скрипт вида, вы получите рендеринг контента.
  200. По умолчанию в MVC в качестве "вида" используется
  201. <code>Zend_View</code>. <code>render()</code> использует имя
  202. контроллера (например, <code>index</code>) и имя текущего
  203. действия (например, <code>index</code>) для определения того,
  204. какой шаблон тянуть. По умолчанию шаблоны имеют расширение
  205. <code>.phtml</code>, это значит, что в нашем примере будет
  206. использоваться шаблон <code>index/index.phtml</code>. Кроме
  207. этого, <code>ViewRenderer</code> автоматически
  208. предполагает, что директория <code>views</code>, находящаяся на
  209. том же уровне, что и директория контроллера, будет базовой
  210. директорией видов, и что действующие скрипты вида будут в
  211. поддиректории <code>views/scripts/</code>.
  212. Таким образом, шаблон для рендеринга будет находится в
  213. <code>application/views/scripts/index/index.phtml</code>.
  214. </para>
  215. </sect3>
  216. <sect3 id="zend.controller.quickstart.go.view">
  217. <title>Создайте скрипт вида</title>
  218. <para>
  219. Как было упомянуто в <link linkend="zend.controller.quickstart.go.controller">предыдущем
  220. разделе</link>, скрипты вида находятся в
  221. <code>application/views/scripts/</code>. Скриптом вида для
  222. контроллера и действия, используемых по умолчанию, является
  223. <code>application/views/scripts/index/index.phtml</code>.
  224. Создайте этот файл и добавьте в него какой-либо HTML-код:
  225. </para>
  226. <programlisting role="php"><![CDATA[
  227. <!DOCTYPE html
  228. PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  229. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  230. <html>
  231. <head>
  232. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  233. <title>My first Zend Framework App</title>
  234. </head>
  235. <body>
  236. <h1>Hello, World!</h1>
  237. </body>
  238. </html>
  239. ]]>
  240. </programlisting>
  241. </sect3>
  242. <sect3 id="zend.controller.quickstart.go.errorhandler">
  243. <title>Создайте контроллер ошибок</title>
  244. <para>
  245. По умолчанию зарегистрирован <link
  246. linkend="zend.controller.plugins.standard.errorhandler">плагин-обработчик
  247. ошибок</link>. Этот плагин ожидает, что есть контроллер для
  248. обработки ошибок. По умолчанию он предполагает, что в модуле,
  249. используемом по умолчанию, имеется контроллер
  250. <code>ErrorController</code> с методом <code>errorAction</code>.
  251. </para>
  252. <programlisting role="php"><![CDATA[
  253. class ErrorController extends Zend_Controller_Action
  254. {
  255. public function errorAction()
  256. {
  257. }
  258. }
  259. ]]>
  260. </programlisting>
  261. <para>
  262. Согласно уже обсуждаемой выше структуре директорий этот файл
  263. будет находиться по пути
  264. <code>application/controllers/ErrorController.php</code>. Нужно
  265. также создать скрипт вида
  266. <code>application/views/scripts/error/error.phtml</code>, пример
  267. его содержимого:
  268. </para>
  269. <programlisting role="php"><![CDATA[
  270. <!DOCTYPE html
  271. PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  272. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  273. <html>
  274. <head>
  275. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  276. <title>Error</title>
  277. </head>
  278. <body>
  279. <h1>An error occurred</h1>
  280. <p>An error occurred; please try again later.</p>
  281. </body>
  282. </html>
  283. ]]>
  284. </programlisting>
  285. </sect3>
  286. <sect3 id="zend.controller.quickstart.go.finish">
  287. <title>Смотрим сайт!</title>
  288. <para>
  289. Теперь, имея свои первые контроллер и вид, вы можете
  290. запустить свой броузер и просматривать сайт. Если ваш домен -
  291. <code>example.com</code>, то любой из следующих URL-ов будет
  292. возвращать ту страницу, которую вы только что создали:
  293. </para>
  294. <itemizedlist>
  295. <listitem><para><code>http://example.com/</code></para></listitem>
  296. <listitem><para><code>http://example.com/index</code></para></listitem>
  297. <listitem><para><code>http://example.com/index/index</code></para></listitem>
  298. </itemizedlist>
  299. <para>
  300. Теперь вы можете приступить к созданию других контроллеров и
  301. методы действий. Поздравляем!
  302. </para>
  303. </sect3>
  304. </sect2>
  305. </sect1>
  306. <!--
  307. vim:se ts=4 sw=4 et:
  308. -->