interface/modules/zend_modules/library/Zend/Navigation/Page/Uri.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Navigation\Page;
  11
  12 use Zend\Navigation\Exception;
  13
  14 /**
  15  * Represents a page that is defined by specifying a URI
  16  */
  17 class Uri extends AbstractPage
  18 {
  19     /**
  20      * Page URI
  21      *
  22      * @var string|null
  23      */
  24     protected $uri = null;
  25
  26     /**
  27      * Sets page URI
  28      *
  29      * @param  string $uri                page URI, must a string or null
  30      *
  31      * @return Uri   fluent interface, returns self
  32      * @throws Exception\InvalidArgumentException  if $uri is invalid
  33      */
  34     public function setUri($uri)
  35     {
  36         if (null !== $uri && !is_string($uri)) {
  37             throw new Exception\InvalidArgumentException(
  38                 'Invalid argument: $uri must be a string or null'
  39             );
  40         }
  41
  42         $this->uri = $uri;
  43         return $this;
  44     }
  45
  46     /**
  47      * Returns URI
  48      *
  49      * @return string
  50      */
  51     public function getUri()
  52     {
  53         return $this->uri;
  54     }
  55
  56     /**
  57      * Returns href for this page
  58      *
  59      * Includes the fragment identifier if it is set.
  60      *
  61      * @return string
  62      */
  63     public function getHref()
  64     {
  65         $uri = $this->getUri();
  66
  67         $fragment = $this->getFragment();
  68         if (null !== $fragment) {
  69             if ('#' == substr($uri, -1)) {
  70                 return $uri . $fragment;
  71             } else {
  72                 return $uri . '#' . $fragment;
  73             }
  74         }
  75
  76         return $uri;
  77     }
  78
  79     /**
  80      * Returns an array representation of the page
  81      *
  82      * @return array
  83      */
  84     public function toArray()
  85     {
  86         return array_merge(
  87             parent::toArray(),
  88             array(
  89                 'uri' => $this->getUri(),
  90             )
  91         );
  92     }
  93 }