documentation/manual/ru/module_specs/Zend_Controller-QuickStart.xml

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