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

   1 <sect1 id="zend.layout.quickstart">
   2     <title>Zend_Layout - Быстрый старт</title>
   3
   4     <para>
   5         В этом разделе представлены два основных способа использования
   6         <code>Zend_Layout</code>: с MVC и без.
   7     </para>
   8
   9     <sect2 id="zend.layout.quickstart.layouts">
  10         <title>Скрипты макетов</title>
  11
  12         <para>
  13             В обоих случаях вам нужно создать скрипт макета.
  14             Скрипты макета используют Zend_View (или другую
  15             реализацию интерфейса Zend_View_Interface, используемую вами).
  16             Переменные макета регистрируются с помощью
  17             <link linkend="zend.view.helpers.initial.placeholder">метки
  18             заполнения</link> <code>Zend_Layout</code>-а,
  19             и доступ к ним может быть произведен через
  20             <link linkend="zend.view.helpers.initial.placeholder">помощника
  21             меток заполнения</link>, либо путем извлечения их как свойств
  22             объекта макета посредством помощника макета.
  23         </para>
  24
  25         <para>
  26             Пример:
  27         </para>
  28
  29         <programlisting language="php"><![CDATA[
  30 <!DOCTYPE html
  31     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  32     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  33 <html>
  34 <head>
  35     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  36     <title>My Site</title>
  37 </head>
  38 <body>
  39 <?php
  40     // извлечение содержимого ключа 'content'
  41     // с использованием помощника макета:
  42     echo $this->layout()->content;
  43
  44     // извлечение содержимого ключа 'foo'
  45     // с использованием помощника меток заполнения:
  46     echo $this->placeholder('Zend_Layout')->foo;
  47
  48     // извлечение объекта макета и получение различных переменных из него
  49     $layout = $this->layout();
  50     echo $layout->bar;
  51     echo $layout->baz;
  52 ?>
  53 </body>
  54 </html>
  55 ]]></programlisting>
  56
  57         <para>
  58             Поскольку <code>Zend_Layout</code> использует <code>Zend_View</code>
  59             для рендеринга, то вы можете использовать любые зарегистрированные
  60             помощники видов, а также обращаться к любым установленным ранее
  61             переменным вида.
  62             Особенно полезны различные <link
  63                 linkend="zend.view.helpers.initial.placeholder">помощники меток
  64                 заполнения</link>, так как они позволяют извлекать содержимое
  65                 таких областей, как раздел &lt;head&gt;, навигация и т.п.:
  66         </para>
  67
  68         <programlisting language="php"><![CDATA[
  69 <!DOCTYPE html
  70     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  71     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  72 <html>
  73 <head>
  74     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  75     <?= $this->headTitle() ?>
  76     <?= $this->headScript() ?>
  77     <?= $this->headStyle() ?>
  78 </head>
  79 <body>
  80     <?= $this->render('header.phtml') ?>
  81
  82     <div id="nav"><?= $this->placeholder('nav') ?></div>
  83
  84     <div id="content"><?= $this->layout()->content ?></div>
  85
  86     <?= $this->render('footer.phtml') ?>
  87 </body>
  88 </html>
  89 ]]></programlisting>
  90     </sect2>
  91
  92     <sect2 id="zend.layout.quickstart.mvc">
  93         <title>Использование Zend_Layout с MVC Zend Framework-а</title>
  94
  95         <para>
  96             <code>Zend_Controller</code> предлагает богатый набор
  97             возможностей для расширения посредством
  98             <link linkend="zend.controller.plugins">плагинов
  99             фронт-контроллера</link> и <link
 100             linkend="zend.controller.actionhelpers">помощников действий</link>.
 101             <code>Zend_View</code> тоже имеет своих
 102             <link linkend="zend.view.helpers">помощников</link>.
 103             <code>Zend_Layout</code> использует возможности такого расширения
 104             при использовании с компонентами MVC.
 105         </para>
 106
 107         <para>
 108             <code>Zend_Layout::startMvc()</code> создает экземпляр
 109             <code>Zend_Layout</code> с любой предоставленной вами конфигурацией
 110             (опционально). Затем он регистрирует плагин фронт-контроллера,
 111             который производит рендеринг макета с любым содержимым приложения
 112             сразу, как только завершается цикл диспетчеризации, регистрирует
 113             помощник действия для доступа к объекту макета из ваших контроллеров
 114             действий. Кроме этого, вы можете в любой момент времени извлечь
 115             экземпляр макета внутри скрипта вида, используя помощник вида
 116             <code>layout</code>.
 117         </para>
 118
 119         <para>
 120             Для начала посмотрим, как производится инициализация Zend_Layout для
 121             использования в MVC:
 122         </para>
 123
 124         <programlisting language="php"><![CDATA[<?php
 125 // В вашем файле загрузки:
 126 Zend_Layout::startMvc();
 127 ?>]]></programlisting>
 128
 129         <para>
 130             <code>startMvc()</code> может принимать массив опций или объект
 131             <code>Zend_Config</code> для настойки экземпляра. Эти опции описаны
 132             в <xref linkend="zend.layout.options" />.
 133         </para>
 134
 135         <para>
 136             В контроллере действий вы можете обращаться к экземпляру макета как
 137             к помощнику действий:
 138         </para>
 139
 140         <programlisting language="php"><![CDATA[<?php
 141 class FooController extends Zend_Controller_Action
 142 {
 143     public function barAction()
 144     {
 145         // отключение макета для данного действия
 146         $this->_helper->layout->disableLayout();
 147     }
 148
 149     public function bazAction()
 150     {
 151         // использование другого скрипта макета с этим действием
 152         $this->_helper->layout->setLayout('foobaz');
 153     };
 154 }
 155 ?>]]></programlisting>
 156
 157         <para>
 158             В своих скриптах вида вы можете обращаться к объекту вида через
 159             помощник вида <code>layout</code>. Этот помощник вида немного
 160             отличается от остальных тем, что не принимает аргументов и
 161             возвращает объект вместо строкового значения. Это позволяет сразу
 162             вызывать методы объекта макета:
 163         </para>
 164
 165         <programlisting language="php"><![CDATA[
 166 <?php $this->layout()->setLayout('foo'); // установка другого макета ?>
 167 ]]></programlisting>
 168
 169         <para>
 170             Вы можете в любой момент времени извлечь зарегистрированный с MVC
 171             экземпляр <code>Zend_Layout</code>, используя статический метод
 172             <code>getMvcInstance()</code>:
 173         </para>
 174
 175         <programlisting language="php"><![CDATA[<?php
 176 // Возвращает null, если до этого не был вызван startMvc()
 177 $layout = Zend_Layout::getMvcInstance();
 178 ?>]]></programlisting>
 179
 180         <para>
 181             Наконец, плагин фронт-контроллера для <code>Zend_Layout</code>-а
 182             имеет одну ценную возможность в дополнение к рендерингу самого
 183             макета: он извлекает все именованные сегменты из объекта ответа и
 184             устанавливает их как переменные макета, при этом сегмент 'default'
 185             присваивается переменной 'content'. Это позволяет иметь доступ к
 186             содержимому приложения и производить его рендеринг в вашем скрипте
 187             вида.
 188         </para>
 189
 190         <para>
 191             Для примера предположим, что в вашем приложении вызывается
 192             <code>FooController::indexAction()</code>, который производит
 193             рендеринг некоторого содержимого в используемый по умолчанию сегмент
 194             ответа и затем производит переход к действию
 195             <code>NavController::menuAction()</code>, который рендерит
 196             содержимое в сегмент 'nav' объекта ответа. Наконец, вы производите
 197             переход к действию <code>CommentController::fetchAction()</code> и
 198             извлекаете комментарии, но их рендеринг производится в
 199             используемый по умолчанию сегмент (комментарии добавляются в конец
 200             уже имеющегося содержимого). Ваш скрипт вида может затем произвести
 201             их рендеринг по отдельности:
 202         </para>
 203
 204         <programlisting language="php"><![CDATA[
 205 <body>
 206     <!-- рендеринг /nav/menu -->
 207     <div id="nav"><?= $this->layout()->nav ?></div>
 208
 209     <!-- рендеринг /foo/index + /comment/fetch -->
 210     <div id="content"><?= $this->layout()->content ?></div>
 211 </body>
 212 ]]></programlisting>
 213
 214         <para>
 215             Эта возможность особенно полезна, если используется вместе с
 216             <link linkend="zend.controller.actionhelpers.actionstack">помощником
 217             действий</link> и
 218             <link
 219             linkend="zend.controller.plugins.standard.actionstack">плагином
 220             ActionStack</link>, с помощью которых вы можете создавать
 221             стек действий для обхода в цикле диспетчеризации и таким
 222             образом создавать страницы с различными "виджетами".
 223         </para>
 224     </sect2>
 225
 226     <sect2 id="zend.layout.quickstart.standalone">
 227         <title>Использование Zend_Layout как отдельной компоненты</title>
 228
 229         <para>
 230             Как отдельная компонента Zend_Layout не предоставляет столько
 231             возможностей или такого удобства, как в случае использовании с MVC.
 232             Тем не менее, и в таком использовании сохраняются два основных
 233             преимущества:
 234         </para>
 235
 236         <itemizedlist>
 237             <listitem><para>
 238                     Область видимости переменных макета.
 239             </para></listitem>
 240
 241             <listitem><para>
 242                     Отделение скрипта макета от других скриптов видов.
 243             </para></listitem>
 244         </itemizedlist>
 245
 246         <para>
 247             При использовании Zend_Layout в качестве отдельной компоненты просто
 248             инстанцируйте объект макета, используйте различные аксессоры для
 249             установки состояния, устанавливайте переменные как свойства объекта
 250             и производите рендеринг макета:
 251         </para>
 252
 253         <programlisting language="php"><![CDATA[<?php
 254 $layout = new Zend_Layout();
 255
 256 // Установка пути к скриптам макета:
 257 $layout->setLayoutPath('/path/to/layouts');
 258
 259 // установка переменных:
 260 $layout->content = $content;
 261 $layout->nav     = $nav;
 262
 263 // выбор другого скрипта вида:
 264 $layout->setLayout('foo');
 265
 266 // рендеринг конечного макета
 267 echo $layout->render();
 268 ?>]]></programlisting>
 269     </sect2>
 270
 271     <sect2 id="zend.layout.quickstart.example">
 272         <title>Пример макета</title>
 273
 274         <para>
 275             Иногда одна картинка стоит тысячи слов. Ниже показан пример
 276             скрипта макета, показывающий, как все это может быть объединено.
 277         </para>
 278
 279          <para>
 280             <inlinegraphic align="center" valign="middle"
 281                 fileref="figures/zend.layout.quickstart.example.png" format="PNG" />
 282         </para>
 283
 284         <para>
 285             Действительный порядок элементов может быть иным в зависимости от
 286             установленного CSS. Например, если вы используете абсолютное
 287             позиционирование, то можете разместить навигацию в конце документа,
 288             но она будет отображаться вверху, то же самое можно сказать о
 289             боковой панели, заголовке. Реальный порядок извлечения
 290             содержимого остается тем же.
 291         </para>
 292     </sect2>
 293 </sect1>
 294 <!--
 295 vim:se ts=4 sw=4 et:
 296 -->