| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!-- EN-Revision: 24249 -->
- <!-- Reviewed: no -->
- <sect3 id="zend.view.helpers.initial.navigation">
- <title>Navigations Helfer</title>
- <para>
- Die Navigations Helfer werden von
- <link linkend="zend.navigation.containers">Zend_Navigation_Container</link> für die
- Darstellung von Navigations Elementen verwendet.
- </para>
- <para>
- Es gibt 2 eingebaute Helfer:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <link
- linkend="zend.view.helpers.initial.navigation.breadcrumbs">Breadcrumbs</link>,
- wird für die Darstellung des Pfades der aktuell aktiven Seite verwendet.
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="zend.view.helpers.initial.navigation.links">Links</link>,
- wird für die Darstellung von Navigations Header Links (z.B.
- <command><link rel="next" href="..." /></command>) verwendet.
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="zend.view.helpers.initial.navigation.menu">Menu</link>,
- wird für die Darstellung von Menüs verwendet.
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="zend.view.helpers.initial.navigation.sitemap">Sitemap</link>,
- wird für die Darstellung von Sitemaps verwendet die dem
- <ulink url="http://www.sitemaps.org/protocol.php">Sitemaps <acronym>XML</acronym>
- Format</ulink> entsprechen.
- </para>
- </listitem>
- <listitem>
- <para>
- <link
- linkend="zend.view.helpers.initial.navigation.navigation">Navigation</link>,
- wird für die Weiterleitung von Aufrufen zu anderen Navigations Helfern
- verwendet.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- Alle eingebauten Helfer erweitern
- <classname>Zend_View_Helper_Navigation_HelperAbstract</classname>, welches die Integration
- von <link linkend="zend.acl">ACL</link> und <link
- linkend="zend.translate">Übersetzung</link> hinzufügt. Die abstrakte Klasse
- implementiert das Interface <classname>Zend_View_Helper_Navigation_Helper</classname>
- welches die folgenden Methoden definiert:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <methodname>getContainer()</methodname> und <methodname>setContainer()</methodname>
- empfängt/setzt den Navigations Container mit dem der Helfer standardmäßig arbeiten
- soll, und <methodname>hasContainer()</methodname> prüft ob der Helfer Container
- registriert hat.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>getTranslator()</methodname> und
- <methodname>setTranslator()</methodname> empfängt und setzt den Übersetzer der für
- die Übersetzung von Überschriften und Titelm verwendet wird, und
- <methodname>getUseTranslator()</methodname> sowie
- <methodname>setUseTranslator()</methodname> kontrollieren ob der Übersetzer
- aktiviert werden soll. Die Methode <methodname>hasTranslator()</methodname> prüft ob
- der Helfer einen Übersetzer registriert hat.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>getAcl()</methodname>, <methodname>setAcl()</methodname>,
- <methodname>getRole()</methodname> und <methodname>setRole()</methodname>
- empfangen und setzen <acronym>ACL</acronym> (<classname>Zend_Acl</classname>)
- Instanzen und Rollen (<type>String</type> oder
- <classname>Zend_Acl_Role_Interface</classname>) die bei der Darstellung für das
- Filtern von Seiten verwendet werden. <methodname>getUseAcl()</methodname> und
- <methodname>setUseAcl()</methodname> kontrolliert ob <acronym>ACL</acronym>
- aktiviert werden soll. Die Methoden <methodname>hasAcl()</methodname> und
- <methodname>hasRole()</methodname> prüfen ob der Helfer eine <acronym>ACL</acronym>
- Instanz oder Rolle registriert hat.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>__toString()</methodname>, die magische Methode stellt sicher das
- der Helfer, durch die direkte Ausgabe an der Instanz des Helfers, dargestellt
- werden kann.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>render()</methodname>, muß von konkreten Helfern implementiert
- werden um die Darstellung durchzuführen.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- Zusätzlich zu den Methoden die vom Interface kommen, implementiert die abstrakte Klasse
- die folgenden Methoden:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <methodname>getIndent()</methodname> und <methodname>setIndent()</methodname>
- empfängt und setzt die Einrückung. Der Setzer akzeptiert einen <type>String</type>
- oder ein <type>Integer</type>. Im Fall eines <type>Integer</type>'s verwendet der
- Helfer die angegebene Zahl als Leerzeichen für die Einrückung. Z.B. bedeutet
- <methodname>setIndent(4)</methodname> eine Einrückung von initial 4 Leerzeichen.
- Die Einrückung kann für alle Helfer außer dem Sitemap Helfer spezifiziert
- werden.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>getMinDepth()</methodname> und <methodname>setMinDepth()</methodname>
- empfängt und setzt die minimale Tiefe die eine Seite haben muß um vom Helfer
- eingefügt zu werden. Das Setzen von <constant>NULL</constant> bedeutet keine
- minimale Tiefe.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>getMaxDepth()</methodname> und <methodname>setMaxDepth()</methodname>
- empfängt und setzt die maximale Tiefe die eine Seite haben muß um vom Helfer
- eingefügt zu werden. Das Setzen von <constant>NULL</constant> bedeutet keine
- maximale Tiefe.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>getRenderInvisible()</methodname> und
- <methodname>setRenderInvisible()</methodname> empfängt und setzt ob Elemente die
- als unsichtbar markiert sind, dargestellt werden oder nicht.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>__call()</methodname> wird verwendet um Aufrufe zum Container, der
- im Helfer registriert ist, weiterzuleiten, was bedeutet das man Methoden in
- einem Helfer aufrufen kann wie wenn Sie im Container wären. Siehe das folgende
- <link
- linkend="zend.view.helpers.initial.navigation.proxy.example">Beispiel</link>.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>findActive($container, $minDepth, $maxDepth)</methodname> wird
- verwendet um die tiefste aktive Seite im angegebenen Container zu finden. Wenn
- keine Tiefe angegeben wird, verwendet diese Methode die Werte die sie von
- <methodname>getMinDepth()</methodname> und
- <methodname>getMaxDepth()</methodname> erhält. Die tiefste aktive Seite muß
- zwischen <varname>$minDepth</varname> und <varname>$maxDepth</varname> inklusive
- liegen. Gibt ein Array zurück das Referenzen zu der gefundenen Instanz der Seite
- enthält, und die Tiefe bei der die Seite gefunden wurde.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>htmlify()</methodname> stellt ein <emphasis>'a'</emphasis>
- <acronym>HTML</acronym> Element von einer
- <classname>Zend_Navigation_Page</classname> Instanz dar.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>accept()</methodname> wird verwendet um zu erkennen ub eine Seite
- akzeptiert werden soll wenn durch Container iteriert wird. Diese Methode prüft
- die Sichtbarkeit der Seite und verifiziert das die Rolle des Helfers auf die
- Ressourcen und Privilegien der Seite zugreifen darf.
- </para>
- </listitem>
- <listitem>
- <para>
- Die statische Methode <methodname>setDefaultAcl()</methodname> wird für das Setzen
- des standardmäßigen <acronym>ACL</acronym> Objekts verwendet, das dann von Helfern
- verwendet wird.
- </para>
- </listitem>
- <listitem>
- <para>
- Die statische Methode <methodname>setDefaultRole()</methodname> wird für das Setzen
- der standardmäßigen <acronym>ACL</acronym> verwendet, die dann von Helfern verwendet
- wird.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- Wenn ein Navigations Container nicht explizit in einem Helfer durch Verwendung von
- <command>$helper->setContainer($nav)</command> gesetzt ist, schaut der Helfer in
- <link linkend="zend.registry">der Registry</link> nach einer Container Instanz mit dem
- Schlüssel <classname>Zend_Navigation</classname>. Wenn ein Container nicht explizit gesetzt
- wurde, oder nicht in der Registry gefunden wird, erstellt der Helfer einen leeren
- <classname>Zend_Navigation</classname> Container wenn
- <command>$helper->getContainer()</command> aufgerufen wird.
- </para>
- <example id="zend.view.helpers.initial.navigation.proxy.example">
- <title>Aufrufe an den Navigations Container weiterleiten</title>
- <para>
- Navigations View Helfer verwenden die magisch <methodname>__call()</methodname> Methode
- um Methodenaufrufe an den Navigationscontainer weiterzuleiten der im View Helfer
- registriert ist.
- </para>
- <programlisting language="php"><![CDATA[
- $this->navigation()->addPage(array(
- 'type' => 'uri',
- 'label' => 'New page'));
- ]]></programlisting>
- <para>
- Der obige Aufruf fügt eine Seite zum Container im <classname>Navigation</classname>
- Helfer hinzu.
- </para>
- </example>
- <sect4 id="zend.view.helpers.initial.navigation.i18n">
- <title>Übersetzung von Labels und Titeln</title>
- <para>
- Der Navigations Helfer unterstützt die Übersetzung von SeitenLabels und Überschriften.
- Man kann einen Übersetzer vom Typ <classname>Zend_Translate</classname> oder
- <classname>Zend_Translate_Adapter</classname> im Helfer setzen indem
- <command>$helper->setTranslator($translator)</command> verwendet wird, oder wie in allen
- anderen I18n-fähigen Komponenten; durch das Hinzufügen des Übersetzers in
- <link linkend="zend.registry">die Registry</link> indem der Schlüssel
- <classname>Zend_Translate</classname> verwendet wird.
- </para>
- <para>
- Wenn man die Übersetzung ausschalten will, sollte man
- <command>$helper->setUseTranslator(false)</command> verwenden.
- </para>
- <para>
- Der <link linkend="zend.view.helpers.initial.navigation.navigation">Proxy Helfer</link>
- injiziert seinen eigenen Übersetzer in den Helfer auf den er weiterleitet wenn der
- weitergeleitete Helfer nicht bereits einen Übersetzer hat.
- </para>
- <note>
- <para>
- Es gibt keinen Übersetzer im Sitemap Helfer, da keine SeitenLabels oder
- Überschriften in einer <acronym>XML</acronym> Sitemap enthalten sind.
- </para>
- </note>
- </sect4>
- <sect4 id="zend.view.helpers.initial.navigation.acl">
- <title>Integration mit ACL</title>
- <para>
- Alle navigatorischen View Helfer unterstützen <acronym>ACL</acronym> abgeleitet von der
- <classname>Zend_View_Helper_Navigation_HelperAbstract</classname> Klasse. Ein
- <classname>Zend_Acl</classname> Objekt kann einer Instanz eines Helfers mit
- <code>$helper->setAcl($acl)</code> hinzugefügt werden, und eine Rolle mit
- <code>$helper->setRole('member')</code> oder
- <code>$helper->setRole(new Zend_Acl_Role('member'))</code>. Wenn <acronym>ACL</acronym>
- im Helfer verwendet wird, muß es der Rolle im Helfer vom <acronym>ACL</acronym> erlaubt
- sein auf die <code>Ressourcen</code> zuzugreifen und/oder das die
- <code>Privilegien</code> für diese Seite bei der Darstellung eingefügt werden dürfen.
- </para>
- <para>
- Wenn eine Seite vom <acronym>ACL</acronym> nicht akzeptiert ist, wird auch jede
- untergeordnete Seite von der Darstellung ausgenommen sein.
- </para>
- <para>
- Der <link linkend="zend.view.helpers.initial.navigation.navigation">Proxy Helfer</link>
- injiziert seine eigene <acronym>ACL</acronym> und Rolle in den Helfer zu dem er
- weiterleitet wenn der weitergeleitete Helfer nicht bereits einen hat.
- </para>
- <para>
- Das Beispiel von unten zeigt wie <acronym>ACL</acronym> die Darstellung beeinflusst.
- </para>
- </sect4>
- <sect4 id="zend.view.helpers.initial.navigation.setup">
- <title>Setup der Navigation das in Beispielen verwendet wird</title>
- <para>
- Dieses Beispiel zeigt das Setup eines Navigations Container für eine fiktive Software
- Firma.
- </para>
- <para>
- Notizen zum Setup:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Die Domain der Site ist <code>www.example.com</code>.
- </para>
- </listitem>
- <listitem>
- <para>
- Interessante Eigenschaften der Seite sind mit einem Kommentar markiert.
- </para>
- </listitem>
- <listitem>
- <para>
- Solange im Beispiel nicht anders erwähnt, fragt der Benutzer nach der
- <acronym>URL</acronym> <code>http://www.example.com/products/server/faq/</code>,
- welche auf die Seite mit dem Label <constant>FAQ</constant> unter
- <code>Foo Server</code> übersetzt wird.
- </para>
- </listitem>
- <listitem>
- <para>
- Das angenommene <acronym>ACL</acronym> und Route Setup wird unter dem Container
- Setup gezeigt.
- </para>
- </listitem>
- </itemizedlist>
- <programlisting language="php"><![CDATA[
- /*
- * Navigations Container (config/array)
- * Jedes Element im Array wird an Zend_Navigation_Page::factory()
- * übergeben wenn der unten angezeigt Navigations Container
- * erstellt wird.
- */
- $pages = array(
- array(
- 'label' => 'Home',
- 'title' => 'Geh zu Home',
- 'module' => 'default',
- 'controller' => 'index',
- 'action' => 'index',
- 'order' => -100 // Sicherstellen das Home die erste Seite ist
- ),
- array(
- 'label' => 'Spezielles Angebot nur diese Woche!',
- 'module' => 'store',
- 'controller' => 'offer',
- 'action' => 'amazing',
- 'visible' => false // nicht sichtbar
- ),
- array(
- 'label' => 'Produkte',
- 'module' => 'products',
- 'controller' => 'index',
- 'action' => 'index',
- 'pages' => array(
- array(
- 'label' => 'Foo Server',
- 'module' => 'products',
- 'controller' => 'server',
- 'action' => 'index',
- 'pages' => array(
- array(
- 'label' => 'FAQ',
- 'module' => 'products',
- 'controller' => 'server',
- 'action' => 'faq',
- 'rel' => array(
- 'canonical' => 'http://www.example.com/?page=faq',
- 'alternate' => array(
- 'module' => 'products',
- 'controller' => 'server',
- 'action' => 'faq',
- 'params' => array('format' => 'xml')
- )
- )
- ),
- array(
- 'label' => 'Editionen',
- 'module' => 'products',
- 'controller' => 'server',
- 'action' => 'editions'
- ),
- array(
- 'label' => 'System Anforderungen',
- 'module' => 'products',
- 'controller' => 'server',
- 'action' => 'requirements'
- )
- )
- ),
- array(
- 'label' => 'Foo Studio',
- 'module' => 'products',
- 'controller' => 'studio',
- 'action' => 'index',
- 'pages' => array(
- array(
- 'label' => 'Kunden Stories',
- 'module' => 'products',
- 'controller' => 'studio',
- 'action' => 'customers'
- ),
- array(
- 'label' => 'Support',
- 'module' => 'prodcts',
- 'controller' => 'studio',
- 'action' => 'support'
- )
- )
- )
- )
- ),
- array(
- 'label' => 'Firma',
- 'title' => 'Über uns',
- 'module' => 'company',
- 'controller' => 'about',
- 'action' => 'index',
- 'pages' => array(
- array(
- 'label' => 'Investor Relations',
- 'module' => 'company',
- 'controller' => 'about',
- 'action' => 'investors'
- ),
- array(
- 'label' => 'News',
- 'class' => 'rss', // Klasse
- 'module' => 'company',
- 'controller' => 'news',
- 'action' => 'index',
- 'pages' => array(
- array(
- 'label' => 'Für die Presse',
- 'module' => 'company',
- 'controller' => 'news',
- 'action' => 'press'
- ),
- array(
- 'label' => 'Archiv',
- 'route' => 'archive', // Route
- 'module' => 'company',
- 'controller' => 'news',
- 'action' => 'archive'
- )
- )
- )
- )
- ),
- array(
- 'label' => 'Community',
- 'module' => 'community',
- 'controller' => 'index',
- 'action' => 'index',
- 'pages' => array(
- array(
- 'label' => 'Mein Account',
- 'module' => 'community',
- 'controller' => 'account',
- 'action' => 'index',
- 'resource' => 'mvc:community.account' // Ressource
- ),
- array(
- 'label' => 'Forum',
- 'uri' => 'http://forums.example.com/',
- 'class' => 'external' // Klasse
- )
- )
- ),
- array(
- 'label' => 'Administration',
- 'module' => 'admin',
- 'controller' => 'index',
- 'action' => 'index',
- 'resource' => 'mvc:admin', // Ressource
- 'pages' => array(
- array(
- 'label' => 'Neuen Artikel schreiben',
- 'module' => 'admin',
- 'controller' => 'post',
- 'aciton' => 'write'
- )
- )
- )
- );
- // Container von einem Array erstellen
- $container = new Zend_Navigation($pages);
- // Den Container im Proxy Helfer speichern
- $view->getHelper('navigation')->setContainer($container);
- // ...oder einfach:
- $view->navigation($container);
- // ...oder ihn einfach in der Registry speichern:
- Zend_Registry::set('Zend_Navigation', $container);
- ]]></programlisting>
- <para>
- Zusätzlich zum obigen Container, wird das folgende Setup angenommen:
- </para>
- <programlisting language="php"><![CDATA[
- // Router Setup (Standardrouten und 'archive' Route):
- $front = Zend_Controller_Front::getInstance();
- $router = $front->getRouter();
- $router->addDefaultRoutes();
- $router->addRoute(
- 'archive',
- new Zend_Controller_Router_Route(
- '/archive/:year',
- array(
- 'module' => 'company',
- 'controller' => 'news',
- 'action' => 'archive',
- 'year' => (int) date('Y') - 1
- ),
- array('year' => '\d+')
- )
- );
- // ACL Setup:
- $acl = new Zend_Acl();
- $acl->addRole(new Zend_Acl_Role('member'));
- $acl->addRole(new Zend_Acl_Role('admin'));
- $acl->add(new Zend_Acl_Resource('mvc:admin'));
- $acl->add(new Zend_Acl_Resource('mvc:community.account'));
- $acl->allow('member', 'mvc:community.account');
- $acl->allow('admin', null);
- // ACL und Rolle im Proxy Helfer speichern:
- $view->navigation()->setAcl($acl)->setRole('member');
- // ...oder ein standard ACL und Rolle statisch setzen:
- Zend_View_Helper_Navigation_HelperAbstract::setDefaultAcl($acl);
- Zend_View_Helper_Navigation_HelperAbstract::setDefaultRole('member');
- ]]></programlisting>
- </sect4>
- <sect4 id="zend.view.helpers.initial.navigation.breadcrumbs">
- <title>Breadcrumbs Helfer</title>
- <para>
- Breadcrumbs werden verwendet um anzuzeigen wo in einer Sitemap ein Benutzer aktuell
- browst, und werden typischerweise wie folgt angezeigt: "Du bist hier: Home > Produkte
- > FantastischesProdukt 1.0". Der BreakCrumbs Helfer folgt den Richtlinien von <ulink
- url="http://developer.yahoo.com/ypatterns/pattern.php?pattern=breadcrumbs">Breadcrumbs
- Pattern - Yahoo! Design Pattern Library</ulink>, und erlaubt eine einfache Anpassung
- (Minimale/Maximale Tiefe, Einrückung, Trennzeichen, und ob das letzte Element verlinkt
- sein soll), oder die Darstellung durch Verwendung eines partiellen View Skripts.
- </para>
- <para>
- Der Breabcrumbs Helfer funktioniert wie folgt; er findet die tiefste aktive Seite in
- einem Navigations Container, und stellt den aufwärtsgerichteten Pfad zum Root dar.
- Für <acronym>MVC</acronym> Seiten wird die "Aktivität" einer Seite erkannt indem das
- Anfrage Objekt angeschaut wird, wie im Kapitel
- <link linkend="zend.navigation.pages.mvc">Zend_Navigation_Page_Mvc</link> beschrieben.
- </para>
- <para>
- Der Helfer setzt die Eigenschaft <code>minDepth</code> standardmäßig auf 1, was
- bedeutet das Breadcrumbs nicht dargestellt werden wenn die tiefste aktive Seite eine
- Root Seite ist. Wenn <code>maxDepth</code> spezifiziert ist, beendet der Helfer die
- Darstellung bei der spezifizierten Tiefe (z.B. stopp bei Level 2 selbst wenn die
- tiefste aktive Seite auf Level 3 ist).
- </para>
- <para>
- Methoden im Breakcrumbs Helfer sind:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <code>{get|set}Separator()</code> empfängt/setzt das Trennzeichen das zwischen
- Breakcrumbs verwendet wird. Der Standardwert ist <code>' &gt; '</code>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}LinkLast()</code> empfängt/setzt ob der letzte Breabcrumb
- als Anker dargestellt werden soll oder nicht. Der Standardwert ist
- <constant>FALSE</constant>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}Partial()</code> empfängt/setzt ein partielles View Skript das
- für die Darstellung von Breadcrumbs verwendet werden soll. Wenn ein partielles
- View Skript gesetzt ist, verwendet die <methodname>render()</methodname> Methode
- des Helfers die <methodname>renderPartial()</methodname> Methode. Wenn kein
- partielles gesetzt ist, wird die <methodname>renderStraight()</methodname>
- Methode verwendet. Der Helfer erwartet das der partielle ein <type>String</type>
- oder ein <type>Array</type> mit zwei Elementen ist. Wen der Partielle ein
- <type>String</type> ist, benennt er den Namen des partiellen Skripts das zu
- verwenden ist. Wenn er ein <type>Array</type> ist, wird das erste Element als
- Name des partiellen View Skripts verwendet, und das zweite Element ist das Modul
- in dem das Skript zu finden ist.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>renderStraight()</methodname> ist die standardmäßige render Methode.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>renderPartial()</methodname> wird für die Darstellung verwendet wenn
- ein partielles View Skript verwendet wird.
- </para>
- </listitem>
- </itemizedlist>
- <example id="zend.view.helpers.initial.navigation.breadcrumbs.example1">
- <title>Darstellung von Breadcrumbs</title>
- <para>
- Dieses Beispiel zeigt wie Breadcrumbs mit Standardsettings dargestellt werden.
- </para>
- <programlisting language="php"><![CDATA[
- In einem View Skript oder Layout:
- <?php echo $this->navigation()->breadcrumbs(); ?>
- Die zwei obigen Aufrufe verwenden die magische __toString() Methode,
- und sind identisch mit:
- <?php echo $this->navigation()->breadcrumbs()->render(); ?>
- Ausgabe:
- <a href="/products">Produkte</a> > <a href="/products/server">Foo Server</a> > FAQ
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.breadcrumbs.example2">
- <title>Einrückung spezifizieren</title>
- <para>
- Dieses Beispiel zeigt wie Breadcrumbs mit anfänglicher Einrückung dargestellt
- werden können.
- </para>
- <programlisting language="php"><![CDATA[
- Darstellung mit 8 Leerzeichen Einrückung:
- <?php echo $this->navigation()->breadcrumbs()->setIndent(8); ?>
- Ausgabe:
- <a href="/products">Products</a> > <a href="/products/server">Foo Server</a> > FAQ
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.breadcrumbs.example3">
- <title>Eigene Ausgabe für Breakcrumbs</title>
- <para>
- Dieses Beispiel zeigt wie man eine eigene Breadcrumbs Ausgabe durch die
- Spezifizierung diverser Optionen erstellt.
- </para>
- <programlisting language="php"><![CDATA[
- In einem View Skript oder Layout:
- <?php
- echo $this->navigation()
- ->breadcrumbs()
- ->setLinkLast(true) // Letzte Seite verlinken
- ->setMaxDepth(1) // Bei Level 1 stoppen
- ->setSeparator(' ▶' . PHP_EOL); // Cooler Seperator mit Umbruch
- ?>
- Output:
- <a href="/products">Produkte</a> ▶
- <a href="/products/server">Foo Server</a>
- /////////////////////////////////////////////////////
- Minimale notwendige Tiefe für die Darstellung von Breadcrumbs setzen:
- <?php
- $this->navigation()->breadcrumbs()->setMinDepth(10);
- echo $this->navigation()->breadcrumbs();
- ?>
- Ausgabe:
- Nichts, weil die tiefste aktive Seite nicht auf Level 10 oder tiefer ist.
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.breadcrumbs.example4">
- <title>Darstellung von Breadcrumbs mit Verwendung eines partiellen View Skripts</title>
- <para>
- Dieses Beispiel zeigt wir eigene Breakcrumbs durch Verwendung eines partiellen
- View Skripts dargestellt werden können. Durch den Aufruf von
- <methodname>setPartial()</methodname> kann man ein partielles View Skript
- spezifizieren das verwendet wird wenn die <methodname>render()</methodname>
- Methode aufgerufen wird. Wenn ein partielles spezifiziert ist wird die Methode
- <methodname>renderPartial()</methodname> aufgerufen. Diese Methode findest die
- tiefste aktive Seite und übergibt ein Array von Seiten die zur aktiven Seite des
- partiellen View Skripts weiterleitet.
- </para>
- <para>
- Im Layout:
- </para>
- <programlisting language="php"><![CDATA[
- $partial = ;
- echo $this->navigation()->breadcrumbs()
- ->setPartial(array('breadcrumbs.phtml', 'default'));
- ]]></programlisting>
- <para>
- Inhalt von
- <code>application/modules/default/views/breadcrumbs.phtml</code>:
- </para>
- <programlisting language="php"><![CDATA[
- echo implode(', ', array_map(
- function ($a) { return $a->getLabel(); },
- $this->pages));
- ]]></programlisting>
- <para>
- Ausgabe:
- </para>
- <programlisting language="php"><![CDATA[
- Produkte, Foo Server, FAQ
- ]]></programlisting>
- </example>
- </sect4>
- <sect4 id="zend.view.helpers.initial.navigation.links">
- <title>Link Helfer</title>
- <para>
- Der Link Helfer wird für die Darstellung von <acronym>HTML</acronym>
- <constant>LINK</constant> Elementen verwendet. Links werden für die Beschreibung von
- Dokument-Beziehungen der aktuell aktiven Seite verwendet. Mehr über Links und Linktypen
- kann unter <ulink
- url="http://www.w3.org/TR/html4/struct/links.html#h-12.3">Dokument-Beziehung: Das
- LINK Element (HTML4 W3C Rec.)</ulink> und <ulink
- url="http://www.w3.org/TR/html4/types.html#h-6.12">Link Typen (HTML4 W3C
- Rec.)</ulink> in der <acronym>HTML</acronym>4 W3C Empfehlung nachgelesen werden.
- </para>
- <para>
- Es gibt zwei Typen von Beziehungen; vorwärts und rückwärts, angezeigt durch die
- Schlüsselwörter <code>'rel'</code> und <code>'rev'</code>. Die meisten Methoden im
- Helfer nehmen einen <varname>$rel</varname> Parameter entgegen, welcher entweder
- <code>'rel'</code> oder <code>'rev'</code> sein muß. Die meisten Methoden nehmen auch
- einen <varname>$type</varname> Parameter entgegen welcher für die Spezifikation des
- Linktyps (z.B. alternate, start, next, prev, chapter, usw.) verwendet wird.
- </para>
- <para>
- Beziehungen können dem Seitenobjekt manuell hinzugefügt werden, oder werden durch
- das Durchlaufen des Containers, der im Helfer registriert ist, gefunden. Die Methode
- <methodname>findRelation($page, $rel, $type)</methodname> versucht zuerst den gegebenen
- <varname>$rel</varname> von <varname>$type</varname> von der <varname>$page</varname>
- durch den Aufruf von <code>$page->findRel($type)</code> oder
- <code>$page->findRel($type)</code> zu finden. Wenn <varname>$page</varname> eine
- Beziehung hat die zu der Instanz einer Seite konvertiert werden kann, wird diese
- Beziehung verwendet. Wenn die Instanz von <varname>$page</varname> keinen
- <varname>$type</varname> spezifiziert hat, schaut der Helfer nach einer Methode im
- Helfer die <code>search$rel$type</code> heißt (z.B.
- <methodname>searchRelNext()</methodname> oder
- <methodname>searchRevAlternate()</methodname>). Wenn so eine Methode existiert, wird Sie
- für die Erkennung der Beziehung der <varname>$page</varname> verwendet indem der
- Container durchlaufen wird.
- </para>
- <para>
- Nicht alle Beziehungen können durch das Durchlaufen des Containers erkannt werden.
- Das sind die Beziehungen die durch eine Suche gefunden werden können:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <methodname>searchRelStart()</methodname>, Vorwärts Beziehung 'start': Die
- erste Seite im Container.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>searchRelNext()</methodname>, Vorwärts Beziehung 'next'; findet
- die nächste Seite im Container, z.B. die Seite nach der aktiven Seite.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>searchRelPrev()</methodname>, Vorwärts Beziehung 'prev'; findet
- die vorhergehende Seite, z.B. die Seite vor der aktiven Seite.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>searchRelChapter()</methodname>, Vorwärts Beziehung 'chapter';
- findet alle Seiten auf Level 0 ausser der 'start' Beziehung oder der aktiven
- Seite wenn diese auf Level 0 ist.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>searchRelSection()</methodname>, Vorwärts Beziehung 'section';
- findet alle Kind-Seiten der aktiven Seite wenn die aktive Seite auf Level 0
- ist (ein 'chapter').
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>searchRelSubsection()</methodname>, Vorwärts Beziehung
- 'subsection'; findet alle Kind-Seiten der aktiven Seite wenn die aktive
- Seite auf Level 1 sind (ein 'section').
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>searchRevSection()</methodname>, Rückwärts Beziehung 'section';
- findet den Elternteil der aktiven Seite wenn die aktive Seite auf Level 1
- ist (ein 'section').
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>searchRevSubsection()</methodname>, Rückwärts Beziehung
- 'subsection'; findet den Elternteil der aktiven Seite wenn die aktive Seite
- auf Level 2 ist (ein 'subsection').
- </para>
- </listitem>
- </itemizedlist>
- <note>
- <para>
- Wenn in der Instanz der Seite nach Beziehungen gesehen wird (
- (<code>$page->getRel($type)</code> oder <code>$page->getRev($type)</code>),
- akzeptiert der Helfer Wert vom Typ <type>String</type>, <type>Array</type>,
- <classname>Zend_Config</classname>, oder
- <classname>Zend_Navigation_Page</classname>. Wenn ein String gefunden wird, wird
- dieser zu einer <classname>Zend_Navigation_Page_Uri</classname> konvertiert. Wenn
- ein Array oder eine Config gefunden wird, wird diese in ein oder mehrere
- Seiteninstanzen konvertiert, und jedes Element wird an die
- <link linkend="zend.navigation.pages.factory">Seiten Factory</link> übergeben.
- Wenn der erste Schlüssel nicht nummerische ist, wird das Array/Config direkt an die
- Seiten Factory übergeben, und eine einzelne Seite wird retourniert.
- </para>
- </note>
- <para>
- Der Helfer unterstützt auch magische Methoden für das Finden von Beziehungen. Um z.B.
- alternative vorwärts Beziehungen zu finden muß
- <code>$helper->findRelAlternate($page)</code> aufgerufen werden, und um rückwärts
- gerichtete Kapitel Beziehungen zu finden <code>$helper->findRevSection($page)</code>.
- Diese Aufrufe korrespondieren mit <code>$helper->findRelation($page, 'rel',
- 'alternate');</code> und <code>$helper->findRelation($page, 'rev', 'section');</code>.
- </para>
- <para>
- Um zu Steuern welche Beziehung dargestellt werden soll, verwendet der Helfer ein render
- Flag. Das render Flag ist ein Integer Wert, und kann in
- <ulink url="http://php.net/manual/en/language.operators.bitwise.php">binären
- <code>und</code> (<code>&</code>) Operationen</ulink> mit den render Konstanten des
- Helfers verwendet werden um festzustellen ob die Beziehung zu der die render Konstante
- gehört, dargestellt werden soll.
- </para>
- <para>
- Siehe das <link linkend="zend.view.helpers.initial.navigation.links.example3">folgende
- Beispiel</link> für weitere Informationen.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_ALTERNATE</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_STYLESHEET</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_START</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_NEXT</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_PREV</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_CONTENTS</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_INDEX</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_GLOSSARY</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_COPYRIGHT</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_CHAPTER</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_SECTION</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_SUBSECTION</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_APPENDIX</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_HELP</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_BOOKMARK</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_CUSTOM</constant>
- </para>
- </listitem>
- <listitem>
- <para>
- <constant>Zend_View_Helper_Navigation_Links::RENDER_ALL</constant>
- </para>
- </listitem>
- </itemizedlist>
- <para>
- Die Konstanten von <constant>RENDER_ALTERNATE</constant> bis
- <constant>RENDER_BOOKMARK</constant> stellen standardmäßige <acronym>HTML</acronym>
- Linktypen dar. <constant>RENDER_CUSTOM</constant> stellt eine nicht-standardmäßige
- Beziehung dar die in der Seite spezifiziert ist. <constant>RENDER_ALL</constant> stellt
- standardmäßige und nicht-standardmäßige Beziehungen dar.
- </para>
- <para>
- Methoden im Link Helfer:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <code>{get|set}RenderFlag()</code> empfängt/setzt das render Flag.
- Standardwert ist <constant>RENDER_ALL</constant>. Siehe das folgende Beispiel
- dafür wie das render Flag zu setzen ist.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>findAllRelations()</methodname> findet alle Beziehungen von allen
- Typen einer angegebenen Seite.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>findRelation()</methodname> findet alle Beziehungen eines
- angegebenen Typs einer angegebenen Seite.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>searchRel{Start|Next|Prev|Chapter|Section|Subsection}()</code>
- durchsucht einen Container um vorwärtsgerichtete Beziehungen zu Startseite,
- nächster Seite, voriger Seite, Kapitel, Sektion und Untersektion zu finden.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>searchRev{Section|Subsection}()</code> durchsucht einen
- Container um rückwärtsgerichtete Beziehungen zu Sektionen oder Untersektionen zu
- finden.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>renderLink()</methodname> stellt ein einzelnes <code>link</code>
- Element dar.
- </para>
- </listitem>
- </itemizedlist>
- <example id="zend.view.helpers.initial.navigation.links.example1">
- <title>Beziehungen in Seiten spezifizieren</title>
- <para>
- Dieses Beispiel zeigt wir Beziehungen in Seiten spezifiziert werden können.
- </para>
- <programlisting language="php"><![CDATA[
- $container = new Zend_Navigation(array(
- array(
- 'label' => 'Strings für Beziehungen verwenden',
- 'rel' => array(
- 'alternate' => 'http://www.example.org/'
- ),
- 'rev' => array(
- 'alternate' => 'http://www.example.net/'
- )
- ),
- array(
- 'label' => 'Arrays für Beziehungen verwenden',
- 'rel' => array(
- 'alternate' => array(
- 'label' => 'Example.org',
- 'uri' => 'http://www.example.org/'
- )
- )
- ),
- array(
- 'label' => 'Konfigurationen für Beziehungen verwenden',
- 'rel' => array(
- 'alternate' => new Zend_Config(array(
- 'label' => 'Example.org',
- 'uri' => 'http://www.example.org/'
- ))
- )
- ),
- array(
- 'label' => 'Instanzen von Seiten für Beziehungen verwenden',
- 'rel' => array(
- 'alternate' => Zend_Navigation_Page::factory(array(
- 'label' => 'Example.org',
- 'uri' => 'http://www.example.org/'
- ))
- )
- )
- ));
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.links.example2">
- <title>Standardmäßige Darstellung von Links</title>
- <para>
- Dieses Beispiel zeigt wie ein Menü von einem Container dargestellt wird, der im
- View Helfer registriert/gefunden wurde.
- </para>
- <programlisting language="php"><![CDATA[
- Im View Skript oder Layout:
- <?php echo $this->view->navigation()->links(); ?>
- Ausgabe:
- <link rel="alternate" href="/products/server/faq/format/xml">
- <link rel="start" href="/" title="Home">
- <link rel="next" href="/products/server/editions" title="Editionen">
- <link rel="prev" href="/products/server" title="Foo Server">
- <link rel="chapter" href="/products" title="Produkte">
- <link rel="chapter" href="/company/about" title="Firma">
- <link rel="chapter" href="/community" title="Community">
- <link rel="canonical" href="http://www.example.com/?page=server-faq">
- <link rev="subsection" href="/products/server" title="Foo Server">
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.links.example3">
- <title>Spezifizieren welche Beziehungen dargestellt werden sollen</title>
- <para>
- Dieses Beispiel zeigt wie spezifiziert werden kann, welche Beziehungen zu finden
- und darzustellen sind.
- </para>
- <programlisting language="php"><![CDATA[
- Nur start, next und prev darstellen:
- $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_START |
- Zend_View_Helper_Navigation_Links::RENDER_NEXT |
- Zend_View_Helper_Navigation_Links::RENDER_PREV);
- Ausgabe:
- <link rel="start" href="/" title="Home">
- <link rel="next" href="/products/server/editions" title="Editionen">
- <link rel="prev" href="/products/server" title="Foo Server">
- ]]></programlisting>
- <programlisting language="php"><![CDATA[
- Nur native Linktypen darstellen:
- $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
- Zend_View_Helper_Navigation_Links::RENDER_CUSTOM);
- Ausgabe:
- <link rel="alternate" href="/products/server/faq/format/xml">
- <link rel="start" href="/" title="Home">
- <link rel="next" href="/products/server/editions" title="Editionen">
- <link rel="prev" href="/products/server" title="Foo Server">
- <link rel="chapter" href="/products" title="Produkte">
- <link rel="chapter" href="/company/about" title="Firma">
- <link rel="chapter" href="/community" title="Community">
- <link rev="subsection" href="/products/server" title="Foo Server">
- ]]></programlisting>
- <programlisting language="php"><![CDATA[
- Alles ausser Kapitel darstellen:
- $helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
- Zend_View_Helper_Navigation_Links::RENDER_CHAPTER);
- Ausgabe:
- <link rel="alternate" href="/products/server/faq/format/xml">
- <link rel="start" href="/" title="Home">
- <link rel="next" href="/products/server/editions" title="Editionen">
- <link rel="prev" href="/products/server" title="Foo Server">
- <link rel="canonical" href="http://www.example.com/?page=server-faq">
- <link rev="subsection" href="/products/server" title="Foo Server">
- ]]></programlisting>
- </example>
- </sect4>
- <sect4 id="zend.view.helpers.initial.navigation.menu">
- <title>Menu Helfer</title>
- <para>
- Der Menu Helfer wird für die Darstellung von Menüs aus Navigations Containern
- verwendet. Standardmäßig wird das Menü durch Verwendung der <acronym>HTML</acronym>
- Tags <code>UL</code> und <code>LI</code> dargestellt. Der Helfer erlaubt aber auch
- die Verwendung eines partiellen View Skripts.
- </para>
- <para>
- Methoden im Menu Helfer:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <code>{get|set}UlClass()</code> empfängt/setzt die <acronym>CSS</acronym> Klasse
- zur Verwendung in <methodname>renderMenu()</methodname>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}OnlyActiveBranch()</code> empfängt/setzt ein Flag das
- spezifiziert ob der aktive Zweig eines Containers dargestellt werden soll.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}RenderParents()</code> empfängt/setzt ein Flag das
- spezifiziert ob Eltern nur dargestellt werden sollen wenn nur der aktive
- Zweig eines Containers dargestellt wird. Wenn es auf <constant>FALSE</constant>
- gesetzt wird, wird nur das tiefste aktive Menü dargestellt.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}Partial()</code> empfängt/setzt ein partielles View Skript
- das für die Darstellung des Menüs verwendet werden soll. Wenn ein partielles
- Skript gesetzt ist, verwendet die <methodname>render()</methodname> Methode des
- Helfers die <methodname>renderPartial()</methodname> Methode. Wenn kein
- Partieller gesetzt ist, wird die <methodname>renderMenu()</methodname> Methode
- verwendet. Der Helfer erwartet das der Partielle ein <type>String</type>, oder
- ein <type>Array</type> mit zwei Elementen, ist. Wenn der Partielle ein
- <type>String</type> ist bezeichnet er den Namen des partiellen Skripts das zu
- verwenden ist. Wenn er ein <type>Array</type> ist wird das erste Element als
- Name des partiellen View Skripts verwendet, und das zweite Element ist das Modul
- indem das Skript gefunden wird.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>htmlify()</methodname> überschreibt die Methode der abstrakten
- Klasse damit <code>span</code> Elemente zurückgegeben werden wenn die Seite kein
- <code>href</code> hat.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>renderMenu($container = null, $options = array())</methodname> ist
- eine standardmäßige render Methode, und stellt einen Container als
- <acronym>HTML</acronym> <code>UL</code> Liste dar.
- </para>
- <para>
- Wenn <varname>$container</varname> nicht angegeben wird, wird der Container der
- im Helfer registriert ist dargestellt.
- </para>
- <para>
- <varname>$options</varname> wird verwendet um temporär spezifizierte Optionen zu
- überschreiben ohne das die Werte in der Helferinstanz zurückgesetzt werden. Es
- ist ein assoziatives Array wobei jeder Schlüssel mit einer Option im Helfer
- korrespondiert.
- </para>
- <para>
- Erkannte Optionen:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <code>indent</code>; Einrückung. Erwartet einen <type>String</type>
- oder einen <code>int</code> Wert.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>minDepth</code>; Minimale Tiefe. Erwartet ein
- <code>int</code> oder <constant>NULL</constant> (keine minimale
- Tiefe).
- </para>
- </listitem>
- <listitem>
- <para>
- <code>maxDepth</code>; Maximale Tiefe. Erwartet ein
- <code>int</code> oder <constant>NULL</constant> (keine maximale
- Tiefe).
- </para>
- </listitem>
- <listitem>
- <para>
- <code>ulClass</code>; <acronym>CSS</acronym> Klasse für das
- <code>ul</code> Element. Erwartet einen <type>String</type>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>onlyActiveBranch</code>; Ob nur der aktive Branch dargestellt
- werden soll. Erwartet einen <type>Boolean</type> Wert.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>renderParents</code>; Ob eltern dargestellt werden sollen
- wenn nur der aktive Branch dargestellt wird. Erwartet einen
- <type>Boolean</type> Wert.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- Wenn keine Option angegeben wird, werden die Werte die im Helfer gesetzt
- sind verwendet.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>renderPartial()</methodname> wird für die Darstellung des Menüs in
- einem partiellen View Skript verwendet.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>renderSubMenu()</methodname> stellt das tiefste Menü Level des
- aktiven Branches eines Containers dar.
- </para>
- </listitem>
- </itemizedlist>
- <example id="zend.view.helpers.initial.navigation.menu.example1">
- <title>Darstellung eines Menüs</title>
- <para>
- Dieses Beispiel zeigt wie ein Menü von einem registrierten/im View Helfer
- gefundenen Container, dargestellt wird. Es ist zu beachten das Seiten basierend
- auf Ihrer Sichtbarkeit und <acronym>ACL</acronym> ausgefiltert werden.
- </para>
- <programlisting language="php"><![CDATA[
- In einem View Skript oder Layout:
- <?php echo $this->navigation()->menu()->render() ?>
- Oder einfach:
- <?php echo $this->navigation()->menu() ?>
- Ausgabe:
- <ul class="navigation">
- <li>
- <a title="Geh zu Home" href="/">Home</a>
- </li>
- <li class="active">
- <a href="/products">Produkte</a>
- <ul>
- <li class="active">
- <a href="/products/server">Foo Server</a>
- <ul>
- <li class="active">
- <a href="/products/server/faq">FAQ</a>
- </li>
- <li>
- <a href="/products/server/editions">Editionen</a>
- </li>
- <li>
- <a href="/products/server/requirements">System Anforderungen</a>
- </li>
- </ul>
- </li>
- <li>
- <a href="/products/studio">Foo Studio</a>
- <ul>
- <li>
- <a href="/products/studio/customers">Kunden Stories</a>
- </li>
- <li>
- <a href="/prodcts/studio/support">Support</a>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- <li>
- <a title="About us" href="/company/about">Firma</a>
- <ul>
- <li>
- <a href="/company/about/investors">Investor Relations</a>
- </li>
- <li>
- <a class="rss" href="/company/news">News</a>
- <ul>
- <li>
- <a href="/company/news/press">Für die Presse</a>
- </li>
- <li>
- <a href="/archive">Archiv</a>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- <li>
- <a href="/community">Community</a>
- <ul>
- <li>
- <a href="/community/account">Mein Account</a>
- </li>
- <li>
- <a class="external" href="http://forums.example.com/">Forums</a>
- </li>
- </ul>
- </li>
- </ul>
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.menu.example2">
- <title>renderMenu() direkt aufrufen</title>
- <para>
- Dieses Beispiel zeigt wie ein Menü dargestellt werden kann das nicht im View
- Helfer registriert ist, indem <methodname>renderMenu()</methodname> direkt
- aufgerufen wird und ein paar wenige Optionen spezifiziert werden.
- </para>
- <programlisting language="php"><![CDATA[
- <?php
- // Nur das 'Community' Menü darstellen
- $community = $this->navigation()->findOneByLabel('Community');
- $options = array(
- 'indent' => 16,
- 'ulClass' => 'community'
- );
- echo $this->navigation()
- ->menu()
- ->renderMenu($community, $options);
- ?>
- Output:
- <ul class="community">
- <li>
- <a href="/community/account">Mein Account</a>
- </li>
- <li>
- <a class="external" href="http://forums.example.com/">Forums</a>
- </li>
- </ul>
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.menu.example3">
- <title>Das tiefste aktive Menü darstellen</title>
- <para>
- Dieses Beispiel zeigt wie <methodname>renderSubMenu()</methodname> das tiefste
- Untermenü des aktiven Branches dargestellt wird.
- </para>
- <para>
- Der Aufruf von <methodname>renderSubMenu($container, $ulClass, $indent)</methodname>
- ist identisch mit dem Aufruf von
- <methodname>renderMenu($container, $options)</methodname> mit den folgenden
- Optionen:
- </para>
- <programlisting language="php"><![CDATA[
- array(
- 'ulClass' => $ulClass,
- 'indent' => $indent,
- 'minDepth' => null,
- 'maxDepth' => null,
- 'onlyActiveBranch' => true,
- 'renderParents' => false
- );
- ]]></programlisting>
- <programlisting language="php"><![CDATA[
- <?php
- echo $this->navigation()
- ->menu()
- ->renderSubMenu(null, 'sidebar', 4);
- ?>
- Die Ausgabe ist die gleiche wenn 'FAQ' oder 'Foo Server' aktiv sind:
- <ul class="sidebar">
- <li class="active">
- <a href="/products/server/faq">FAQ</a>
- </li>
- <li>
- <a href="/products/server/editions">Editionen</a>
- </li>
- <li>
- <a href="/products/server/requirements">System Anforderungen</a>
- </li>
- </ul>
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.menu.example4">
- <title>Darstellung eines Menüs mit maximaler Tiefe</title>
- <programlisting language="php"><![CDATA[
- <?php
- echo $this->navigation()
- ->menu()
- ->setMaxDepth(1);
- ?>
- Ausgabe:
- <ul class="navigation">
- <li>
- <a title="Geh zu Home" href="/">Home</a>
- </li>
- <li class="active">
- <a href="/products">Produkte</a>
- <ul>
- <li class="active">
- <a href="/products/server">Foo Server</a>
- </li>
- <li>
- <a href="/products/studio">Foo Studio</a>
- </li>
- </ul>
- </li>
- <li>
- <a title="About us" href="/company/about">Firma</a>
- <ul>
- <li>
- <a href="/company/about/investors">Investor Relations</a>
- </li>
- <li>
- <a class="rss" href="/company/news">News</a>
- </li>
- </ul>
- </li>
- <li>
- <a href="/community">Community</a>
- <ul>
- <li>
- <a href="/community/account">Mein Account</a>
- </li>
- <li>
- <a class="external" href="http://forums.example.com/">Forums</a>
- </li>
- </ul>
- </li>
- </ul>
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.menu.example5">
- <title>Darstellung eines Menüs mit minimaler Tiefe</title>
- <programlisting language="php"><![CDATA[
- <?php
- echo $this->navigation()
- ->menu()
- ->setMinDepth(1);
- ?>
- Ausgabe:
- <ul class="navigation">
- <li class="active">
- <a href="/products/server">Foo Server</a>
- <ul>
- <li class="active">
- <a href="/products/server/faq">FAQ</a>
- </li>
- <li>
- <a href="/products/server/editions">Editionen</a>
- </li>
- <li>
- <a href="/products/server/requirements">System Anforderungen</a>
- </li>
- </ul>
- </li>
- <li>
- <a href="/products/studio">Foo Studio</a>
- <ul>
- <li>
- <a href="/products/studio/customers">Kunden Stories</a>
- </li>
- <li>
- <a href="/prodcts/studio/support">Support</a>
- </li>
- </ul>
- </li>
- <li>
- <a href="/company/about/investors">Investor Relations</a>
- </li>
- <li>
- <a class="rss" href="/company/news">News</a>
- <ul>
- <li>
- <a href="/company/news/press">Für die Presse</a>
- </li>
- <li>
- <a href="/archive">Archiv</a>
- </li>
- </ul>
- </li>
- <li>
- <a href="/community/account">Mein Account</a>
- </li>
- <li>
- <a class="external" href="http://forums.example.com/">Forums</a>
- </li>
- </ul>
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.menu.example6">
- <title>Nur den aktiven Branch eines Menüs darstellen</title>
- <programlisting language="php"><![CDATA[
- <?php
- echo $this->navigation()
- ->menu()
- ->setOnlyActiveBranch(true);
- ?>
- Ausgabe:
- <ul class="navigation">
- <li class="active">
- <a href="/products">Produkte</a>
- <ul>
- <li class="active">
- <a href="/products/server">Foo Server</a>
- <ul>
- <li class="active">
- <a href="/products/server/faq">FAQ</a>
- </li>
- <li>
- <a href="/products/server/editions">Editionen</a>
- </li>
- <li>
- <a href="/products/server/requirements">System Anforderungen</a>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.menu.example7">
- <title>
- Nur den aktiven Branch eines Menüs mit minimaler Tiefe darstellen
- </title>
- <programlisting language="php"><![CDATA[
- <?php
- echo $this->navigation()
- ->menu()
- ->setOnlyActiveBranch(true)
- ->setMinDepth(1);
- ?>
- Ausgabe:
- <ul class="navigation">
- <li class="active">
- <a href="/products/server">Foo Server</a>
- <ul>
- <li class="active">
- <a href="/products/server/faq">FAQ</a>
- </li>
- <li>
- <a href="/products/server/editions">Editionen</a>
- </li>
- <li>
- <a href="/products/server/requirements">System Anforderungen</a>
- </li>
- </ul>
- </li>
- </ul>
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.menu.example8">
- <title>
- Nur den aktiven Branch eines Menüs mit maximaler Tiefe darstellen
- </title>
- <programlisting language="php"><![CDATA[
- <?php
- echo $this->navigation()
- ->menu()
- ->setOnlyActiveBranch(true)
- ->setMaxDepth(1);
- ?>
- Ausgabe:
- <ul class="navigation">
- <li class="active">
- <a href="/products">Produkte</a>
- <ul>
- <li class="active">
- <a href="/products/server">Foo Server</a>
- </li>
- <li>
- <a href="/products/studio">Foo Studio</a>
- </li>
- </ul>
- </li>
- </ul>
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.menu.example9">
- <title>
- Nur den aktiven Branch eines Menüs mit maximaler Tiefe aber ohne Eltern darstellen
- </title>
- <para>
- </para>
- <programlisting language="php"><![CDATA[
- <?php
- echo $this->navigation()
- ->menu()
- ->setOnlyActiveBranch(true)
- ->setRenderParents(false)
- ->setMaxDepth(1);
- ?>
- Ausgabe:
- <ul class="navigation">
- <li class="active">
- <a href="/products/server">Foo Server</a>
- </li>
- <li>
- <a href="/products/studio">Foo Studio</a>
- </li>
- </ul>
- ]]></programlisting>
- </example>
- <example id="zend.view.helpers.initial.navigation.menu.example10">
- <title>
- Darstellen eines eigenen Menüs durch Verwendung eines partiellen View Skripts
- </title>
- <para>
- Dieses Beispiel zeigt wie ein eigenes Menü, durch Verwendung eines partiellen View
- Skripts, dargestellt werden kann. Durch Aufruf von
- <methodname>setPartial()</methodname> kann ein partielles View Skript spezifiziert
- werden das verwendet wird wenn man <methodname>render()</methodname> aufruft. Wenn
- ein Partielles spezifiziert ist, wird die <methodname>renderPartial()</methodname>
- Methode aufgerufen. Diese Methode fügt den Container in die View ein, und verwendet
- hierbei den Schlüssel <code>container</code>.
- </para>
- <para>In a layout:</para>
- <programlisting language="php"><![CDATA[
- $partial = array('menu.phtml', 'default');
- $this->navigation()->menu()->setPartial($partial);
- echo $this->navigation()->menu()->render();
- ]]></programlisting>
- <para>In application/modules/default/views/menu.phtml:</para>
- <programlisting language="php"><![CDATA[
- foreach ($this->container as $page) {
- echo $this->navigation()->menu()->htmlify($page), PHP_EOL;
- }
- ]]></programlisting>
- <para>Ausgabe:</para>
- <programlisting language="php"><![CDATA[
- <a title="Geh zu Home" href="/">Home</a>
- <a href="/products">Produkte</a>
- <a title="About us" href="/company/about">Firma</a>
- <a href="/community">Community</a>
- ]]></programlisting>
- </example>
- </sect4>
- <sect4 id="zend.view.helpers.initial.navigation.sitemap">
- <title>Sitemap Helfer</title>
- <para>
- Der Sitemap Helfer wird für die Erzeugung von <acronym>XML</acronym> Sitemaps verwendet
- wie im <ulink url="http://www.sitemaps.org/protocol.php">Sitemaps <acronym>XML</acronym>
- Format</ulink> definiert. Mehr darüber kann unter <ulink
- url="http://en.wikipedia.org/wiki/Sitemaps"> Sitemaps in Wikipedia</ulink>
- nachgelesen werden.
- </para>
- <para>
- Standardmäßig verwendet der Sitemap Helfer
- <link linkend="zend.validate.sitemap">Sitemap Prüfungen</link> um jedes Element zu
- prüfen das dargestellt werden soll. Das kann deaktiviert werden indem man
- <code>$helper->setUseSitemapValidators(false)</code> aufruft.
- </para>
- <note>
- <para>
- Wenn man die Sitemap Prüfungen deaktiviert, werden die eigenen Eigenschaften
- (siehe Tabelle) nicht geprüft.
- </para>
- </note>
- <para>
- Der Sitemap Helfer unterstützt auch die Pürfung von
- <ulink url="http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">Sitemap XSD
- Schemas</ulink> der erzeugten Sitemap. Das ist standardmäßig deaktiviert, da es eine
- Anfrage auf die Schema Datei benötigt. Es kann mit
- <code>$helper->setUseSchemaValidation(true)</code> aktiviert werden.
- </para>
- <table id="zend.view.helpers.initial.navigation.sitemap.elements">
- <title>Sitemap XML Elemente</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Element</entry>
- <entry>Beschreibung</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>loc</code></entry>
- <entry>
- Absolute <acronym>URL</acronym> zur Seite. Eine absolute
- <acronym>URL</acronym> wird vom Helfer erzeugt.
- </entry>
- </row>
- <row>
- <entry><code>lastmod</code></entry>
- <entry>
- <para>
- Das Datum der letzten Änderung der Datei, im
- <ulink url="http://www.w3.org/TR/NOTE-datetime">W3C
- Datetime</ulink> Format. Dieser Zeitabschnitt kann bei Bedarf
- unterdrückt, und nur YYYY-MM-DD verwendet werden.
- </para>
- <para>
- Der Helfer versucht den <code>lastmod</code> Wert von der
- Seiteneigenschaft <code>lastmod</code> zu erhalten wenn diese auf
- der Seite gesetzt ist. Wenn der Wert kein gültiges Datum ist, wird
- er ignoriert.
- </para>
- </entry>
- </row>
- <row>
- <entry><code>changefreq</code></entry>
- <entry>
- <para>
- Wie oft eine Seite geändert wird. Dieser Wert bietet eine generelle
- Information für Suchmaschinen und muß nicht exakt mit der Anzahl
- der Suchen auf der Seite übereinstimmen. Gültige Werte sind:
- </para>
- <itemizedlist>
- <listitem><para>always</para></listitem>
- <listitem><para>hourly</para></listitem>
- <listitem><para>daily</para></listitem>
- <listitem><para>weekly</para></listitem>
- <listitem><para>monthly</para></listitem>
- <listitem><para>yearly</para></listitem>
- <listitem><para>never</para></listitem>
- </itemizedlist>
- <para>
- Der Helfer versucht den <code>changefreq</code> Wert von der
- Seiteneigenschaft <code>changefreq</code> zu erhalten, wenn diese
- auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird er
- ignoriert.
- </para>
- </entry>
- </row>
- <row>
- <entry><code>priority</code></entry>
- <entry>
- <para>
- Die Priorität dieser <acronym>URL</acronym> relativ zu anderen
- <acronym>URL</acronym>s auf der eigenen Site. Der gültige Bereich
- für diesen Wert ist von 0.0 bis 1.0.
- </para>
- <para>
- Der Helfer versucht den <code>priority</code> Wert von der
- Seiteneigenschaft <code>priority</code> zu erhalten wenn dieser
- auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird
- er ignoriert.
- </para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- Methoden im Sitemap Helfer:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <code>{get|set}FormatOutput()</code> empfängt/setzt ein Flag das anzeigt ob
- <acronym>XML</acronym> Ausgaben formatiert werden sollen. Das entspricht der
- Eigenschaft <code>formatOutput</code> der nativen
- <classname>DOMDocument</classname> Klasse. Mehr kann man unter <ulink
- url="http://php.net/domdocument">PHP: DOMDocument - Handbuch</ulink>
- nachlesen. Der Standardwert ist <constant>FALSE</constant>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}UseXmlDeclaration()</code> empfängt/setzt ein Flag das
- anzeigt ob die <acronym>XML</acronym> Deklaration bei der Darstellung enthalten
- sein soll. Der Standardwert ist <constant>TRUE</constant>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}UseSitemapValidators()</code> empfängt/setzt ein Flag das
- anzeigt ob Sitemap Prüfungen verwendet werden sollen wenn die DOM Sitemap
- dargestellt werden soll. Der Standardwert ist <constant>TRUE</constant>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}UseSchemaValidation()</code> empfängt/setzt ein Flag das
- anzeigt ob der Helfer eine <acronym>XML</acronym> Schema Prüfung verwenden soll
- wenn die DOM Sitemap erzeugt wird. Der Standardwert ist
- <constant>FALSE</constant>. Wenn <constant>TRUE</constant>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}ServerUrl()</code> empfängt/setzt die Server
- <acronym>URL</acronym> die nicht-absoluten <acronym>URL</acronym>s in der
- <methodname>url()</methodname> Methode vorangestellt werden. Wenn keine Server
- <acronym>URL</acronym> spezifiziert ist, wird diese vom Helfer festgestellt.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>url()</methodname> wird verwendet um absolute
- <acronym>URL</acronym>s zu Seiten zu erstellen.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>getDomSitemap()</methodname> erzeugt ein DOMDocument von einem
- angegebenen Container.
- </para>
- </listitem>
- </itemizedlist>
- <example id="zend.view.helpers.initial.navigation.sitemap.example">
- <title>Eine XML Sitemap darstellen</title>
- <para>
- Dieses Beispiel zeigt wie eine <acronym>XML</acronym> Sitemap, basierend auf dem
- Setup das wir vorher angegeben haben, dargestellt wird.
- </para>
- <programlisting language="php"><![CDATA[
- // In einem View Skript oder Layout:
- // Ausgabeformat
- $this->navigation()
- ->sitemap()
- ->setFormatOutput(true); // Standardwert ist false
- // Andere mögliche Methoden:
- // ->setUseXmlDeclaration(false); // Standardwert ist true
- // ->setServerUrl('http://my.otherhost.com');
- // Standard ist die automatische Erkennung
- // Sitemap ausdrucken
- echo $this->navigation()->sitemap();
- ]]></programlisting>
- <para>
- Es ist zu beachten wie Seiten die unsichtbar oder Seiten mit <acronym>ACL</acronym>
- Rollen die mit dem View Helfer inkompatibel sin, ausgefiltert werden:
- </para>
- <programlisting language="xml"><![CDATA[
- <?xml version="1.0" encoding="UTF-8"?>
- <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
- <url>
- <loc>http://www.example.com/</loc>
- </url>
- <url>
- <loc>http://www.example.com/products</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/server</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/server/faq</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/server/editions</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/server/requirements</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/studio</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/studio/customers</loc>
- </url>
- <url>
- <loc>http://www.example.com/prodcts/studio/support</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/about</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/about/investors</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/news</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/news/press</loc>
- </url>
- <url>
- <loc>http://www.example.com/archive</loc>
- </url>
- <url>
- <loc>http://www.example.com/community</loc>
- </url>
- <url>
- <loc>http://www.example.com/community/account</loc>
- </url>
- <url>
- <loc>http://forums.example.com/</loc>
- </url>
- </urlset>
- ]]></programlisting>
- <para>
- Die Sitemap ohne Verwendung einer <acronym>ACL</acronym> Rolle darstellen (sollte
- /community/account ausfiltern):
- </para>
- <programlisting language="php"><![CDATA[
- echo $this->navigation()
- ->sitemap()
- ->setFormatOutput(true)
- ->setRole();
- ]]></programlisting>
- <programlisting language="xml"><![CDATA[
- <?xml version="1.0" encoding="UTF-8"?>
- <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
- <url>
- <loc>http://www.example.com/</loc>
- </url>
- <url>
- <loc>http://www.example.com/products</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/server</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/server/faq</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/server/editions</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/server/requirements</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/studio</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/studio/customers</loc>
- </url>
- <url>
- <loc>http://www.example.com/prodcts/studio/support</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/about</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/about/investors</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/news</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/news/press</loc>
- </url>
- <url>
- <loc>http://www.example.com/archive</loc>
- </url>
- <url>
- <loc>http://www.example.com/community</loc>
- </url>
- <url>
- <loc>http://forums.example.com/</loc>
- </url>
- </urlset>
- ]]></programlisting>
- <para>
- Darstellen der Sitemap mit Verwendung einer maximalen Tiefe von 1.
- </para>
- <programlisting language="php"><![CDATA[
- echo $this->navigation()
- ->sitemap()
- ->setFormatOutput(true)
- ->setMaxDepth(1);
- ]]></programlisting>
- <programlisting language="xml"><![CDATA[
- <?xml version="1.0" encoding="UTF-8"?>
- <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
- <url>
- <loc>http://www.example.com/</loc>
- </url>
- <url>
- <loc>http://www.example.com/products</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/server</loc>
- </url>
- <url>
- <loc>http://www.example.com/products/studio</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/about</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/about/investors</loc>
- </url>
- <url>
- <loc>http://www.example.com/company/news</loc>
- </url>
- <url>
- <loc>http://www.example.com/community</loc>
- </url>
- <url>
- <loc>http://www.example.com/community/account</loc>
- </url>
- <url>
- <loc>http://forums.example.com/</loc>
- </url>
- </urlset>
- ]]></programlisting>
- </example>
- <note>
- <title>Standardmäßig wird die UTF-8 Kodierung verwendet</title>
- <para>
- Standardmäßig verwendet Zend Framework <acronym>UTF-8</acronym> als seine
- Standardkodierung, und speziell in diesem Fall, macht das
- <classname>Zend_View</classname> genauso. Die Zeichenkodierung kann im View Objekt
- selbst auf etwas anderes gesetzt werden indem die Methode
- <methodname>setEncoding()</methodname> verwendet wird (oder der Parameter
- <varname>encoding</varname> bei der Instanzierung angegeben wird). Trotzdem, da
- <classname>Zend_View_Interface</classname> keine Zugriffsmethoden für die Kodierung
- anbietet ist es möglich dass, wenn man eine eigene View Implementation verwendet,
- man keine <methodname>getEncoding()</methodname> Methode hat, welche der View Helfer
- intern für die Erkennung des Zeichensets verwendet in das kodiert werden soll.
- </para>
- <para>
- Wenn man <acronym>UTF-8</acronym> in solch einer Situation nicht verwenden will,
- muss man in der eigenen View Implementation eine
- <methodname>getEncoding()</methodname> Methode implementieren.
- </para>
- </note>
- </sect4>
- <sect4 id="zend.view.helpers.initial.navigation.navigation">
- <title>Navigation Helfer</title>
- <para>
- Der Navigation Helfer ist ein Proxy Helfer der Aufrufe zu anderen Navigations Helfern
- durchführt. Er kann als Einstiegspunkt für alle navigations-basierenden View Tasks
- verwendet werden. Die vorher erwähnten Navigations Helfer sind im Namespace
- <classname>Zend_View_Helper_Navigation</classname> und würden es deshalb benötigen, den
- Pfad <code>Zend/View/Helper/Navigation</code> als Helfer Pfad der View hinzuzufügen. Mit
- dem Proxy Helfer der im <classname>Zend_View_Helper</classname> Namespace sitzt, ist er
- immer vorhanden, ohne das irgendein Helfer Pfad an der View hinzugefügt werden muß.
- </para>
- <para>
- Der Navigations Helfer findet andere Helfer die das
- <classname>Zend_View_Helper_Navigation_Helper</classname> Interface implementieren,
- was bedeuet das auch auf eigene View Helfer weitergeleitet wird. Das würde trotzdem
- das Hinzufügen des eigenen Helfer Pfades zur View benötigen.
- </para>
- <para>
- Wenn auf andere Helfer weitergeleitet wird, kann der Navigations Helfer seinen
- Container, <acronym>ACL</acronym>/Rolle und Übersetzer injizieren. Das bedeutet weder
- das man diese drei nicht explizit in allen navigatorischen Helfern setzen muß, noch das
- diese in <classname>Zend_Registry</classname> oder in statische Methoden injiziert
- werden muß.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <methodname>findHelper()</methodname> findet alle angegebenen Helfer, prüft das
- dieser ein navigatorischer Helfer ist, und injiziiert Container,
- <acronym>ACL</acronym>/Rolle und Übersetzer.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}InjectContainer()</code> empfängt/setzt ein Flag das anzeigt
- ob der Container an weitergeleitete Helfer injiziiert werden soll. Der
- Standardwert ist <constant>TRUE</constant>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}InjectAcl()</code> empfängt/setzt ein Flag das anzeigt ob die
- <acronym>ACL</acronym>/Rolle an weitergeleitete Helfer injiziiert werden soll.
- Der Standardwert ist <constant>TRUE</constant>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}InjectTranslator()</code> empfängt/setzt ein Flag das anzeigt
- ob der Übersetzer an weitergeleitete Helfer injiziiert werden soll. Der
- Standardwert ist <constant>TRUE</constant>.
- </para>
- </listitem>
- <listitem>
- <para>
- <code>{get|set}DefaultProxy()</code> empfängt/setzt den Standard Proxy. Der
- Standardwert ist <code>'menu'</code>.
- </para>
- </listitem>
- <listitem>
- <para>
- <methodname>render()</methodname> leitet auf die render Methode des
- Standardproxies weiter.
- </para>
- </listitem>
- </itemizedlist>
- </sect4>
- </sect3>
|