interface/modules/zend_modules/library/Zend/Mvc/Router/PriorityList.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\Mvc\Router;
  11
  12 use Countable;
  13 use Iterator;
  14
  15 /**
  16  * Priority list
  17  */
  18 class PriorityList implements Iterator, Countable
  19 {
  20     /**
  21      * Internal list of all routes.
  22      *
  23      * @var array
  24      */
  25     protected $routes = array();
  26
  27     /**
  28      * Serial assigned to routes to preserve LIFO.
  29      *
  30      * @var int
  31      */
  32     protected $serial = 0;
  33
  34     /**
  35      * Internal counter to avoid usage of count().
  36      *
  37      * @var int
  38      */
  39     protected $count = 0;
  40
  41     /**
  42      * Whether the list was already sorted.
  43      *
  44      * @var bool
  45      */
  46     protected $sorted = false;
  47
  48     /**
  49      * Insert a new route.
  50      *
  51      * @param  string  $name
  52      * @param  RouteInterface   $route
  53      * @param  int $priority
  54      * @return void
  55      */
  56     public function insert($name, RouteInterface $route, $priority)
  57     {
  58         $this->sorted = false;
  59         $this->count++;
  60
  61         $this->routes[$name] = array(
  62             'route'    => $route,
  63             'priority' => (int) $priority,
  64             'serial'   => $this->serial++,
  65         );
  66     }
  67
  68     /**
  69      * Remove a route.
  70      *
  71      * @param  string $name
  72      * @return void
  73      */
  74     public function remove($name)
  75     {
  76         if (!isset($this->routes[$name])) {
  77             return;
  78         }
  79
  80         $this->count--;
  81
  82         unset($this->routes[$name]);
  83     }
  84
  85     /**
  86      * Remove all routes.
  87      *
  88      * @return void
  89      */
  90     public function clear()
  91     {
  92         $this->routes = array();
  93         $this->serial = 0;
  94         $this->count  = 0;
  95         $this->sorted = false;
  96     }
  97
  98     /**
  99      * Get a route.
 100      *
 101      * @param  string $name
 102      * @return RouteInterface
 103      */
 104     public function get($name)
 105     {
 106         if (!isset($this->routes[$name])) {
 107             return null;
 108         }
 109
 110         return $this->routes[$name]['route'];
 111     }
 112
 113     /**
 114      * Sort all routes.
 115      *
 116      * @return void
 117      */
 118     protected function sort()
 119     {
 120         uasort($this->routes, array($this, 'compare'));
 121         $this->sorted = true;
 122     }
 123
 124     /**
 125      * Compare the priority of two routes.
 126      *
 127      * @param  array $route1,
 128      * @param  array $route2
 129      * @return int
 130      */
 131     protected function compare(array $route1, array $route2)
 132     {
 133         if ($route1['priority'] === $route2['priority']) {
 134             return ($route1['serial'] > $route2['serial'] ? -1 : 1);
 135         }
 136
 137         return ($route1['priority'] > $route2['priority'] ? -1 : 1);
 138     }
 139
 140     /**
 141      * rewind(): defined by Iterator interface.
 142      *
 143      * @see    Iterator::rewind()
 144      * @return void
 145      */
 146     public function rewind()
 147     {
 148         if (!$this->sorted) {
 149             $this->sort();
 150         }
 151
 152         reset($this->routes);
 153     }
 154
 155     /**
 156      * current(): defined by Iterator interface.
 157      *
 158      * @see    Iterator::current()
 159      * @return RouteInterface
 160      */
 161     public function current()
 162     {
 163         $node = current($this->routes);
 164         return ($node !== false ? $node['route'] : false);
 165     }
 166
 167     /**
 168      * key(): defined by Iterator interface.
 169      *
 170      * @see    Iterator::key()
 171      * @return string
 172      */
 173     public function key()
 174     {
 175         return key($this->routes);
 176     }
 177
 178     /**
 179      * next(): defined by Iterator interface.
 180      *
 181      * @see    Iterator::next()
 182      * @return RouteInterface
 183      */
 184     public function next()
 185     {
 186         $node = next($this->routes);
 187         return ($node !== false ? $node['route'] : false);
 188     }
 189
 190     /**
 191      * valid(): defined by Iterator interface.
 192      *
 193      * @see    Iterator::valid()
 194      * @return bool
 195      */
 196     public function valid()
 197     {
 198         return ($this->current() !== false);
 199     }
 200
 201     /**
 202      * count(): defined by Countable interface.
 203      *
 204      * @see    Countable::count()
 205      * @return int
 206      */
 207     public function count()
 208     {
 209         return $this->count;
 210     }
 211 }