Zend_View-Helpers-Navigation.xml 86 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20143 -->
  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>renderPartial()</methodname>
  647. Methode aufgerufen wird. Diese Methode findest die tiefste aktive Seite und übergibt
  648. ein Array von Seiten die zur aktiven Seite des partiellen View Skripts weiterleitet.
  649. </para>
  650. <para>
  651. Im Layout:
  652. </para>
  653. <programlisting language="php"><![CDATA[
  654. $partial = ;
  655. echo $this->navigation()->breadcrumbs()
  656. ->setPartial(array('breadcrumbs.phtml', 'default'));
  657. ]]></programlisting>
  658. <para>
  659. Inhalt von
  660. <code>application/modules/default/views/breadcrumbs.phtml</code>:
  661. </para>
  662. <programlisting language="php"><![CDATA[
  663. echo implode(', ', array_map(
  664. create_function('$a', 'return $a->getLabel();'),
  665. $this->pages));
  666. ]]></programlisting>
  667. <para>
  668. Ausgabe:
  669. </para>
  670. <programlisting language="php"><![CDATA[
  671. Produkte, Foo Server, FAQ
  672. ]]></programlisting>
  673. </example>
  674. </sect4>
  675. <sect4 id="zend.view.helpers.initial.navigation.links">
  676. <title>Link Helfer</title>
  677. <para>
  678. Der Link Helfer wird für die Darstellung von HTML <constant>LINK</constant> Elementen
  679. verwendet. Links werden für die Beschreibung von Dokument-Beziehungen der aktuell
  680. aktiven Seite verwendet. Mehr über Links und Linktypen kann unter
  681. <ulink url="http://www.w3.org/TR/html4/struct/links.html#h-12.3">Dokument-Beziehung:
  682. Das LINK Element (HTML4 W3C Rec.)</ulink> und
  683. <ulink url="http://www.w3.org/TR/html4/types.html#h-6.12">Link Typen
  684. (HTML4 W3C Rec.)</ulink> in der HMTL4 W3C Empfehlung nachgelesen werden.
  685. </para>
  686. <para>
  687. Es gibt zwei Typen von Beziehungen; vorwärts und rückwärts, angezeigt durch die
  688. Schlüsselwörter <code>'rel'</code> und <code>'rev'</code>. Die meisten Methoden im
  689. Helfer nehmen einen <varname>$rel</varname> Parameter entgegen, welcher entweder
  690. <code>'rel'</code> oder <code>'rev'</code> sein muß. Die meisten Methoden nehmen auch
  691. einen <varname>$type</varname> Parameter entgegen welcher für die Spezifikation des
  692. Linktyps (z.B. alternate, start, next, prev, chapter, usw.) verwendet wird.
  693. </para>
  694. <para>
  695. Beziehungen können dem Seitenobjekt manuell hinzugefügt werden, oder werden durch
  696. das Durchlaufen des Containers, der im Helfer registriert ist, gefunden. Die Methode
  697. <methodname>findRelation($page, $rel, $type)</methodname> versucht zuerst den gegebenen
  698. <varname>$rel</varname> von <varname>$type</varname> von der <varname>$page</varname>
  699. durch den Aufruf von <code>$page->findRel($type)</code> oder
  700. <code>$page->findRel($type)</code> zu finden. Wenn <varname>$page</varname> eine
  701. Beziehung hat die zu der Instanz einer Seite konvertiert werden kann, wird diese
  702. Beziehung verwendet. Wenn die Instanz von <varname>$page</varname> keinen
  703. <varname>$type</varname> spezifiziert hat, schaut der Helfer nach einer Methode im
  704. Helfer die <code>search$rel$type</code> heißt (z.B.
  705. <methodname>searchRelNext()</methodname> oder
  706. <methodname>searchRevAlternate()</methodname>). Wenn so eine Methode existiert, wird Sie
  707. für die Erkennung der Beziehung der <varname>$page</varname> verwendet indem der
  708. Container durchlaufen wird.
  709. </para>
  710. <para>
  711. Nicht alle Beziehungen können durch das Durchlaufen des Containers erkannt werden.
  712. Das sind die Beziehungen die durch eine Suche gefunden werden können:
  713. </para>
  714. <itemizedlist>
  715. <listitem>
  716. <para>
  717. <methodname>searchRelStart()</methodname>, Vorwärts Beziehung 'start': Die
  718. erste Seite im Container.
  719. </para>
  720. </listitem>
  721. <listitem>
  722. <para>
  723. <methodname>searchRelNext()</methodname>, Vorwärts Beziehung 'next'; findet
  724. die nächste Seite im Container, z.B. die Seite nach der aktiven Seite.
  725. </para>
  726. </listitem>
  727. <listitem>
  728. <para>
  729. <methodname>searchRelPrev()</methodname>, Vorwärts Beziehung 'prev'; findet
  730. die vorhergehende Seite, z.B. die Seite vor der aktiven Seite.
  731. </para>
  732. </listitem>
  733. <listitem>
  734. <para>
  735. <methodname>searchRelChapter()</methodname>, Vorwärts Beziehung 'chapter';
  736. findet alle Seiten auf Level 0 ausser der 'start' Beziehung oder der aktiven
  737. Seite wenn diese auf Level 0 ist.
  738. </para>
  739. </listitem>
  740. <listitem>
  741. <para>
  742. <methodname>searchRelSection()</methodname>, Vorwärts Beziehung 'section';
  743. findet alle Kind-Seiten der aktiven Seite wenn die aktive Seite auf Level 0
  744. ist (ein 'chapter').
  745. </para>
  746. </listitem>
  747. <listitem>
  748. <para>
  749. <methodname>searchRelSubsection()</methodname>, Vorwärts Beziehung
  750. 'subsection'; findet alle Kind-Seiten der aktiven Seite wenn die aktive
  751. Seite auf Level 1 sind (ein 'section').
  752. </para>
  753. </listitem>
  754. <listitem>
  755. <para>
  756. <methodname>searchRevSection()</methodname>, Rückwärts Beziehung 'section';
  757. findet den Elternteil der aktiven Seite wenn die aktive Seite auf Level 1
  758. ist (ein 'section').
  759. </para>
  760. </listitem>
  761. <listitem>
  762. <para>
  763. <methodname>searchRevSubsection()</methodname>, Rückwärts Beziehung
  764. 'subsection'; findet den Elternteil der aktiven Seite wenn die aktive Seite
  765. auf Level 2 ist (ein 'subsection').
  766. </para>
  767. </listitem>
  768. </itemizedlist>
  769. <note>
  770. <para>
  771. Wenn in der Instanz der Seite nach Beziehungen gesehen wird (
  772. (<code>$page->getRel($type)</code> oder <code>$page->getRev($type)</code>),
  773. akzeptiert der Helfer Wert vom Typ <type>String</type>, <type>Array</type>,
  774. <classname>Zend_Config</classname>, oder
  775. <classname>Zend_Navigation_Page</classname>. Wenn ein String gefunden wird, wird
  776. dieser zu einer <classname>Zend_Navigation_Page_Uri</classname> konvertiert. Wenn
  777. ein Array oder eine Config gefunden wird, wird diese in ein oder mehrere
  778. Seiteninstanzen konvertiert, und jedes Element wird an die
  779. <link linkend="zend.navigation.pages.factory">Seiten Factory</link> übergeben.
  780. Wenn der erste Schlüssel nicht nummerische ist, wird das Array/Config direkt an die
  781. Seiten Factory übergeben, und eine einzelne Seite wird retourniert.
  782. </para>
  783. </note>
  784. <para>
  785. Der Helfer unterstützt auch magische Methoden für das Finden von Beziehungen. Um z.B.
  786. alternative vorwärts Beziehungen zu finden muß
  787. <code>$helper->findRelAlternate($page)</code> aufgerufen werden, und um rückwärts
  788. gerichtete Kapitel Beziehungen zu finden <code>$helper->findRevSection($page)</code>.
  789. Diese Aufrufe korrespondieren mit <code>$helper->findRelation($page, 'rel',
  790. 'alternate');</code> und <code>$helper->findRelation($page, 'rev', 'section');</code>.
  791. </para>
  792. <para>
  793. Um zu Steuern welche Beziehung dargestellt werden soll, verwendet der Helfer ein render
  794. Flag. Das render Flag ist ein Integer Wert, und kann in
  795. <ulink url="http://php.net/manual/en/language.operators.bitwise.php">binären
  796. <code>und</code> (<code>&amp;</code>) Operationen</ulink> mit den render Konstanten des
  797. Helfers verwendet werden um festzustellen ob die Beziehung zu der die render Konstante
  798. gehört, dargestellt werden soll.
  799. </para>
  800. <para>
  801. Siehe das <link linkend="zend.view.helpers.initial.navigation.links.example3">folgende
  802. Beispiel</link> für weitere Informationen.
  803. </para>
  804. <itemizedlist>
  805. <listitem>
  806. <para>
  807. <constant>Zend_View_Helper_Navigation_Link::RENDER_ALTERNATE</constant>
  808. </para>
  809. </listitem>
  810. <listitem>
  811. <para>
  812. <constant>Zend_View_Helper_Navigation_Link::RENDER_STYLESHEET</constant>
  813. </para>
  814. </listitem>
  815. <listitem>
  816. <para>
  817. <constant>Zend_View_Helper_Navigation_Link::RENDER_START</constant>
  818. </para>
  819. </listitem>
  820. <listitem>
  821. <para>
  822. <constant>Zend_View_Helper_Navigation_Link::RENDER_NEXT</constant>
  823. </para>
  824. </listitem>
  825. <listitem>
  826. <para>
  827. <constant>Zend_View_Helper_Navigation_Link::RENDER_PREV</constant>
  828. </para>
  829. </listitem>
  830. <listitem>
  831. <para>
  832. <constant>Zend_View_Helper_Navigation_Link::RENDER_CONTENTS</constant>
  833. </para>
  834. </listitem>
  835. <listitem>
  836. <para>
  837. <constant>Zend_View_Helper_Navigation_Link::RENDER_INDEX</constant>
  838. </para>
  839. </listitem>
  840. <listitem>
  841. <para>
  842. <constant>Zend_View_Helper_Navigation_Link::RENDER_GLOSSARY</constant>
  843. </para>
  844. </listitem>
  845. <listitem>
  846. <para>
  847. <constant>Zend_View_Helper_Navigation_Link::RENDER_COPYRIGHT</constant>
  848. </para>
  849. </listitem>
  850. <listitem>
  851. <para>
  852. <constant>Zend_View_Helper_Navigation_Link::RENDER_CHAPTER</constant>
  853. </para>
  854. </listitem>
  855. <listitem>
  856. <para>
  857. <constant>Zend_View_Helper_Navigation_Link::RENDER_SECTION</constant>
  858. </para>
  859. </listitem>
  860. <listitem>
  861. <para>
  862. <constant>Zend_View_Helper_Navigation_Link::RENDER_SUBSECTION</constant>
  863. </para>
  864. </listitem>
  865. <listitem>
  866. <para>
  867. <constant>Zend_View_Helper_Navigation_Link::RENDER_APPENDIX</constant>
  868. </para>
  869. </listitem>
  870. <listitem>
  871. <para>
  872. <constant>Zend_View_Helper_Navigation_Link::RENDER_HELP</constant>
  873. </para>
  874. </listitem>
  875. <listitem>
  876. <para>
  877. <constant>Zend_View_Helper_Navigation_Link::RENDER_BOOKMARK</constant>
  878. </para>
  879. </listitem>
  880. <listitem>
  881. <para>
  882. <constant>Zend_View_Helper_Navigation_Link::RENDER_CUSTOM</constant>
  883. </para>
  884. </listitem>
  885. <listitem>
  886. <para>
  887. <constant>Zend_View_Helper_Navigation_Link::RENDER_ALL</constant>
  888. </para>
  889. </listitem>
  890. </itemizedlist>
  891. <para>
  892. Die Konstanten von <constant>RENDER_ALTERNATE</constant> bis
  893. <constant>RENDER_BOOKMARK</constant> stellen standardmäßige HTML Linktypen dar.
  894. <constant>RENDER_CUSTOM</constant> stellt eine nicht-standardmäßige Beziehung dar die
  895. in der Seite spezifiziert ist. <constant>RENDER_ALL</constant> stellt standardmäßige
  896. und nicht-standardmäßige Beziehungen dar.
  897. </para>
  898. <para>
  899. Methoden im Link Helfer:
  900. </para>
  901. <itemizedlist>
  902. <listitem>
  903. <para>
  904. <code>{get|set}RenderFlag()</code> empfängt/setzt das render Flag.
  905. Standardwert ist <constant>RENDER_ALL</constant>. Siehe das folgende Beispiel
  906. dafür wie das render Flag zu setzen ist.
  907. </para>
  908. </listitem>
  909. <listitem>
  910. <para>
  911. <methodname>findAllRelations()</methodname> findet alle Beziehungen von allen
  912. Typen einer angegebenen Seite.
  913. </para>
  914. </listitem>
  915. <listitem>
  916. <para>
  917. <methodname>findRelation()</methodname> findet alle Beziehungen eines angegebenen
  918. Typs einer angegebenen Seite.
  919. </para>
  920. </listitem>
  921. <listitem>
  922. <para>
  923. <methodname>searchRel{Start|Next|Prev|Chapter|Section|Subsection}()</methodname>
  924. durchsucht einen Container um vorwärtsgerichtete Beziehungen zu Startseite,
  925. nächster Seite, voriger Seite, Kapitel, Sektion und Untersektion zu finden.
  926. </para>
  927. </listitem>
  928. <listitem>
  929. <para>
  930. <methodname>searchRev{Section|Subsection}()</methodname> durchsucht einen
  931. Container um rückwärtsgerichtete Beziehungen zu Sektionen oder Untersektionen zu
  932. finden.
  933. </para>
  934. </listitem>
  935. <listitem>
  936. <para>
  937. <methodname>renderLink()</methodname> stellt ein einzelnes <code>link</code>
  938. Element dar.
  939. </para>
  940. </listitem>
  941. </itemizedlist>
  942. <example id="zend.view.helpers.initial.navigation.links.example1">
  943. <title>Beziehungen in Seiten spezifizieren</title>
  944. <para>
  945. Dieses Beispiel zeigt wir Beziehungen in Seiten spezifiziert werden können.
  946. </para>
  947. <programlisting language="php"><![CDATA[
  948. $container = new Zend_Navigation(array(
  949. array(
  950. 'label' => 'Strings für Beziehungen verwenden',
  951. 'rel' => array(
  952. 'alternate' => 'http://www.example.org/'
  953. ),
  954. 'rev' => array(
  955. 'alternate' => 'http://www.example.net/'
  956. )
  957. ),
  958. array(
  959. 'label' => 'Arrays für Beziehungen verwenden',
  960. 'rel' => array(
  961. 'alternate' => array(
  962. 'label' => 'Example.org',
  963. 'uri' => 'http://www.example.org/'
  964. )
  965. )
  966. ),
  967. array(
  968. 'label' => 'Konfigurationen für Beziehungen verwenden',
  969. 'rel' => array(
  970. 'alternate' => new Zend_Config(array(
  971. 'label' => 'Example.org',
  972. 'uri' => 'http://www.example.org/'
  973. ))
  974. )
  975. ),
  976. array(
  977. 'label' => 'Instanzen von Seiten für Beziehungen verwenden',
  978. 'rel' => array(
  979. 'alternate' => Zend_Navigation_Page::factory(array(
  980. 'label' => 'Example.org',
  981. 'uri' => 'http://www.example.org/'
  982. ))
  983. )
  984. )
  985. ));
  986. ]]></programlisting>
  987. </example>
  988. <example id="zend.view.helpers.initial.navigation.links.example2">
  989. <title>Standardmäßige Darstellung von Links</title>
  990. <para>
  991. Dieses Beispiel zeigt wie ein Menü von einem Container dargestellt wird, der im
  992. View Helfer registriert/gefunden wurde.
  993. </para>
  994. <programlisting language="php"><![CDATA[
  995. Im View Skript oder Layout:
  996. <?php echo $this->view->navigation()->links(); ?>
  997. Ausgabe:
  998. <link rel="alternate" href="/products/server/faq/format/xml">
  999. <link rel="start" href="/" title="Home">
  1000. <link rel="next" href="/products/server/editions" title="Editionen">
  1001. <link rel="prev" href="/products/server" title="Foo Server">
  1002. <link rel="chapter" href="/products" title="Produkte">
  1003. <link rel="chapter" href="/company/about" title="Firma">
  1004. <link rel="chapter" href="/community" title="Community">
  1005. <link rel="canonical" href="http://www.example.com/?page=server-faq">
  1006. <link rev="subsection" href="/products/server" title="Foo Server">
  1007. ]]></programlisting>
  1008. </example>
  1009. <example id="zend.view.helpers.initial.navigation.links.example3">
  1010. <title>Spezifizieren welche Beziehungen dargestellt werden sollen</title>
  1011. <para>
  1012. Dieses Beispiel zeigt wie spezifiziert werden kann, welche Beziehungen zu finden
  1013. und darzustellen sind.
  1014. </para>
  1015. <programlisting language="php"><![CDATA[
  1016. Nur start, next und prev darstellen:
  1017. $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_START |
  1018. Zend_View_Helper_Navigation_Links::RENDER_NEXT |
  1019. Zend_View_Helper_Navigation_Links::RENDER_PREV);
  1020. Ausgabe:
  1021. <link rel="start" href="/" title="Home">
  1022. <link rel="next" href="/products/server/editions" title="Editionen">
  1023. <link rel="prev" href="/products/server" title="Foo Server">
  1024. ]]></programlisting>
  1025. <programlisting language="php"><![CDATA[
  1026. Nur native Linktypen darstellen:
  1027. $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
  1028. Zend_View_Helper_Navigation_Links::RENDER_CUSTOM);
  1029. Ausgabe:
  1030. <link rel="alternate" href="/products/server/faq/format/xml">
  1031. <link rel="start" href="/" title="Home">
  1032. <link rel="next" href="/products/server/editions" title="Editionen">
  1033. <link rel="prev" href="/products/server" title="Foo Server">
  1034. <link rel="chapter" href="/products" title="Produkte">
  1035. <link rel="chapter" href="/company/about" title="Firma">
  1036. <link rel="chapter" href="/community" title="Community">
  1037. <link rev="subsection" href="/products/server" title="Foo Server">
  1038. ]]></programlisting>
  1039. <programlisting language="php"><![CDATA[
  1040. Alles ausser Kapitel darstellen:
  1041. $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
  1042. Zend_View_Helper_Navigation_Links::RENDER_CHAPTER);
  1043. Ausgabe:
  1044. <link rel="alternate" href="/products/server/faq/format/xml">
  1045. <link rel="start" href="/" title="Home">
  1046. <link rel="next" href="/products/server/editions" title="Editionen">
  1047. <link rel="prev" href="/products/server" title="Foo Server">
  1048. <link rel="canonical" href="http://www.example.com/?page=server-faq">
  1049. <link rev="subsection" href="/products/server" title="Foo Server">
  1050. ]]></programlisting>
  1051. </example>
  1052. </sect4>
  1053. <sect4 id="zend.view.helpers.initial.navigation.menu">
  1054. <title>Menu Helfer</title>
  1055. <para>
  1056. Der Menu Helfer wird für die Darstellung von Menüs aus Navigations Containern
  1057. verwendet. Standardmäßig wird das Menü durch Verwendung der HTML Tags
  1058. <code>UL</code> und <code>LI</code> dargestellt. Der Helfer erlaubt aber auch
  1059. die Verwendung eines partiellen View Skripts.
  1060. </para>
  1061. <para>
  1062. Methoden im Menu Helfer:
  1063. </para>
  1064. <itemizedlist>
  1065. <listitem>
  1066. <para>
  1067. <code>{get|set}UlClass()</code> empfängt/setzt die <acronym>CSS</acronym> Klasse
  1068. zur Verwendung in <methodname>renderMenu()</methodname>.
  1069. </para>
  1070. </listitem>
  1071. <listitem>
  1072. <para>
  1073. <code>{get|set}OnlyActiveBranch()</code> empfängt/setzt ein Flag das
  1074. spezifiziert ob der aktive Zweig eines Containers dargestellt werden soll.
  1075. </para>
  1076. </listitem>
  1077. <listitem>
  1078. <para>
  1079. <code>{get|set}RenderParents()</code> empfängt/setzt ein Flag das
  1080. spezifiziert ob Eltern nur dargestellt werden sollen wenn nur der aktive
  1081. Zweig eines Containers dargestellt wird. Wenn es auf <constant>FALSE</constant>
  1082. gesetzt wird, wird nur das tiefste aktive Menü dargestellt.
  1083. </para>
  1084. </listitem>
  1085. <listitem>
  1086. <para>
  1087. <code>{get|set}Partial()</code> empfängt/setzt ein partielles View Skript
  1088. das für die Darstellung des Menüs verwendet werden soll. Wenn ein partielles
  1089. Skript gesetzt ist, verwendet die <methodname>render()</methodname> Methode des
  1090. Helfers die <methodname>renderPartial()</methodname> Methode. Wenn kein
  1091. Partieller gesetzt ist, wird die <methodname>renderMenu()</methodname> Methode
  1092. verwendet. Der Helfer erwartet das der Partielle ein <type>String</type>, oder
  1093. ein <type>Array</type> mit zwei Elementen, ist. Wenn der Partielle ein
  1094. <type>String</type> ist bezeichnet er den Namen des partiellen Skripts das zu
  1095. verwenden ist. Wenn er ein <type>Array</type> ist wird das erste Element als
  1096. Name des partiellen View Skripts verwendet, und das zweite Element ist das Modul
  1097. indem das Skript gefunden wird.
  1098. </para>
  1099. </listitem>
  1100. <listitem>
  1101. <para>
  1102. <methodname>htmlify()</methodname> überschreibt die Methode der abstrakten
  1103. Klasse damit <code>span</code> Elemente zurückgegeben werden wenn die Seite kein
  1104. <code>href</code> hat.
  1105. </para>
  1106. </listitem>
  1107. <listitem>
  1108. <para>
  1109. <methodname>renderMenu($container = null, $options = array())</methodname> ist
  1110. eine standardmäßige render Methode, und stellt einen Container als HTML
  1111. <code>UL</code> Liste dar.
  1112. </para>
  1113. <para>
  1114. Wenn <varname>$container</varname> nicht angegeben wird, wird der Container der
  1115. im Helfer registriert ist dargestellt.
  1116. </para>
  1117. <para>
  1118. <varname>$options</varname> wird verwendet um temporär spezifizierte Optionen zu
  1119. überschreiben ohne das die Werte in der Helferinstanz resetiert werden. Es
  1120. ist ein assoziatives Array wobei jeder Schlüssel mit einer Option im Helfer
  1121. korrespondiert.
  1122. </para>
  1123. <para>
  1124. Erkannte Optionen:
  1125. </para>
  1126. <itemizedlist>
  1127. <listitem>
  1128. <para>
  1129. <code>indent</code>; Einrückung. Erwartet einen <type>String</type>
  1130. oder einen <code>int</code> Wert.
  1131. </para>
  1132. </listitem>
  1133. <listitem>
  1134. <para>
  1135. <code>minDepth</code>; Minimale Tiefe. Erwartet ein
  1136. <code>int</code> oder <constant>NULL</constant> (keine minimale
  1137. Tiefe).
  1138. </para>
  1139. </listitem>
  1140. <listitem>
  1141. <para>
  1142. <code>maxDepth</code>; Maximale Tiefe. Erwartet ein
  1143. <code>int</code> oder <constant>NULL</constant> (keine maximale
  1144. Tiefe).
  1145. </para>
  1146. </listitem>
  1147. <listitem>
  1148. <para>
  1149. <code>ulClass</code>; <acronym>CSS</acronym> Klasse für das
  1150. <code>ul</code> Element. Erwartet einen <type>String</type>.
  1151. </para>
  1152. </listitem>
  1153. <listitem>
  1154. <para>
  1155. <code>onlyActiveBranch</code>; Ob nur der aktive Branch dargestellt
  1156. werden soll. Erwartet einen <type>Boolean</type> Wert.
  1157. </para>
  1158. </listitem>
  1159. <listitem>
  1160. <para>
  1161. <code>renderParents</code>; Ob eltern dargestellt werden sollen
  1162. wenn nur der aktive Branch dargestellt wird. Erwartet einen
  1163. <type>Boolean</type> Wert.
  1164. </para>
  1165. </listitem>
  1166. </itemizedlist>
  1167. <para>
  1168. Wenn keine Option angegeben wird, werden die Werte die im Helfer gesetzt
  1169. sind verwendet.
  1170. </para>
  1171. </listitem>
  1172. <listitem>
  1173. <para>
  1174. <methodname>renderPartial()</methodname> wird für die Darstellung des Menüs in
  1175. einem partiellen View Skript verwendet.
  1176. </para>
  1177. </listitem>
  1178. <listitem>
  1179. <para>
  1180. <methodname>renderSubMenu()</methodname> stellt das tiefste Menü Level des
  1181. aktiven Branches eines Containers dar.
  1182. </para>
  1183. </listitem>
  1184. </itemizedlist>
  1185. <example id="zend.view.helpers.initial.navigation.menu.example1">
  1186. <title>Darstellung eines Menüs</title>
  1187. <para>
  1188. Dieses Beispiel zeigt wie ein Menü von einem registrierten/im View Helfer
  1189. gefundenen Container, dargestellt wird. Es ist zu beachten das Seiten basierend
  1190. auf Ihrer Sichtbarkeit und <acronym>ACL</acronym> ausgefiltert werden.
  1191. </para>
  1192. <programlisting language="php"><![CDATA[
  1193. In einem View Skript oder Layout:
  1194. <?php echo $this->navigation()->menu()->render() ?>
  1195. Oder einfach:
  1196. <?php echo $this->navigation()->menu() ?>
  1197. Ausgabe:
  1198. <ul class="navigation">
  1199. <li>
  1200. <a title="Geh zu Home" href="/">Home</a>
  1201. </li>
  1202. <li class="active">
  1203. <a href="/products">Produkte</a>
  1204. <ul>
  1205. <li class="active">
  1206. <a href="/products/server">Foo Server</a>
  1207. <ul>
  1208. <li class="active">
  1209. <a href="/products/server/faq">FAQ</a>
  1210. </li>
  1211. <li>
  1212. <a href="/products/server/editions">Editionen</a>
  1213. </li>
  1214. <li>
  1215. <a href="/products/server/requirements">System Anforderungen</a>
  1216. </li>
  1217. </ul>
  1218. </li>
  1219. <li>
  1220. <a href="/products/studio">Foo Studio</a>
  1221. <ul>
  1222. <li>
  1223. <a href="/products/studio/customers">Kunden Stories</a>
  1224. </li>
  1225. <li>
  1226. <a href="/prodcts/studio/support">Support</a>
  1227. </li>
  1228. </ul>
  1229. </li>
  1230. </ul>
  1231. </li>
  1232. <li>
  1233. <a title="About us" href="/company/about">Firma</a>
  1234. <ul>
  1235. <li>
  1236. <a href="/company/about/investors">Investor Relations</a>
  1237. </li>
  1238. <li>
  1239. <a class="rss" href="/company/news">News</a>
  1240. <ul>
  1241. <li>
  1242. <a href="/company/news/press">Für die Presse</a>
  1243. </li>
  1244. <li>
  1245. <a href="/archive">Archiv</a>
  1246. </li>
  1247. </ul>
  1248. </li>
  1249. </ul>
  1250. </li>
  1251. <li>
  1252. <a href="/community">Community</a>
  1253. <ul>
  1254. <li>
  1255. <a href="/community/account">Mein Account</a>
  1256. </li>
  1257. <li>
  1258. <a class="external" href="http://forums.example.com/">Forums</a>
  1259. </li>
  1260. </ul>
  1261. </li>
  1262. </ul>
  1263. ]]></programlisting>
  1264. </example>
  1265. <example id="zend.view.helpers.initial.navigation.menu.example2">
  1266. <title>renderMenu() direkt aufrufen</title>
  1267. <para>
  1268. Dieses Beispiel zeigt wie ein Menü dargestellt werden kann das nicht im View
  1269. Helfer registriert ist, indem <methodname>renderMenu()</methodname> direkt
  1270. aufgerufen wird und ein paar wenige Optionen spezifiziert werden.
  1271. </para>
  1272. <programlisting language="php"><![CDATA[
  1273. <?php
  1274. // Nur das 'Community' Menü darstellen
  1275. $community = $this->navigation()->findOneByLabel('Community');
  1276. $options = array(
  1277. 'indent' => 16,
  1278. 'ulClass' => 'community'
  1279. );
  1280. echo $this->navigation()
  1281. ->menu()
  1282. ->renderMenu($community, $options);
  1283. ?>
  1284. Output:
  1285. <ul class="community">
  1286. <li>
  1287. <a href="/community/account">Mein Account</a>
  1288. </li>
  1289. <li>
  1290. <a class="external" href="http://forums.example.com/">Forums</a>
  1291. </li>
  1292. </ul>
  1293. ]]></programlisting>
  1294. </example>
  1295. <example id="zend.view.helpers.initial.navigation.menu.example3">
  1296. <title>Das tiefste aktive Menü darstellen</title>
  1297. <para>
  1298. Dieses Beispiel zeigt wie <methodname>renderSubMenu()</methodname> das tiefste
  1299. Untermenü des aktiven Branches dargestellt wird.
  1300. </para>
  1301. <para>
  1302. Der Aufruf von <methodname>renderSubMenu($container, $ulClass, $indent)</methodname>
  1303. ist identisch mit dem Aufruf von
  1304. <methodname>renderMenu($container, $options)</methodname> mit den folgenden
  1305. Optionen:
  1306. </para>
  1307. <programlisting language="php"><![CDATA[
  1308. array(
  1309. 'ulClass' => $ulClass,
  1310. 'indent' => $indent,
  1311. 'minDepth' => null,
  1312. 'maxDepth' => null,
  1313. 'onlyActiveBranch' => true,
  1314. 'renderParents' => false
  1315. );
  1316. ]]></programlisting>
  1317. <programlisting language="php"><![CDATA[
  1318. <?php
  1319. echo $this->navigation()
  1320. ->menu()
  1321. ->renderSubMenu(null, 'sidebar', 4);
  1322. ?>
  1323. Die Ausgabe ist die gleiche wenn 'FAQ' oder 'Foo Server' aktiv sind:
  1324. <ul class="sidebar">
  1325. <li class="active">
  1326. <a href="/products/server/faq">FAQ</a>
  1327. </li>
  1328. <li>
  1329. <a href="/products/server/editions">Editionen</a>
  1330. </li>
  1331. <li>
  1332. <a href="/products/server/requirements">System Anforderungen</a>
  1333. </li>
  1334. </ul>
  1335. ]]></programlisting>
  1336. </example>
  1337. <example id="zend.view.helpers.initial.navigation.menu.example4">
  1338. <title>Darstellung eines Menüs mit maximaler Tiefe</title>
  1339. <programlisting language="php"><![CDATA[
  1340. <?php
  1341. echo $this->navigation()
  1342. ->menu()
  1343. ->setMaxDepth(1);
  1344. ?>
  1345. Ausgabe:
  1346. <ul class="navigation">
  1347. <li>
  1348. <a title="Geh zu Home" href="/">Home</a>
  1349. </li>
  1350. <li class="active">
  1351. <a href="/products">Produkte</a>
  1352. <ul>
  1353. <li class="active">
  1354. <a href="/products/server">Foo Server</a>
  1355. </li>
  1356. <li>
  1357. <a href="/products/studio">Foo Studio</a>
  1358. </li>
  1359. </ul>
  1360. </li>
  1361. <li>
  1362. <a title="About us" href="/company/about">Firma</a>
  1363. <ul>
  1364. <li>
  1365. <a href="/company/about/investors">Investor Relations</a>
  1366. </li>
  1367. <li>
  1368. <a class="rss" href="/company/news">News</a>
  1369. </li>
  1370. </ul>
  1371. </li>
  1372. <li>
  1373. <a href="/community">Community</a>
  1374. <ul>
  1375. <li>
  1376. <a href="/community/account">Mein Account</a>
  1377. </li>
  1378. <li>
  1379. <a class="external" href="http://forums.example.com/">Forums</a>
  1380. </li>
  1381. </ul>
  1382. </li>
  1383. </ul>
  1384. ]]></programlisting>
  1385. </example>
  1386. <example id="zend.view.helpers.initial.navigation.menu.example5">
  1387. <title>Darstellung eines Menüs mit minimaler Tiefe</title>
  1388. <programlisting language="php"><![CDATA[
  1389. <?php
  1390. echo $this->navigation()
  1391. ->menu()
  1392. ->setMinDepth(1);
  1393. ?>
  1394. Ausgabe:
  1395. <ul class="navigation">
  1396. <li class="active">
  1397. <a href="/products/server">Foo Server</a>
  1398. <ul>
  1399. <li class="active">
  1400. <a href="/products/server/faq">FAQ</a>
  1401. </li>
  1402. <li>
  1403. <a href="/products/server/editions">Editionen</a>
  1404. </li>
  1405. <li>
  1406. <a href="/products/server/requirements">System Anforderungen</a>
  1407. </li>
  1408. </ul>
  1409. </li>
  1410. <li>
  1411. <a href="/products/studio">Foo Studio</a>
  1412. <ul>
  1413. <li>
  1414. <a href="/products/studio/customers">Kunden Stories</a>
  1415. </li>
  1416. <li>
  1417. <a href="/prodcts/studio/support">Support</a>
  1418. </li>
  1419. </ul>
  1420. </li>
  1421. <li>
  1422. <a href="/company/about/investors">Investor Relations</a>
  1423. </li>
  1424. <li>
  1425. <a class="rss" href="/company/news">News</a>
  1426. <ul>
  1427. <li>
  1428. <a href="/company/news/press">Für die Presse</a>
  1429. </li>
  1430. <li>
  1431. <a href="/archive">Archiv</a>
  1432. </li>
  1433. </ul>
  1434. </li>
  1435. <li>
  1436. <a href="/community/account">Mein Account</a>
  1437. </li>
  1438. <li>
  1439. <a class="external" href="http://forums.example.com/">Forums</a>
  1440. </li>
  1441. </ul>
  1442. ]]></programlisting>
  1443. </example>
  1444. <example id="zend.view.helpers.initial.navigation.menu.example6">
  1445. <title>Nur den aktiven Branch eines Menüs darstellen</title>
  1446. <programlisting language="php"><![CDATA[
  1447. <?php
  1448. echo $this->navigation()
  1449. ->menu()
  1450. ->setOnlyActiveBranch(true);
  1451. ?>
  1452. Ausgabe:
  1453. <ul class="navigation">
  1454. <li class="active">
  1455. <a href="/products">Produkte</a>
  1456. <ul>
  1457. <li class="active">
  1458. <a href="/products/server">Foo Server</a>
  1459. <ul>
  1460. <li class="active">
  1461. <a href="/products/server/faq">FAQ</a>
  1462. </li>
  1463. <li>
  1464. <a href="/products/server/editions">Editionen</a>
  1465. </li>
  1466. <li>
  1467. <a href="/products/server/requirements">System Anforderungen</a>
  1468. </li>
  1469. </ul>
  1470. </li>
  1471. </ul>
  1472. </li>
  1473. </ul>
  1474. ]]></programlisting>
  1475. </example>
  1476. <example id="zend.view.helpers.initial.navigation.menu.example7">
  1477. <title>
  1478. Nur den aktiven Branch eines Menüs mit minimaler Tiefe darstellen
  1479. </title>
  1480. <programlisting language="php"><![CDATA[
  1481. <?php
  1482. echo $this->navigation()
  1483. ->menu()
  1484. ->setOnlyActiveBranch(true)
  1485. ->setMinDepth(1);
  1486. ?>
  1487. Ausgabe:
  1488. <ul class="navigation">
  1489. <li class="active">
  1490. <a href="/products/server">Foo Server</a>
  1491. <ul>
  1492. <li class="active">
  1493. <a href="/products/server/faq">FAQ</a>
  1494. </li>
  1495. <li>
  1496. <a href="/products/server/editions">Editionen</a>
  1497. </li>
  1498. <li>
  1499. <a href="/products/server/requirements">System Anforderungen</a>
  1500. </li>
  1501. </ul>
  1502. </li>
  1503. </ul>
  1504. ]]></programlisting>
  1505. </example>
  1506. <example id="zend.view.helpers.initial.navigation.menu.example8">
  1507. <title>
  1508. Nur den aktiven Branch eines Menüs mit maximaler Tiefe darstellen
  1509. </title>
  1510. <programlisting language="php"><![CDATA[
  1511. <?php
  1512. echo $this->navigation()
  1513. ->menu()
  1514. ->setOnlyActiveBranch(true)
  1515. ->setMaxDepth(1);
  1516. ?>
  1517. Ausgabe:
  1518. <ul class="navigation">
  1519. <li class="active">
  1520. <a href="/products">Produkte</a>
  1521. <ul>
  1522. <li class="active">
  1523. <a href="/products/server">Foo Server</a>
  1524. </li>
  1525. <li>
  1526. <a href="/products/studio">Foo Studio</a>
  1527. </li>
  1528. </ul>
  1529. </li>
  1530. </ul>
  1531. ]]></programlisting>
  1532. </example>
  1533. <example id="zend.view.helpers.initial.navigation.menu.example9">
  1534. <title>
  1535. Nur den aktiven Branch eines Menüs mit maximaler Tiefe aber ohne Eltern darstellen
  1536. </title>
  1537. <para>
  1538. </para>
  1539. <programlisting language="php"><![CDATA[
  1540. <?php
  1541. echo $this->navigation()
  1542. ->menu()
  1543. ->setOnlyActiveBranch(true)
  1544. ->setRenderParents(false)
  1545. ->setMaxDepth(1);
  1546. ?>
  1547. Ausgabe:
  1548. <ul class="navigation">
  1549. <li class="active">
  1550. <a href="/products/server">Foo Server</a>
  1551. </li>
  1552. <li>
  1553. <a href="/products/studio">Foo Studio</a>
  1554. </li>
  1555. </ul>
  1556. ]]></programlisting>
  1557. </example>
  1558. <example id="zend.view.helpers.initial.navigation.menu.example10">
  1559. <title>
  1560. Darstellen eines eigenen Menüs durch Verwendung eines partiellen View Skripts
  1561. </title>
  1562. <para>
  1563. Dieses Beispiel zeigt wie ein eigenes Menü, durch Verwendung eines partiellen View
  1564. Skripts, dargestellt werden kann. Durch Aufruf von
  1565. <methodname>setPartial()</methodname> kann ein partielles View Skript spezifiziert
  1566. werden das verwendet wird wenn man <methodname>render()</methodname> aufruft. Wenn
  1567. ein Partielles spezifiziert ist, wird die <methodname>renderPartial()</methodname>
  1568. Methode aufgerufen. Diese Methode fügt den Container in die View ein, und verwendet
  1569. hierbei den Schlüssel <code>container</code>.
  1570. </para>
  1571. <para>In a layout:</para>
  1572. <programlisting language="php"><![CDATA[
  1573. $partial = array('menu.phtml', 'default');
  1574. $this->navigation()->menu()->setPartial($partial);
  1575. echo $this->navigation()->menu()->render();
  1576. ]]></programlisting>
  1577. <para>In application/modules/default/views/menu.phtml:</para>
  1578. <programlisting language="php"><![CDATA[
  1579. foreach ($this->container as $page) {
  1580. echo $this->navigation()->menu()->htmlify($page), PHP_EOL;
  1581. }
  1582. ]]></programlisting>
  1583. <para>Ausgabe:</para>
  1584. <programlisting language="php"><![CDATA[
  1585. <a title="Geh zu Home" href="/">Home</a>
  1586. <a href="/products">Produkte</a>
  1587. <a title="About us" href="/company/about">Firma</a>
  1588. <a href="/community">Community</a>
  1589. ]]></programlisting>
  1590. </example>
  1591. </sect4>
  1592. <sect4 id="zend.view.helpers.initial.navigation.sitemap">
  1593. <title>Sitemap Helfer</title>
  1594. <para>
  1595. Der Sitemap Helfer wird für die Erzeugung von <acronym>XML</acronym> Sitemaps verwendet
  1596. wie im <ulink url="http://www.sitemaps.org/protocol.php">Sitemaps <acronym>XML</acronym>
  1597. Format</ulink> definiert. Mehr darüber kann unter <ulink
  1598. url="http://en.wikipedia.org/wiki/Sitemaps"> Sitemaps in Wikipedia</ulink>
  1599. nachgelesen werden.
  1600. </para>
  1601. <para>
  1602. Standardmäßig verwendet der Sitemap Helfer
  1603. <link linkend="zend.validate.sitemap">Sitemap Prüfungen</link> um jedes Element zu
  1604. prüfen das dargestellt werden soll. Das kann deaktiviert werden indem man
  1605. <code>$helper->setUseSitemapValidators(false)</code> aufruft.
  1606. </para>
  1607. <note>
  1608. <para>
  1609. Wenn man die Sitemap Prüfungen deaktiviert, werden die eigenen Eigenschaften
  1610. (siehe Tabelle) nicht geprüft.
  1611. </para>
  1612. </note>
  1613. <para>
  1614. Der Sitemap Helfer unterstützt auch die Pürfung von
  1615. <ulink url="http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">Sitemap XSD
  1616. Schemas</ulink> der erzeugten Sitemap. Das ist standardmäßig deaktiviert, da es eine
  1617. Anfrage auf die Schema Datei benötigt. Es kann mit
  1618. <code>$helper->setUseSchemaValidation(true)</code> aktiviert werden.
  1619. </para>
  1620. <table id="zend.view.helpers.initial.navigation.sitemap.elements">
  1621. <title>Sitemap XML Elemente</title>
  1622. <tgroup cols="2">
  1623. <thead>
  1624. <row>
  1625. <entry>Element</entry>
  1626. <entry>Beschreibung</entry>
  1627. </row>
  1628. </thead>
  1629. <tbody>
  1630. <row>
  1631. <entry><code>loc</code></entry>
  1632. <entry>
  1633. Absolute <acronym>URL</acronym> zur Seite. Eine absolute
  1634. <acronym>URL</acronym> wird vom Helfer erzeugt.
  1635. </entry>
  1636. </row>
  1637. <row>
  1638. <entry><code>lastmod</code></entry>
  1639. <entry>
  1640. <para>
  1641. Das Datum der letzten Änderung der Datei, im
  1642. <ulink url="http://www.w3.org/TR/NOTE-datetime">W3C
  1643. Datetime</ulink> Format. Dieser Zeitabschnitt kann bei Bedarf
  1644. unterdrückt, und nur YYYY-MM-DD verwendet werden.
  1645. </para>
  1646. <para>
  1647. Der Helfer versucht den <code>lastmod</code> Wert von der
  1648. Seiteneigenschaft <code>lastmod</code> zu erhalten wenn diese auf
  1649. der Seite gesetzt ist. Wenn der Wert kein gültiges Datum ist, wird
  1650. er ignoriert.
  1651. </para>
  1652. </entry>
  1653. </row>
  1654. <row>
  1655. <entry><code>changefreq</code></entry>
  1656. <entry>
  1657. <para>
  1658. Wie oft eine Seite geändert wird. Dieser Wert bietet eine generelle
  1659. Information für Suchmaschinen und muß nicht exakt mit der Anzahl
  1660. der Suchen auf der Seite übereinstimmen. Gültige Werte sind:
  1661. </para>
  1662. <itemizedlist>
  1663. <listitem><para>always</para></listitem>
  1664. <listitem><para>hourly</para></listitem>
  1665. <listitem><para>daily</para></listitem>
  1666. <listitem><para>weekly</para></listitem>
  1667. <listitem><para>monthly</para></listitem>
  1668. <listitem><para>yearly</para></listitem>
  1669. <listitem><para>never</para></listitem>
  1670. </itemizedlist>
  1671. <para>
  1672. Der Helfer versucht den <code>changefreq</code> Wert von der
  1673. Seiteneigenschaft <code>changefreq</code> zu erhalten, wenn diese
  1674. auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird er
  1675. ignoriert.
  1676. </para>
  1677. </entry>
  1678. </row>
  1679. <row>
  1680. <entry><code>priority</code></entry>
  1681. <entry>
  1682. <para>
  1683. Die Priorität dieser <acronym>URL</acronym> relativ zu anderen
  1684. <acronym>URL</acronym>s auf der eigenen Site. Der gültige Bereich
  1685. für diesen Wert ist von 0.0 bis 1.0.
  1686. </para>
  1687. <para>
  1688. Der Helfer versucht den <code>priority</code> Wert von der
  1689. Seiteneigenschaft <code>priority</code> zu erhalten wenn dieser
  1690. auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird
  1691. er ignoriert.
  1692. </para>
  1693. </entry>
  1694. </row>
  1695. </tbody>
  1696. </tgroup>
  1697. </table>
  1698. <para>
  1699. Methoden im Sitemap Helfer:
  1700. </para>
  1701. <itemizedlist>
  1702. <listitem>
  1703. <para>
  1704. <code>{get|set}FormatOutput()</code> empfängt/setzt ein Flag das anzeigt ob
  1705. <acronym>XML</acronym> Ausgaben formatiert werden sollen. Das entspricht der
  1706. Eigenschaft <code>formatOutput</code> der nativen
  1707. <classname>DOMDocument</classname> Klasse. Mehr kann man unter <ulink
  1708. url="http://php.net/domdocument">PHP: DOMDocument - Handbuch</ulink>
  1709. nachlesen. Der Standardwert ist <constant>FALSE</constant>.
  1710. </para>
  1711. </listitem>
  1712. <listitem>
  1713. <para>
  1714. <code>{get|set}UseXmlDeclaration()</code> empfängt/setzt ein Flag das
  1715. anzeigt ob die <acronym>XML</acronym> Deklaration bei der Darstellung enthalten
  1716. sein soll. Der Standardwert ist <constant>TRUE</constant>.
  1717. </para>
  1718. </listitem>
  1719. <listitem>
  1720. <para>
  1721. <code>{get|set}UseSitemapValidators()</code> empfängt/setzt ein Flag das
  1722. anzeigt ob Sitemap Prüfungen verwendet werden sollen wenn die DOM Sitemap
  1723. dargestellt werden soll. Der Standardwert ist <constant>TRUE</constant>.
  1724. </para>
  1725. </listitem>
  1726. <listitem>
  1727. <para>
  1728. <code>{get|set}UseSchemaValidation()</code> empfängt/setzt ein Flag das
  1729. anzeigt ob der Helfer eine <acronym>XML</acronym> Schema Prüfung verwenden soll
  1730. wenn die DOM Sitemap erzeugt wird. Der Standardwert ist
  1731. <constant>FALSE</constant>.
  1732. </para>
  1733. </listitem>
  1734. <listitem>
  1735. <para>
  1736. <code>{get|set}ServerUrl()</code> empfängt/setzt die Server
  1737. <acronym>URL</acronym> die nicht-absoluten <acronym>URL</acronym>s in der
  1738. <methodname>url()</methodname> Methode vorangestellt werden. Wenn keine Server
  1739. <acronym>URL</acronym> spezifiziert ist, wird diese vom Helfer festgestellt.
  1740. </para>
  1741. </listitem>
  1742. <listitem>
  1743. <para>
  1744. <methodname>url()</methodname> wird verwendet um absolute
  1745. <acronym>URL</acronym>s zu Seiten zu erstellen.
  1746. </para>
  1747. </listitem>
  1748. <listitem>
  1749. <para>
  1750. <methodname>getDomSitemap()</methodname> erzeugt ein DOMDocument von einem
  1751. angegebenen Container.
  1752. </para>
  1753. </listitem>
  1754. </itemizedlist>
  1755. <example id="zend.view.helpers.initial.navigation.sitemap.example">
  1756. <title>Eine XML Sitemap darstellen</title>
  1757. <para>
  1758. Dieses Beispiel zeigt wie eine <acronym>XML</acronym> Sitemap, basierend auf dem
  1759. Setup das wir vorher angegeben haben, dargestellt wird.
  1760. </para>
  1761. <programlisting language="php"><![CDATA[
  1762. // In einem View Skript oder Layout:
  1763. // Ausgabeformat
  1764. $this->navigation()
  1765. ->sitemap()
  1766. ->setFormatOutput(true); // Standardwert ist false
  1767. // Andere mögliche Methoden:
  1768. // ->setUseXmlDeclaration(false); // Standardwert ist true
  1769. // ->setServerUrl('http://my.otherhost.com');
  1770. // Standard ist die automatische Erkennung
  1771. // Sitemap ausdrucken
  1772. echo $this->navigation()->sitemap();
  1773. ]]></programlisting>
  1774. <para>
  1775. Es ist zu beachten wie Seiten die unsichtbar oder Seiten mit <acronym>ACL</acronym>
  1776. Rollen die mit dem View Helfer inkompatibel sin, ausgefiltert werden:
  1777. </para>
  1778. <programlisting language="xml"><![CDATA[
  1779. <?xml version="1.0" encoding="UTF-8"?>
  1780. <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  1781. <url>
  1782. <loc>http://www.example.com/</loc>
  1783. </url>
  1784. <url>
  1785. <loc>http://www.example.com/products</loc>
  1786. </url>
  1787. <url>
  1788. <loc>http://www.example.com/products/server</loc>
  1789. </url>
  1790. <url>
  1791. <loc>http://www.example.com/products/server/faq</loc>
  1792. </url>
  1793. <url>
  1794. <loc>http://www.example.com/products/server/editions</loc>
  1795. </url>
  1796. <url>
  1797. <loc>http://www.example.com/products/server/requirements</loc>
  1798. </url>
  1799. <url>
  1800. <loc>http://www.example.com/products/studio</loc>
  1801. </url>
  1802. <url>
  1803. <loc>http://www.example.com/products/studio/customers</loc>
  1804. </url>
  1805. <url>
  1806. <loc>http://www.example.com/prodcts/studio/support</loc>
  1807. </url>
  1808. <url>
  1809. <loc>http://www.example.com/company/about</loc>
  1810. </url>
  1811. <url>
  1812. <loc>http://www.example.com/company/about/investors</loc>
  1813. </url>
  1814. <url>
  1815. <loc>http://www.example.com/company/news</loc>
  1816. </url>
  1817. <url>
  1818. <loc>http://www.example.com/company/news/press</loc>
  1819. </url>
  1820. <url>
  1821. <loc>http://www.example.com/archive</loc>
  1822. </url>
  1823. <url>
  1824. <loc>http://www.example.com/community</loc>
  1825. </url>
  1826. <url>
  1827. <loc>http://www.example.com/community/account</loc>
  1828. </url>
  1829. <url>
  1830. <loc>http://forums.example.com/</loc>
  1831. </url>
  1832. </urlset>
  1833. ]]></programlisting>
  1834. <para>
  1835. Die Sitemap ohne Verwendung einer <acronym>ACL</acronym> Rolle darstellen (sollte
  1836. /community/account ausfiltern):
  1837. </para>
  1838. <programlisting language="php"><![CDATA[
  1839. echo $this->navigation()
  1840. ->sitemap()
  1841. ->setFormatOutput(true)
  1842. ->setRole();
  1843. ]]></programlisting>
  1844. <programlisting language="xml"><![CDATA[
  1845. <?xml version="1.0" encoding="UTF-8"?>
  1846. <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  1847. <url>
  1848. <loc>http://www.example.com/</loc>
  1849. </url>
  1850. <url>
  1851. <loc>http://www.example.com/products</loc>
  1852. </url>
  1853. <url>
  1854. <loc>http://www.example.com/products/server</loc>
  1855. </url>
  1856. <url>
  1857. <loc>http://www.example.com/products/server/faq</loc>
  1858. </url>
  1859. <url>
  1860. <loc>http://www.example.com/products/server/editions</loc>
  1861. </url>
  1862. <url>
  1863. <loc>http://www.example.com/products/server/requirements</loc>
  1864. </url>
  1865. <url>
  1866. <loc>http://www.example.com/products/studio</loc>
  1867. </url>
  1868. <url>
  1869. <loc>http://www.example.com/products/studio/customers</loc>
  1870. </url>
  1871. <url>
  1872. <loc>http://www.example.com/prodcts/studio/support</loc>
  1873. </url>
  1874. <url>
  1875. <loc>http://www.example.com/company/about</loc>
  1876. </url>
  1877. <url>
  1878. <loc>http://www.example.com/company/about/investors</loc>
  1879. </url>
  1880. <url>
  1881. <loc>http://www.example.com/company/news</loc>
  1882. </url>
  1883. <url>
  1884. <loc>http://www.example.com/company/news/press</loc>
  1885. </url>
  1886. <url>
  1887. <loc>http://www.example.com/archive</loc>
  1888. </url>
  1889. <url>
  1890. <loc>http://www.example.com/community</loc>
  1891. </url>
  1892. <url>
  1893. <loc>http://forums.example.com/</loc>
  1894. </url>
  1895. </urlset>
  1896. ]]></programlisting>
  1897. <para>
  1898. Darstellen der Sitemap mit Verwendung einer maximalen Tiefe von 1.
  1899. </para>
  1900. <programlisting language="php"><![CDATA[
  1901. echo $this->navigation()
  1902. ->sitemap()
  1903. ->setFormatOutput(true)
  1904. ->setMaxDepth(1);
  1905. ]]></programlisting>
  1906. <programlisting language="xml"><![CDATA[
  1907. <?xml version="1.0" encoding="UTF-8"?>
  1908. <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  1909. <url>
  1910. <loc>http://www.example.com/</loc>
  1911. </url>
  1912. <url>
  1913. <loc>http://www.example.com/products</loc>
  1914. </url>
  1915. <url>
  1916. <loc>http://www.example.com/products/server</loc>
  1917. </url>
  1918. <url>
  1919. <loc>http://www.example.com/products/studio</loc>
  1920. </url>
  1921. <url>
  1922. <loc>http://www.example.com/company/about</loc>
  1923. </url>
  1924. <url>
  1925. <loc>http://www.example.com/company/about/investors</loc>
  1926. </url>
  1927. <url>
  1928. <loc>http://www.example.com/company/news</loc>
  1929. </url>
  1930. <url>
  1931. <loc>http://www.example.com/community</loc>
  1932. </url>
  1933. <url>
  1934. <loc>http://www.example.com/community/account</loc>
  1935. </url>
  1936. <url>
  1937. <loc>http://forums.example.com/</loc>
  1938. </url>
  1939. </urlset>
  1940. ]]></programlisting>
  1941. </example>
  1942. <note>
  1943. <title>Standardmäßig wird die UTF-8 Kodierung verwendet</title>
  1944. <para>
  1945. Standardmäßig verwendet Zend Framework <acronym>UTF-8</acronym> als seine
  1946. Standardkodierung, und speziell in diesem Fall, macht das
  1947. <classname>Zend_View</classname> genauso. Die Zeichenkodierung kann im View Objekt
  1948. selbst auf etwas anderes gesetzt werden indem die Methode
  1949. <methodname>setEncoding()</methodname> verwendet wird (oder der Parameter
  1950. <varname>encoding</varname> bei der Instanzierung angegeben wird). Trotzdem, da
  1951. <classname>Zend_View_Interface</classname> keine Zugriffsmethoden für die Kodierung
  1952. anbietet ist es möglich dass, wenn man eine eigene View Implementation verwendet,
  1953. man keine <methodname>getEncoding()</methodname> Methode hat, welche der View Helfer
  1954. intern für die Erkennung des Zeichensets verwendet in das kodiert werden soll.
  1955. </para>
  1956. <para>
  1957. Wenn man <acronym>UTF-8</acronym> in solch einer Situation nicht verwenden will,
  1958. muss man in der eigenen View Implementation eine
  1959. <methodname>getEncoding()</methodname> Methode implementieren.
  1960. </para>
  1961. </note>
  1962. </sect4>
  1963. <sect4 id="zend.view.helpers.initial.navigation.navigation">
  1964. <title>Navigation Helfer</title>
  1965. <para>
  1966. Der Navigation Helfer ist ein Proxy Helfer der Aufrufe zu anderen Navigations Helfern
  1967. durchführt. Er kann als Einstiegspunkt für alle navigations-basierenden View Tasks
  1968. verwendet werden. Die vorher erwähnten Navigations Helfer sind im Namespace
  1969. <classname>Zend_View_Helper_Navigation</classname> und würden es deshalb benötigen, den
  1970. Pfad <code>Zend/View/Helper/Navigation</code> als Helfer Pfad der View hinzuzufügen. Mit
  1971. dem Proxy Helfer der im <classname>Zend_View_Helper</classname> Namespace sitzt, ist er
  1972. immer vorhanden, ohne das irgendein Helfer Pfad an der View hinzugefügt werden muß.
  1973. </para>
  1974. <para>
  1975. Der Navigations Helfer findet andere Helfer die das
  1976. <classname>Zend_View_Helper_Navigation_Helper</classname> Interface implementieren,
  1977. was bedeuet das auch auf eigene View Helfer weitergeleitet wird. Das würde trotzdem
  1978. das Hinzufügen des eigenen Helfer Pfades zur View benötigen.
  1979. </para>
  1980. <para>
  1981. Wenn auf andere Helfer weitergeleitet wird, kann der Navigations Helfer seinen
  1982. Container, <acronym>ACL</acronym>/Rolle und Übersetzer injizieren. Das bedeutet weder
  1983. das man diese drei nicht explizit in allen navigatorischen Helfern setzen muß, noch das
  1984. diese in <classname>Zend_Registry</classname> oder in statische Methoden injiziert
  1985. werden muß.
  1986. </para>
  1987. <itemizedlist>
  1988. <listitem>
  1989. <para>
  1990. <methodname>findHelper()</methodname> findet alle angegebenen Helfer, prüft das
  1991. dieser ein navigatorischer Helfer ist, und injiziiert Container,
  1992. <acronym>ACL</acronym>/Rolle und Übersetzer.
  1993. </para>
  1994. </listitem>
  1995. <listitem>
  1996. <para>
  1997. <code>{get|set}InjectContainer()</code> empfängt/setzt ein Flag das anzeigt
  1998. ob der Container an weitergeleitete Helfer injiziiert werden soll. Der
  1999. Standardwert ist <constant>TRUE</constant>.
  2000. </para>
  2001. </listitem>
  2002. <listitem>
  2003. <para>
  2004. <code>{get|set}InjectAcl()</code> empfängt/setzt ein Flag das anzeigt ob die
  2005. <acronym>ACL</acronym>/Rolle an weitergeleitete Helfer injiziiert werden soll.
  2006. Der Standardwert ist <constant>TRUE</constant>.
  2007. </para>
  2008. </listitem>
  2009. <listitem>
  2010. <para>
  2011. <code>{get|set}InjectTranslator()</code> empfängt/setzt ein Flag das anzeigt
  2012. ob der Übersetzer an weitergeleitete Helfer injiziiert werden soll. Der
  2013. Standardwert ist <constant>TRUE</constant>.
  2014. </para>
  2015. </listitem>
  2016. <listitem>
  2017. <para>
  2018. <code>{get|set}DefaultProxy()</code> empfängt/setzt den Standard Proxy. Der
  2019. Standardwert ist <code>'menu'</code>.
  2020. </para>
  2021. </listitem>
  2022. <listitem>
  2023. <para>
  2024. <methodname>render()</methodname> leitet auf die render Methode des
  2025. Standardproxies weiter.
  2026. </para>
  2027. </listitem>
  2028. </itemizedlist>
  2029. </sect4>
  2030. </sect3>