Zend_Controller-QuickStart.xml 18 KB

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