<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category  Zend

 * @package   Zend_Navigation

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license   http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Page.php 22882 2010-08-22 14:00:16Z freak $

 */

/**

 * @see Zend_Navigation_Container

 */

require_once 'Zend/Navigation/Container.php';

/**

 * Base class for Zend_Navigation_Page pages

 *

 * @category  Zend

 * @package   Zend_Navigation

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license   http://framework.zend.com/license/new-bsd     New BSD License

 */

abstract class Zend_Navigation_Page extends Zend_Navigation_Container

{

    /**

     * Page label

     *

     * @var string|null

     */

    protected $_label;

    /**

     * Page id

     *

     * @var string|null

     */

    protected $_id;

    /**

     * Style class for this page (CSS)

     *

     * @var string|null

     */

    protected $_class;

    /**

     * A more descriptive title for this page

     *

     * @var string|null

     */

    protected $_title;

    /**

     * This page's target

     *

     * @var string|null

     */

    protected $_target;

    /**

     * Forward links to other pages

     *

     * @link http://www.w3.org/TR/html4/struct/links.html#h-12.3.1

     *

     * @var array

     */

    protected $_rel = array();

    /**

     * Reverse links to other pages

     *

     * @link http://www.w3.org/TR/html4/struct/links.html#h-12.3.1

     *

     * @var array

     */

    protected $_rev = array();

    /**

     * Page order used by parent container

     *

     * @var int|null

     */

    protected $_order;

    /**

     * ACL resource associated with this page

     *

     * @var string|Zend_Acl_Resource_Interface|null

     */

    protected $_resource;

    /**

     * ACL privilege associated with this page

     *

     * @var string|null

     */

    protected $_privilege;

    /**

     * Whether this page should be considered active

     *

     * @var bool

     */

    protected $_active = false;

    /**

     * Whether this page should be considered visible

     *

     * @var bool

     */

    protected $_visible = true;

    /**

     * Parent container

     *

     * @var Zend_Navigation_Container|null

     */

    protected $_parent;

    /**

     * Custom page properties, used by __set(), __get() and __isset()

     *

     * @var array

     */

    protected $_properties = array();

    /**

     * The type of page to use when it wasn't set

     * 

     * @var string

     */

    protected static $_defaultPageType;

    // Initialization:

    /**

     * Factory for Zend_Navigation_Page classes

     *

     * A specific type to construct can be specified by specifying the key

     * 'type' in $options. If type is 'uri' or 'mvc', the type will be resolved

     * to Zend_Navigation_Page_Uri or Zend_Navigation_Page_Mvc. Any other value

     * for 'type' will be considered the full name of the class to construct.

     * A valid custom page class must extend Zend_Navigation_Page.

     *

     * If 'type' is not given, the type of page to construct will be determined

     * by the following rules:

     * - If $options contains either of the keys 'action', 'controller',

     *   'module', or 'route', a Zend_Navigation_Page_Mvc page will be created.

     * - If $options contains the key 'uri', a Zend_Navigation_Page_Uri page

     *   will be created.

     *

     * @param  array|Zend_Config $options  options used for creating page

     * @return Zend_Navigation_Page        a page instance

     * @throws Zend_Navigation_Exception   if $options is not array/Zend_Config

     * @throws Zend_Exception              if 'type' is specified and

     *                                     Zend_Loader is unable to load the

     *                                     class

     * @throws Zend_Navigation_Exception   if something goes wrong during

     *                                     instantiation of the page

     * @throws Zend_Navigation_Exception   if 'type' is given, and the specified

     *                                     type does not extend this class

     * @throws Zend_Navigation_Exception   if unable to determine which class

     *                                     to instantiate

     */

    public static function factory($options)

    {

        if ($options instanceof Zend_Config) {

            $options = $options->toArray();

        }

        if (!is_array($options)) {

            require_once 'Zend/Navigation/Exception.php';

            throw new Zend_Navigation_Exception(

                'Invalid argument: $options must be an array or Zend_Config');

        }

        if (isset($options['type'])) {

            $type = $options['type'];

        } elseif(self::getDefaultPageType()!= null) {

            $type = self::getDefaultPageType();

        }

        if(isset($type)) {

            if (is_string($type) && !empty($type)) {

                switch (strtolower($type)) {

                    case 'mvc':

                        $type = 'Zend_Navigation_Page_Mvc';

                        break;

                    case 'uri':

                        $type = 'Zend_Navigation_Page_Uri';

                        break;

                }

                if (!class_exists($type)) {

                    require_once 'Zend/Loader.php';

                    @Zend_Loader::loadClass($type);

                }

                $page = new $type($options);

                if (!$page instanceof Zend_Navigation_Page) {

                    require_once 'Zend/Navigation/Exception.php';

                    throw new Zend_Navigation_Exception(sprintf(

                            'Invalid argument: Detected type "%s", which ' .

                            'is not an instance of Zend_Navigation_Page',

                            $type));

                }

                return $page;

            }

        }

        $hasUri = isset($options['uri']);

        $hasMvc = isset($options['action']) || isset($options['controller']) ||

                  isset($options['module']) || isset($options['route']);

        if ($hasMvc) {

            require_once 'Zend/Navigation/Page/Mvc.php';

            return new Zend_Navigation_Page_Mvc($options);

        } elseif ($hasUri) {

            require_once 'Zend/Navigation/Page/Uri.php';

            return new Zend_Navigation_Page_Uri($options);

        } else {

            require_once 'Zend/Navigation/Exception.php';

            throw new Zend_Navigation_Exception(

                'Invalid argument: Unable to determine class to instantiate');

        }

    }

    /**

     * Page constructor

     *

     * @param  array|Zend_Config $options   [optional] page options. Default is

     *                                      null, which should set defaults.

     * @throws Zend_Navigation_Exception    if invalid options are given

     */

    public function __construct($options = null)

    {

        if (is_array($options)) {

            $this->setOptions($options);

        } elseif ($options instanceof Zend_Config) {

            $this->setConfig($options);

        }

        // do custom initialization

        $this->_init();

    }

    /**

     * Initializes page (used by subclasses)

     *

     * @return void

     */

    protected function _init()

    {

    }

    /**

     * Sets page properties using a Zend_Config object

     *

     * @param  Zend_Config $config        config object to get properties from

     * @return Zend_Navigation_Page       fluent interface, returns self

     * @throws Zend_Navigation_Exception  if invalid options are given

     */

    public function setConfig(Zend_Config $config)

    {

        return $this->setOptions($config->toArray());

    }

    /**

     * Sets page properties using options from an associative array

     *

     * Each key in the array corresponds to the according set*() method, and

     * each word is separated by underscores, e.g. the option 'target'

     * corresponds to setTarget(), and the option 'reset_params' corresponds to

     * the method setResetParams().

     *

     * @param  array $options             associative array of options to set

     * @return Zend_Navigation_Page       fluent interface, returns self

     * @throws Zend_Navigation_Exception  if invalid options are given

     */

    public function setOptions(array $options)

    {

        foreach ($options as $key => $value) {

            $this->set($key, $value);

        }

        return $this;

    }

    // Accessors:

    /**

     * Sets page label

     *

     * @param  string $label              new page label

     * @return Zend_Navigation_Page       fluent interface, returns self

     * @throws Zend_Navigation_Exception  if empty/no string is given

     */

    public function setLabel($label)

    {

        if (null !== $label && !is_string($label)) {

            require_once 'Zend/Navigation/Exception.php';

            throw new Zend_Navigation_Exception(

                    'Invalid argument: $label must be a string or null');

        }

        $this->_label = $label;

        return $this;

    }

    /**

     * Returns page label

     *

     * @return string  page label or null

     */

    public function getLabel()

    {

        return $this->_label;

    }

    /**

     * Sets page id

     *

     * @param  string|null $id            [optional] id to set. Default is null,

     *                                    which sets no id.

     * @return Zend_Navigation_Page       fluent interface, returns self

     * @throws Zend_Navigation_Exception  if not given string or null

     */

    public function setId($id = null)

    {

        if (null !== $id && !is_string($id) && !is_numeric($id)) {

            require_once 'Zend/Navigation/Exception.php';

            throw new Zend_Navigation_Exception(

                    'Invalid argument: $id must be a string, number or null');

        }

        $this->_id = null === $id ? $id : (string) $id;

        return $this;

    }

    /**

     * Returns page id

     *

     * @return string|null  page id or null

     */

    public function getId()

    {

        return $this->_id;

    }

    /**

     * Sets page CSS class

     *

     * @param  string|null $class         [optional] CSS class to set. Default

     *                                    is null, which sets no CSS class.

     * @return Zend_Navigation_Page       fluent interface, returns self

     * @throws Zend_Navigation_Exception  if not given string or null

     */

    public function setClass($class = null)

    {

        if (null !== $class && !is_string($class)) {

            require_once 'Zend/Navigation/Exception.php';

            throw new Zend_Navigation_Exception(

                    'Invalid argument: $class must be a string or null');

        }

        $this->_class = $class;

        return $this;

    }

    /**

     * Returns page class (CSS)

     *

     * @return string|null  page's CSS class or null

     */

    public function getClass()

    {

        return $this->_class;

    }

    /**

     * Sets page title

     *

     * @param  string $title              [optional] page title. Default is

     *                                    null, which sets no title.

     * @return Zend_Navigation_Page       fluent interface, returns self

     * @throws Zend_Navigation_Exception  if not given string or null

     */

    public function setTitle($title = null)

    {

        if (null !== $title && !is_string($title)) {

            require_once 'Zend/Navigation/Exception.php';

            throw new Zend_Navigation_Exception(

                    'Invalid argument: $title must be a non-empty string');

        }

        $this->_title = $title;

        return $this;

    }

    /**

     * Returns page title

     *

     * @return string|null  page title or null

     */

    public function getTitle()

    {

        return $this->_title;

    }

    /**

     * Sets page target

     *

     * @param  string|null $target        [optional] target to set. Default is

     *                                    null, which sets no target.

     * @return Zend_Navigation_Page       fluent interface, returns self

     * @throws Zend_Navigation_Exception  if target is not string or null

     */

    public function setTarget($target = null)

    {

        if (null !== $target && !is_string($target)) {

            require_once 'Zend/Navigation/Exception.php';

            throw new Zend_Navigation_Exception(

                    'Invalid argument: $target must be a string or null');

        }

        $this->_target = $target;

        return $this;

    }

    /**

     * Returns page target

     *

     * @return string|null  page target or null

     */

    public function getTarget()

    {

        return $this->_target;

    }

    /**

     * Sets the page's forward links to other pages

     *

     * This method expects an associative array of forward links to other pages,

     * where each element's key is the name of the relation (e.g. alternate,

     * prev, next, help, etc), and the value is a mixed value that could somehow

     * be considered a page.

     *

     * @param  array|Zend_Config $relations  [optional] an associative array of

     *                                       forward links to other pages

     * @return Zend_Navigation_Page          fluent interface, returns self

     */

    public function setRel($relations = null)