2
0

Zend_View-Helpers-Navigation.xml 84 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 18823 -->
  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 <acronym>ACL</acronym> (<classname>Zend_Acl</classname>) Instanzen
  82. und Rollen (<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 <acronym>ACL</acronym> aktiviert
  85. werden soll. Die Methoden <methodname>hasAcl()</methodname> und
  86. <methodname>hasRole()</methodname> prüfen ob der Helfer eine <acronym>ACL</acronym>
  87. Instanz oder 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. <acronym>ACL</acronym> 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. <acronym>ACL</acronym> 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 <acronym>ACL</acronym> 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 <acronym>ACL</acronym>
  250. im Helfer verwendet wird, muß es der Rolle im Helfer vom <acronym>ACL</acronym> erlaubt
  251. sein auf die <code>Ressourcen</code> zuzugreifen und/oder das die
  252. <code>Privilegien</code> für diese Seite bei der Darstellung eingefügt werden dürfen.
  253. </para>
  254. <para>
  255. Wenn eine Seite vom <acronym>ACL</acronym> nicht akzeptiert ist, wird auch jede
  256. untergeordnete Seite von der Darstellung ausgenommen sein.
  257. </para>
  258. <para>
  259. Der <link linkend="zend.view.helpers.initial.navigation.navigation">Proxy Helfer</link>
  260. injiziert seine eigene <acronym>ACL</acronym> und Rolle in den Helfer zu dem er
  261. weiterleitet wenn der weitergeleitete Helfer nicht bereits einen hat.
  262. </para>
  263. <para>
  264. Das Beispiel von unten zeigt wie <acronym>ACL</acronym> 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. </para>
  276. <itemizedlist>
  277. <listitem>
  278. <para>
  279. Die Domain der Site ist <code>www.example.com</code>.
  280. </para>
  281. </listitem>
  282. <listitem>
  283. <para>
  284. Interessante Eigenschaften der Seite sind mit einem Kommentar markiert.
  285. </para>
  286. </listitem>
  287. <listitem>
  288. <para>
  289. Solange im Beispiel nicht anders erwähnt, fragt der Benutzer nach der
  290. <acronym>URL</acronym> <code>http://www.example.com/products/server/faq/</code>,
  291. welche auf die Seite mit dem Label <constant>FAQ</constant> unter
  292. <code>Foo Server</code> übersetzt wird.
  293. </para>
  294. </listitem>
  295. <listitem>
  296. <para>
  297. Das angenommene <acronym>ACL</acronym> und Route Setup wird unter dem Container
  298. Setup gezeigt.
  299. </para>
  300. </listitem>
  301. </itemizedlist>
  302. <programlisting language="php"><![CDATA[
  303. /*
  304. * Navigations Container (config/array)
  305. * Jedes Element im Array wird an Zend_Navigation_Page::factory()
  306. * übergeben wenn der unten angezeigt Navigations Container
  307. * erstellt wird.
  308. */
  309. $pages = array(
  310. array(
  311. 'label' => 'Home',
  312. 'title' => 'Geh zu Home',
  313. 'module' => 'default',
  314. 'controller' => 'index',
  315. 'action' => 'index',
  316. 'order' => -100 // Sicherstellen das Home die erste Seite ist
  317. ),
  318. array(
  319. 'label' => 'Spezielles Angebot nur diese Woche!',
  320. 'module' => 'store',
  321. 'controller' => 'offer',
  322. 'action' => 'amazing',
  323. 'visible' => false // nicht sichtbar
  324. ),
  325. array(
  326. 'label' => 'Produkte',
  327. 'module' => 'products',
  328. 'controller' => 'index',
  329. 'action' => 'index',
  330. 'pages' => array(
  331. array(
  332. 'label' => 'Foo Server',
  333. 'module' => 'products',
  334. 'controller' => 'server',
  335. 'action' => 'index',
  336. 'pages' => array(
  337. array(
  338. 'label' => 'FAQ',
  339. 'module' => 'products',
  340. 'controller' => 'server',
  341. 'action' => 'faq',
  342. 'rel' => array(
  343. 'canonical' => 'http://www.example.com/?page=faq',
  344. 'alternate' => array(
  345. 'module' => 'products',
  346. 'controller' => 'server',
  347. 'action' => 'faq',
  348. 'params' => array('format' => 'xml')
  349. )
  350. )
  351. ),
  352. array(
  353. 'label' => 'Editionen',
  354. 'module' => 'products',
  355. 'controller' => 'server',
  356. 'action' => 'editions'
  357. ),
  358. array(
  359. 'label' => 'System Anforderungen',
  360. 'module' => 'products',
  361. 'controller' => 'server',
  362. 'action' => 'requirements'
  363. )
  364. )
  365. ),
  366. array(
  367. 'label' => 'Foo Studio',
  368. 'module' => 'products',
  369. 'controller' => 'studio',
  370. 'action' => 'index',
  371. 'pages' => array(
  372. array(
  373. 'label' => 'Kunden Stories',
  374. 'module' => 'products',
  375. 'controller' => 'studio',
  376. 'action' => 'customers'
  377. ),
  378. array(
  379. 'label' => 'Support',
  380. 'module' => 'prodcts',
  381. 'controller' => 'studio',
  382. 'action' => 'support'
  383. )
  384. )
  385. )
  386. )
  387. ),
  388. array(
  389. 'label' => 'Firma',
  390. 'title' => 'Über uns',
  391. 'module' => 'company',
  392. 'controller' => 'about',
  393. 'action' => 'index',
  394. 'pages' => array(
  395. array(
  396. 'label' => 'Investor Relations',
  397. 'module' => 'company',
  398. 'controller' => 'about',
  399. 'action' => 'investors'
  400. ),
  401. array(
  402. 'label' => 'News',
  403. 'class' => 'rss', // Klasse
  404. 'module' => 'company',
  405. 'controller' => 'news',
  406. 'action' => 'index',
  407. 'pages' => array(
  408. array(
  409. 'label' => 'Für die Presse',
  410. 'module' => 'company',
  411. 'controller' => 'news',
  412. 'action' => 'press'
  413. ),
  414. array(
  415. 'label' => 'Archiv',
  416. 'route' => 'archive', // Route
  417. 'module' => 'company',
  418. 'controller' => 'news',
  419. 'action' => 'archive'
  420. )
  421. )
  422. )
  423. )
  424. ),
  425. array(
  426. 'label' => 'Community',
  427. 'module' => 'community',
  428. 'controller' => 'index',
  429. 'action' => 'index',
  430. 'pages' => array(
  431. array(
  432. 'label' => 'Mein Account',
  433. 'module' => 'community',
  434. 'controller' => 'account',
  435. 'action' => 'index',
  436. 'resource' => 'mvc:community.account' // Ressource
  437. ),
  438. array(
  439. 'label' => 'Forum',
  440. 'uri' => 'http://forums.example.com/',
  441. 'class' => 'external' // Klasse
  442. )
  443. )
  444. ),
  445. array(
  446. 'label' => 'Administration',
  447. 'module' => 'admin',
  448. 'controller' => 'index',
  449. 'action' => 'index',
  450. 'resource' => 'mvc:admin', // Ressource
  451. 'pages' => array(
  452. array(
  453. 'label' => 'Neuen Artikel schreiben',
  454. 'module' => 'admin',
  455. 'controller' => 'post',
  456. 'aciton' => 'write'
  457. )
  458. )
  459. )
  460. );
  461. // Container von einem Array erstellen
  462. $container = new Zend_Navigation($pages);
  463. // Den Container im Proxy Helfer speichern
  464. $view->getHelper('navigation')->setContainer($container);
  465. // ...oder einfach:
  466. $view->navigation($container);
  467. // ...oder ihn einfach in der Registry speichern:
  468. Zend_Registry::set('Zend_Navigation', $container);
  469. ]]></programlisting>
  470. <para>
  471. Zusätzlich zum obigen Container, wird das folgende Setup angenommen:
  472. </para>
  473. <programlisting language="php"><![CDATA[
  474. // Router Setup (Standardrouten und 'archive' Route):
  475. $front = Zend_Controller_Front::getInstance();
  476. $router = $front->getRouter();
  477. $router->addDefaultRoutes();
  478. $router->addRoute(
  479. 'archive',
  480. new Zend_Controller_Router_Route(
  481. '/archive/:year',
  482. array(
  483. 'module' => 'company',
  484. 'controller' => 'news',
  485. 'action' => 'archive',
  486. 'year' => (int) date('Y') - 1
  487. ),
  488. array('year' => '\d+')
  489. )
  490. );
  491. // ACL Setup:
  492. $acl = new Zend_Acl();
  493. $acl->addRole(new Zend_Acl_Role('member'));
  494. $acl->addRole(new Zend_Acl_Role('admin'));
  495. $acl->add(new Zend_Acl_Resource('mvc:admin'));
  496. $acl->add(new Zend_Acl_Resource('mvc:community.account'));
  497. $acl->allow('member', 'mvc:community.account');
  498. $acl->allow('admin', null);
  499. // ACL und Rolle im Proxy Helfer speichern:
  500. $view->navigation()->setAcl($acl)->setRole('member');
  501. // ...oder ein standard ACL und Rolle statisch setzen:
  502. Zend_View_Helper_Navigation_HelperAbstract::setDefaultAcl($acl);
  503. Zend_View_Helper_Navigation_HelperAbstract::setDefaultRole('member');
  504. ]]></programlisting>
  505. </sect4>
  506. <sect4 id="zend.view.helpers.initial.navigation.breadcrumbs">
  507. <title>Breadcrumbs Helfer</title>
  508. <para>
  509. Breadcrumbs werden verwendet um anzuzeigen wo in einer Sitemap ein Benutzer aktuell
  510. browst, und werden typischerweise wie folgt angezeigt: "Du bist hier: Home > Produkte
  511. > FantastischesProdukt 1.0". Der BreakCrumbs Helfer folgt den Richtlinien von <ulink
  512. url="http://developer.yahoo.com/ypatterns/pattern.php?pattern=breadcrumbs">Breadcrumbs
  513. Pattern - Yahoo! Design Pattern Library</ulink>, und erlaubt eine einfache Anpassung
  514. (Minimale/Maximale Tiefe, Einrückung, Trennzeichen, und ob das letzte Element verlinkt
  515. sein soll), oder die Darstellung durch Verwendung eines partiellen View Skripts.
  516. </para>
  517. <para>
  518. Der Breabcrumbs Helfer funktioniert wie folgt; er findet die tiefste aktive Seite in
  519. einem Navigations Container, und stellt den aufwärtsgerichteten Pfad zum Root dar.
  520. Für <acronym>MVC</acronym> Seiten wird die "Aktivität" einer Seite erkannt indem das
  521. Anfrage Objekt angeschaut wird, wie im Kapitel
  522. <link linkend="zend.navigation.pages.mvc">Zend_Navigation_Page_Mvc</link> beschrieben.
  523. </para>
  524. <para>
  525. Der Helfer setzt die Eigenschaft <code>minDepth</code> standardmäßig auf 1, was
  526. bedeutet das Breadcrumbs nicht dargestellt werden wenn die tiefste aktive Seite eine
  527. Root Seite ist. Wenn <code>maxDepth</code> spezifiziert ist, beendet der Helfer die
  528. Darstellung bei der spezifizierten Tiefe (z.B. stopp bei Level 2 selbst wenn die
  529. tiefste aktive Seite auf Level 3 ist).
  530. </para>
  531. <para>
  532. Methoden im Breakcrumbs Helfer sind:
  533. </para>
  534. <itemizedlist>
  535. <listitem>
  536. <para>
  537. <code>{get|set}Separator()</code> empfängt/setzt das Trennzeichen das zwischen
  538. Breakcrumbs verwendet wird. Der Standardwert ist <code>' &amp;gt; '</code>.
  539. </para>
  540. </listitem>
  541. <listitem>
  542. <para>
  543. <code>{get|set}LinkLast()</code> empfängt/setzt ob der letzte Breabcrumb
  544. als Anker dargestellt werden soll oder nicht. Der Standardwert ist
  545. <constant>FALSE</constant>.
  546. </para>
  547. </listitem>
  548. <listitem>
  549. <para>
  550. <code>{get|set}Partial()</code> empfängt/setzt ein partielles View Skript das
  551. für die Darstellung von Breadcrumbs verwendet werden soll. Wenn ein partielles
  552. View Skript gesetzt ist, verwendet die <methodname>render()</methodname> Methode
  553. des Helfers die <methodname>renderPartial()</methodname> Methode. Wenn kein
  554. partielles gesetzt ist, wird die <methodname>renderStraight()</methodname>
  555. Methode verwendet. Der Helfer erwartet das der partielle ein <type>String</type>
  556. oder ein <type>Array</type> mit zwei Elementen ist. Wen der Partielle ein
  557. <type>String</type> ist, benennt er den Namen des partiellen Skripts das zu
  558. verwenden ist. Wenn er ein <type>Array</type> ist, wird das erste Element als
  559. Name des partiellen View Skripts verwendet, und das zweite Element ist das Modul
  560. in dem das Skript zu finden ist.
  561. </para>
  562. </listitem>
  563. <listitem>
  564. <para>
  565. <methodname>renderStraight()</methodname> ist die standardmäßige render Methode.
  566. </para>
  567. </listitem>
  568. <listitem>
  569. <para>
  570. <methodname>renderPartial()</methodname> wird für die Darstellung verwendet wenn
  571. ein partielles View Skript verwendet wird.
  572. </para>
  573. </listitem>
  574. </itemizedlist>
  575. <example id="zend.view.helpers.initial.navigation.breadcrumbs.example1">
  576. <title>Darstellung von Breadcrumbs</title>
  577. <para>
  578. Dieses Beispiel zeigt wie Breadcrumbs mit Standardsettings dargestellt werden.
  579. </para>
  580. <programlisting language="php"><![CDATA[
  581. In einem View Skript oder Layout:
  582. <?php echo $this->navigation()->breadcrumbs(); ?>
  583. Die zwei obigen Aufrufe verwenden die magische __toString() Methode,
  584. und sind identisch mit:
  585. <?php echo $this->navigation()->breadcrumbs()->render(); ?>
  586. Ausgabe:
  587. <a href="/products">Produkte</a> &gt; <a href="/products/server">Foo Server</a> &gt; FAQ
  588. ]]></programlisting>
  589. </example>
  590. <example id="zend.view.helpers.initial.navigation.breadcrumbs.example2">
  591. <title>Einrückung spezifizieren</title>
  592. <para>
  593. Dieses Beispiel zeigt wie Breadcrumbs mit anfänglicher Einrückung dargestellt
  594. werden können.
  595. </para>
  596. <programlisting language="php"><![CDATA[
  597. Darstellung mit 8 Leerzeichen Einrückung:
  598. <?php echo $this->navigation()->breadcrumbs()->setIndent(8); ?>
  599. Ausgabe:
  600. <a href="/products">Products</a> &gt; <a href="/products/server">Foo Server</a> &gt; FAQ
  601. ]]></programlisting>
  602. </example>
  603. <example id="zend.view.helpers.initial.navigation.breadcrumbs.example3">
  604. <title>Eigene Ausgabe für Breakcrumbs</title>
  605. <para>
  606. Dieses Beispiel zeigt wie man eine eigene Breadcrumbs Ausgabe durch die
  607. Spezifizierung diverser Optionen erstellt.
  608. </para>
  609. <programlisting language="php"><![CDATA[
  610. In einem View Skript oder Layout:
  611. <?php
  612. echo $this->navigation()
  613. ->breadcrumbs()
  614. ->setLinkLast(true) // Letzte Seite verlinken
  615. ->setMaxDepth(1) // Bei Level 1 stoppen
  616. ->setSeparator(' &#9654;' . PHP_EOL); // Cooler Seperator mit Umbruch
  617. ?>
  618. Output:
  619. <a href="/products">Produkte</a> &#9654;
  620. <a href="/products/server">Foo Server</a>
  621. /////////////////////////////////////////////////////
  622. Minimale notwendige Tiefe für die Darstellung von Breadcrumbs setzen:
  623. <?php
  624. $this->navigation()->breadcrumbs()->setMinDepth(10);
  625. echo $this->navigation()->breadcrumbs();
  626. ?>
  627. Ausgabe:
  628. Nichts, weil die tiefste aktive Seite nicht auf Level 10 oder tiefer ist.
  629. ]]></programlisting>
  630. </example>
  631. <example id="zend.view.helpers.initial.navigation.breadcrumbs.example4">
  632. <title>Darstellung von Breadcrumbs mit Verwendung eines partiellen View Skripts</title>
  633. <para>
  634. Dieses Beispiel zeigt wir eigene Breakcrumbs durch Verwendung eines partiellen
  635. View Skripts dargestellt werden können. Durch den Aufruf von
  636. <methodname>setPartial()</methodname> kann man ein partielles View Skript
  637. spezifizieren das verwendet wird wenn die <methodname>renderPartial()</methodname>
  638. Methode aufgerufen wird. Diese Methode findest die tiefste aktive Seite und übergibt
  639. ein Array von Seiten die zur aktiven Seite des partiellen View Skripts weiterleitet.
  640. </para>
  641. <para>
  642. Im Layout:
  643. </para>
  644. <programlisting language="php"><![CDATA[
  645. $partial = ;
  646. echo $this->navigation()->breadcrumbs()
  647. ->setPartial(array('breadcrumbs.phtml', 'default'));
  648. ]]></programlisting>
  649. <para>
  650. Inhalt von
  651. <code>application/modules/default/views/breadcrumbs.phtml</code>:
  652. </para>
  653. <programlisting language="php"><![CDATA[
  654. echo implode(', ', array_map(
  655. create_function('$a', 'return $a->getLabel();'),
  656. $this->pages));
  657. ]]></programlisting>
  658. <para>
  659. Ausgabe:
  660. </para>
  661. <programlisting language="php"><![CDATA[
  662. Produkte, Foo Server, FAQ
  663. ]]></programlisting>
  664. </example>
  665. </sect4>
  666. <sect4 id="zend.view.helpers.initial.navigation.links">
  667. <title>Link Helfer</title>
  668. <para>
  669. Der Link Helfer wird für die Darstellung von HTML <constant>LINK</constant> Elementen
  670. verwendet. Links werden für die Beschreibung von Dokument-Beziehungen der aktuell
  671. aktiven Seite verwendet. Mehr über Links und Linktypen kann unter
  672. <ulink url="http://www.w3.org/TR/html4/struct/links.html#h-12.3">Dokument-Beziehung:
  673. Das LINK Element (HTML4 W3C Rec.)</ulink> und
  674. <ulink url="http://www.w3.org/TR/html4/types.html#h-6.12">Link Typen
  675. (HTML4 W3C Rec.)</ulink> in der HMTL4 W3C Empfehlung nachgelesen werden.
  676. </para>
  677. <para>
  678. Es gibt zwei Typen von Beziehungen; vorwärts und rückwärts, angezeigt durch die
  679. Schlüsselwörter <code>'rel'</code> und <code>'rev'</code>. Die meisten Methoden im
  680. Helfer nehmen einen <varname>$rel</varname> Parameter entgegen, welcher entweder
  681. <code>'rel'</code> oder <code>'rev'</code> sein muß. Die meisten Methoden nehmen auch
  682. einen <varname>$type</varname> Parameter entgegen welcher für die Spezifikation des
  683. Linktyps (z.B. alternate, start, next, prev, chapter, usw.) verwendet wird.
  684. </para>
  685. <para>
  686. Beziehungen können dem Seitenobjekt manuell hinzugefügt werden, oder werden durch
  687. das Durchlaufen des Containers, der im Helfer registriert ist, gefunden. Die Methode
  688. <methodname>findRelation($page, $rel, $type)</methodname> versucht zuerst den gegebenen
  689. <varname>$rel</varname> von <varname>$type</varname> von der <varname>$page</varname>
  690. durch den Aufruf von <code>$page->findRel($type)</code> oder
  691. <code>$page->findRel($type)</code> zu finden. Wenn <varname>$page</varname> eine
  692. Beziehung hat die zu der Instanz einer Seite konvertiert werden kann, wird diese
  693. Beziehung verwendet. Wenn die Instanz von <varname>$page</varname> keinen
  694. <varname>$type</varname> spezifiziert hat, schaut der Helfer nach einer Methode im
  695. Helfer die <code>search$rel$type</code> heißt (z.B.
  696. <methodname>searchRelNext()</methodname> oder
  697. <methodname>searchRevAlternate()</methodname>). Wenn so eine Methode existiert, wird Sie
  698. für die Erkennung der Beziehung der <varname>$page</varname> verwendet indem der
  699. Container durchlaufen wird.
  700. </para>
  701. <para>
  702. Nicht alle Beziehungen können durch das Durchlaufen des Containers erkannt werden.
  703. Das sind die Beziehungen die durch eine Suche gefunden werden können:
  704. </para>
  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. <note>
  761. <para>
  762. Wenn in der Instanz der Seite nach Beziehungen gesehen wird (
  763. (<code>$page->getRel($type)</code> oder <code>$page->getRev($type)</code>),
  764. akzeptiert der Helfer Wert vom Typ <type>String</type>, <type>Array</type>,
  765. <classname>Zend_Config</classname>, oder
  766. <classname>Zend_Navigation_Page</classname>. Wenn ein String gefunden wird, wird
  767. dieser zu einer <classname>Zend_Navigation_Page_Uri</classname> konvertiert. Wenn
  768. ein Array oder eine Config gefunden wird, wird diese in ein oder mehrere
  769. Seiteninstanzen konvertiert, und jedes Element wird an die
  770. <link linkend="zend.navigation.pages.factory">Seiten Factory</link> übergeben.
  771. Wenn der erste Schlüssel nicht nummerische ist, wird das Array/Config direkt an die
  772. Seiten Factory übergeben, und eine einzelne Seite wird retourniert.
  773. </para>
  774. </note>
  775. <para>
  776. Der Helfer unterstützt auch magische Methoden für das Finden von Beziehungen. Um z.B.
  777. alternative vorwärts Beziehungen zu finden muß
  778. <code>$helper->findRelAlternate($page)</code> aufgerufen werden, und um rückwärts
  779. gerichtete Kapitel Beziehungen zu finden <code>$helper->findRevSection($page)</code>.
  780. Diese Aufrufe korrespondieren mit <code>$helper->findRelation($page, 'rel',
  781. 'alternate');</code> und <code>$helper->findRelation($page, 'rev', 'section');</code>.
  782. </para>
  783. <para>
  784. Um zu Steuern welche Beziehung dargestellt werden soll, verwendet der Helfer ein render
  785. Flag. Das render Flag ist ein Integer Wert, und kann in
  786. <ulink url="http://php.net/manual/en/language.operators.bitwise.php">binären
  787. <code>und</code> (<code>&amp;</code>) Operationen</ulink> mit den render Konstanten des
  788. Helfers verwendet werden um festzustellen ob die Beziehung zu der die render Konstante
  789. gehört, dargestellt werden soll.
  790. </para>
  791. <para>
  792. Siehe das <link linkend="zend.view.helpers.initial.navigation.links.example3">folgende
  793. Beispiel</link> für weitere Informationen.
  794. </para>
  795. <itemizedlist>
  796. <listitem>
  797. <para>
  798. <constant>Zend_View_Helper_Navigation_Link::RENDER_ALTERNATE</constant>
  799. </para>
  800. </listitem>
  801. <listitem>
  802. <para>
  803. <constant>Zend_View_Helper_Navigation_Link::RENDER_STYLESHEET</constant>
  804. </para>
  805. </listitem>
  806. <listitem>
  807. <para>
  808. <constant>Zend_View_Helper_Navigation_Link::RENDER_START</constant>
  809. </para>
  810. </listitem>
  811. <listitem>
  812. <para>
  813. <constant>Zend_View_Helper_Navigation_Link::RENDER_NEXT</constant>
  814. </para>
  815. </listitem>
  816. <listitem>
  817. <para>
  818. <constant>Zend_View_Helper_Navigation_Link::RENDER_PREV</constant>
  819. </para>
  820. </listitem>
  821. <listitem>
  822. <para>
  823. <constant>Zend_View_Helper_Navigation_Link::RENDER_CONTENTS</constant>
  824. </para>
  825. </listitem>
  826. <listitem>
  827. <para>
  828. <constant>Zend_View_Helper_Navigation_Link::RENDER_INDEX</constant>
  829. </para>
  830. </listitem>
  831. <listitem>
  832. <para>
  833. <constant>Zend_View_Helper_Navigation_Link::RENDER_GLOSSARY</constant>
  834. </para>
  835. </listitem>
  836. <listitem>
  837. <para>
  838. <constant>Zend_View_Helper_Navigation_Link::RENDER_COPYRIGHT</constant>
  839. </para>
  840. </listitem>
  841. <listitem>
  842. <para>
  843. <constant>Zend_View_Helper_Navigation_Link::RENDER_CHAPTER</constant>
  844. </para>
  845. </listitem>
  846. <listitem>
  847. <para>
  848. <constant>Zend_View_Helper_Navigation_Link::RENDER_SECTION</constant>
  849. </para>
  850. </listitem>
  851. <listitem>
  852. <para>
  853. <constant>Zend_View_Helper_Navigation_Link::RENDER_SUBSECTION</constant>
  854. </para>
  855. </listitem>
  856. <listitem>
  857. <para>
  858. <constant>Zend_View_Helper_Navigation_Link::RENDER_APPENDIX</constant>
  859. </para>
  860. </listitem>
  861. <listitem>
  862. <para>
  863. <constant>Zend_View_Helper_Navigation_Link::RENDER_HELP</constant>
  864. </para>
  865. </listitem>
  866. <listitem>
  867. <para>
  868. <constant>Zend_View_Helper_Navigation_Link::RENDER_BOOKMARK</constant>
  869. </para>
  870. </listitem>
  871. <listitem>
  872. <para>
  873. <constant>Zend_View_Helper_Navigation_Link::RENDER_CUSTOM</constant>
  874. </para>
  875. </listitem>
  876. <listitem>
  877. <para>
  878. <constant>Zend_View_Helper_Navigation_Link::RENDER_ALL</constant>
  879. </para>
  880. </listitem>
  881. </itemizedlist>
  882. <para>
  883. Die Konstanten von <constant>RENDER_ALTERNATE</constant> bis
  884. <constant>RENDER_BOOKMARK</constant> stellen standardmäßige HTML Linktypen dar.
  885. <constant>RENDER_CUSTOM</constant> stellt eine nicht-standardmäßige Beziehung dar die
  886. in der Seite spezifiziert ist. <constant>RENDER_ALL</constant> stellt standardmäßige
  887. und nicht-standardmäßige Beziehungen dar.
  888. </para>
  889. <para>
  890. Methoden im Link Helfer:
  891. </para>
  892. <itemizedlist>
  893. <listitem>
  894. <para>
  895. <code>{get|set}RenderFlag()</code> empfängt/setzt das render Flag.
  896. Standardwert ist <constant>RENDER_ALL</constant>. Siehe das folgende Beispiel
  897. dafür wie das render Flag zu setzen ist.
  898. </para>
  899. </listitem>
  900. <listitem>
  901. <para>
  902. <methodname>findAllRelations()</methodname> findet alle Beziehungen von allen
  903. Typen einer angegebenen Seite.
  904. </para>
  905. </listitem>
  906. <listitem>
  907. <para>
  908. <methodname>findRelation()</methodname> findet alle Beziehungen eines angegebenen
  909. Typs einer angegebenen Seite.
  910. </para>
  911. </listitem>
  912. <listitem>
  913. <para>
  914. <methodname>searchRel{Start|Next|Prev|Chapter|Section|Subsection}()</methodname>
  915. durchsucht einen Container um vorwärtsgerichtete Beziehungen zu Startseite,
  916. nächster Seite, voriger Seite, Kapitel, Sektion und Untersektion zu finden.
  917. </para>
  918. </listitem>
  919. <listitem>
  920. <para>
  921. <methodname>searchRev{Section|Subsection}()</methodname> durchsucht einen
  922. Container um rückwärtsgerichtete Beziehungen zu Sektionen oder Untersektionen zu
  923. finden.
  924. </para>
  925. </listitem>
  926. <listitem>
  927. <para>
  928. <methodname>renderLink()</methodname> stellt ein einzelnes <code>link</code>
  929. Element dar.
  930. </para>
  931. </listitem>
  932. </itemizedlist>
  933. <example id="zend.view.helpers.initial.navigation.links.example1">
  934. <title>Beziehungen in Seiten spezifizieren</title>
  935. <para>
  936. Dieses Beispiel zeigt wir Beziehungen in Seiten spezifiziert werden können.
  937. </para>
  938. <programlisting language="php"><![CDATA[
  939. $container = new Zend_Navigation(array(
  940. array(
  941. 'label' => 'Strings für Beziehungen verwenden',
  942. 'rel' => array(
  943. 'alternate' => 'http://www.example.org/'
  944. ),
  945. 'rev' => array(
  946. 'alternate' => 'http://www.example.net/'
  947. )
  948. ),
  949. array(
  950. 'label' => 'Arrays für Beziehungen verwenden',
  951. 'rel' => array(
  952. 'alternate' => array(
  953. 'label' => 'Example.org',
  954. 'uri' => 'http://www.example.org/'
  955. )
  956. )
  957. ),
  958. array(
  959. 'label' => 'Konfigurationen für Beziehungen verwenden',
  960. 'rel' => array(
  961. 'alternate' => new Zend_Config(array(
  962. 'label' => 'Example.org',
  963. 'uri' => 'http://www.example.org/'
  964. ))
  965. )
  966. ),
  967. array(
  968. 'label' => 'Instanzen von Seiten für Beziehungen verwenden',
  969. 'rel' => array(
  970. 'alternate' => Zend_Navigation_Page::factory(array(
  971. 'label' => 'Example.org',
  972. 'uri' => 'http://www.example.org/'
  973. ))
  974. )
  975. )
  976. ));
  977. ]]></programlisting>
  978. </example>
  979. <example id="zend.view.helpers.initial.navigation.links.example2">
  980. <title>Standardmäßige Darstellung von Links</title>
  981. <para>
  982. Dieses Beispiel zeigt wie ein Menü von einem Container dargestellt wird, der im
  983. View Helfer registriert/gefunden wurde.
  984. </para>
  985. <programlisting language="php"><![CDATA[
  986. Im View Skript oder Layout:
  987. <?php echo $this->view->navigation()->links(); ?>
  988. Ausgabe:
  989. <link rel="alternate" href="/products/server/faq/format/xml">
  990. <link rel="start" href="/" title="Home">
  991. <link rel="next" href="/products/server/editions" title="Editionen">
  992. <link rel="prev" href="/products/server" title="Foo Server">
  993. <link rel="chapter" href="/products" title="Produkte">
  994. <link rel="chapter" href="/company/about" title="Firma">
  995. <link rel="chapter" href="/community" title="Community">
  996. <link rel="canonical" href="http://www.example.com/?page=server-faq">
  997. <link rev="subsection" href="/products/server" title="Foo Server">
  998. ]]></programlisting>
  999. </example>
  1000. <example id="zend.view.helpers.initial.navigation.links.example3">
  1001. <title>Spezifizieren welche Beziehungen dargestellt werden sollen</title>
  1002. <para>
  1003. Dieses Beispiel zeigt wie spezifiziert werden kann, welche Beziehungen zu finden
  1004. und darzustellen sind.
  1005. </para>
  1006. <programlisting language="php"><![CDATA[
  1007. Nur start, next und prev darstellen:
  1008. $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_START |
  1009. Zend_View_Helper_Navigation_Links::RENDER_NEXT |
  1010. Zend_View_Helper_Navigation_Links::RENDER_PREV);
  1011. Ausgabe:
  1012. <link rel="start" href="/" title="Home">
  1013. <link rel="next" href="/products/server/editions" title="Editionen">
  1014. <link rel="prev" href="/products/server" title="Foo Server">
  1015. ]]></programlisting>
  1016. <programlisting language="php"><![CDATA[
  1017. Nur native Linktypen darstellen:
  1018. $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
  1019. Zend_View_Helper_Navigation_Links::RENDER_CUSTOM);
  1020. Ausgabe:
  1021. <link rel="alternate" href="/products/server/faq/format/xml">
  1022. <link rel="start" href="/" title="Home">
  1023. <link rel="next" href="/products/server/editions" title="Editionen">
  1024. <link rel="prev" href="/products/server" title="Foo Server">
  1025. <link rel="chapter" href="/products" title="Produkte">
  1026. <link rel="chapter" href="/company/about" title="Firma">
  1027. <link rel="chapter" href="/community" title="Community">
  1028. <link rev="subsection" href="/products/server" title="Foo Server">
  1029. ]]></programlisting>
  1030. <programlisting language="php"><![CDATA[
  1031. Alles ausser Kapitel darstellen:
  1032. $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
  1033. Zend_View_Helper_Navigation_Links::RENDER_CHAPTER);
  1034. Ausgabe:
  1035. <link rel="alternate" href="/products/server/faq/format/xml">
  1036. <link rel="start" href="/" title="Home">
  1037. <link rel="next" href="/products/server/editions" title="Editionen">
  1038. <link rel="prev" href="/products/server" title="Foo Server">
  1039. <link rel="canonical" href="http://www.example.com/?page=server-faq">
  1040. <link rev="subsection" href="/products/server" title="Foo Server">
  1041. ]]></programlisting>
  1042. </example>
  1043. </sect4>
  1044. <sect4 id="zend.view.helpers.initial.navigation.menu">
  1045. <title>Menu Helfer</title>
  1046. <para>
  1047. Der Menu Helfer wird für die Darstellung von Menüs aus Navigations Containern
  1048. verwendet. Standardmäßig wird das Menü durch Verwendung der HTML Tags
  1049. <code>UL</code> und <code>LI</code> dargestellt. Der Helfer erlaubt aber auch
  1050. die Verwendung eines partiellen View Skripts.
  1051. </para>
  1052. <para>
  1053. Methoden im Menu Helfer:
  1054. </para>
  1055. <itemizedlist>
  1056. <listitem>
  1057. <para>
  1058. <code>{get|set}UlClass()</code> empfängt/setzt die <acronym>CSS</acronym> Klasse
  1059. zur Verwendung in <methodname>renderMenu()</methodname>.
  1060. </para>
  1061. </listitem>
  1062. <listitem>
  1063. <para>
  1064. <code>{get|set}OnlyActiveBranch()</code> empfängt/setzt ein Flag das
  1065. spezifiziert ob der aktive Zweig eines Containers dargestellt werden soll.
  1066. </para>
  1067. </listitem>
  1068. <listitem>
  1069. <para>
  1070. <code>{get|set}RenderParents()</code> empfängt/setzt ein Flag das
  1071. spezifiziert ob Eltern nur dargestellt werden sollen wenn nur der aktive
  1072. Zweig eines Containers dargestellt wird. Wenn es auf <constant>FALSE</constant>
  1073. gesetzt wird, wird nur das tiefste aktive Menü dargestellt.
  1074. </para>
  1075. </listitem>
  1076. <listitem>
  1077. <para>
  1078. <code>{get|set}Partial()</code> empfängt/setzt ein partielles View Skript
  1079. das für die Darstellung des Menüs verwendet werden soll. Wenn ein partielles
  1080. Skript gesetzt ist, verwendet die <methodname>render()</methodname> Methode des
  1081. Helfers die <methodname>renderPartial()</methodname> Methode. Wenn kein
  1082. Partieller gesetzt ist, wird die <methodname>renderMenu()</methodname> Methode
  1083. verwendet. Der Helfer erwartet das der Partielle ein <type>String</type>, oder
  1084. ein <type>Array</type> mit zwei Elementen, ist. Wenn der Partielle ein
  1085. <type>String</type> ist bezeichnet er den Namen des partiellen Skripts das zu
  1086. verwenden ist. Wenn er ein <type>Array</type> ist wird das erste Element als
  1087. Name des partiellen View Skripts verwendet, und das zweite Element ist das Modul
  1088. indem das Skript gefunden wird.
  1089. </para>
  1090. </listitem>
  1091. <listitem>
  1092. <para>
  1093. <methodname>htmlify()</methodname> überschreibt die Methode der abstrakten
  1094. Klasse damit <code>span</code> Elemente zurückgegeben werden wenn die Seite kein
  1095. <code>href</code> hat.
  1096. </para>
  1097. </listitem>
  1098. <listitem>
  1099. <para>
  1100. <methodname>renderMenu($container = null, $options = array())</methodname> ist
  1101. eine standardmäßige render Methode, und stellt einen Container als HTML
  1102. <code>UL</code> Liste dar.
  1103. </para>
  1104. <para>
  1105. Wenn <varname>$container</varname> nicht angegeben wird, wird der Container der
  1106. im Helfer registriert ist dargestellt.
  1107. </para>
  1108. <para>
  1109. <varname>$options</varname> wird verwendet um temporär spezifizierte Optionen zu
  1110. überschreiben ohne das die Werte in der Helferinstanz resetiert werden. Es
  1111. ist ein assoziatives Array wobei jeder Schlüssel mit einer Option im Helfer
  1112. korrespondiert.
  1113. </para>
  1114. <para>
  1115. Erkannte Optionen:
  1116. </para>
  1117. <itemizedlist>
  1118. <listitem>
  1119. <para>
  1120. <code>indent</code>; Einrückung. Erwartet einen <type>String</type>
  1121. oder einen <code>int</code> Wert.
  1122. </para>
  1123. </listitem>
  1124. <listitem>
  1125. <para>
  1126. <code>minDepth</code>; Minimale Tiefe. Erwartet ein
  1127. <code>int</code> oder <constant>NULL</constant> (keine minimale
  1128. Tiefe).
  1129. </para>
  1130. </listitem>
  1131. <listitem>
  1132. <para>
  1133. <code>maxDepth</code>; Maximale Tiefe. Erwartet ein
  1134. <code>int</code> oder <constant>NULL</constant> (keine maximale
  1135. Tiefe).
  1136. </para>
  1137. </listitem>
  1138. <listitem>
  1139. <para>
  1140. <code>ulClass</code>; <acronym>CSS</acronym> Klasse für das
  1141. <code>ul</code> Element. Erwartet einen <type>String</type>.
  1142. </para>
  1143. </listitem>
  1144. <listitem>
  1145. <para>
  1146. <code>onlyActiveBranch</code>; Ob nur der aktive Branch dargestellt
  1147. werden soll. Erwartet einen <type>Boolean</type> Wert.
  1148. </para>
  1149. </listitem>
  1150. <listitem>
  1151. <para>
  1152. <code>renderParents</code>; Ob eltern dargestellt werden sollen
  1153. wenn nur der aktive Branch dargestellt wird. Erwartet einen
  1154. <type>Boolean</type> Wert.
  1155. </para>
  1156. </listitem>
  1157. </itemizedlist>
  1158. <para>
  1159. Wenn keine Option angegeben wird, werden die Werte die im Helfer gesetzt
  1160. sind verwendet.
  1161. </para>
  1162. </listitem>
  1163. <listitem>
  1164. <para>
  1165. <methodname>renderPartial()</methodname> wird für die Darstellung des Menüs in
  1166. einem partiellen View Skript verwendet.
  1167. </para>
  1168. </listitem>
  1169. <listitem>
  1170. <para>
  1171. <methodname>renderSubMenu()</methodname> stellt das tiefste Menü Level des
  1172. aktiven Branches eines Containers dar.
  1173. </para>
  1174. </listitem>
  1175. </itemizedlist>
  1176. <example id="zend.view.helpers.initial.navigation.menu.example1">
  1177. <title>Darstellung eines Menüs</title>
  1178. <para>
  1179. Dieses Beispiel zeigt wie ein Menü von einem registrierten/im View Helfer
  1180. gefundenen Container, dargestellt wird. Es ist zu beachten das Seiten basierend
  1181. auf Ihrer Sichtbarkeit und <acronym>ACL</acronym> ausgefiltert werden.
  1182. </para>
  1183. <programlisting language="php"><![CDATA[
  1184. In einem View Skript oder Layout:
  1185. <?php echo $this->navigation()->menu()->render() ?>
  1186. Oder einfach:
  1187. <?php echo $this->navigation()->menu() ?>
  1188. Ausgabe:
  1189. <ul class="navigation">
  1190. <li>
  1191. <a title="Geh zu Home" href="/">Home</a>
  1192. </li>
  1193. <li class="active">
  1194. <a href="/products">Produkte</a>
  1195. <ul>
  1196. <li class="active">
  1197. <a href="/products/server">Foo Server</a>
  1198. <ul>
  1199. <li class="active">
  1200. <a href="/products/server/faq">FAQ</a>
  1201. </li>
  1202. <li>
  1203. <a href="/products/server/editions">Editionen</a>
  1204. </li>
  1205. <li>
  1206. <a href="/products/server/requirements">System Anforderungen</a>
  1207. </li>
  1208. </ul>
  1209. </li>
  1210. <li>
  1211. <a href="/products/studio">Foo Studio</a>
  1212. <ul>
  1213. <li>
  1214. <a href="/products/studio/customers">Kunden Stories</a>
  1215. </li>
  1216. <li>
  1217. <a href="/prodcts/studio/support">Support</a>
  1218. </li>
  1219. </ul>
  1220. </li>
  1221. </ul>
  1222. </li>
  1223. <li>
  1224. <a title="About us" href="/company/about">Firma</a>
  1225. <ul>
  1226. <li>
  1227. <a href="/company/about/investors">Investor Relations</a>
  1228. </li>
  1229. <li>
  1230. <a class="rss" href="/company/news">News</a>
  1231. <ul>
  1232. <li>
  1233. <a href="/company/news/press">Für die Presse</a>
  1234. </li>
  1235. <li>
  1236. <a href="/archive">Archiv</a>
  1237. </li>
  1238. </ul>
  1239. </li>
  1240. </ul>
  1241. </li>
  1242. <li>
  1243. <a href="/community">Community</a>
  1244. <ul>
  1245. <li>
  1246. <a href="/community/account">Mein Account</a>
  1247. </li>
  1248. <li>
  1249. <a class="external" href="http://forums.example.com/">Forums</a>
  1250. </li>
  1251. </ul>
  1252. </li>
  1253. </ul>
  1254. ]]></programlisting>
  1255. </example>
  1256. <example id="zend.view.helpers.initial.navigation.menu.example2">
  1257. <title>renderMenu() direkt aufrufen</title>
  1258. <para>
  1259. Dieses Beispiel zeigt wie ein Menü dargestellt werden kann das nicht im View
  1260. Helfer registriert ist, indem <methodname>renderMenu()</methodname> direkt
  1261. aufgerufen wird und ein paar wenige Optionen spezifiziert werden.
  1262. </para>
  1263. <programlisting language="php"><![CDATA[
  1264. <?php
  1265. // Nur das 'Community' Menü darstellen
  1266. $community = $this->navigation()->findOneByLabel('Community');
  1267. $options = array(
  1268. 'indent' => 16,
  1269. 'ulClass' => 'community'
  1270. );
  1271. echo $this->navigation()
  1272. ->menu()
  1273. ->renderMenu($community, $options);
  1274. ?>
  1275. Output:
  1276. <ul class="community">
  1277. <li>
  1278. <a href="/community/account">Mein Account</a>
  1279. </li>
  1280. <li>
  1281. <a class="external" href="http://forums.example.com/">Forums</a>
  1282. </li>
  1283. </ul>
  1284. ]]></programlisting>
  1285. </example>
  1286. <example id="zend.view.helpers.initial.navigation.menu.example3">
  1287. <title>Das tiefste aktive Menü darstellen</title>
  1288. <para>
  1289. Dieses Beispiel zeigt wie <methodname>renderSubMenu()</methodname> das tiefste
  1290. Untermenü des aktiven Branches dargestellt wird.
  1291. </para>
  1292. <para>
  1293. Der Aufruf von <methodname>renderSubMenu($container, $ulClass, $indent)</methodname>
  1294. ist identisch mit dem Aufruf von
  1295. <methodname>renderMenu($container, $options)</methodname> mit den folgenden
  1296. Optionen:
  1297. </para>
  1298. <programlisting language="php"><![CDATA[
  1299. array(
  1300. 'ulClass' => $ulClass,
  1301. 'indent' => $indent,
  1302. 'minDepth' => null,
  1303. 'maxDepth' => null,
  1304. 'onlyActiveBranch' => true,
  1305. 'renderParents' => false
  1306. );
  1307. ]]></programlisting>
  1308. <programlisting language="php"><![CDATA[
  1309. <?php
  1310. echo $this->navigation()
  1311. ->menu()
  1312. ->renderSubMenu(null, 'sidebar', 4);
  1313. ?>
  1314. Die Ausgabe ist die gleiche wenn 'FAQ' oder 'Foo Server' aktiv sind:
  1315. <ul class="sidebar">
  1316. <li class="active">
  1317. <a href="/products/server/faq">FAQ</a>
  1318. </li>
  1319. <li>
  1320. <a href="/products/server/editions">Editionen</a>
  1321. </li>
  1322. <li>
  1323. <a href="/products/server/requirements">System Anforderungen</a>
  1324. </li>
  1325. </ul>
  1326. ]]></programlisting>
  1327. </example>
  1328. <example id="zend.view.helpers.initial.navigation.menu.example4">
  1329. <title>Darstellung eines Menüs mit maximaler Tiefe</title>
  1330. <programlisting language="php"><![CDATA[
  1331. <?php
  1332. echo $this->navigation()
  1333. ->menu()
  1334. ->setMaxDepth(1);
  1335. ?>
  1336. Ausgabe:
  1337. <ul class="navigation">
  1338. <li>
  1339. <a title="Geh zu Home" href="/">Home</a>
  1340. </li>
  1341. <li class="active">
  1342. <a href="/products">Produkte</a>
  1343. <ul>
  1344. <li class="active">
  1345. <a href="/products/server">Foo Server</a>
  1346. </li>
  1347. <li>
  1348. <a href="/products/studio">Foo Studio</a>
  1349. </li>
  1350. </ul>
  1351. </li>
  1352. <li>
  1353. <a title="About us" href="/company/about">Firma</a>
  1354. <ul>
  1355. <li>
  1356. <a href="/company/about/investors">Investor Relations</a>
  1357. </li>
  1358. <li>
  1359. <a class="rss" href="/company/news">News</a>
  1360. </li>
  1361. </ul>
  1362. </li>
  1363. <li>
  1364. <a href="/community">Community</a>
  1365. <ul>
  1366. <li>
  1367. <a href="/community/account">Mein Account</a>
  1368. </li>
  1369. <li>
  1370. <a class="external" href="http://forums.example.com/">Forums</a>
  1371. </li>
  1372. </ul>
  1373. </li>
  1374. </ul>
  1375. ]]></programlisting>
  1376. </example>
  1377. <example id="zend.view.helpers.initial.navigation.menu.example5">
  1378. <title>Darstellung eines Menüs mit minimaler Tiefe</title>
  1379. <programlisting language="php"><![CDATA[
  1380. <?php
  1381. echo $this->navigation()
  1382. ->menu()
  1383. ->setMinDepth(1);
  1384. ?>
  1385. Ausgabe:
  1386. <ul class="navigation">
  1387. <li class="active">
  1388. <a href="/products/server">Foo Server</a>
  1389. <ul>
  1390. <li class="active">
  1391. <a href="/products/server/faq">FAQ</a>
  1392. </li>
  1393. <li>
  1394. <a href="/products/server/editions">Editionen</a>
  1395. </li>
  1396. <li>
  1397. <a href="/products/server/requirements">System Anforderungen</a>
  1398. </li>
  1399. </ul>
  1400. </li>
  1401. <li>
  1402. <a href="/products/studio">Foo Studio</a>
  1403. <ul>
  1404. <li>
  1405. <a href="/products/studio/customers">Kunden Stories</a>
  1406. </li>
  1407. <li>
  1408. <a href="/prodcts/studio/support">Support</a>
  1409. </li>
  1410. </ul>
  1411. </li>
  1412. <li>
  1413. <a href="/company/about/investors">Investor Relations</a>
  1414. </li>
  1415. <li>
  1416. <a class="rss" href="/company/news">News</a>
  1417. <ul>
  1418. <li>
  1419. <a href="/company/news/press">Für die Presse</a>
  1420. </li>
  1421. <li>
  1422. <a href="/archive">Archiv</a>
  1423. </li>
  1424. </ul>
  1425. </li>
  1426. <li>
  1427. <a href="/community/account">Mein Account</a>
  1428. </li>
  1429. <li>
  1430. <a class="external" href="http://forums.example.com/">Forums</a>
  1431. </li>
  1432. </ul>
  1433. ]]></programlisting>
  1434. </example>
  1435. <example id="zend.view.helpers.initial.navigation.menu.example6">
  1436. <title>Nur den aktiven Branch eines Menüs darstellen</title>
  1437. <programlisting language="php"><![CDATA[
  1438. <?php
  1439. echo $this->navigation()
  1440. ->menu()
  1441. ->setOnlyActiveBranch(true);
  1442. ?>
  1443. Ausgabe:
  1444. <ul class="navigation">
  1445. <li class="active">
  1446. <a href="/products">Produkte</a>
  1447. <ul>
  1448. <li class="active">
  1449. <a href="/products/server">Foo Server</a>
  1450. <ul>
  1451. <li class="active">
  1452. <a href="/products/server/faq">FAQ</a>
  1453. </li>
  1454. <li>
  1455. <a href="/products/server/editions">Editionen</a>
  1456. </li>
  1457. <li>
  1458. <a href="/products/server/requirements">System Anforderungen</a>
  1459. </li>
  1460. </ul>
  1461. </li>
  1462. </ul>
  1463. </li>
  1464. </ul>
  1465. ]]></programlisting>
  1466. </example>
  1467. <example id="zend.view.helpers.initial.navigation.menu.example7">
  1468. <title>
  1469. Nur den aktiven Branch eines Menüs mit minimaler Tiefe darstellen
  1470. </title>
  1471. <programlisting language="php"><![CDATA[
  1472. <?php
  1473. echo $this->navigation()
  1474. ->menu()
  1475. ->setOnlyActiveBranch(true)
  1476. ->setMinDepth(1);
  1477. ?>
  1478. Ausgabe:
  1479. <ul class="navigation">
  1480. <li class="active">
  1481. <a href="/products/server">Foo Server</a>
  1482. <ul>
  1483. <li class="active">
  1484. <a href="/products/server/faq">FAQ</a>
  1485. </li>
  1486. <li>
  1487. <a href="/products/server/editions">Editionen</a>
  1488. </li>
  1489. <li>
  1490. <a href="/products/server/requirements">System Anforderungen</a>
  1491. </li>
  1492. </ul>
  1493. </li>
  1494. </ul>
  1495. ]]></programlisting>
  1496. </example>
  1497. <example id="zend.view.helpers.initial.navigation.menu.example8">
  1498. <title>
  1499. Nur den aktiven Branch eines Menüs mit maximaler Tiefe darstellen
  1500. </title>
  1501. <programlisting language="php"><![CDATA[
  1502. <?php
  1503. echo $this->navigation()
  1504. ->menu()
  1505. ->setOnlyActiveBranch(true)
  1506. ->setMaxDepth(1);
  1507. ?>
  1508. Ausgabe:
  1509. <ul class="navigation">
  1510. <li class="active">
  1511. <a href="/products">Produkte</a>
  1512. <ul>
  1513. <li class="active">
  1514. <a href="/products/server">Foo Server</a>
  1515. </li>
  1516. <li>
  1517. <a href="/products/studio">Foo Studio</a>
  1518. </li>
  1519. </ul>
  1520. </li>
  1521. </ul>
  1522. ]]></programlisting>
  1523. </example>
  1524. <example id="zend.view.helpers.initial.navigation.menu.example9">
  1525. <title>
  1526. Nur den aktiven Branch eines Menüs mit maximaler Tiefe aber ohne Eltern darstellen
  1527. </title>
  1528. <para>
  1529. </para>
  1530. <programlisting language="php"><![CDATA[
  1531. <?php
  1532. echo $this->navigation()
  1533. ->menu()
  1534. ->setOnlyActiveBranch(true)
  1535. ->setRenderParents(false)
  1536. ->setMaxDepth(1);
  1537. ?>
  1538. Ausgabe:
  1539. <ul class="navigation">
  1540. <li class="active">
  1541. <a href="/products/server">Foo Server</a>
  1542. </li>
  1543. <li>
  1544. <a href="/products/studio">Foo Studio</a>
  1545. </li>
  1546. </ul>
  1547. ]]></programlisting>
  1548. </example>
  1549. <example id="zend.view.helpers.initial.navigation.menu.example10">
  1550. <title>
  1551. Darstellen eines eigenen Menüs durch Verwendung eines partiellen View Skripts
  1552. </title>
  1553. <para>
  1554. Dieses Beispiel zeigt wie ein eigenes Menü, durch Verwendung eines partiellen View
  1555. Skripts, dargestellt werden kann. Durch Aufruf von
  1556. <methodname>setPartial()</methodname> kann ein partielles View Skript spezifiziert
  1557. werden das verwendet wird wenn man <methodname>render()</methodname> aufruft. Wenn
  1558. ein Partielles spezifiziert ist, wird die <methodname>renderPartial()</methodname>
  1559. Methode aufgerufen. Diese Methode fügt den Container in die View ein, und verwendet
  1560. hierbei den Schlüssel <code>container</code>.
  1561. </para>
  1562. <para>In a layout:</para>
  1563. <programlisting language="php"><![CDATA[
  1564. $partial = array('menu.phtml', 'default');
  1565. $this->navigation()->menu()->setPartial($partial);
  1566. echo $this->navigation()->menu()->render();
  1567. ]]></programlisting>
  1568. <para>In application/modules/default/views/menu.phtml:</para>
  1569. <programlisting language="php"><![CDATA[
  1570. foreach ($this->container as $page) {
  1571. echo $this->navigation()->menu()->htmlify($page), PHP_EOL;
  1572. }
  1573. ]]></programlisting>
  1574. <para>Ausgabe:</para>
  1575. <programlisting language="php"><![CDATA[
  1576. <a title="Geh zu Home" href="/">Home</a>
  1577. <a href="/products">Produkte</a>
  1578. <a title="About us" href="/company/about">Firma</a>
  1579. <a href="/community">Community</a>
  1580. ]]></programlisting>
  1581. </example>
  1582. </sect4>
  1583. <sect4 id="zend.view.helpers.initial.navigation.sitemap">
  1584. <title>Sitemap Helfer</title>
  1585. <para>
  1586. Der Sitemap Helfer wird für die Erzeugung von <acronym>XML</acronym> Sitemaps verwendet
  1587. wie im <ulink url="http://www.sitemaps.org/protocol.php">Sitemaps <acronym>XML</acronym>
  1588. Format</ulink> definiert. Mehr darüber kann unter <ulink
  1589. url="http://en.wikipedia.org/wiki/Sitemaps"> Sitemaps in Wikipedia</ulink>
  1590. nachgelesen werden.
  1591. </para>
  1592. <para>
  1593. Standardmäßig verwendet der Sitemap Helfer
  1594. <link linkend="zend.validate.sitemap">Sitemap Prüfungen</link> um jedes Element zu
  1595. prüfen das dargestellt werden soll. Das kann deaktiviert werden indem man
  1596. <code>$helper->setUseSitemapValidators(false)</code> aufruft.
  1597. </para>
  1598. <note>
  1599. <para>
  1600. Wenn man die Sitemap Prüfungen deaktiviert, werden die eigenen Eigenschaften
  1601. (siehe Tabelle) nicht geprüft.
  1602. </para>
  1603. </note>
  1604. <para>
  1605. Der Sitemap Helfer unterstützt auch die Pürfung von
  1606. <ulink url="http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">Sitemap XSD
  1607. Schemas</ulink> der erzeugten Sitemap. Das ist standardmäßig deaktiviert, da es eine
  1608. Anfrage auf die Schema Datei benötigt. Es kann mit
  1609. <code>$helper->setUseSchemaValidation(true)</code> aktiviert werden.
  1610. </para>
  1611. <table id="zend.view.helpers.initial.navigation.sitemap.elements">
  1612. <title>Sitemap XML Elemente</title>
  1613. <tgroup cols="2">
  1614. <thead>
  1615. <row>
  1616. <entry>Element</entry>
  1617. <entry>Beschreibung</entry>
  1618. </row>
  1619. </thead>
  1620. <tbody>
  1621. <row>
  1622. <entry><code>loc</code></entry>
  1623. <entry>
  1624. Absolute <acronym>URL</acronym> zur Seite. Eine absolute
  1625. <acronym>URL</acronym> wird vom Helfer erzeugt.
  1626. </entry>
  1627. </row>
  1628. <row>
  1629. <entry><code>lastmod</code></entry>
  1630. <entry>
  1631. <para>
  1632. Das Datum der letzten Änderung der Datei, im
  1633. <ulink url="http://www.w3.org/TR/NOTE-datetime">W3C
  1634. Datetime</ulink> Format. Dieser Zeitabschnitt kann bei Bedarf
  1635. unterdrückt, und nur YYYY-MM-DD verwendet werden.
  1636. </para>
  1637. <para>
  1638. Der Helfer versucht den <code>lastmod</code> Wert von der
  1639. Seiteneigenschaft <code>lastmod</code> zu erhalten wenn diese auf
  1640. der Seite gesetzt ist. Wenn der Wert kein gültiges Datum ist, wird
  1641. er ignoriert.
  1642. </para>
  1643. </entry>
  1644. </row>
  1645. <row>
  1646. <entry><code>changefreq</code></entry>
  1647. <entry>
  1648. <para>
  1649. Wie oft eine Seite geändert wird. Dieser Wert bietet eine generelle
  1650. Information für Suchmaschinen und muß nicht exakt mit der Anzahl
  1651. der Suchen auf der Seite übereinstimmen. Gültige Werte sind:
  1652. </para>
  1653. <itemizedlist>
  1654. <listitem><para>always</para></listitem>
  1655. <listitem><para>hourly</para></listitem>
  1656. <listitem><para>daily</para></listitem>
  1657. <listitem><para>weekly</para></listitem>
  1658. <listitem><para>monthly</para></listitem>
  1659. <listitem><para>yearly</para></listitem>
  1660. <listitem><para>never</para></listitem>
  1661. </itemizedlist>
  1662. <para>
  1663. Der Helfer versucht den <code>changefreq</code> Wert von der
  1664. Seiteneigenschaft <code>changefreq</code> zu erhalten, wenn diese
  1665. auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird er
  1666. ignoriert.
  1667. </para>
  1668. </entry>
  1669. </row>
  1670. <row>
  1671. <entry><code>priority</code></entry>
  1672. <entry>
  1673. <para>
  1674. Die Priorität dieser <acronym>URL</acronym> relativ zu anderen
  1675. <acronym>URL</acronym>s auf der eigenen Site. Der gültige Bereich
  1676. für diesen Wert ist von 0.0 bis 1.0.
  1677. </para>
  1678. <para>
  1679. Der Helfer versucht den <code>priority</code> Wert von der
  1680. Seiteneigenschaft <code>priority</code> zu erhalten wenn dieser
  1681. auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird
  1682. er ignoriert.
  1683. </para>
  1684. </entry>
  1685. </row>
  1686. </tbody>
  1687. </tgroup>
  1688. </table>
  1689. <para>
  1690. Methoden im Sitemap Helfer:
  1691. </para>
  1692. <itemizedlist>
  1693. <listitem>
  1694. <para>
  1695. <code>{get|set}FormatOutput()</code> empfängt/setzt ein Flag das anzeigt ob
  1696. <acronym>XML</acronym> Ausgaben formatiert werden sollen. Das entspricht der
  1697. Eigenschaft <code>formatOutput</code> der nativen
  1698. <classname>DOMDocument</classname> Klasse. Mehr kann man unter <ulink
  1699. url="http://php.net/domdocument">PHP: DOMDocument - Handbuch</ulink>
  1700. nachlesen. Der Standardwert ist <constant>FALSE</constant>.
  1701. </para>
  1702. </listitem>
  1703. <listitem>
  1704. <para>
  1705. <code>{get|set}UseXmlDeclaration()</code> empfängt/setzt ein Flag das
  1706. anzeigt ob die <acronym>XML</acronym> Deklaration bei der Darstellung enthalten
  1707. sein soll. Der Standardwert ist <constant>TRUE</constant>.
  1708. </para>
  1709. </listitem>
  1710. <listitem>
  1711. <para>
  1712. <code>{get|set}UseSitemapValidators()</code> empfängt/setzt ein Flag das
  1713. anzeigt ob Sitemap Prüfungen verwendet werden sollen wenn die DOM Sitemap
  1714. dargestellt werden soll. Der Standardwert ist <constant>TRUE</constant>.
  1715. </para>
  1716. </listitem>
  1717. <listitem>
  1718. <para>
  1719. <code>{get|set}UseSchemaValidation()</code> empfängt/setzt ein Flag das
  1720. anzeigt ob der Helfer eine <acronym>XML</acronym> Schema Prüfung verwenden soll
  1721. wenn die DOM Sitemap erzeugt wird. Der Standardwert ist
  1722. <constant>FALSE</constant>.
  1723. </para>
  1724. </listitem>
  1725. <listitem>
  1726. <para>
  1727. <code>{get|set}ServerUrl()</code> empfängt/setzt die Server
  1728. <acronym>URL</acronym> die nicht-absoluten <acronym>URL</acronym>s in der
  1729. <methodname>url()</methodname> Methode vorangestellt werden. Wenn keine Server
  1730. <acronym>URL</acronym> spezifiziert ist, wird diese vom Helfer festgestellt.
  1731. </para>
  1732. </listitem>
  1733. <listitem>
  1734. <para>
  1735. <methodname>url()</methodname> wird verwendet um absolute
  1736. <acronym>URL</acronym>s zu Seiten zu 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 <acronym>XML</acronym> Sitemap, basierend auf dem
  1750. Setup das wir 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 <acronym>ACL</acronym>
  1767. Rollen die mit dem 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 <acronym>ACL</acronym> Rolle darstellen (sollte
  1827. /community/account 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, <acronym>ACL</acronym>/Rolle und Übersetzer injizieren. Das bedeutet weder
  1954. das man diese drei nicht explizit in allen navigatorischen Helfern setzen muß, noch das
  1955. diese in <classname>Zend_Registry</classname> oder in statische Methoden injiziert
  1956. werden muß.
  1957. </para>
  1958. <itemizedlist>
  1959. <listitem>
  1960. <para>
  1961. <methodname>findHelper()</methodname> findet alle angegebenen Helfer, prüft das
  1962. dieser ein navigatorischer Helfer ist, und injiziiert Container,
  1963. <acronym>ACL</acronym>/Rolle und Übersetzer.
  1964. </para>
  1965. </listitem>
  1966. <listitem>
  1967. <para>
  1968. <code>{get|set}InjectContainer()</code> empfängt/setzt ein Flag das anzeigt
  1969. ob der Container an weitergeleitete Helfer injiziiert werden soll. Der
  1970. Standardwert ist <constant>TRUE</constant>.
  1971. </para>
  1972. </listitem>
  1973. <listitem>
  1974. <para>
  1975. <code>{get|set}InjectAcl()</code> empfängt/setzt ein Flag das anzeigt ob die
  1976. <acronym>ACL</acronym>/Rolle an weitergeleitete Helfer injiziiert werden soll.
  1977. Der Standardwert ist <constant>TRUE</constant>.
  1978. </para>
  1979. </listitem>
  1980. <listitem>
  1981. <para>
  1982. <code>{get|set}InjectTranslator()</code> empfängt/setzt ein Flag das anzeigt
  1983. ob der Übersetzer an weitergeleitete Helfer injiziiert werden soll. Der
  1984. Standardwert ist <constant>TRUE</constant>.
  1985. </para>
  1986. </listitem>
  1987. <listitem>
  1988. <para>
  1989. <code>{get|set}DefaultProxy()</code> empfängt/setzt den Standard Proxy. Der
  1990. Standardwert ist <code>'menu'</code>.
  1991. </para>
  1992. </listitem>
  1993. <listitem>
  1994. <para>
  1995. <methodname>render()</methodname> leitet auf die render Methode des
  1996. Standardproxies weiter.
  1997. </para>
  1998. </listitem>
  1999. </itemizedlist>
  2000. </sect4>
  2001. </sect3>