Zend_Layout-Options.xml 9.2 KB

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