Zend_Layout-Options.xml 8.7 KB

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