File indexing completed on 2024-06-23 05:55:09

 <?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_Controller
  * @subpackage Router
  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  * @version    $Id$
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
 /** Zend_Controller_Router_Route_Abstract */
 // require_once 'Zend/Controller/Router/Route/Abstract.php';
 
 /**
  * Chain route is used for managing route chaining.
  *
  * @package    Zend_Controller
  * @subpackage Router
  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 class Zend_Controller_Router_Route_Chain extends Zend_Controller_Router_Route_Abstract
 {
 
     /**
      * Routes
      *
      * @var array
      */
     protected $_routes = array();
 
     /**
      * Separators
      *
      * @var array
      */
     protected $_separators = array();
 
     /**
      * Instantiates route based on passed Zend_Config structure
      *
      * @param  Zend_Config $config Configuration object
      * @return Zend_Controller_Router_Route_Chain
      */
     public static function getInstance(Zend_Config $config)
     {
         $defs = ($config->defaults instanceof Zend_Config) ? $config->defaults->toArray() : array();
 
         return new self($config->route, $defs);
     }
 
     /**
      * Add a route to this chain
      *
      * @param  Zend_Controller_Router_Route_Abstract $route
      * @param  string                                $separator
      * @return Zend_Controller_Router_Route_Chain
      */
     public function chain(Zend_Controller_Router_Route_Abstract $route, $separator = self::URI_DELIMITER)
     {
         $this->_routes[]     = $route;
         $this->_separators[] = $separator;
 
         return $this;
     }
 
     /**
      * Matches a user submitted path with a previously defined route.
      * Assigns and returns an array of defaults on a successful match.
      *
      * @param  Zend_Controller_Request_Http $request Request to get the path info from
      * @param  null                         $partial
      * @return array|false An array of assigned values or a false on a mismatch
      */
     public function match($request, $partial = null)
     {
         $rawPath     = $request->getPathInfo();
         $path        = trim($request->getPathInfo(), self::URI_DELIMITER);
         $subPath     = $path;
         $values      = array();
         $matchedPath = null;
 
         foreach ($this->_routes as $key => $route) {
             if ($key > 0
                 && $matchedPath !== null
                 && $subPath !== ''
                 && $subPath !== false
             ) {
                 $separator = substr($subPath, 0, strlen($this->_separators[$key]));
 
                 if ($separator !== $this->_separators[$key]) {
                     $request->setPathInfo($rawPath);
                     return false;
                 }
 
                 $subPath = substr($subPath, strlen($separator));
             }
             // TODO: Should be an interface method. Hack for 1.0 BC
             if (!method_exists($route, 'getVersion') || $route->getVersion() == 1) {
                 $match = $subPath;
             } else {
                 $request->setPathInfo($subPath);
                 $match = $request;
             }
 
             $res = $route->match($match, true);
 
             if ($res === false) {
                 $request->setPathInfo($rawPath);
                 return false;
             }
 
             $matchedPath = $route->getMatchedPath();
 
             if ($matchedPath !== null) {
                 $subPath   = substr($subPath, strlen($matchedPath));
             }
 
             $values = $res + $values;
         }
 
         $request->setPathInfo($path);
 
         if ($subPath !== '' && $subPath !== false) {
             return false;
         }
 
         return $values;
     }
 
     /**
      * Assembles a URL path defined by this route
      *
      * @param  array $data An array of variable and value pairs used as parameters
      * @param  bool  $reset
      * @param  bool  $encode
      * @return string Route path with user submitted parameters
      */
     public function assemble($data = array(), $reset = false, $encode = false)
     {
         $value     = '';
         $numRoutes = count($this->_routes);
 
         foreach ($this->_routes as $key => $route) {
             if ($key > 0) {
                 $value .= $this->_separators[$key];
             }
 
             $value .= $route->assemble($data, $reset, $encode, (($numRoutes - 1) > $key));
 
             if (method_exists($route, 'getVariables')) {
                 $variables = $route->getVariables();
 
                 foreach ($variables as $variable) {
                     $data[$variable] = null;
                 }
             }
         }
 
         return $value;
     }
 
     /**
      * Set the request object for this and the child routes
      *
      * @param  Zend_Controller_Request_Abstract|null $request
      * @return void
      */
     public function setRequest(Zend_Controller_Request_Abstract $request = null)
     {
         $this->_request = $request;
 
         foreach ($this->_routes as $route) {
             if (method_exists($route, 'setRequest')) {
                 $route->setRequest($request);
             }
         }
     }
 
     /**
      * Return a single parameter of route's defaults
      *
      * @param  string $name Array key of the parameter
      * @return string Previously set default
      */
     public function getDefault($name)
     {
         $default = null;
         foreach ($this->_routes as $route) {
             if (method_exists($route, 'getDefault')) {
                 $current = $route->getDefault($name);
                 if (null !== $current) {
                     $default = $current;
                 }
             }
         }
 
         return $default;
     }
 
     /**
      * Return an array of defaults
      *
      * @return array Route defaults
      */
     public function getDefaults()
     {
         $defaults = array();
         foreach ($this->_routes as $route) {
             if (method_exists($route, 'getDefaults')) {
                 $defaults = array_merge($defaults, $route->getDefaults());
             }
         }
 
         return $defaults;
     }
 }