Zend_View-Helpers-Navigation.xml 83 KB

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