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

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect2 id="zend.navigation.pages.custom">
   4     <title>Creating custom page types</title>
   5
   6     <para>
   7         When extending <classname>Zend_Navigation_Page</classname>, there is
   8         usually no need to override the constructor or the methods
   9         <methodname>setOptions()</methodname> or <methodname>setConfig()</methodname>. The page
  10         constructor takes a single parameter, an <type>Array</type> or a
  11         <classname>Zend_Config</classname> object, which is passed to
  12         <methodname>setOptions()</methodname> or <methodname>setConfig()</methodname> respectively.
  13         Those methods will in turn call <methodname>set()</methodname> method, which
  14         will map options to native or custom properties. If the option
  15         <code>internal_id</code> is given, the method will first look for a
  16         method named <methodname>setInternalId()</methodname>, and pass the option to this
  17         method if it exists. If the method does not exist, the option will be
  18         set as a custom property of the page, and be accessible via
  19         <code>$internalId = $page->internal_id;</code> or
  20         <code>$internalId = $page->get('internal_id');</code>.
  21     </para>
  22
  23     <example id="zend.navigation.custom.example.simple">
  24         <title>The most simple custom page</title>
  25
  26         <para>
  27             The only thing a custom page class needs to implement is the
  28             <methodname>getHref()</methodname> method.
  29         </para>
  30
  31         <programlisting language="php"><![CDATA[
  32 class My_Simple_Page extends Zend_Navigation_Page
  33 {
  34     public function getHref()
  35     {
  36         return 'something-completely-different';
  37     }
  38 }
  39 ]]></programlisting>
  40     </example>
  41
  42     <example id="zend.navigation.custom.example.properties">
  43         <title>A custom page with properties</title>
  44
  45         <para>
  46             When adding properties to an extended page, there is no need
  47             to override/modify <methodname>setOptions()</methodname> or
  48             <methodname>setConfig()</methodname>.
  49         </para>
  50
  51         <programlisting language="php"><![CDATA[
  52 class My_Navigation_Page extends Zend_Navigation_Page
  53 {
  54     private $_foo;
  55     private $_fooBar;
  56
  57     public function setFoo($foo)
  58     {
  59         $this->_foo = $foo;
  60     }
  61
  62     public function getFoo()
  63     {
  64         return $this->_foo;
  65     }
  66
  67     public function setFooBar($fooBar)
  68     {
  69         $this->_fooBar = $fooBar;
  70     }
  71
  72     public function getFooBar()
  73     {
  74         return $this->_fooBar;
  75     }
  76
  77     public function getHref()
  78     {
  79         return $this->foo . '/' . $this->fooBar;
  80     }
  81 }
  82
  83 // can now construct using
  84 $page = new My_Navigation_Page(array(
  85     'label'   => 'Property names are mapped to setters',
  86     'foo'     => 'bar',
  87     'foo_bar' => 'baz'
  88 ));
  89
  90 // ...or
  91 $page = Zend_Navigation_Page::factory(array(
  92     'type'    => 'My_Navigation_Page',
  93     'label'   => 'Property names are mapped to setters',
  94     'foo'     => 'bar',
  95     'foo_bar' => 'baz'
  96 ));
  97 ]]></programlisting>
  98     </example>
  99 </sect2>