Zend_Navigation-Pages-Common.xml 11 KB

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