This is an example of how custom properties can be used. Custom properties will also be included inf $page->toArray().

<?php
 
$page = new Zym_Navigation_Page_Mvc(array('label' => 'Lorem ipsum'));
$page->foo = 'bar';
$page->meaning = 42;
 
echo $page->foo;
 
if ($page->meaning != 42) {
    // action should be taken
}

These examples show that MVC pages use Zend_Controller_Action_Helper_Url internally to generate URLs when calling $page->getHref().

	Note
	All examples assume a regular MVC setup with default being the default module name, and that the route named default has not been modified. The URL/URI returned is relative to your application's baseUrl. In the examples, the base is '/' for simplicity.

<?php
 
// getHref() returns /
$page = new Zym_Navigation_Page_Mvc(array(
    'label'      => 'foo',
    'action'     => 'index',
    'controller' => 'index'
));
 
// getHref() returns /blog/post/view
$page = new Zym_Navigation_Page_Mvc(array(
    'label'      => 'foo',
    'action'     => 'view',
    'controller' => 'post',
    'module'     => 'blog'
));
 
// getHref() returns /blog/post/view/id/1337
$page = new Zym_Navigation_Page_Mvc(array(
    'label'      => 'foo',
    'action'     => 'view',
    'controller' => 'post',
    'module'     => 'blog',
    'id'         => 1337
));

These examples show that MVC pages determine whether they are active by using the params found in the request object.

	Note
	All examples assume a regular MVC setup with default being the default module name, and that the route named default has not been modified.

<?php
 
/*
 * Dispatched request:
 * - module:     default
 * - controller: index
 * - action:     index
 */
 
$page1 = new Zym_Navigation_Page_Mvc(array(
    'label'      => 'foo',
    'action'     => 'index',
    'controller' => 'index'
));
 
$page2 = new Zym_Navigation_Page_Mvc(array(
    'label'      => 'foo',
    'action'     => 'bar',
    'controller' => 'index'
));
 
$page1->isActive(); // returns true
$page2->isActive(); // returns false 
 
/*
 * Dispatched request:
 * - module:     blog
 * - controller: post
 * - action:     view
 * - id:         1337
 */
 
$page = new Zym_Navigation_Page_Mvc(array(
    'label'      => 'foo',
    'action'     => 'view',
    'controller' => 'post',
    'module'     => 'blog'
));
 
// returns true, because request has the same module, controller and action
$page->isActive(); 
 
/*
 * Dispatched request:
 * - module:     blog
 * - controller: post
 * - action:     view
 */
 
$page = new Zym_Navigation_Page_Mvc(array(
    'label'      => 'foo',
    'action'     => 'view',
    'controller' => 'post',
    'module'     => 'blog',
    'id'         => null
));
 
// returns false, because page requires the id param to be set in the request
$page->isActive(); // returns false

MVC pages are aware of routes. Setting what route should be used when generating the URL is done by specifying the route option when constructing, or by calling $page->setRoute('routeName') on a page instance.

<?php
 
// the following route is added to the ZF router 
Zend_Controller_Front::getInstance()->getRouter()->addRoute(
    'article_view', // route name
    new Zend_Controller_Router_Route(
        'a/:id',
        array(
            'module'     => 'news',
            'controller' => 'article',
            'action'     => 'view',
            'id'         => null
        )
    )
);
 
// a page is created with a 'route' option
$page = new Zym_Navigation_Page_Mvc(array(
    'label'  => 'A news article',
    'route'  => 'article_view',
    'params' => array(
        'id' => 42
    )
));
 
// returns: /a/42
$page->getHref();

The only thing you need to add to a custom page is the getHref() method.

<?php
require_once 'Zym/Navigation/Page.php';
 
class My_Simple_Page extends Zym_Navigation_Page
{
    public function getHref()
    {
        return 'something-completely-different';
    }
}

When adding properties to an extended page, there is no need to override/modify setOptions() or setConfig().

<?php
require_once 'Zym/Navigation/Page.php';
 
class My_Navigation_Page extends Zym_Navigation_Page
{
    protected $_foo;
    protected $_fooBar;
 
    public function setFoo($foo)
    {
        $this->_foo = $foo;
    }
 
    public function setFooBar($fooBar)
    {
        $this->_fooBar = $fooBar;
    }
}
 
// can now construct using
$page = new My_Navigation_Page(array(
    'label'   => 'Property names are translated',
    'foo'     => 'bar',
    'foo_bar' => 'baz'
));
 
// ...or
$page = Zym_Navigation_Page::factory(array(
    'type'    => 'My_Navigation_Page',
    'label'   => 'Property names are translated',
    'foo'     => 'bar',
    'foo_bar' => 'baz'
));

This is an example of a more strict version of Zym_Navigation_Page_Mvc. Most of the code is left out to focus on the point; adding validation.

<?php
class My_Strict_Page extends Zym_Navigation_Page_Mvc
{
    /**
     * An MVC page must have controller and action set
     *
     * @return void
     * @throws Zym_Navigation_Page_InvalidException  if page is invalid
     */
    protected function _validate()
    {
        if (!isset($this->_controller)) {
            $msg = 'Page controller is not set';
        } elseif (!isset($this->_action)) {
            $msg = 'Page action is not set';
        }
 
        if (isset($msg)) {
            require_once 'Zym/Navigation/Page/InvalidException.php';
            throw new Zym_Navigation_Page_InvalidException($msg);
        } else {
            parent::_validate();
        }
    }
}