Zend_Layout-Options.xml 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 17133 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.layout.options">
  5. <title>Zend_Layout Konfigurations Optionen</title>
  6. <para>
  7. <classname>Zend_Layout</classname> hat eine Variation an Konfigurations Optionen. Diese
  8. können durch den Aufruf entsprechender Zugriffsmethoden gesetzt werden, durch die Übergabe
  9. eines Arrays oder <classname>Zend_Config</classname> Objektes an den Konstruktor oder
  10. <methodname>startMvc()</methodname>, durch die Übergabe eines Arrays von Optionen an
  11. <methodname>setOptions()</methodname>, oder der Übergabe eines
  12. <classname>Zend_Config</classname> Objektes an <methodname>setConfig()</methodname>.
  13. </para>
  14. <itemizedlist>
  15. <listitem>
  16. <para>
  17. <emphasis>layout</emphasis>: Das Layout das verwendet werden soll. Verwendet die
  18. aktuelle Beugung um den Namen, der dem entsprechenden Layout View Skript angegeben
  19. wurde, aufzulösen. Standardmäßig ist dieser Wert 'layout' und wird zu 'layout.phtml'
  20. aufgelöst. Zugriffsmethoden sind <methodname>setLayout()</methodname> und
  21. <methodname>getLayout()</methodname>.
  22. </para>
  23. </listitem>
  24. <listitem>
  25. <para>
  26. <emphasis>layoutPath</emphasis>: Der Basispfad zu den Layout View Skripten.
  27. Zugriffsmethoden sind <methodname>setLayoutPath()</methodname> und
  28. <methodname>getLayoutPath()</methodname>.
  29. </para>
  30. </listitem>
  31. <listitem>
  32. <para>
  33. <emphasis>contentKey</emphasis>: Die Layout Variable die für Standardinhalte
  34. verwendet wird (wenn mit dem MVC verwendet). Der Standardwert ist 'content'.
  35. Zugriffsmethoden sind <methodname>setContentKey()</methodname> und
  36. <methodname>getContentKey()</methodname>.
  37. </para>
  38. </listitem>
  39. <listitem>
  40. <para>
  41. <emphasis>mvcSuccessfulActionOnly</emphasis>: Wenn MVC verwendet wird, dann wird das
  42. Layout nicht dargestellt wenn eine Aktion eine Ausnahme wirft und dieses Flag true
  43. ist (das wird verwendet um zu verhindern das das Layout doppelt dargestellt wird
  44. wenn das <link
  45. linkend="zend.controller.plugins.standard.errorhandler">ErrorHandler
  46. Plugin</link> verwendet wird. Standardmäßig ist dieses Flag true.
  47. Zugriffsmethoden sind <methodname>setMvcSuccessfulActionOnly()</methodname> und
  48. <methodname>getMvcSuccessfulActionOnly()</methodname>.
  49. </para>
  50. </listitem>
  51. <listitem>
  52. <para>
  53. <emphasis>view</emphasis>: Das View Objekt das für die Darstellung verwendet wird.
  54. Wenn mit MVC verwendet, dann versucht <classname>Zend_Layout</classname> das View
  55. Objekt zu verwenden das mit <link
  56. linkend="zend.controller.actionhelpers.viewrenderer">dem ViewRenderer</link>
  57. registriert wurde wenn kein explizites View Objekt übergeben wurde. Zugriffsmethoden
  58. sind <methodname>setView()</methodname> und <methodname>getView()</methodname>.
  59. </para>
  60. </listitem>
  61. <listitem>
  62. <para>
  63. <emphasis>helperClass</emphasis>: Die Action Helfer Klasse die verwendet wird wenn
  64. <classname>Zend_Layout</classname> mit den MVC Komponenten verwendet wird.
  65. Standardmäßig ist das
  66. <classname>Zend_Layout_Controller_Action_Helper_Layout</classname>. Zugriffsmethoden
  67. sind <methodname>setHelperClass()</methodname> und
  68. <methodname>getHelperClass()</methodname>.
  69. </para>
  70. </listitem>
  71. <listitem>
  72. <para>
  73. <emphasis>pluginClass</emphasis>: Das Front Controller Plugin das verwendet wird
  74. wenn <classname>Zend_Layout</classname> mit den MVC Komponenten verwendet wird.
  75. Standardmäßig ist das <classname>Zend_Layout_Controller_Plugin_Layout</classname>.
  76. Zugriffsmethoden sind <methodname>setPluginClass()</methodname> und
  77. <methodname>getPluginClass()</methodname>.
  78. </para>
  79. </listitem>
  80. <listitem>
  81. <para>
  82. <emphasis>inflector</emphasis>: Die Beugung die verwendet werden soll wenn Layout
  83. Namen zu Layout Skript Pfaden aufgelöst werden; siehe <link
  84. linkend="zend.layout.advanced.inflector">die <classname>Zend_Layout</classname>
  85. Beugungs Dokumentation für weitere Details</link>. Zugriffsmethoden sind
  86. <methodname>setInflector()</methodname> und <methodname>getInflector()</methodname>.
  87. </para>
  88. </listitem>
  89. </itemizedlist>
  90. <note>
  91. <title>HelferKlasse und PluginKlasse müssen an startMvc() übergeben werden</title>
  92. <para>
  93. Damit die <code>helperClass</code> und <code>pluginClass</code> Einstellungen wirken,
  94. müssen diese als Option an <methodname>startMvc()</methodname> übergeben werden; wenn
  95. sie später gesetzt werden, haben Sie keinen Effekt.
  96. </para>
  97. </note>
  98. <sect2 id="zend.layout.options.examples">
  99. <title>Beispiele</title>
  100. <para>
  101. Die folgenden Beispiele nehmen das folgende <code>$options</code> Array und
  102. <code>$config</code> Objekt an:
  103. </para>
  104. <programlisting language="php"><![CDATA[
  105. $options = array(
  106. 'layout' => 'foo',
  107. 'layoutPath' => '/path/to/layouts',
  108. 'contentKey' => 'CONTENT', // Ignoriert wenn MVC nicht verwendet wird
  109. );
  110. ]]></programlisting>
  111. <programlisting language="php"><![CDATA[
  112. /**
  113. [layout]
  114. layout = "foo"
  115. layoutPath = "/path/to/layouts"
  116. contentKey = "CONTENT"
  117. */
  118. $config = new Zend_Config_Ini('/path/to/layout.ini', 'layout');
  119. ]]></programlisting>
  120. <example id="zend.layout.options.examples.constructor">
  121. <title>Optionen an den Konstruktor oder startMvc() übergeben</title>
  122. <para>
  123. Beide, der Konstruktor und die statische <methodname>startMvc()</methodname> Methode
  124. akzeptieren entweder ein Array von Optionen oder ein
  125. <classname>Zend_Config</classname> Objekt mit Optionen um die
  126. <classname>Zend_Layout</classname> Instanz zu konfigurieren.
  127. </para>
  128. <para>
  129. Zuerst zeigen wir die Übergabe eines Arrays:
  130. </para>
  131. <programlisting language="php"><![CDATA[
  132. // Konstruktor verwenden:
  133. $layout = new Zend_Layout($options);
  134. // startMvc() verwenden:
  135. $layout = Zend_Layout::startMvc($options);
  136. ]]></programlisting>
  137. <para>
  138. Und jetzt die Verwendung eines Config Objekts:
  139. </para>
  140. <programlisting language="php"><![CDATA[
  141. $config = new Zend_Config_Ini('/path/to/layout.ini', 'layout');
  142. // Konstruktor verwenden:
  143. $layout = new Zend_Layout($config);
  144. // startMvc() verwenden:
  145. $layout = Zend_Layout::startMvc($config);
  146. ]]></programlisting>
  147. <para>
  148. Grundsätzlich ist das der einfachste Weg um die <classname>Zend_Layout</classname>
  149. Instanz anzupassen.
  150. </para>
  151. </example>
  152. <example id="zend.layout.options.examples.setoptionsconfig">
  153. <title>setOption() und setConfig() verwenden</title>
  154. <para>
  155. Machmal ist es notwendig das <classname>Zend_Layout</classname> Objekt zu
  156. Konfigurieren nachdem es instanziiert wurde; <methodname>setOptions()</methodname>
  157. und <methodname>setConfig()</methodname> bieten einen schnellen und einfachen Weg
  158. das zu tun:
  159. </para>
  160. <programlisting language="php"><![CDATA[
  161. // Ein Array von Optionen verwenden:
  162. $layout->setOptions($options);
  163. // Ein Zend_Config Objekt verwenden:
  164. $layout->setConfig($options);
  165. ]]></programlisting>
  166. <para>
  167. Es ist zu beachten das einige Optionen, wie <code>pluginClass</code> und
  168. <code>helperClass</code>, keinen Effekt haven wenn Sie mit Hilfe dieser Methode
  169. übergeben werden; sie müssen mit dem Konstruktor oder der
  170. <methodname>startMvc()</methodname> Methode übergeben werden.
  171. </para>
  172. </example>
  173. <example id="zend.layout.options.examples.accessors">
  174. <title>Zugriffsmethoden verwenden</title>
  175. <para>
  176. Letztendlich kann die <classname>Zend_Layout</classname> Instanz auch über
  177. Zugriffsmetoden konfiguriert werden. Alle Zugriffsmethoden implementieren ein
  178. Flüssiges Interface, was bedeutet das Ihre Aufrufe gekettet werden können:
  179. </para>
  180. <programlisting language="php"><![CDATA[
  181. $layout->setLayout('foo')
  182. ->setLayoutPath('/path/to/layouts')
  183. ->setContentKey('CONTENT');
  184. ]]></programlisting>
  185. </example>
  186. </sect2>
  187. </sect1>
  188. <!--
  189. vim:se ts=4 sw=4 et:
  190. -->