Zend_Layout-Options.xml 8.5 KB

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