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

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect2 id="zend.navigation.pages.uri">
    <title>Zend_Navigation_Page_Uri</title>

    <para>
        Pages of type <classname>Zend_Navigation_Page_Uri</classname> can be
        used to link to pages on other domains or sites, or to implement
        custom logic for the page. <acronym>URI</acronym> pages are simple; in addition
        to the common page options, a <acronym>URI</acronym> page takes only one option —
        <code>uri</code>. The <code>uri</code> will be returned when
        calling <code>$page->getHref()</code>, and may be a
        <type>String</type> or <constant>NULL</constant>.
    </para>

    <note>
        <para>
            <classname>Zend_Navigation_Page_Uri</classname> will not try to determine
            whether it should be active when calling <code>$page->isActive()</code>.
            It merely returns what currently is set, so to make a <acronym>URI</acronym> page active
            you have to manually call <code>$page->setActive()</code> or
            specifying <code>active</code> as a page option when constructing.
        </para>
    </note>

    <table id="zend.navigation.pages.uri.options">
        <title>URI page options</title>

        <tgroup cols="4">
            <thead>
                <row>
                    <entry>Key</entry>
                    <entry>Type</entry>
                    <entry>Default</entry>
                    <entry>Description</entry>
                </row>
            </thead>

            <tbody>
                <row>
                    <entry><code>uri</code></entry>
                    <entry><type>String</type></entry>
                    <entry><constant>NULL</constant></entry>

                    <entry>
                        <acronym>URI</acronym> to page. This can be any string or
                        <constant>NULL</constant>.
                    </entry>
                </row>
            </tbody>
        </tgroup>
    </table>
</sect2>