Zend_View-Helpers-Navigation.xml 83 KB

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