documentation/manual/en/module_specs/Zend_Navigation-Pages-URI.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect2 id="zend.navigation.pages.uri">
   4     <title>Zend_Navigation_Page_Uri</title>
   5
   6     <para>
   7         Pages of type <classname>Zend_Navigation_Page_Uri</classname> can be
   8         used to link to pages on other domains or sites, or to implement
   9         custom logic for the page. <acronym>URI</acronym> pages are simple; in addition
  10         to the common page options, a <acronym>URI</acronym> page takes only one option —
  11         <code>uri</code>. The <code>uri</code> will be returned when
  12         calling <code>$page->getHref()</code>, and may be a
  13         <type>String</type> or <constant>NULL</constant>.
  14     </para>
  15
  16     <note>
  17         <para>
  18             <classname>Zend_Navigation_Page_Uri</classname> will not try to determine
  19             whether it should be active when calling <code>$page->isActive()</code>.
  20             It merely returns what currently is set, so to make a <acronym>URI</acronym> page active
  21             you have to manually call <code>$page->setActive()</code> or
  22             specifying <code>active</code> as a page option when constructing.
  23         </para>
  24     </note>
  25
  26     <table id="zend.navigation.pages.uri.options">
  27         <title>URI page options</title>
  28
  29         <tgroup cols="4">
  30             <thead>
  31                 <row>
  32                     <entry>Key</entry>
  33                     <entry>Type</entry>
  34                     <entry>Default</entry>
  35                     <entry>Description</entry>
  36                 </row>
  37             </thead>
  38
  39             <tbody>
  40                 <row>
  41                     <entry><code>uri</code></entry>
  42                     <entry><type>String</type></entry>
  43                     <entry><constant>NULL</constant></entry>
  44
  45                     <entry>
  46                         <acronym>URI</acronym> to page. This can be any string or
  47                         <constant>NULL</constant>.
  48                     </entry>
  49                 </row>
  50             </tbody>
  51         </tgroup>
  52     </table>
  53 </sect2>