Zend_Navigation-Pages-Common.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15746 -->
  3. <!-- Reviewed: no -->
  4. <sect2 id="zend.navigation.pages.common">
  5. <title>Übliche Seiten Features</title>
  6. <para>
  7. Alle Seiten Klassen müssen <classname>Zend_Navigation_Page</classname> erweitern, und
  8. teilen deshalb ein übliches Set von Features und Eigenschaften. Am ehesten zu beachten
  9. ist, das Sie die Optionen in der anbei zu sehenden Tabelle und den gleichen
  10. Initialisierungs Prozess teilen.
  11. </para>
  12. <para>
  13. Options Schlüssel werden zu <code>set</code> Methoden gemappt. Das bedeutet das die Option
  14. <code>order</code> auf die Methode <code>setOrder()</code> gemappt wird, und
  15. <code>reset_params</code> auf die Methode <code>setResetParams()</code>. Wenn es keine
  16. Setter Methode für die Option gibt, wird diese als eigene Eigenschaft der Seite gesetzt.
  17. </para>
  18. <para>
  19. Lesen Sie mehr über das erweitern von Zend_Navigation_Page in
  20. <link linkend="zend.navigation.pages.custom">Erstellung eigener Seiten Typen</link>.
  21. </para>
  22. <table id="zend.navigation.pages.common.options">
  23. <title>Übliche Seiten Optionen</title>
  24. <tgroup cols="4">
  25. <thead>
  26. <row>
  27. <entry>Schlüssel</entry>
  28. <entry>Typ</entry>
  29. <entry>Standardwert</entry>
  30. <entry>Beschreibung</entry>
  31. </row>
  32. </thead>
  33. <tbody>
  34. <row>
  35. <entry><code>label</code></entry>
  36. <entry><type>String</type></entry>
  37. <entry><constant>NULL</constant></entry>
  38. <entry>
  39. Ein Seitenlabel, wie 'Home' oder 'Blog'.
  40. </entry>
  41. </row>
  42. <row>
  43. <entry><code>id</code></entry>
  44. <entry><type>String</type> | <code>int</code></entry>
  45. <entry><constant>NULL</constant></entry>
  46. <entry>
  47. Ein Id Tag/Attribut das verwendet werden kann wenn die Seite dargestellt
  48. wird, typischerweise in einem Anker Element.
  49. </entry>
  50. </row>
  51. <row>
  52. <entry><code>class</code></entry>
  53. <entry><type>String</type></entry>
  54. <entry><constant>NULL</constant></entry>
  55. <entry>
  56. Eine CSS Klasse die verwendet werden kann wenn die Seite dargestellt wird,
  57. typischerweise ein Anker Element.
  58. </entry>
  59. </row>
  60. <row>
  61. <entry><code>title</code></entry>
  62. <entry><type>String</type></entry>
  63. <entry><constant>NULL</constant></entry>
  64. <entry>
  65. Eine kurze Seitenbeschreibung, typischerweise für die Verwendung als
  66. <code>title</code> Attribut in einem Anker.
  67. </entry>
  68. </row>
  69. <row>
  70. <entry><code>target</code></entry>
  71. <entry><type>String</type></entry>
  72. <entry><constant>NULL</constant></entry>
  73. <entry>
  74. Spezifiziert ein Ziel das für die Seite verwendet werden kann,
  75. typischerweise ein Anker Element.
  76. </entry>
  77. </row>
  78. <row>
  79. <entry><code>rel</code></entry>
  80. <entry><type>Array</type></entry>
  81. <entry><code>array()</code></entry>
  82. <entry>
  83. Spezifiziert die Weiterleitungs-Relation für die Seite. Jedes Element im
  84. Array ist ein Schlüssel-Wert Paar, wobei der Schlüssel den Relation/Link
  85. Typ bestimmt, und der Wert ist ein Pointer zu der verlinkten Seite. Ein
  86. Beispiel eines Schlüssel-Wert Paares ist
  87. <code>'alternate' => 'format/plain.html'</code>. Um die volle Flexibilität
  88. zu erlauben, gibt es keine Einschränkungen an den Relationswerten. Der Wert
  89. muß kein String sein. Lesen Sie über <code>rel</code> und <code>rev</code>
  90. im <link linkend="zend.view.helpers.initial.navigation.links">Kapitel der
  91. Link Helfer</link>.
  92. </entry>
  93. </row>
  94. <row>
  95. <entry><code>rev</code></entry>
  96. <entry><type>Array</type></entry>
  97. <entry><code>array()</code></entry>
  98. <entry>
  99. Spezifiziert die Rückwärts Relation für die Seite. Arbeitet genauso wie
  100. <code>rel</code>.
  101. </entry>
  102. </row>
  103. <row>
  104. <entry><code>order</code></entry>
  105. <entry><type>String</type> | <code>int</code> | <constant>NULL</constant></entry>
  106. <entry><constant>NULL</constant></entry>
  107. <entry>
  108. Arbeitet die order für Elemente in
  109. Works like order for elements in
  110. <link linkend="zend.form.quickstart.render">
  111. <classname>Zend_Form</classname></link>. Wenn spezifiziert, dann wird die
  112. Seite in einer speziellen Reihenfolge durchlaufen, was bedeutet das man
  113. eine Seite dazu zwingen kann das eine Seite vor anderen durchlaufen wird
  114. indem das <code>order</code> Attribut auf eine kleinere Nummer gesetzt
  115. wird, z.B. -100. Wenn ein <type>String</type> angegeben wird, muß dieser
  116. in einen gültigen <code>int</code> aufgelöst werden können. Wenn
  117. <constant>NULL</constant> angegeben wird, wird er resetiert, was bedeutet das die
  118. Reihenfolge verwendet wird mit der die Seite in den Container hinzugefügt
  119. wurde.
  120. </entry>
  121. </row>
  122. <row>
  123. <entry><code>resource</code></entry>
  124. <entry>
  125. <type>String</type> | <classname>Zend_Acl_Resource_Interface</classname> |
  126. <constant>NULL</constant>
  127. </entry>
  128. <entry><constant>NULL</constant></entry>
  129. <entry>
  130. ACL Ressource die mit der Seite verknüpft werden soll. Lesen Sie mehr im
  131. <link linkend="zend.view.helpers.initial.navigation.acl">Kapitel ACL
  132. Integration in View Helfern</link>.
  133. </entry>
  134. </row>
  135. <row>
  136. <entry><code>privilege</code></entry>
  137. <entry><type>String</type> | <constant>NULL</constant></entry>
  138. <entry><constant>NULL</constant></entry>
  139. <entry>
  140. ACL Privileg das mit der Seite assoziiert werden soll. Lesen Sie mehr im
  141. <link linkend="zend.view.helpers.initial.navigation.acl">Kapitel über ACL
  142. Integration in View Helfern</link>.
  143. </entry>
  144. </row>
  145. <row>
  146. <entry><code>active</code></entry>
  147. <entry><code>bool</code></entry>
  148. <entry><constant>FALSE</constant></entry>
  149. <entry>
  150. Ob die Seite für die aktuelle Anfrage als aktiv betrachtet werden soll.
  151. Wenn active <constant>FALSE</constant> ist oder nicht angegeben wird, werden MVC
  152. Seiten Ihr Eigenschaften gegen das Anfrage Objekt prüfen wenn
  153. <code>$page->isActive()</code> aufgerufen wird.
  154. </entry>
  155. </row>
  156. <row>
  157. <entry><code>visible</code></entry>
  158. <entry><code>bool</code></entry>
  159. <entry><constant>TRUE</constant></entry>
  160. <entry>
  161. Ob die Seite für den Benutzer sichtbar sein soll, oder nur ein Teil einer
  162. Struktur ist. Unsichtbare Seiten werden von View Helfern übersprungen.
  163. </entry>
  164. </row>
  165. <row>
  166. <entry><code>pages</code></entry>
  167. <entry>
  168. <type>Array</type> | <classname>Zend_Config</classname> | <constant>NULL</constant>
  169. </entry>
  170. <entry><constant>NULL</constant></entry>
  171. <entry>
  172. Kind Seiten der Seite. Das sollte ein <type>Array</type> oder
  173. <classname>Zend_Config</classname> Objekt sein das entweder Seiten Optionen
  174. enthält die in die <code>factory()</code> Methode übergeben werden können,
  175. oder die aktuelle <classname>Zend_Navigation_Page</classname> Instanz, oder
  176. einen Mix von beiden.
  177. </entry>
  178. </row>
  179. </tbody>
  180. </tgroup>
  181. </table>
  182. <note>
  183. <title>Eigene Eigenschaften</title>
  184. <para>
  185. Alle Seiten unterstützen das Setzen und Empfangen von eigenen Eigenschaften durch
  186. Verwendung der magischen Methoden <code>__set($name, $value)</code>,
  187. <code>__get($name)</code>, <code>__isset($name)</code> und
  188. <code>__unset($name)</code>. Eigene Eigenschaften können jeden Wert haben, und sind
  189. im Array enthalten das von <code>$page->toArray()</code> zurückgegeben wird, was
  190. bedeutet das Seiten erfolgreich serialisiert/de-serialisiert werden können, selbst
  191. wenn die Seiten Eigenschaften enthalten die nicht nativ in der Seitenklasse sind.
  192. </para>
  193. <para>
  194. Sowohl native als auch eigene Eigenschaften können gesetzt werden indem
  195. <code>$page->set($name, $value)</code> verwendet und empfangen indem
  196. <code>$page->get($name)</code> verwendet wird, oder durch die Verwendung der
  197. magischen Methoden.
  198. </para>
  199. </note>
  200. <example id="zend.navigation.pages.common.example.customprops">
  201. <title>Eigene Seiten Eigenschaften</title>
  202. <para>
  203. Dieses Beispiel zeigt wie eigene Eigenschaften verwendet werden können.
  204. </para>
  205. <programlisting language="php"><![CDATA[
  206. $page = new Zend_Navigation_Page_Mvc();
  207. $page->foo = 'bar';
  208. $page->meaning = 42;
  209. echo $page->foo;
  210. if ($page->meaning != 42) {
  211. // Eine Aktion sollte durchgeführt werden
  212. }
  213. ]]></programlisting>
  214. </example>
  215. </sect2>