tweet_live: comparison web/lib/Zend/Navigation/Page.php

equal deleted inserted replaced

-:5e7a0fedabdf
+:877f952ae2bd
 * 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)
+* @copyright  Copyright (c) 2005-2012 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 $
+* @version    $Id: Page.php 25125 2012-11-16 15:12:06Z rob $
 */
 /**
 * @see Zend_Navigation_Container
 */
 /**
 * 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)
+* @copyright  Copyright (c) 2005-2012 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
 {
 /**
 * @var string|null
 */
 protected $_label;
 /**
+* Fragment identifier (anchor identifier)
+*
+* The fragment identifier (anchor identifier) pointing to an anchor within
+* a resource that is subordinate to another, primary resource.
+* The fragment identifier introduced by a hash mark "#".
+* Example: http://www.example.org/foo.html#bar ("bar" is the fragment identifier)
+*
+* @link http://www.w3.org/TR/html401/intro/intro.html#fragment-uri
+*
+* @var string|null
+*/
+protected $_fragment;
+/**
 * Page id
 *
 * @var string|null
 */
 protected $_id;
 * @var string|null
 */
 protected $_target;
 /**
+* Accessibility key character
+*
+* This attribute assigns an access key to an element. An access key is a
+* single character from the document character set.
+*
+* @link http://www.w3.org/TR/html401/interact/forms.html#access-keys
+*
+* @var string|null
+*/
+protected $_accesskey;
+/**
 * Forward links to other pages
 *
 * @link http://www.w3.org/TR/html4/struct/links.html#h-12.3.1
 *
 * @var array
 * @var array
 */
 protected $_properties = array();
 /**
+* Custom HTML attributes
+*
+* @var array
+*/
+protected $_customHtmlAttribs = array();
+/**
 * The type of page to use when it wasn't set
 *
 * @var string
 */
 protected static $_defaultPageType;
 // Initialization:
 /**
 * Factory for Zend_Navigation_Page classes
 *
 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';
 }
 }
 $hasUri = isset($options['uri']);
 $hasMvc = isset($options['action']) || isset($options['controller']) ||
-isset($options['module']) || isset($options['route']);
+isset($options['module']) || isset($options['route']) ||
+isset($options['params']);
 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');
+$message = 'Invalid argument: Unable to determine class to instantiate';
-}
+if (isset($options['label'])) {
+$message .= ' (Page label: ' . $options['label'] . ')';
+}
+throw new Zend_Navigation_Exception($message);
+}
 }
 /**
 * Page constructor
 *
 {
 return $this->_label;
 }
 /**
+* Sets a fragment identifier
+*
+* @param  string $fragment   new fragment identifier
+* @return Zend_Navigation_Page         fluent interface, returns self
+* @throws Zend_Navigation_Exception    if empty/no string is given
+*/
+public function setFragment($fragment)
+{
+if (null !== $fragment && !is_string($fragment)) {
+require_once 'Zend/Navigation/Exception.php';
+throw new Zend_Navigation_Exception(
+'Invalid argument: $fragment must be a string or null');
+}
+$this->_fragment = $fragment;
+return $this;
+}
+/**
+* Returns fragment identifier
+*
+* @return string|null  fragment identifier
+*/
+public function getFragment()
+{
+return $this->_fragment;
+}
+/**
 * 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
 * @return string|null  page target or null
 */
 public function getTarget()
 {
 return $this->_target;
+}
+/**
+* Sets access key for this page
+*
+* @param  string|null $character     [optional] access key to set. Default
+*                                    is null, which sets no access key.
+* @return Zend_Navigation_Page       fluent interface, returns self
+* @throws Zend_Navigation_Exception  if access key is not string or null or
+*                                    if the string length not equal to one
+*/
+public function setAccesskey($character = null)
+{
+if (null !== $character
+&& (!is_string($character) || 1 != strlen($character)))
+{
+require_once 'Zend/Navigation/Exception.php';
+throw new Zend_Navigation_Exception(
+'Invalid argument: $character must be a single character or null'
+);
+}
+$this->_accesskey = $character;
+return $this;
+}
+/**
+* Returns page access key
+*
+* @return string|null  page access key or null
+*/
+public function getAccesskey()
+{
+return $this->_accesskey;
 }
 /**
 * Sets the page's forward links to other pages
 *
 $this->_rev[$relation] :
 null;
 }
 return $this->_rev;
+}
+/**
+* Sets a single custom HTML attribute
+*
+* @param  string      $name            name of the HTML attribute
+* @param  string|null $value           value for the HTML attribute
+* @return Zend_Navigation_Page         fluent interface, returns self
+* @throws Zend_Navigation_Exception    if name is not string or value is
+*                                      not null or a string
+*/
+public function setCustomHtmlAttrib($name, $value)
+{
+if (!is_string($name)) {
+require_once 'Zend/Navigation/Exception.php';
+throw new Zend_Navigation_Exception(
+'Invalid argument: $name must be a string'
+);
+}
+if (null !== $value && !is_string($value)) {
+require_once 'Zend/Navigation/Exception.php';
+throw new Zend_Navigation_Exception(
+'Invalid argument: $value must be a string or null'
+);
+}
+if (null === $value && isset($this->_customHtmlAttribs[$name])) {
+unset($this->_customHtmlAttribs[$name]);
+} else {
+$this->_customHtmlAttribs[$name] = $value;
+}
+return $this;
+}
+/**
+* Returns a single custom HTML attributes by name
+*
+* @param  string $name                 name of the HTML attribute
+* @return string|null                  value for the HTML attribute or null
+* @throws Zend_Navigation_Exception    if name is not string
+*/
+public function getCustomHtmlAttrib($name)
+{
+if (!is_string($name)) {
+require_once 'Zend/Navigation/Exception.php';
+throw new Zend_Navigation_Exception(
+'Invalid argument: $name must be a string'
+);
+}
+if (isset($this->_customHtmlAttribs[$name])) {
+return $this->_customHtmlAttribs[$name];
+}
+return null;
+}
+/**
+* Sets multiple custom HTML attributes at once
+*
+* @param array $attribs        an associative array of html attributes
+* @return Zend_Navigation_Page fluent interface, returns self
+*/
+public function setCustomHtmlAttribs(array $attribs)
+{
+foreach ($attribs as $key => $value) {
+$this->setCustomHtmlAttrib($key, $value);
+}
+return $this;
+}
+/**
+* Returns all custom HTML attributes as an array
+*
+* @return array    an array containing custom HTML attributes
+*/
+public function getCustomHtmlAttribs()
+{
+return $this->_customHtmlAttribs;
+}
+/**
+* Removes a custom HTML attribute from the page
+*
+* @param  string $name          name of the custom HTML attribute
+* @return Zend_Navigation_Page  fluent interface, returns self
+*/
+public function removeCustomHtmlAttrib($name)
+{
+if (!is_string($name)) {
+require_once 'Zend/Navigation/Exception.php';
+throw new Zend_Navigation_Exception(
+'Invalid argument: $name must be a string'
+);
+}
+if (isset($this->_customHtmlAttribs[$name])) {
+unset($this->_customHtmlAttribs[$name]);
+}
+}
+/**
+* Clear all custom HTML attributes
+*
+* @return Zend_Navigation_Page fluent interface, returns self
+*/
+public function clearCustomHtmlAttribs()
+{
+$this->_customHtmlAttribs = array();
+return $this;
 }
 /**
 * Sets page order to use in parent container
 *
 *                               considered visible or not. Default is true.
 * @return Zend_Navigation_Page  fluent interface, returns self
 */
 public function setVisible($visible = true)
 {
+if (is_string($visible) && 'false' == strtolower($visible)) {
+$visible = false;
+}
 $this->_visible = (bool) $visible;
 return $this;
 }
 /**
 public function toArray()
 {
 return array_merge(
 $this->getCustomProperties(),
 array(
-'label'     => $this->getlabel(),
+'label'             => $this->getlabel(),
-'id'        => $this->getId(),
+'fragment'          => $this->getFragment(),
-'class'     => $this->getClass(),
+'id'                => $this->getId(),
-'title'     => $this->getTitle(),
+'class'             => $this->getClass(),
-'target'    => $this->getTarget(),
+'title'             => $this->getTitle(),
-'rel'       => $this->getRel(),
+'target'            => $this->getTarget(),
-'rev'       => $this->getRev(),
+'accesskey'         => $this->getAccesskey(),
-'order'     => $this->getOrder(),
+'rel'               => $this->getRel(),
-'resource'  => $this->getResource(),
+'rev'               => $this->getRev(),
-'privilege' => $this->getPrivilege(),
+'customHtmlAttribs' => $this->getCustomHtmlAttribs(),
-'active'    => $this->isActive(),
+'order'             => $this->getOrder(),
-'visible'   => $this->isVisible(),
+'resource'          => $this->getResource(),
-'type'      => get_class($this),
+'privilege'         => $this->getPrivilege(),
-'pages'     => parent::toArray()
+'active'            => $this->isActive(),
-));
+'visible'           => $this->isVisible(),
+'type'              => get_class($this),
+'pages'             => parent::toArray()
+)
+);
 }
 // Internal methods:
 /**
 */
 protected static function _normalizePropertyName($property)
 {
 return str_replace(' ', '', ucwords(str_replace('_', ' ', $property)));
 }
 public static function setDefaultPageType($type = null) {
 if($type !== null && !is_string($type)) {
 throw new Zend_Navigation_Exception(
 'Cannot set default page type: type is no string but should be'
 );
 }
 self::$_defaultPageType = $type;
 }
 public static function getDefaultPageType() {
 return self::$_defaultPageType;
 }
 // Abstract methods:

changeset 807	877f952ae2bd
parent 207	621fa6caec0c
child 1230	68c69c656a2c