Zend_View-Helpers-Navigation.xml 84 KB

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