Zend_View-Helpers-Navigation.xml 86 KB

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