interface/modules/zend_modules/library/Zend/Mvc/Router/RouteStackInterface.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 interface RouteStackInterface extends RouteInterface
  13 {
  14     /**
  15      * Add a route to the stack.
  16      *
  17      * @param  string  $name
  18      * @param  mixed   $route
  19      * @param  int $priority
  20      * @return RouteStackInterface
  21      */
  22     public function addRoute($name, $route, $priority = null);
  23
  24     /**
  25      * Add multiple routes to the stack.
  26      *
  27      * @param  array|\Traversable $routes
  28      * @return RouteStackInterface
  29      */
  30     public function addRoutes($routes);
  31
  32     /**
  33      * Remove a route from the stack.
  34      *
  35      * @param  string $name
  36      * @return RouteStackInterface
  37      */
  38     public function removeRoute($name);
  39
  40     /**
  41      * Remove all routes from the stack and set new ones.
  42      *
  43      * @param  array|\Traversable $routes
  44      * @return RouteStackInterface
  45      */
  46     public function setRoutes($routes);
  47 }