Zend_View-Helpers-Navigation.xml 83 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 17175 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.view.helpers.initial.navigation">
  5. <title>Navigations Helfer</title>
  6. <para>
  7. Die Navigations Helfer werden von
  8. <link linkend="zend.navigation.containers">Zend_Navigation_Container</link> für die
  9. Darstellung von Navigations Elementen verwendet.
  10. </para>
  11. <para>
  12. Es gibt 2 eingebaute Helfer:
  13. </para>
  14. <itemizedlist>
  15. <listitem>
  16. <para>
  17. <link
  18. linkend="zend.view.helpers.initial.navigation.breadcrumbs">Breadcrumbs</link>,
  19. wird für die Darstellung des Pfades der aktuell aktiven Seite verwendet.
  20. </para>
  21. </listitem>
  22. <listitem>
  23. <para>
  24. <link linkend="zend.view.helpers.initial.navigation.links">Links</link>,
  25. wird für die Darstellung von Navigations Header Links (z.B.
  26. <code>&lt;link rel="next" href="..." /&gt;</code>) verwendet.
  27. </para>
  28. </listitem>
  29. <listitem>
  30. <para>
  31. <link linkend="zend.view.helpers.initial.navigation.menu">Menu</link>,
  32. wird für die Darstellung von Menüs verwendet.
  33. </para>
  34. </listitem>
  35. <listitem>
  36. <para>
  37. <link linkend="zend.view.helpers.initial.navigation.sitemap">Sitemap</link>,
  38. wird für die Darstellung von Sitemaps verwendet die dem
  39. <ulink url="http://www.sitemaps.org/protocol.php">Sitemaps <acronym>XML</acronym>
  40. Format</ulink> entsprechen.
  41. </para>
  42. </listitem>
  43. <listitem>
  44. <para>
  45. <link
  46. linkend="zend.view.helpers.initial.navigation.navigation">Navigation</link>,
  47. wird für die Weiterleitung von Aufrufen zu anderen Navigations Helfern
  48. verwendet.
  49. </para>
  50. </listitem>
  51. </itemizedlist>
  52. <para>
  53. Alle eingebauten Helfer erweitern
  54. <classname>Zend_View_Helper_Navigation_HelperAbstract</classname>, welches die Integration
  55. von <link linkend="zend.acl">ACL</link> und <link
  56. linkend="zend.translate">Übersetzung</link> hinzufügt. Die abstrakte Klasse
  57. implementiert das Interface <classname>Zend_View_Helper_Navigation_Helper</classname>
  58. welches die folgenden Methoden definiert:
  59. </para>
  60. <itemizedlist>
  61. <listitem>
  62. <para>
  63. <code>{get|set}Container()</code> empfängt/setzt den Navigations Container
  64. mit dem der Helfer standardmäßig arbeiten soll, und
  65. <methodname>hasContainer()</methodname> prüft ob der Helfer Container
  66. registriert hat.
  67. </para>
  68. </listitem>
  69. <listitem>
  70. <para>
  71. <code>{get|set}Translator()</code> empfängt/setzt den Übersetzer der für die
  72. Übersetzung von Überschriften und Titelm verwendet wird, und
  73. <code>{get|set}UseTranslator()</code> kontrolliert ob der Übersetzer aktiviert
  74. werden soll. Die Methode <methodname>hasTranslator()</methodname> prüft ob der
  75. Helfer einen Übersetzer registriert hat.
  76. </para>
  77. </listitem>
  78. <listitem>
  79. <para>
  80. <code>{get|set}Acl()</code>, <code>{get|set}Role()</code>,
  81. empfängt/setzt ACL (<classname>Zend_Acl</classname>) Instanzen und Rollen
  82. (<type>String</type> oder <classname>Zend_Acl_Role_Interface</classname>)
  83. die bei der Darstellung für das Filtern von Seiten verwendet werden, und
  84. <code>{get|set}UseAcl()</code> kontrolliert ob ACL aktiviert werden soll.
  85. Die Methoden <methodname>hasAcl()</methodname> und
  86. <methodname>hasRole()</methodname> prüfen ob der Helfer eine ACL Instanz oder
  87. Rolle registriert hat.
  88. </para>
  89. </listitem>
  90. <listitem>
  91. <para>
  92. <methodname>__toString()</methodname>, die magische Methode stellt sicher das
  93. der Helfer, durch den direkten Aufruf von <code>echo</code> an der Instanz des
  94. Helfers, dargestellt werden kann.
  95. </para>
  96. </listitem>
  97. <listitem>
  98. <para>
  99. <methodname>render()</methodname>, muß von konkreten Helfern implementiert
  100. werden um die Darstellung durchzuführen.
  101. </para>
  102. </listitem>
  103. </itemizedlist>
  104. <para>
  105. Zusätzlich zu den Methoden die vom Interface kommen, implementiert die abstrakte Klasse
  106. die folgenden Methoden:
  107. </para>
  108. <itemizedlist>
  109. <listitem>
  110. <para>
  111. <code>{get|set}Indent()</code> empfängt/setzt die Einrückung. Der Setzer
  112. akzeptiert einen <type>String</type> oder ein <code>int</code>. Im
  113. Fall eines <code>int</code>'s verwendet der Helfer die angegebene Zahl
  114. als Leerzeichen für die Einrückung. Z.B. bedeutet
  115. <methodname>setIndent(4)</methodname> eine Einrückung von initial 4 Leerzeichen.
  116. Die Einrückung kann für alle Helfer außer dem Sitemap Helfer spezifiziert
  117. werden.
  118. </para>
  119. </listitem>
  120. <listitem>
  121. <para>
  122. <code>{get|set}MinDepth()</code> empfängt/setzt die minimale Tiefe die eine
  123. Seite haben muß um vom Helfer eingefügt zu werden. Das Setzen von
  124. <constant>NULL</constant> bedeutet keine minimale Tiefe.
  125. </para>
  126. </listitem>
  127. <listitem>
  128. <para>
  129. <code>{get|set}MaxDepth()</code> empfängt/setzt die maximale Tiefe die eine
  130. Seite haben muß um vom Helfer eingefügt zu werden. Das Setzen von
  131. <constant>NULL</constant> bedeutet keine maximale Tiefe.
  132. </para>
  133. </listitem>
  134. <listitem>
  135. <para>
  136. <code>{get|set}RenderInvisible()</code> empfängt/setzt ob Elemente die als
  137. unsichtbar markiert sind, dargestellt werden oder nicht.
  138. </para>
  139. </listitem>
  140. <listitem>
  141. <para>
  142. <methodname>__call()</methodname> wird verwendet um Aufrufe zum Container, der
  143. im Helfer registriert ist, weiterzuleiten, was bedeutet das man Methoden in
  144. einem Helfer aufrufen kann wie wenn Sie im Container wären. Siehe das folgende
  145. <link
  146. linkend="zend.view.helpers.initial.navigation.proxy.example">Beispiel</link>.
  147. </para>
  148. </listitem>
  149. <listitem>
  150. <para>
  151. <methodname>findActive($container, $minDepth, $maxDepth)</methodname> wird
  152. verwendet um die tiefste aktive Seite im angegebenen Container zu finden. Wenn
  153. keine Tiefe angegeben wird, verwendet diese Methode die Werte die sie von
  154. <methodname>getMinDepth()</methodname> und
  155. <methodname>getMaxDepth()</methodname> erhält. Die tiefste aktive Seite muß
  156. zwischen <varname>$minDepth</varname> und <varname>$maxDepth</varname> inklusive
  157. liegen. Gibt ein Array zurück das Referenzen zu der gefundenen Instanz der Seite
  158. enthält, und die Tiefe bei der die Seite gefunden wurde.
  159. </para>
  160. </listitem>
  161. <listitem>
  162. <para>
  163. <methodname>htmlify()</methodname> stellt ein <code>a</code> HTML Element von
  164. einer <classname>Zend_Navigation_Page</classname> Instanz dar.
  165. </para>
  166. </listitem>
  167. <listitem>
  168. <para>
  169. <methodname>accept()</methodname> wird verwendet um zu erkennen ub eine Seite
  170. akzeptiert werden soll wenn durch Container iteriert wird. Diese Methode prüft
  171. die Sichtbarkeit der Seite und verifiziert das die Rolle des Helfers auf die
  172. Ressource/Privilegien der Seite zugreifen darf.
  173. </para>
  174. </listitem>
  175. <listitem>
  176. <para>
  177. <code>static setDefaultAcl()</code> wird für das Setzen des standardmäßigen
  178. ACL Objekts verwendet, das dann von Helfern verwendet wird.
  179. </para>
  180. </listitem>
  181. <listitem>
  182. <para>
  183. <code>static setDefaultRole()</code> wird für das Setzen der standardmäßigen
  184. Rolle verwendet, die dann von Helfern verwendet wird.
  185. </para>
  186. </listitem>
  187. </itemizedlist>
  188. <para>
  189. Wenn ein Navigations Container nicht explizit in einem Helfer durch Verwendung von
  190. <code>$helper->setContainer($nav)</code> gesetzt ist, schaut der Helfer in
  191. <link linkend="zend.registry">der Registry</link> nach einer Container Instanz mit dem
  192. Schlüssel <classname>Zend_Navigation</classname>. Wenn ein Container nicht explizit gesetzt
  193. wurde, oder nicht in der Registry gefunden wird, erstellt der Helfer einen leeren
  194. <classname>Zend_Navigation</classname> Container wenn <code>$helper->getContainer()</code>
  195. aufgerufen wird.
  196. </para>
  197. <example id="zend.view.helpers.initial.navigation.proxy.example">
  198. <title>Aufrufe an den Navigations Container weiterleiten</title>
  199. <para>
  200. Navigations View Helfer verwenden die magisch <methodname>__call()</methodname> Methode
  201. um Methodenaufrufe an den Navigationscontainer weiterzuleiten der im View Helfer
  202. registriert ist.
  203. </para>
  204. <programlisting language="php"><![CDATA[
  205. $this->navigation()->addPage(array(
  206. 'type' => 'uri',
  207. 'label' => 'New page'));
  208. ]]></programlisting>
  209. <para>
  210. Der obige Aufruf fügt eine Seite zum Container im <classname>Navigation</classname>
  211. Helfer hinzu.
  212. </para>
  213. </example>
  214. <sect4 id="zend.view.helpers.initial.navigation.i18n">
  215. <title>Übersetzung von Labels und Titeln</title>
  216. <para>
  217. Der Navigations Helfer unterstützt die Übersetzung von SeitenLabels und Überschriften.
  218. Man kann einen Übersetzer vom Typ <classname>Zend_Translate</classname> oder
  219. <classname>Zend_Translate_Adapter</classname> im Helfer setzen indem
  220. <code>$helper->setTranslator($translator)</code> verwendet wird, oder wie in allen
  221. anderen I18n-fähigen Komponenten; durch das Hinzufügen des Übersetzers in
  222. <link linkend="zend.registry">die Registry</link> indem der Schlüssel
  223. <classname>Zend_Translate</classname> verwendet wird.
  224. </para>
  225. <para>
  226. Wenn man die Übersetzung ausschalten will, sollte man
  227. <code>$helper->setUseTranslator(false)</code> verwenden.
  228. </para>
  229. <para>
  230. Der <link linkend="zend.view.helpers.initial.navigation.navigation">Proxy Helfer</link>
  231. injiziert seinen eigenen Übersetzer in den Helfer auf den er weiterleitet wenn der
  232. weitergeleitete Helfer nicht bereits einen Übersetzer hat.
  233. </para>
  234. <note>
  235. <para>
  236. Es gibt keinen Übersetzer im Sitemap Helfer, da keine SeitenLabels oder
  237. Überschriften in einer <acronym>XML</acronym> Sitemap enthalten sind.
  238. </para>
  239. </note>
  240. </sect4>
  241. <sect4 id="zend.view.helpers.initial.navigation.acl">
  242. <title>Integration mit ACL</title>
  243. <para>
  244. Alle navigatorischen View Helfer unterstützen ACL abgeleitet von der
  245. <classname>Zend_View_Helper_Navigation_HelperAbstract</classname> Klasse. Ein
  246. <classname>Zend_Acl</classname> Objekt kann einer Instanz eines Helfers mit
  247. <code>$helper->setAcl($acl)</code> hinzugefügt werden, und eine Rolle mit
  248. <code>$helper->setRole('member')</code> oder
  249. <code>$helper->setRole(new Zend_Acl_Role('member'))</code>. Wenn ACL im Helfer
  250. verwendet wird, muß es der Rolle im Helfer vom ACL erlaubt sein auf die
  251. <code>Ressourcen</code> zuzugreifen und/oder das die <code>Privilegien</code> für diese
  252. Seite bei der Darstellung eingefügt werden dürfen.
  253. </para>
  254. <para>
  255. Wenn eine Seite vom ACL nicht akzeptiert ist, wird auch jede untergeordnete Seite von
  256. der Darstellung ausgenommen sein.
  257. If a page is not accepted by ACL, any descendant page will also
  258. be excluded from rendering.
  259. </para>
  260. <para>
  261. Der <link linkend="zend.view.helpers.initial.navigation.navigation">Proxy Helfer</link>
  262. injiziert seine eigene ACL und Rolle in den Helfer zu dem er weiterleitet wenn der
  263. weitergeleitete Helfer nicht bereits einen hat.
  264. </para>
  265. <para>
  266. Das Beispiel von unten zeigt wie ACL die Darstellung beeinflusst.
  267. </para>
  268. </sect4>
  269. <sect4 id="zend.view.helpers.initial.navigation.setup">
  270. <title>Setup der Navigation das in Beispielen verwendet wird</title>
  271. <para>
  272. Dieses Beispiel zeigt das Setup eines Navigations Container für eine fiktive Software
  273. Firma.
  274. </para>
  275. <para>
  276. Notizen zum Setup:
  277. </para>
  278. <itemizedlist>
  279. <listitem>
  280. <para>
  281. Die Domain der Site ist <code>www.example.com</code>.
  282. </para>
  283. </listitem>
  284. <listitem>
  285. <para>
  286. Interessante Eigenschaften der Seite sind mit einem Kommentar markiert.
  287. </para>
  288. </listitem>
  289. <listitem>
  290. <para>
  291. Solange im Beispiel nicht anders erwähnt, fragt der Benutzer nach der
  292. <acronym>URL</acronym> <code>http://www.example.com/products/server/faq/</code>,
  293. welche auf die Seite mit dem Label <constant>FAQ</constant> unter
  294. <code>Foo Server</code> übersetzt wird.
  295. </para>
  296. </listitem>
  297. <listitem>
  298. <para>
  299. Das angenommene ACL und Route Setup wird unter dem Container Setup gezeigt.
  300. </para>
  301. </listitem>
  302. </itemizedlist>
  303. <programlisting language="php"><![CDATA[
  304. /*
  305. * Navigations Container (config/array)
  306. * Jedes Element im Array wird an Zend_Navigation_Page::factory()
  307. * übergeben wenn der unten angezeigt Navigations Container
  308. * erstellt wird.
  309. */
  310. $pages = array(
  311. array(
  312. 'label' => 'Home',
  313. 'title' => 'Geh zu Home',
  314. 'module' => 'default',
  315. 'controller' => 'index',
  316. 'action' => 'index',
  317. 'order' => -100 // Sicherstellen das Home die erste Seite ist
  318. ),
  319. array(
  320. 'label' => 'Spezielles Angebot nur diese Woche!',
  321. 'module' => 'store',
  322. 'controller' => 'offer',
  323. 'action' => 'amazing',
  324. 'visible' => false // nicht sichtbar
  325. ),
  326. array(
  327. 'label' => 'Produkte',
  328. 'module' => 'products',
  329. 'controller' => 'index',
  330. 'action' => 'index',
  331. 'pages' => array(
  332. array(
  333. 'label' => 'Foo Server',
  334. 'module' => 'products',
  335. 'controller' => 'server',
  336. 'action' => 'index',
  337. 'pages' => array(
  338. array(
  339. 'label' => 'FAQ',
  340. 'module' => 'products',
  341. 'controller' => 'server',
  342. 'action' => 'faq',
  343. 'rel' => array(
  344. 'canonical' => 'http://www.example.com/?page=faq',
  345. 'alternate' => array(
  346. 'module' => 'products',
  347. 'controller' => 'server',
  348. 'action' => 'faq',
  349. 'params' => array('format' => 'xml')
  350. )
  351. )
  352. ),
  353. array(
  354. 'label' => 'Editionen',
  355. 'module' => 'products',
  356. 'controller' => 'server',
  357. 'action' => 'editions'
  358. ),
  359. array(
  360. 'label' => 'System Anforderungen',
  361. 'module' => 'products',
  362. 'controller' => 'server',
  363. 'action' => 'requirements'
  364. )
  365. )
  366. ),
  367. array(
  368. 'label' => 'Foo Studio',
  369. 'module' => 'products',
  370. 'controller' => 'studio',
  371. 'action' => 'index',
  372. 'pages' => array(
  373. array(
  374. 'label' => 'Kunden Stories',
  375. 'module' => 'products',
  376. 'controller' => 'studio',
  377. 'action' => 'customers'
  378. ),
  379. array(
  380. 'label' => 'Support',
  381. 'module' => 'prodcts',
  382. 'controller' => 'studio',
  383. 'action' => 'support'
  384. )
  385. )
  386. )
  387. )
  388. ),
  389. array(
  390. 'label' => 'Firma',
  391. 'title' => 'Über uns',
  392. 'module' => 'company',
  393. 'controller' => 'about',
  394. 'action' => 'index',
  395. 'pages' => array(
  396. array(
  397. 'label' => 'Investor Relations',
  398. 'module' => 'company',
  399. 'controller' => 'about',
  400. 'action' => 'investors'
  401. ),
  402. array(
  403. 'label' => 'News',
  404. 'class' => 'rss', // Klasse
  405. 'module' => 'company',
  406. 'controller' => 'news',
  407. 'action' => 'index',
  408. 'pages' => array(
  409. array(
  410. 'label' => 'Für die Presse',
  411. 'module' => 'company',
  412. 'controller' => 'news',
  413. 'action' => 'press'
  414. ),
  415. array(
  416. 'label' => 'Archiv',
  417. 'route' => 'archive', // Route
  418. 'module' => 'company',
  419. 'controller' => 'news',
  420. 'action' => 'archive'
  421. )
  422. )
  423. )
  424. )
  425. ),
  426. array(
  427. 'label' => 'Community',
  428. 'module' => 'community',
  429. 'controller' => 'index',
  430. 'action' => 'index',
  431. 'pages' => array(
  432. array(
  433. 'label' => 'Mein Account',
  434. 'module' => 'community',
  435. 'controller' => 'account',
  436. 'action' => 'index',
  437. 'resource' => 'mvc:community.account' // Ressource
  438. ),
  439. array(
  440. 'label' => 'Forum',
  441. 'uri' => 'http://forums.example.com/',
  442. 'class' => 'external' // Klasse
  443. )
  444. )
  445. ),
  446. array(
  447. 'label' => 'Administration',
  448. 'module' => 'admin',
  449. 'controller' => 'index',
  450. 'action' => 'index',
  451. 'resource' => 'mvc:admin', // Ressource
  452. 'pages' => array(
  453. array(
  454. 'label' => 'Neuen Artikel schreiben',
  455. 'module' => 'admin',
  456. 'controller' => 'post',
  457. 'aciton' => 'write'
  458. )
  459. )
  460. )
  461. );
  462. // Container von einem Array erstellen
  463. $container = new Zend_Navigation($pages);
  464. // Den Container im Proxy Helfer speichern
  465. $view->getHelper('navigation')->setContainer($container);
  466. // ...oder einfach:
  467. $view->navigation($container);
  468. // ...oder ihn einfach in der Registry speichern:
  469. Zend_Registry::set('Zend_Navigation', $container);
  470. ]]></programlisting>
  471. <para>
  472. Zusätzlich zum obigen Container, wird das folgende Setup angenommen:
  473. </para>
  474. <programlisting language="php"><![CDATA[
  475. // Router Setup (Standardrouten und 'archive' Route):
  476. $front = Zend_Controller_Front::getInstance();
  477. $router = $front->getRouter();
  478. $router->addDefaultRoutes();
  479. $router->addRoute(
  480. 'archive',
  481. new Zend_Controller_Router_Route(
  482. '/archive/:year',
  483. array(
  484. 'module' => 'company',
  485. 'controller' => 'news',
  486. 'action' => 'archive',
  487. 'year' => (int) date('Y') - 1
  488. ),
  489. array('year' => '\d+')
  490. )
  491. );
  492. // ACL Setup:
  493. $acl = new Zend_Acl();
  494. $acl->addRole(new Zend_Acl_Role('member'));
  495. $acl->addRole(new Zend_Acl_Role('admin'));
  496. $acl->add(new Zend_Acl_Resource('mvc:admin'));
  497. $acl->add(new Zend_Acl_Resource('mvc:community.account'));
  498. $acl->allow('member', 'mvc:community.account');
  499. $acl->allow('admin', null);
  500. // ACL und Rolle im Proxy Helfer speichern:
  501. $view->navigation()->setAcl($acl)->setRole('member');
  502. // ...oder ein standard ACL und Rolle statisch setzen:
  503. Zend_View_Helper_Navigation_HelperAbstract::setDefaultAcl($acl);
  504. Zend_View_Helper_Navigation_HelperAbstract::setDefaultRole('member');
  505. ]]></programlisting>
  506. </sect4>
  507. <sect4 id="zend.view.helpers.initial.navigation.breadcrumbs">
  508. <title>Breadcrumbs Helfer</title>
  509. <para>
  510. Breadcrumbs werden verwendet um anzuzeigen wo in einer Sitemap ein Benutzer aktuell
  511. browst, und werden typischerweise wie folgt angezeigt: "Du bist hier: Home > Produkte
  512. > FantastischesProdukt 1.0". Der BreakCrumbs Helfer folgt den Richtlinien von <ulink
  513. url="http://developer.yahoo.com/ypatterns/pattern.php?pattern=breadcrumbs">Breadcrumbs
  514. Pattern - Yahoo! Design Pattern Library</ulink>, und erlaubt eine einfache Anpassung
  515. (Minimale/Maximale Tiefe, Einrückung, Trennzeichen, und ob das letzte Element verlinkt
  516. sein soll), oder die Darstellung durch Verwendung eines partiellen View Skripts.
  517. </para>
  518. <para>
  519. Der Breabcrumbs Helfer funktioniert wie folgt; er findet die tiefste aktive Seite in
  520. einem Navigations Container, und stellt den aufwärtsgerichteten Pfad zum Root dar.
  521. Für <acronym>MVC</acronym> Seiten wird die "Aktivität" einer Seite erkannt indem das
  522. Anfrage Objekt angeschaut wird, wie im Kapitel
  523. <link linkend="zend.navigation.pages.mvc">Zend_Navigation_Page_Mvc</link> beschrieben.
  524. </para>
  525. <para>
  526. Der Helfer setzt die Eigenschaft <code>minDepth</code> standardmäßig auf 1, was
  527. bedeutet das Breadcrumbs nicht dargestellt werden wenn die tiefste aktive Seite eine
  528. Root Seite ist. Wenn <code>maxDepth</code> spezifiziert ist, beendet der Helfer die
  529. Darstellung bei der spezifizierten Tiefe (z.B. stopp bei Level 2 selbst wenn die
  530. tiefste aktive Seite auf Level 3 ist).
  531. </para>
  532. <para>
  533. Methoden im Breakcrumbs Helfer sind:
  534. </para>
  535. <itemizedlist>
  536. <listitem>
  537. <para>
  538. <code>{get|set}Separator()</code> empfängt/setzt das Trennzeichen das zwischen
  539. Breakcrumbs verwendet wird. Der Standardwert ist <code>' &amp;gt; '</code>.
  540. </para>
  541. </listitem>
  542. <listitem>
  543. <para>
  544. <code>{get|set}LinkLast()</code> empfängt/setzt ob der letzte Breabcrumb
  545. als Anker dargestellt werden soll oder nicht. Der Standardwert ist
  546. <constant>FALSE</constant>.
  547. </para>
  548. </listitem>
  549. <listitem>
  550. <para>
  551. <code>{get|set}Partial()</code> empfängt/setzt ein partielles View Skript das
  552. für die Darstellung von Breadcrumbs verwendet werden soll. Wenn ein partielles
  553. View Skript gesetzt ist, verwendet die <methodname>render()</methodname> Methode
  554. des Helfers die <methodname>renderPartial()</methodname> Methode. Wenn kein
  555. partielles gesetzt ist, wird die <methodname>renderStraight()</methodname>
  556. Methode verwendet. Der Helfer erwartet das der partielle ein <type>String</type>
  557. oder ein <type>Array</type> mit zwei Elementen ist. Wen der Partielle ein
  558. <type>String</type> ist, benennt er den Namen des partiellen Skripts das zu
  559. verwenden ist. Wenn er ein <type>Array</type> ist, wird das erste Element als
  560. Name des partiellen View Skripts verwendet, und das zweite Element ist das Modul
  561. in dem das Skript zu finden ist.
  562. </para>
  563. </listitem>
  564. <listitem>
  565. <para>
  566. <methodname>renderStraight()</methodname> ist die standardmäßige render Methode.
  567. </para>
  568. </listitem>
  569. <listitem>
  570. <para>
  571. <methodname>renderPartial()</methodname> wird für die Darstellung verwendet wenn
  572. ein partielles View Skript verwendet wird.
  573. </para>
  574. </listitem>
  575. </itemizedlist>
  576. <example id="zend.view.helpers.initial.navigation.breadcrumbs.example1">
  577. <title>Darstellung von Breadcrumbs</title>
  578. <para>
  579. Dieses Beispiel zeigt wie Breadcrumbs mit Standardsettings dargestellt werden.
  580. </para>
  581. <programlisting language="php"><![CDATA[
  582. In einem View Skript oder Layout:
  583. <?php echo $this->navigation()->breadcrumbs(); ?>
  584. oder wenn Short-Tags aktiviert sind:
  585. <?php $this->navigation()->breadcrumbs(); ?>
  586. Die zwei obigen Aufrufe verwenden die magische __toString() Methode,
  587. und sind identisch mit:
  588. <?php echo $this->navigation()->breadcrumbs()->render(); ?>
  589. Ausgabe:
  590. <a href="/products">Produkte</a> &gt; <a href="/products/server">Foo Server</a> &gt; FAQ
  591. ]]></programlisting>
  592. </example>
  593. <example id="zend.view.helpers.initial.navigation.breadcrumbs.example2">
  594. <title>Einrückung spezifizieren</title>
  595. <para>
  596. Dieses Beispiel zeigt wie Breadcrumbs mit anfänglicher Einrückung dargestellt
  597. werden können.
  598. </para>
  599. <programlisting language="php"><![CDATA[
  600. Darstellung mit 8 Leerzeichen Einrückung:
  601. <?php echo $this->navigation()->breadcrumbs()->setIndent(8); ?>
  602. Ausgabe:
  603. <a href="/products">Products</a> &gt; <a href="/products/server">Foo Server</a> &gt; FAQ
  604. ]]></programlisting>
  605. </example>
  606. <example id="zend.view.helpers.initial.navigation.breadcrumbs.example3">
  607. <title>Eigene Ausgabe für Breakcrumbs</title>
  608. <para>
  609. Dieses Beispiel zeigt wie man eine eigene Breadcrumbs Ausgabe durch die
  610. Spezifizierung diverser Optionen erstellt.
  611. </para>
  612. <programlisting language="php"><![CDATA[
  613. In einem View Skript oder Layout:
  614. <?php
  615. echo $this->navigation()
  616. ->breadcrumbs()
  617. ->setLinkLast(true) // Letzte Seite verlinken
  618. ->setMaxDepth(1) // Bei Level 1 stoppen
  619. ->setSeparator(' &#9654;' . PHP_EOL); // Cooler Seperator mit Umbruch
  620. ?>
  621. Output:
  622. <a href="/products">Produkte</a> &#9654;
  623. <a href="/products/server">Foo Server</a>
  624. /////////////////////////////////////////////////////
  625. Minimale notwendige Tiefe für die Darstellung von Breadcrumbs setzen:
  626. <?php
  627. $this->navigation()->breadcrumbs()->setMinDepth(10);
  628. echo $this->navigation()->breadcrumbs();
  629. ?>
  630. Ausgabe:
  631. Nichts, weil die tiefste aktive Seite nicht auf Level 10 oder tiefer ist.
  632. ]]></programlisting>
  633. </example>
  634. <example id="zend.view.helpers.initial.navigation.breadcrumbs.example4">
  635. <title>Darstellung von Breadcrumbs mit Verwendung eines partiellen View Skripts</title>
  636. <para>
  637. Dieses Beispiel zeigt wir eigene Breakcrumbs durch Verwendung eines partiellen
  638. View Skripts dargestellt werden können. Durch den Aufruf von
  639. <methodname>setPartial()</methodname> kann man ein partielles View Skript
  640. spezifizieren das verwendet wird wenn die <methodname>renderPartial()</methodname>
  641. Methode aufgerufen wird. Diese Methode findest die tiefste aktive Seite und übergibt
  642. ein Array von Seiten die zur aktiven Seite des partiellen View Skripts weiterleitet.
  643. </para>
  644. <para>
  645. Im Layout:
  646. </para>
  647. <programlisting language="php"><![CDATA[
  648. $partial = ;
  649. echo $this->navigation()->breadcrumbs()
  650. ->setPartial(array('breadcrumbs.phtml', 'default'));
  651. ]]></programlisting>
  652. <para>
  653. Inhalt von
  654. <code>application/modules/default/views/breadcrumbs.phtml</code>:
  655. </para>
  656. <programlisting language="php"><![CDATA[
  657. echo implode(', ', array_map(
  658. create_function('$a', 'return $a->getLabel();'),
  659. $this->pages));
  660. ]]></programlisting>
  661. <para>
  662. Ausgabe:
  663. </para>
  664. <programlisting language="php"><![CDATA[
  665. Produkte, Foo Server, FAQ
  666. ]]></programlisting>
  667. </example>
  668. </sect4>
  669. <sect4 id="zend.view.helpers.initial.navigation.links">
  670. <title>Link Helfer</title>
  671. <para>
  672. Der Link Helfer wird für die Darstellung von HTML <constant>LINK</constant> Elementen
  673. verwendet. Links werden für die Beschreibung von Dokument-Beziehungen der aktuell
  674. aktiven Seite verwendet. Mehr über Links und Linktypen kann unter
  675. <ulink url="http://www.w3.org/TR/html4/struct/links.html#h-12.3">Dokument-Beziehung:
  676. Das LINK Element (HTML4 W3C Rec.)</ulink> und
  677. <ulink url="http://www.w3.org/TR/html4/types.html#h-6.12">Link Typen
  678. (HTML4 W3C Rec.)</ulink> in der HMTL4 W3C Empfehlung nachgelesen werden.
  679. </para>
  680. <para>
  681. Es gibt zwei Typen von Beziehungen; vorwärts und rückwärts, angezeigt durch die
  682. Schlüsselwörter <code>'rel'</code> und <code>'rev'</code>. Die meisten Methoden im
  683. Helfer nehmen einen <varname>$rel</varname> Parameter entgegen, welcher entweder
  684. <code>'rel'</code> oder <code>'rev'</code> sein muß. Die meisten Methoden nehmen auch
  685. einen <varname>$type</varname> Parameter entgegen welcher für die Spezifikation des
  686. Linktyps (z.B. alternate, start, next, prev, chapter, usw.) verwendet wird.
  687. </para>
  688. <para>
  689. Beziehungen können dem Seitenobjekt manuell hinzugefügt werden, oder werden durch
  690. das Durchlaufen des Containers, der im Helfer registriert ist, gefunden. Die Methode
  691. <methodname>findRelation($page, $rel, $type)</methodname> versucht zuerst den gegebenen
  692. <varname>$rel</varname> von <varname>$type</varname> von der <varname>$page</varname>
  693. durch den Aufruf von <code>$page->findRel($type)</code> oder
  694. <code>$page->findRel($type)</code> zu finden. Wenn <varname>$page</varname> eine
  695. Beziehung hat die zu der Instanz einer Seite konvertiert werden kann, wird diese
  696. Beziehung verwendet. Wenn die Instanz von <varname>$page</varname> keinen
  697. <varname>$type</varname> spezifiziert hat, schaut der Helfer nach einer Methode im
  698. Helfer die <code>search$rel$type</code> heißt (z.B.
  699. <methodname>searchRelNext()</methodname> oder
  700. <methodname>searchRevAlternate()</methodname>). Wenn so eine Methode existiert, wird Sie
  701. für die Erkennung der Beziehung der <varname>$page</varname> verwendet indem der
  702. Container durchlaufen wird.
  703. </para>
  704. <para>
  705. Nicht alle Beziehungen können durch das Durchlaufen des Containers erkannt werden.
  706. Das sind die Beziehungen die durch eine Suche gefunden werden können:
  707. </para>
  708. <itemizedlist>
  709. <listitem>
  710. <para>
  711. <methodname>searchRelStart()</methodname>, Vorwärts Beziehung 'start': Die
  712. erste Seite im Container.
  713. </para>
  714. </listitem>
  715. <listitem>
  716. <para>
  717. <methodname>searchRelNext()</methodname>, Vorwärts Beziehung 'next'; findet
  718. die nächste Seite im Container, z.B. die Seite nach der aktiven Seite.
  719. </para>
  720. </listitem>
  721. <listitem>
  722. <para>
  723. <methodname>searchRelPrev()</methodname>, Vorwärts Beziehung 'prev'; findet
  724. die vorhergehende Seite, z.B. die Seite vor der aktiven Seite.
  725. </para>
  726. </listitem>
  727. <listitem>
  728. <para>
  729. <methodname>searchRelChapter()</methodname>, Vorwärts Beziehung 'chapter';
  730. findet alle Seiten auf Level 0 ausser der 'start' Beziehung oder der aktiven
  731. Seite wenn diese auf Level 0 ist.
  732. </para>
  733. </listitem>
  734. <listitem>
  735. <para>
  736. <methodname>searchRelSection()</methodname>, Vorwärts Beziehung 'section';
  737. findet alle Kind-Seiten der aktiven Seite wenn die aktive Seite auf Level 0
  738. ist (ein 'chapter').
  739. </para>
  740. </listitem>
  741. <listitem>
  742. <para>
  743. <methodname>searchRelSubsection()</methodname>, Vorwärts Beziehung
  744. 'subsection'; findet alle Kind-Seiten der aktiven Seite wenn die aktive
  745. Seite auf Level 1 sind (ein 'section').
  746. </para>
  747. </listitem>
  748. <listitem>
  749. <para>
  750. <methodname>searchRevSection()</methodname>, Rückwärts Beziehung 'section';
  751. findet den Elternteil der aktiven Seite wenn die aktive Seite auf Level 1
  752. ist (ein 'section').
  753. </para>
  754. </listitem>
  755. <listitem>
  756. <para>
  757. <methodname>searchRevSubsection()</methodname>, Rückwärts Beziehung
  758. 'subsection'; findet den Elternteil der aktiven Seite wenn die aktive Seite
  759. auf Level 2 ist (ein 'subsection').
  760. </para>
  761. </listitem>
  762. </itemizedlist>
  763. <note>
  764. <para>
  765. Wenn in der Instanz der Seite nach Beziehungen gesehen wird (
  766. (<code>$page->getRel($type)</code> oder <code>$page->getRev($type)</code>),
  767. akzeptiert der Helfer Wert vom Typ <type>String</type>, <type>Array</type>,
  768. <classname>Zend_Config</classname>, oder
  769. <classname>Zend_Navigation_Page</classname>. Wenn ein String gefunden wird, wird
  770. dieser zu einer <classname>Zend_Navigation_Page_Uri</classname> konvertiert. Wenn
  771. ein Array oder eine Config gefunden wird, wird diese in ein oder mehrere
  772. Seiteninstanzen konvertiert, und jedes Element wird an die
  773. <link linkend="zend.navigation.pages.factory">Seiten Factory</link> übergeben.
  774. Wenn der erste Schlüssel nicht nummerische ist, wird das Array/Config direkt an die
  775. Seiten Factory übergeben, und eine einzelne Seite wird retourniert.
  776. </para>
  777. </note>
  778. <para>
  779. Der Helfer unterstützt auch magische Methoden für das Finden von Beziehungen. Um z.B.
  780. alternative vorwärts Beziehungen zu finden muß
  781. <code>$helper->findRelAlternate($page)</code> aufgerufen werden, und um rückwärts
  782. gerichtete Kapitel Beziehungen zu finden <code>$helper->findRevSection($page)</code>.
  783. Diese Aufrufe korrespondieren mit <code>$helper->findRelation($page, 'rel',
  784. 'alternate');</code> und <code>$helper->findRelation($page, 'rev', 'section');</code>.
  785. </para>
  786. <para>
  787. Um zu Steuern welche Beziehung dargestellt werden soll, verwendet der Helfer ein render
  788. Flag. Das render Flag ist ein Integer Wert, und kann in
  789. <ulink url="http://php.net/manual/en/language.operators.bitwise.php">binären
  790. <code>und</code> (<code>&amp;</code>) Operationen</ulink> mit den render Konstanten des
  791. Helfers verwendet werden um festzustellen ob die Beziehung zu der die render Konstante
  792. gehört, dargestellt werden soll.
  793. </para>
  794. <para>
  795. Siehe das <link linkend="zend.view.helpers.initial.navigation.links.example3">folgende
  796. Beispiel</link> für weitere Informationen.
  797. </para>
  798. <itemizedlist>
  799. <listitem>
  800. <para>
  801. <constant>Zend_View_Helper_Navigation_Link::RENDER_ALTERNATE</constant>
  802. </para>
  803. </listitem>
  804. <listitem>
  805. <para>
  806. <constant>Zend_View_Helper_Navigation_Link::RENDER_STYLESHEET</constant>
  807. </para>
  808. </listitem>
  809. <listitem>
  810. <para>
  811. <constant>Zend_View_Helper_Navigation_Link::RENDER_START</constant>
  812. </para>
  813. </listitem>
  814. <listitem>
  815. <para>
  816. <constant>Zend_View_Helper_Navigation_Link::RENDER_NEXT</constant>
  817. </para>
  818. </listitem>
  819. <listitem>
  820. <para>
  821. <constant>Zend_View_Helper_Navigation_Link::RENDER_PREV</constant>
  822. </para>
  823. </listitem>
  824. <listitem>
  825. <para>
  826. <constant>Zend_View_Helper_Navigation_Link::RENDER_CONTENTS</constant>
  827. </para>
  828. </listitem>
  829. <listitem>
  830. <para>
  831. <constant>Zend_View_Helper_Navigation_Link::RENDER_INDEX</constant>
  832. </para>
  833. </listitem>
  834. <listitem>
  835. <para>
  836. <constant>Zend_View_Helper_Navigation_Link::RENDER_GLOSSARY</constant>
  837. </para>
  838. </listitem>
  839. <listitem>
  840. <para>
  841. <constant>Zend_View_Helper_Navigation_Link::RENDER_COPYRIGHT</constant>
  842. </para>
  843. </listitem>
  844. <listitem>
  845. <para>
  846. <constant>Zend_View_Helper_Navigation_Link::RENDER_CHAPTER</constant>
  847. </para>
  848. </listitem>
  849. <listitem>
  850. <para>
  851. <constant>Zend_View_Helper_Navigation_Link::RENDER_SECTION</constant>
  852. </para>
  853. </listitem>
  854. <listitem>
  855. <para>
  856. <constant>Zend_View_Helper_Navigation_Link::RENDER_SUBSECTION</constant>
  857. </para>
  858. </listitem>
  859. <listitem>
  860. <para>
  861. <constant>Zend_View_Helper_Navigation_Link::RENDER_APPENDIX</constant>
  862. </para>
  863. </listitem>
  864. <listitem>
  865. <para>
  866. <constant>Zend_View_Helper_Navigation_Link::RENDER_HELP</constant>
  867. </para>
  868. </listitem>
  869. <listitem>
  870. <para>
  871. <constant>Zend_View_Helper_Navigation_Link::RENDER_BOOKMARK</constant>
  872. </para>
  873. </listitem>
  874. <listitem>
  875. <para>
  876. <constant>Zend_View_Helper_Navigation_Link::RENDER_CUSTOM</constant>
  877. </para>
  878. </listitem>
  879. <listitem>
  880. <para>
  881. <constant>Zend_View_Helper_Navigation_Link::RENDER_ALL</constant>
  882. </para>
  883. </listitem>
  884. </itemizedlist>
  885. <para>
  886. Die Konstanten von <constant>RENDER_ALTERNATE</constant> bis
  887. <constant>RENDER_BOOKMARK</constant> stellen standardmäßige HTML Linktypen dar.
  888. <constant>RENDER_CUSTOM</constant> stellt eine nicht-standardmäßige Beziehung dar die
  889. in der Seite spezifiziert ist. <constant>RENDER_ALL</constant> stellt standardmäßige
  890. und nicht-standardmäßige Beziehungen dar.
  891. </para>
  892. <para>
  893. Methoden im Link Helfer:
  894. </para>
  895. <itemizedlist>
  896. <listitem>
  897. <para>
  898. <code>{get|set}RenderFlag()</code> empfängt/setzt das render Flag.
  899. Standardwert ist <constant>RENDER_ALL</constant>. Siehe das folgende Beispiel
  900. dafür wie das render Flag zu setzen ist.
  901. </para>
  902. </listitem>
  903. <listitem>
  904. <para>
  905. <methodname>findAllRelations()</methodname> findet alle Beziehungen von allen
  906. Typen einer angegebenen Seite.
  907. </para>
  908. </listitem>
  909. <listitem>
  910. <para>
  911. <methodname>findRelation()</methodname> findet alle Beziehungen eines angegebenen
  912. Typs einer angegebenen Seite.
  913. </para>
  914. </listitem>
  915. <listitem>
  916. <para>
  917. <methodname>searchRel{Start|Next|Prev|Chapter|Section|Subsection}()</methodname>
  918. durchsucht einen Container um vorwärtsgerichtete Beziehungen zu Startseite,
  919. nächster Seite, voriger Seite, Kapitel, Sektion und Untersektion zu finden.
  920. </para>
  921. </listitem>
  922. <listitem>
  923. <para>
  924. <methodname>searchRev{Section|Subsection}()</methodname> durchsucht einen
  925. Container um rückwärtsgerichtete Beziehungen zu Sektionen oder Untersektionen zu
  926. finden.
  927. </para>
  928. </listitem>
  929. <listitem>
  930. <para>
  931. <methodname>renderLink()</methodname> stellt ein einzelnes <code>link</code>
  932. Element dar.
  933. </para>
  934. </listitem>
  935. </itemizedlist>
  936. <example id="zend.view.helpers.initial.navigation.links.example1">
  937. <title>Beziehungen in Seiten spezifizieren</title>
  938. <para>
  939. Dieses Beispiel zeigt wir Beziehungen in Seiten spezifiziert werden können.
  940. </para>
  941. <programlisting language="php"><![CDATA[
  942. $container = new Zend_Navigation(array(
  943. array(
  944. 'label' => 'Strings für Beziehungen verwenden',
  945. 'rel' => array(
  946. 'alternate' => 'http://www.example.org/'
  947. ),
  948. 'rev' => array(
  949. 'alternate' => 'http://www.example.net/'
  950. )
  951. ),
  952. array(
  953. 'label' => 'Arrays für Beziehungen verwenden',
  954. 'rel' => array(
  955. 'alternate' => array(
  956. 'label' => 'Example.org',
  957. 'uri' => 'http://www.example.org/'
  958. )
  959. )
  960. ),
  961. array(
  962. 'label' => 'Konfigurationen für Beziehungen verwenden',
  963. 'rel' => array(
  964. 'alternate' => new Zend_Config(array(
  965. 'label' => 'Example.org',
  966. 'uri' => 'http://www.example.org/'
  967. ))
  968. )
  969. ),
  970. array(
  971. 'label' => 'Instanzen von Seiten für Beziehungen verwenden',
  972. 'rel' => array(
  973. 'alternate' => Zend_Navigation_Page::factory(array(
  974. 'label' => 'Example.org',
  975. 'uri' => 'http://www.example.org/'
  976. ))
  977. )
  978. )
  979. ));
  980. ]]></programlisting>
  981. </example>
  982. <example id="zend.view.helpers.initial.navigation.links.example2">
  983. <title>Standardmäßige Darstellung von Links</title>
  984. <para>
  985. Dieses Beispiel zeigt wie ein Menü von einem Container dargestellt wird, der im
  986. View Helfer registriert/gefunden wurde.
  987. </para>
  988. <programlisting language="php"><![CDATA[
  989. Im View Skript oder Layout:
  990. <?php echo $this->view->navigation()->links(); ?>
  991. Ausgabe:
  992. <link rel="alternate" href="/products/server/faq/format/xml">
  993. <link rel="start" href="/" title="Home">
  994. <link rel="next" href="/products/server/editions" title="Editionen">
  995. <link rel="prev" href="/products/server" title="Foo Server">
  996. <link rel="chapter" href="/products" title="Produkte">
  997. <link rel="chapter" href="/company/about" title="Firma">
  998. <link rel="chapter" href="/community" title="Community">
  999. <link rel="canonical" href="http://www.example.com/?page=server-faq">
  1000. <link rev="subsection" href="/products/server" title="Foo Server">
  1001. ]]></programlisting>
  1002. </example>
  1003. <example id="zend.view.helpers.initial.navigation.links.example3">
  1004. <title>Spezifizieren welche Beziehungen dargestellt werden sollen</title>
  1005. <para>
  1006. Dieses Beispiel zeigt wie spezifiziert werden kann, welche Beziehungen zu finden
  1007. und darzustellen sind.
  1008. </para>
  1009. <programlisting language="php"><![CDATA[
  1010. Nur start, next und prev darstellen:
  1011. $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_START |
  1012. Zend_View_Helper_Navigation_Links::RENDER_NEXT |
  1013. Zend_View_Helper_Navigation_Links::RENDER_PREV);
  1014. Ausgabe:
  1015. <link rel="start" href="/" title="Home">
  1016. <link rel="next" href="/products/server/editions" title="Editionen">
  1017. <link rel="prev" href="/products/server" title="Foo Server">
  1018. ]]></programlisting>
  1019. <programlisting language="php"><![CDATA[
  1020. Nur native Linktypen darstellen:
  1021. $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
  1022. Zend_View_Helper_Navigation_Links::RENDER_CUSTOM);
  1023. Ausgabe:
  1024. <link rel="alternate" href="/products/server/faq/format/xml">
  1025. <link rel="start" href="/" title="Home">
  1026. <link rel="next" href="/products/server/editions" title="Editionen">
  1027. <link rel="prev" href="/products/server" title="Foo Server">
  1028. <link rel="chapter" href="/products" title="Produkte">
  1029. <link rel="chapter" href="/company/about" title="Firma">
  1030. <link rel="chapter" href="/community" title="Community">
  1031. <link rev="subsection" href="/products/server" title="Foo Server">
  1032. ]]></programlisting>
  1033. <programlisting language="php"><![CDATA[
  1034. Alles ausser Kapitel darstellen:
  1035. $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
  1036. Zend_View_Helper_Navigation_Links::RENDER_CHAPTER);
  1037. Ausgabe:
  1038. <link rel="alternate" href="/products/server/faq/format/xml">
  1039. <link rel="start" href="/" title="Home">
  1040. <link rel="next" href="/products/server/editions" title="Editionen">
  1041. <link rel="prev" href="/products/server" title="Foo Server">
  1042. <link rel="canonical" href="http://www.example.com/?page=server-faq">
  1043. <link rev="subsection" href="/products/server" title="Foo Server">
  1044. ]]></programlisting>
  1045. </example>
  1046. </sect4>
  1047. <sect4 id="zend.view.helpers.initial.navigation.menu">
  1048. <title>Menu Helfer</title>
  1049. <para>
  1050. Der Menu Helfer wird für die Darstellung von Menüs aus Navigations Containern
  1051. verwendet. Standardmäßig wird das Menü durch Verwendung der HTML Tags
  1052. <code>UL</code> und <code>LI</code> dargestellt. Der Helfer erlaubt aber auch
  1053. die Verwendung eines partiellen View Skripts.
  1054. </para>
  1055. <para>
  1056. Methoden im Menu Helfer:
  1057. </para>
  1058. <itemizedlist>
  1059. <listitem>
  1060. <para>
  1061. <code>{get|set}UlClass()</code> empfängt/setzt die <acronym>CSS</acronym> Klasse
  1062. zur Verwendung in <methodname>renderMenu()</methodname>.
  1063. </para>
  1064. </listitem>
  1065. <listitem>
  1066. <para>
  1067. <code>{get|set}OnlyActiveBranch()</code> empfängt/setzt ein Flag das
  1068. spezifiziert ob der aktive Zweig eines Containers dargestellt werden soll.
  1069. </para>
  1070. </listitem>
  1071. <listitem>
  1072. <para>
  1073. <code>{get|set}RenderParents()</code> empfängt/setzt ein Flag das
  1074. spezifiziert ob Eltern nur dargestellt werden sollen wenn nur der aktive
  1075. Zweig eines Containers dargestellt wird. Wenn es auf <constant>FALSE</constant>
  1076. gesetzt wird, wird nur das tiefste aktive Menü dargestellt.
  1077. </para>
  1078. </listitem>
  1079. <listitem>
  1080. <para>
  1081. <code>{get|set}Partial()</code> empfängt/setzt ein partielles View Skript
  1082. das für die Darstellung des Menüs verwendet werden soll. Wenn ein partielles
  1083. Skript gesetzt ist, verwendet die <methodname>render()</methodname> Methode des
  1084. Helfers die <methodname>renderPartial()</methodname> Methode. Wenn kein
  1085. Partieller gesetzt ist, wird die <methodname>renderMenu()</methodname> Methode
  1086. verwendet. Der Helfer erwartet das der Partielle ein <type>String</type>, oder
  1087. ein <type>Array</type> mit zwei Elementen, ist. Wenn der Partielle ein
  1088. <type>String</type> ist bezeichnet er den Namen des partiellen Skripts das zu
  1089. verwenden ist. Wenn er ein <type>Array</type> ist wird das erste Element als
  1090. Name des partiellen View Skripts verwendet, und das zweite Element ist das Modul
  1091. indem das Skript gefunden wird.
  1092. </para>
  1093. </listitem>
  1094. <listitem>
  1095. <para>
  1096. <methodname>htmlify()</methodname> überschreibt die Methode der abstrakten
  1097. Klasse damit <code>span</code> Elemente zurückgegeben werden wenn die Seite kein
  1098. <code>href</code> hat.
  1099. </para>
  1100. </listitem>
  1101. <listitem>
  1102. <para>
  1103. <methodname>renderMenu($container = null, $options = array())</methodname> ist
  1104. eine standardmäßige render Methode, und stellt einen Container als HTML
  1105. <code>UL</code> Liste dar.
  1106. </para>
  1107. <para>
  1108. Wenn <varname>$container</varname> nicht angegeben wird, wird der Container der
  1109. im Helfer registriert ist dargestellt.
  1110. </para>
  1111. <para>
  1112. <varname>$options</varname> wird verwendet um temporär spezifizierte Optionen zu
  1113. überschreiben ohne das die Werte in der Helferinstanz resetiert werden. Es
  1114. ist ein assoziatives Array wobei jeder Schlüssel mit einer Option im Helfer
  1115. korrespondiert.
  1116. </para>
  1117. <para>
  1118. Erkannte Optionen:
  1119. </para>
  1120. <itemizedlist>
  1121. <listitem>
  1122. <para>
  1123. <code>indent</code>; Einrückung. Erwartet einen <type>String</type>
  1124. oder einen <code>int</code> Wert.
  1125. </para>
  1126. </listitem>
  1127. <listitem>
  1128. <para>
  1129. <code>minDepth</code>; Minimale Tiefe. Erwartet ein
  1130. <code>int</code> oder <constant>NULL</constant> (keine minimale
  1131. Tiefe).
  1132. </para>
  1133. </listitem>
  1134. <listitem>
  1135. <para>
  1136. <code>maxDepth</code>; Maximale Tiefe. Erwartet ein
  1137. <code>int</code> oder <constant>NULL</constant> (keine maximale
  1138. Tiefe).
  1139. </para>
  1140. </listitem>
  1141. <listitem>
  1142. <para>
  1143. <code>ulClass</code>; <acronym>CSS</acronym> Klasse für das
  1144. <code>ul</code> Element. Erwartet einen <type>String</type>.
  1145. </para>
  1146. </listitem>
  1147. <listitem>
  1148. <para>
  1149. <code>onlyActiveBranch</code>; Ob nur der aktive Branch dargestellt
  1150. werden soll. Erwartet einen <type>Boolean</type> Wert.
  1151. </para>
  1152. </listitem>
  1153. <listitem>
  1154. <para>
  1155. <code>renderParents</code>; Ob eltern dargestellt werden sollen
  1156. wenn nur der aktive Branch dargestellt wird. Erwartet einen
  1157. <type>Boolean</type> Wert.
  1158. </para>
  1159. </listitem>
  1160. </itemizedlist>
  1161. <para>
  1162. Wenn keine Option angegeben wird, werden die Werte die im Helfer gesetzt
  1163. sind verwendet.
  1164. </para>
  1165. </listitem>
  1166. <listitem>
  1167. <para>
  1168. <methodname>renderPartial()</methodname> wird für die Darstellung des Menüs in
  1169. einem partiellen View Skript verwendet.
  1170. </para>
  1171. </listitem>
  1172. <listitem>
  1173. <para>
  1174. <methodname>renderSubMenu()</methodname> stellt das tiefste Menü Level des
  1175. aktiven Branches eines Containers dar.
  1176. </para>
  1177. </listitem>
  1178. </itemizedlist>
  1179. <example id="zend.view.helpers.initial.navigation.menu.example1">
  1180. <title>Darstellung eines Menüs</title>
  1181. <para>
  1182. Dieses Beispiel zeigt wie ein Menü von einem registrierten/im View Helfer
  1183. gefundenen Container, dargestellt wird. Es ist zu beachten das Seiten basierend
  1184. auf Ihrer Sichtbarkeit und ACL ausgefiltert werden.
  1185. </para>
  1186. <programlisting language="php"><![CDATA[
  1187. In einem View Skript oder Layout:
  1188. <?php echo $this->navigation()->menu()->render() ?>
  1189. Oder einfach:
  1190. <?php echo $this->navigation()->menu() ?>
  1191. Oder wenn Short Tags aktiviert sind:
  1192. <?= $this->navigation()->menu() ?>
  1193. Ausgabe:
  1194. <ul class="navigation">
  1195. <li>
  1196. <a title="Geh zu Home" href="/">Home</a>
  1197. </li>
  1198. <li class="active">
  1199. <a href="/products">Produkte</a>
  1200. <ul>
  1201. <li class="active">
  1202. <a href="/products/server">Foo Server</a>
  1203. <ul>
  1204. <li class="active">
  1205. <a href="/products/server/faq">FAQ</a>
  1206. </li>
  1207. <li>
  1208. <a href="/products/server/editions">Editionen</a>
  1209. </li>
  1210. <li>
  1211. <a href="/products/server/requirements">System Anforderungen</a>
  1212. </li>
  1213. </ul>
  1214. </li>
  1215. <li>
  1216. <a href="/products/studio">Foo Studio</a>
  1217. <ul>
  1218. <li>
  1219. <a href="/products/studio/customers">Kunden Stories</a>
  1220. </li>
  1221. <li>
  1222. <a href="/prodcts/studio/support">Support</a>
  1223. </li>
  1224. </ul>
  1225. </li>
  1226. </ul>
  1227. </li>
  1228. <li>
  1229. <a title="About us" href="/company/about">Firma</a>
  1230. <ul>
  1231. <li>
  1232. <a href="/company/about/investors">Investor Relations</a>
  1233. </li>
  1234. <li>
  1235. <a class="rss" href="/company/news">News</a>
  1236. <ul>
  1237. <li>
  1238. <a href="/company/news/press">Für die Presse</a>
  1239. </li>
  1240. <li>
  1241. <a href="/archive">Archiv</a>
  1242. </li>
  1243. </ul>
  1244. </li>
  1245. </ul>
  1246. </li>
  1247. <li>
  1248. <a href="/community">Community</a>
  1249. <ul>
  1250. <li>
  1251. <a href="/community/account">Mein Account</a>
  1252. </li>
  1253. <li>
  1254. <a class="external" href="http://forums.example.com/">Forums</a>
  1255. </li>
  1256. </ul>
  1257. </li>
  1258. </ul>
  1259. ]]></programlisting>
  1260. </example>
  1261. <example id="zend.view.helpers.initial.navigation.menu.example2">
  1262. <title>renderMenu() direkt aufrufen</title>
  1263. <para>
  1264. Dieses Beispiel zeigt wie ein Menü dargestellt werden kann das nicht im View
  1265. Helfer registriert ist, indem <methodname>renderMenu()</methodname> direkt
  1266. aufgerufen wird und ein paar wenige Optionen spezifiziert werden.
  1267. </para>
  1268. <programlisting language="php"><![CDATA[
  1269. <?php
  1270. // Nur das 'Community' Menü darstellen
  1271. $community = $this->navigation()->findOneByLabel('Community');
  1272. $options = array(
  1273. 'indent' => 16,
  1274. 'ulClass' => 'community'
  1275. );
  1276. echo $this->navigation()
  1277. ->menu()
  1278. ->renderMenu($community, $options);
  1279. ?>
  1280. Output:
  1281. <ul class="community">
  1282. <li>
  1283. <a href="/community/account">Mein Account</a>
  1284. </li>
  1285. <li>
  1286. <a class="external" href="http://forums.example.com/">Forums</a>
  1287. </li>
  1288. </ul>
  1289. ]]></programlisting>
  1290. </example>
  1291. <example id="zend.view.helpers.initial.navigation.menu.example3">
  1292. <title>Das tiefste aktive Menü darstellen</title>
  1293. <para>
  1294. Dieses Beispiel zeigt wie <methodname>renderSubMenu()</methodname> das tiefste
  1295. Untermenü des aktiven Branches dargestellt wird.
  1296. </para>
  1297. <para>
  1298. Der Aufruf von <methodname>renderSubMenu($container, $ulClass, $indent)</methodname>
  1299. ist identisch mit dem Aufruf von
  1300. <methodname>renderMenu($container, $options)</methodname> mit den folgenden
  1301. Optionen:
  1302. </para>
  1303. <programlisting language="php"><![CDATA[
  1304. array(
  1305. 'ulClass' => $ulClass,
  1306. 'indent' => $indent,
  1307. 'minDepth' => null,
  1308. 'maxDepth' => null,
  1309. 'onlyActiveBranch' => true,
  1310. 'renderParents' => false
  1311. );
  1312. ]]></programlisting>
  1313. <programlisting language="php"><![CDATA[
  1314. <?php
  1315. echo $this->navigation()
  1316. ->menu()
  1317. ->renderSubMenu(null, 'sidebar', 4);
  1318. ?>
  1319. Die Ausgabe ist die gleiche wenn 'FAQ' oder 'Foo Server' aktiv sind:
  1320. <ul class="sidebar">
  1321. <li class="active">
  1322. <a href="/products/server/faq">FAQ</a>
  1323. </li>
  1324. <li>
  1325. <a href="/products/server/editions">Editionen</a>
  1326. </li>
  1327. <li>
  1328. <a href="/products/server/requirements">System Anforderungen</a>
  1329. </li>
  1330. </ul>
  1331. ]]></programlisting>
  1332. </example>
  1333. <example id="zend.view.helpers.initial.navigation.menu.example4">
  1334. <title>Darstellung eines Menüs mit maximaler Tiefe</title>
  1335. <programlisting language="php"><![CDATA[
  1336. <?php
  1337. echo $this->navigation()
  1338. ->menu()
  1339. ->setMaxDepth(1);
  1340. ?>
  1341. Ausgabe:
  1342. <ul class="navigation">
  1343. <li>
  1344. <a title="Geh zu Home" href="/">Home</a>
  1345. </li>
  1346. <li class="active">
  1347. <a href="/products">Produkte</a>
  1348. <ul>
  1349. <li class="active">
  1350. <a href="/products/server">Foo Server</a>
  1351. </li>
  1352. <li>
  1353. <a href="/products/studio">Foo Studio</a>
  1354. </li>
  1355. </ul>
  1356. </li>
  1357. <li>
  1358. <a title="About us" href="/company/about">Firma</a>
  1359. <ul>
  1360. <li>
  1361. <a href="/company/about/investors">Investor Relations</a>
  1362. </li>
  1363. <li>
  1364. <a class="rss" href="/company/news">News</a>
  1365. </li>
  1366. </ul>
  1367. </li>
  1368. <li>
  1369. <a href="/community">Community</a>
  1370. <ul>
  1371. <li>
  1372. <a href="/community/account">Mein Account</a>
  1373. </li>
  1374. <li>
  1375. <a class="external" href="http://forums.example.com/">Forums</a>
  1376. </li>
  1377. </ul>
  1378. </li>
  1379. </ul>
  1380. ]]></programlisting>
  1381. </example>
  1382. <example id="zend.view.helpers.initial.navigation.menu.example5">
  1383. <title>Darstellung eines Menüs mit minimaler Tiefe</title>
  1384. <programlisting language="php"><![CDATA[
  1385. <?php
  1386. echo $this->navigation()
  1387. ->menu()
  1388. ->setMinDepth(1);
  1389. ?>
  1390. Ausgabe:
  1391. <ul class="navigation">
  1392. <li class="active">
  1393. <a href="/products/server">Foo Server</a>
  1394. <ul>
  1395. <li class="active">
  1396. <a href="/products/server/faq">FAQ</a>
  1397. </li>
  1398. <li>
  1399. <a href="/products/server/editions">Editionen</a>
  1400. </li>
  1401. <li>
  1402. <a href="/products/server/requirements">System Anforderungen</a>
  1403. </li>
  1404. </ul>
  1405. </li>
  1406. <li>
  1407. <a href="/products/studio">Foo Studio</a>
  1408. <ul>
  1409. <li>
  1410. <a href="/products/studio/customers">Kunden Stories</a>
  1411. </li>
  1412. <li>
  1413. <a href="/prodcts/studio/support">Support</a>
  1414. </li>
  1415. </ul>
  1416. </li>
  1417. <li>
  1418. <a href="/company/about/investors">Investor Relations</a>
  1419. </li>
  1420. <li>
  1421. <a class="rss" href="/company/news">News</a>
  1422. <ul>
  1423. <li>
  1424. <a href="/company/news/press">Für die Presse</a>
  1425. </li>
  1426. <li>
  1427. <a href="/archive">Archiv</a>
  1428. </li>
  1429. </ul>
  1430. </li>
  1431. <li>
  1432. <a href="/community/account">Mein Account</a>
  1433. </li>
  1434. <li>
  1435. <a class="external" href="http://forums.example.com/">Forums</a>
  1436. </li>
  1437. </ul>
  1438. ]]></programlisting>
  1439. </example>
  1440. <example id="zend.view.helpers.initial.navigation.menu.example6">
  1441. <title>Nur den aktiven Branch eines Menüs darstellen</title>
  1442. <programlisting language="php"><![CDATA[
  1443. <?php
  1444. echo $this->navigation()
  1445. ->menu()
  1446. ->setOnlyActiveBranch(true);
  1447. ?>
  1448. Ausgabe:
  1449. <ul class="navigation">
  1450. <li class="active">
  1451. <a href="/products">Produkte</a>
  1452. <ul>
  1453. <li class="active">
  1454. <a href="/products/server">Foo Server</a>
  1455. <ul>
  1456. <li class="active">
  1457. <a href="/products/server/faq">FAQ</a>
  1458. </li>
  1459. <li>
  1460. <a href="/products/server/editions">Editionen</a>
  1461. </li>
  1462. <li>
  1463. <a href="/products/server/requirements">System Anforderungen</a>
  1464. </li>
  1465. </ul>
  1466. </li>
  1467. </ul>
  1468. </li>
  1469. </ul>
  1470. ]]></programlisting>
  1471. </example>
  1472. <example id="zend.view.helpers.initial.navigation.menu.example7">
  1473. <title>
  1474. Nur den aktiven Branch eines Menüs mit minimaler Tiefe darstellen
  1475. </title>
  1476. <programlisting language="php"><![CDATA[
  1477. <?php
  1478. echo $this->navigation()
  1479. ->menu()
  1480. ->setOnlyActiveBranch(true)
  1481. ->setMinDepth(1);
  1482. ?>
  1483. Ausgabe:
  1484. <ul class="navigation">
  1485. <li class="active">
  1486. <a href="/products/server">Foo Server</a>
  1487. <ul>
  1488. <li class="active">
  1489. <a href="/products/server/faq">FAQ</a>
  1490. </li>
  1491. <li>
  1492. <a href="/products/server/editions">Editionen</a>
  1493. </li>
  1494. <li>
  1495. <a href="/products/server/requirements">System Anforderungen</a>
  1496. </li>
  1497. </ul>
  1498. </li>
  1499. </ul>
  1500. ]]></programlisting>
  1501. </example>
  1502. <example id="zend.view.helpers.initial.navigation.menu.example8">
  1503. <title>
  1504. Nur den aktiven Branch eines Menüs mit maximaler Tiefe darstellen
  1505. </title>
  1506. <programlisting language="php"><![CDATA[
  1507. <?php
  1508. echo $this->navigation()
  1509. ->menu()
  1510. ->setOnlyActiveBranch(true)
  1511. ->setMaxDepth(1);
  1512. ?>
  1513. Ausgabe:
  1514. <ul class="navigation">
  1515. <li class="active">
  1516. <a href="/products">Produkte</a>
  1517. <ul>
  1518. <li class="active">
  1519. <a href="/products/server">Foo Server</a>
  1520. </li>
  1521. <li>
  1522. <a href="/products/studio">Foo Studio</a>
  1523. </li>
  1524. </ul>
  1525. </li>
  1526. </ul>
  1527. ]]></programlisting>
  1528. </example>
  1529. <example id="zend.view.helpers.initial.navigation.menu.example9">
  1530. <title>
  1531. Nur den aktiven Branch eines Menüs mit maximaler Tiefe aber ohne Eltern darstellen
  1532. </title>
  1533. <para>
  1534. </para>
  1535. <programlisting language="php"><![CDATA[
  1536. <?php
  1537. echo $this->navigation()
  1538. ->menu()
  1539. ->setOnlyActiveBranch(true)
  1540. ->setRenderParents(false)
  1541. ->setMaxDepth(1);
  1542. ?>
  1543. Ausgabe:
  1544. <ul class="navigation">
  1545. <li class="active">
  1546. <a href="/products/server">Foo Server</a>
  1547. </li>
  1548. <li>
  1549. <a href="/products/studio">Foo Studio</a>
  1550. </li>
  1551. </ul>
  1552. ]]></programlisting>
  1553. </example>
  1554. <example id="zend.view.helpers.initial.navigation.menu.example10">
  1555. <title>
  1556. Darstellen eines eigenen Menüs durch Verwendung eines partiellen View Skripts
  1557. </title>
  1558. <para>
  1559. Dieses Beispiel zeigt wie ein eigenes Menü, durch Verwendung eines partiellen View
  1560. Skripts, dargestellt werden kann. Durch Aufruf von
  1561. <methodname>setPartial()</methodname> kann ein partielles View Skript spezifiziert
  1562. werden das verwendet wird wenn man <methodname>render()</methodname> aufruft. Wenn
  1563. ein Partielles spezifiziert ist, wird die <methodname>renderPartial()</methodname>
  1564. Methode aufgerufen. Diese Methode fügt den Container in die View ein, und verwendet
  1565. hierbei den Schlüssel <code>container</code>.
  1566. </para>
  1567. <para>In a layout:</para>
  1568. <programlisting language="php"><![CDATA[
  1569. $partial = array('menu.phtml', 'default');
  1570. $this->navigation()->menu()->setPartial($partial);
  1571. echo $this->navigation()->menu()->render();
  1572. ]]></programlisting>
  1573. <para>In application/modules/default/views/menu.phtml:</para>
  1574. <programlisting language="php"><![CDATA[
  1575. foreach ($this->container as $page) {
  1576. echo $this->menu()->htmlify($page), PHP_EOL;
  1577. }
  1578. ]]></programlisting>
  1579. <para>Ausgabe:</para>
  1580. <programlisting language="php"><![CDATA[
  1581. <a title="Geh zu Home" href="/">Home</a>
  1582. <a href="/products">Produkte</a>
  1583. <a title="About us" href="/company/about">Firma</a>
  1584. <a href="/community">Community</a>
  1585. ]]></programlisting>
  1586. </example>
  1587. </sect4>
  1588. <sect4 id="zend.view.helpers.initial.navigation.sitemap">
  1589. <title>Sitemap Helfer</title>
  1590. <para>
  1591. Der Sitemap Helfer wird für die Erzeugung von <acronym>XML</acronym> Sitemaps verwendet
  1592. wie im <ulink url="http://www.sitemaps.org/protocol.php">Sitemaps <acronym>XML</acronym>
  1593. Format</ulink> definiert. Mehr darüber kann unter <ulink
  1594. url="http://en.wikipedia.org/wiki/Sitemaps"> Sitemaps in Wikipedia</ulink>
  1595. nachgelesen werden.
  1596. </para>
  1597. <para>
  1598. Standardmäßig verwendet der Sitemap Helfer
  1599. <link linkend="zend.validate.sitemap">Sitemap Prüfungen</link> um jedes Element zu
  1600. prüfen das dargestellt werden soll. Das kann deaktiviert werden indem man
  1601. <code>$helper->setUseSitemapValidators(false)</code> aufruft.
  1602. </para>
  1603. <note>
  1604. <para>
  1605. Wenn man die Sitemap Prüfungen deaktiviert, werden die eigenen Eigenschaften
  1606. (siehe Tabelle) nicht geprüft.
  1607. </para>
  1608. </note>
  1609. <para>
  1610. Der Sitemap Helfer unterstützt auch die Pürfung von
  1611. <ulink url="http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">Sitemap XSD
  1612. Schemas</ulink> der erzeugten Sitemap. Das ist standardmäßig deaktiviert, da es eine
  1613. Anfrage auf die Schema Datei benötigt. Es kann mit
  1614. <code>$helper->setUseSchemaValidation(true)</code> aktiviert werden.
  1615. </para>
  1616. <table id="zend.view.helpers.initial.navigation.sitemap.elements">
  1617. <title>Sitemap XML Elemente</title>
  1618. <tgroup cols="2">
  1619. <thead>
  1620. <row>
  1621. <entry>Element</entry>
  1622. <entry>Beschreibung</entry>
  1623. </row>
  1624. </thead>
  1625. <tbody>
  1626. <row>
  1627. <entry><code>loc</code></entry>
  1628. <entry>
  1629. Absolute UTL zur Seite. Eine absolute URL wird vom Helfer erzeugt.
  1630. </entry>
  1631. </row>
  1632. <row>
  1633. <entry><code>lastmod</code></entry>
  1634. <entry>
  1635. <para>
  1636. Das Datum der letzten Änderung der Datei, im
  1637. <ulink url="http://www.w3.org/TR/NOTE-datetime">W3C
  1638. Datetime</ulink> Format. Dieser Zeitabschnitt kann bei Bedarf
  1639. unterdrückt, und nur YYYY-MM-DD verwendet werden.
  1640. </para>
  1641. <para>
  1642. Der Helfer versucht den <code>lastmod</code> Wert von der
  1643. Seiteneigenschaft <code>lastmod</code> zu erhalten wenn diese auf
  1644. der Seite gesetzt ist. Wenn der Wert kein gültiges Datum ist, wird
  1645. er ignoriert.
  1646. </para>
  1647. </entry>
  1648. </row>
  1649. <row>
  1650. <entry><code>changefreq</code></entry>
  1651. <entry>
  1652. <para>
  1653. Wie oft eine Seite geändert wird. Dieser Wert bietet eine generelle
  1654. Information für Suchmaschinen und muß nicht exakt mit der Anzahl
  1655. der Suchen auf der Seite übereinstimmen. Gültige Werte sind:
  1656. </para>
  1657. <itemizedlist>
  1658. <listitem><para>always</para></listitem>
  1659. <listitem><para>hourly</para></listitem>
  1660. <listitem><para>daily</para></listitem>
  1661. <listitem><para>weekly</para></listitem>
  1662. <listitem><para>monthly</para></listitem>
  1663. <listitem><para>yearly</para></listitem>
  1664. <listitem><para>never</para></listitem>
  1665. </itemizedlist>
  1666. <para>
  1667. Der Helfer versucht den <code>changefreq</code> Wert von der
  1668. Seiteneigenschaft <code>changefreq</code> zu erhalten, wenn diese
  1669. auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird er
  1670. ignoriert.
  1671. </para>
  1672. </entry>
  1673. </row>
  1674. <row>
  1675. <entry><code>priority</code></entry>
  1676. <entry>
  1677. <para>
  1678. Die Priorität dieser <acronym>URL</acronym> relativ zu anderen
  1679. <acronym>URL</acronym>s auf der eigenen Site. Der gültige Bereich
  1680. für diesen Wert ist von 0.0 bis 1.0.
  1681. </para>
  1682. <para>
  1683. Der Helfer versucht den <code>priority</code> Wert von der
  1684. Seiteneigenschaft <code>priority</code> zu erhalten wenn dieser
  1685. auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird
  1686. er ignoriert.
  1687. </para>
  1688. </entry>
  1689. </row>
  1690. </tbody>
  1691. </tgroup>
  1692. </table>
  1693. <para>
  1694. Methoden im Sitemap Helfer:
  1695. </para>
  1696. <itemizedlist>
  1697. <listitem>
  1698. <para>
  1699. <code>{get|set}FormatOutput()</code> empfängt/setzt ein Flag das anzeigt ob
  1700. <acronym>XML</acronym> Ausgaben formatiert werden sollen. Das entspricht der
  1701. Eigenschaft <code>formatOutput</code> der nativen
  1702. <classname>DOMDocument</classname> Klasse. Mehr kann man unter <ulink
  1703. url="http://php.net/domdocument">PHP: DOMDocument - Handbuch</ulink>
  1704. nachlesen. Der Standardwert ist <constant>FALSE</constant>.
  1705. </para>
  1706. </listitem>
  1707. <listitem>
  1708. <para>
  1709. <code>{get|set}UseXmlDeclaration()</code> empfängt/setzt ein Flag das
  1710. anzeigt ob die <acronym>XML</acronym> Deklaration bei der Darstellung enthalten
  1711. sein soll. Der Standardwert ist <constant>TRUE</constant>.
  1712. </para>
  1713. </listitem>
  1714. <listitem>
  1715. <para>
  1716. <code>{get|set}UseSitemapValidators()</code> empfängt/setzt ein Flag das
  1717. anzeigt ob Sitemap Prüfungen verwendet werden sollen wenn die DOM Sitemap
  1718. dargestellt werden soll. Der Standardwert ist <constant>TRUE</constant>.
  1719. </para>
  1720. </listitem>
  1721. <listitem>
  1722. <para>
  1723. <code>{get|set}UseSchemaValidation()</code> empfängt/setzt ein Flag das
  1724. anzeigt ob der Helfer eine <acronym>XML</acronym> Schema Prüfung verwenden soll
  1725. wenn die DOM Sitemap erzeugt wird. Der Standardwert ist
  1726. <constant>FALSE</constant>.
  1727. </para>
  1728. </listitem>
  1729. <listitem>
  1730. <para>
  1731. <code>{get|set}ServerUrl()</code> empfängt/setzt die Server
  1732. <acronym>URL</acronym> die nicht-absoluten <acronym>URL</acronym>s in der
  1733. <methodname>url()</methodname> Methode vorangestellt werden. Wenn keine Server
  1734. <acronym>URL</acronym> spezifiziert ist, wird diese vom Helfer festgestellt.
  1735. </para>
  1736. </listitem>
  1737. <listitem>
  1738. <para>
  1739. <methodname>url()</methodname> wird verwendet um absolute
  1740. <acronym>URL</acronym>s zu Seiten zu erstellen.
  1741. </para>
  1742. </listitem>
  1743. <listitem>
  1744. <para>
  1745. <methodname>getDomSitemap()</methodname> erzeugt ein DOMDocument von einem
  1746. angegebenen Container.
  1747. </para>
  1748. </listitem>
  1749. </itemizedlist>
  1750. <example id="zend.view.helpers.initial.navigation.sitemap.example">
  1751. <title>Eine XML Sitemap darstellen</title>
  1752. <para>
  1753. Dieses Beispiel zeigt wie eine <acronym>XML</acronym> Sitemap, basierend auf dem
  1754. Setup das wir vorher angegeben haben, dargestellt wird.
  1755. </para>
  1756. <programlisting language="php"><![CDATA[
  1757. // In einem View Skript oder Layout:
  1758. // Ausgabeformat
  1759. $this->navigation()
  1760. ->sitemap()
  1761. ->setFormatOutput(true); // Standardwert ist false
  1762. // Andere mögliche Methoden:
  1763. // ->setUseXmlDeclaration(false); // Standardwert ist true
  1764. // ->setServerUrl('http://my.otherhost.com');
  1765. // Standard ist die automatische Erkennung
  1766. // Sitemap ausdrucken
  1767. echo $this->navigation()->sitemap();
  1768. ]]></programlisting>
  1769. <para>
  1770. Es ist zu beachten wie Seiten die unsichtbar oder Seiten mit ACL Rollen die mit dem
  1771. View Helfer inkompatibel sin, ausgefiltert werden:
  1772. </para>
  1773. <programlisting language="xml"><![CDATA[
  1774. <?xml version="1.0" encoding="UTF-8"?>
  1775. <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  1776. <url>
  1777. <loc>http://www.example.com/</loc>
  1778. </url>
  1779. <url>
  1780. <loc>http://www.example.com/products</loc>
  1781. </url>
  1782. <url>
  1783. <loc>http://www.example.com/products/server</loc>
  1784. </url>
  1785. <url>
  1786. <loc>http://www.example.com/products/server/faq</loc>
  1787. </url>
  1788. <url>
  1789. <loc>http://www.example.com/products/server/editions</loc>
  1790. </url>
  1791. <url>
  1792. <loc>http://www.example.com/products/server/requirements</loc>
  1793. </url>
  1794. <url>
  1795. <loc>http://www.example.com/products/studio</loc>
  1796. </url>
  1797. <url>
  1798. <loc>http://www.example.com/products/studio/customers</loc>
  1799. </url>
  1800. <url>
  1801. <loc>http://www.example.com/prodcts/studio/support</loc>
  1802. </url>
  1803. <url>
  1804. <loc>http://www.example.com/company/about</loc>
  1805. </url>
  1806. <url>
  1807. <loc>http://www.example.com/company/about/investors</loc>
  1808. </url>
  1809. <url>
  1810. <loc>http://www.example.com/company/news</loc>
  1811. </url>
  1812. <url>
  1813. <loc>http://www.example.com/company/news/press</loc>
  1814. </url>
  1815. <url>
  1816. <loc>http://www.example.com/archive</loc>
  1817. </url>
  1818. <url>
  1819. <loc>http://www.example.com/community</loc>
  1820. </url>
  1821. <url>
  1822. <loc>http://www.example.com/community/account</loc>
  1823. </url>
  1824. <url>
  1825. <loc>http://forums.example.com/</loc>
  1826. </url>
  1827. </urlset>
  1828. ]]></programlisting>
  1829. <para>
  1830. Die Sitemap ohne Verwendung einer ACL Rolle darstellen (sollte /community/account
  1831. ausfiltern):
  1832. </para>
  1833. <programlisting language="php"><![CDATA[
  1834. echo $this->navigation()
  1835. ->sitemap()
  1836. ->setFormatOutput(true)
  1837. ->setRole();
  1838. ]]></programlisting>
  1839. <programlisting language="xml"><![CDATA[
  1840. <?xml version="1.0" encoding="UTF-8"?>
  1841. <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  1842. <url>
  1843. <loc>http://www.example.com/</loc>
  1844. </url>
  1845. <url>
  1846. <loc>http://www.example.com/products</loc>
  1847. </url>
  1848. <url>
  1849. <loc>http://www.example.com/products/server</loc>
  1850. </url>
  1851. <url>
  1852. <loc>http://www.example.com/products/server/faq</loc>
  1853. </url>
  1854. <url>
  1855. <loc>http://www.example.com/products/server/editions</loc>
  1856. </url>
  1857. <url>
  1858. <loc>http://www.example.com/products/server/requirements</loc>
  1859. </url>
  1860. <url>
  1861. <loc>http://www.example.com/products/studio</loc>
  1862. </url>
  1863. <url>
  1864. <loc>http://www.example.com/products/studio/customers</loc>
  1865. </url>
  1866. <url>
  1867. <loc>http://www.example.com/prodcts/studio/support</loc>
  1868. </url>
  1869. <url>
  1870. <loc>http://www.example.com/company/about</loc>
  1871. </url>
  1872. <url>
  1873. <loc>http://www.example.com/company/about/investors</loc>
  1874. </url>
  1875. <url>
  1876. <loc>http://www.example.com/company/news</loc>
  1877. </url>
  1878. <url>
  1879. <loc>http://www.example.com/company/news/press</loc>
  1880. </url>
  1881. <url>
  1882. <loc>http://www.example.com/archive</loc>
  1883. </url>
  1884. <url>
  1885. <loc>http://www.example.com/community</loc>
  1886. </url>
  1887. <url>
  1888. <loc>http://forums.example.com/</loc>
  1889. </url>
  1890. </urlset>
  1891. ]]></programlisting>
  1892. <para>
  1893. Darstellen der Sitemap mit Verwendung einer maximalen Tiefe von 1.
  1894. </para>
  1895. <programlisting language="php"><![CDATA[
  1896. echo $this->navigation()
  1897. ->sitemap()
  1898. ->setFormatOutput(true)
  1899. ->setMaxDepth(1);
  1900. ]]></programlisting>
  1901. <programlisting language="xml"><![CDATA[
  1902. <?xml version="1.0" encoding="UTF-8"?>
  1903. <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  1904. <url>
  1905. <loc>http://www.example.com/</loc>
  1906. </url>
  1907. <url>
  1908. <loc>http://www.example.com/products</loc>
  1909. </url>
  1910. <url>
  1911. <loc>http://www.example.com/products/server</loc>
  1912. </url>
  1913. <url>
  1914. <loc>http://www.example.com/products/studio</loc>
  1915. </url>
  1916. <url>
  1917. <loc>http://www.example.com/company/about</loc>
  1918. </url>
  1919. <url>
  1920. <loc>http://www.example.com/company/about/investors</loc>
  1921. </url>
  1922. <url>
  1923. <loc>http://www.example.com/company/news</loc>
  1924. </url>
  1925. <url>
  1926. <loc>http://www.example.com/community</loc>
  1927. </url>
  1928. <url>
  1929. <loc>http://www.example.com/community/account</loc>
  1930. </url>
  1931. <url>
  1932. <loc>http://forums.example.com/</loc>
  1933. </url>
  1934. </urlset>
  1935. ]]></programlisting>
  1936. </example>
  1937. </sect4>
  1938. <sect4 id="zend.view.helpers.initial.navigation.navigation">
  1939. <title>Navigation Helfer</title>
  1940. <para>
  1941. Der Navigation Helfer ist ein Proxy Helfer der Aufrufe zu anderen Navigations Helfern
  1942. durchführt. Er kann als Einstiegspunkt fpr alle navigations-basierenden View Tasks
  1943. verwendet werden. Die vorher erwähnten Navigations Helfer sind im Namespace
  1944. <classname>Zend_View_Helper_Navigation</classname> und würden es deshalb benötigen, den
  1945. Pfad <code>Zend/View/Helper/Navigation</code> als Helfer Pfad der View hinzuzufügen. Mit
  1946. dem Proxy Helfer der im <classname>Zend_View_Helper</classname> Namespace sitzt, ist er
  1947. immer vorhanden, ohne das irgendein Helfer Pfad an der View hinzugefügt werden muß.
  1948. </para>
  1949. <para>
  1950. Der Navigations Helfer findet andere Helfer die das
  1951. <classname>Zend_View_Helper_Navigation_Helper</classname> Interface implementieren,
  1952. was bedeuet das auch auf eigene View Helfer weitergeleitet wird. Das würde trotzdem
  1953. das Hinzufügen des eigenen Helfer Pfades zur View benötigen.
  1954. </para>
  1955. <para>
  1956. Wenn auf andere Helfer weitergeleitet wird, kann der Navigations Helfer seinen
  1957. Container, ACL/Rolle und Übersetzer injizieren. Das bedeutet weder das man diese drei
  1958. nicht explizit in allen navigatorischen Helfern setzen muß, noch das diese in
  1959. <classname>Zend_Registry</classname> oder in statische Methoden injiziert werden muß.
  1960. </para>
  1961. <itemizedlist>
  1962. <listitem>
  1963. <para>
  1964. <methodname>findHelper()</methodname> findet alle angegebenen Helfer, prüft das
  1965. dieser ein navigatorischer Helfer ist, und injiziiert Container, ACL/Rolle und
  1966. Übersetzer.
  1967. </para>
  1968. </listitem>
  1969. <listitem>
  1970. <para>
  1971. <code>{get|set}InjectContainer()</code> empfängt/setzt ein Flag das anzeigt
  1972. ob der Container an weitergeleitete Helfer injiziiert werden soll. Der
  1973. Standardwert ist <constant>TRUE</constant>.
  1974. </para>
  1975. </listitem>
  1976. <listitem>
  1977. <para>
  1978. <code>{get|set}InjectAcl()</code> empfängt/setzt ein Flag das anzeigt ob die
  1979. ACL/Rolle an weitergeleitete Helfer injiziiert werden soll. Der Standardwert
  1980. ist <constant>TRUE</constant>.
  1981. </para>
  1982. </listitem>
  1983. <listitem>
  1984. <para>
  1985. <code>{get|set}InjectTranslator()</code> empfängt/setzt ein Flag das anzeigt
  1986. ob der Übersetzer an weitergeleitete Helfer injiziiert werden soll. Der
  1987. Standardwert ist <constant>TRUE</constant>.
  1988. </para>
  1989. </listitem>
  1990. <listitem>
  1991. <para>
  1992. <code>{get|set}DefaultProxy()</code> empfängt/setzt den Standard Proxy. Der
  1993. Standardwert ist <code>'menu'</code>.
  1994. </para>
  1995. </listitem>
  1996. <listitem>
  1997. <para>
  1998. <methodname>render()</methodname> leitet auf die render Methode des
  1999. Standardproxies weiter.
  2000. </para>
  2001. </listitem>
  2002. </itemizedlist>
  2003. </sect4>
  2004. </sect3>