CommunityID/libs/Zend/Controller/Router/Route/Chain.php

169 lines
5.3 KiB
PHP
Raw Normal View History

2019-07-17 20:08:50 +00:00
<?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.
*
* @package Zend_Controller
* @subpackage Router
* @copyright Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
* @version $Id: Route.php 1847 2006-11-23 11:36:41Z martel $
* @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-2008 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
{
protected $_routes = array();
protected $_separators = array();
/**
* Instantiates route based on passed Zend_Config structure
*
* @param Zend_Config $config Configuration object
*/
public static function getInstance(Zend_Config $config)
2019-07-17 20:16:19 +00:00
{
$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 = '/')
{
$this->_routes[] = $route;
2019-07-17 20:08:50 +00:00
$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.
*
2019-07-17 20:16:19 +00:00
* @param Zend_Controller_Request_Http $request Request to get the path info from
2019-07-17 20:08:50 +00:00
* @return array|false An array of assigned values or a false on a mismatch
*/
public function match($request, $partial = null)
{
2019-07-17 20:16:19 +00:00
$path = trim($request->getPathInfo(), '/');
$subPath = $path;
$values = array();
2019-07-17 20:08:50 +00:00
foreach ($this->_routes as $key => $route) {
2019-07-17 20:16:19 +00:00
if ($key > 0 && $matchedPath !== null) {
$separator = substr($subPath, 0, strlen($this->_separators[$key]));
if ($separator !== $this->_separators[$key]) {
return false;
}
$subPath = substr($subPath, strlen($separator));
}
2019-07-17 20:08:50 +00:00
// TODO: Should be an interface method. Hack for 1.0 BC
if (!method_exists($route, 'getVersion') || $route->getVersion() == 1) {
2019-07-17 20:16:19 +00:00
$match = $subPath;
2019-07-17 20:08:50 +00:00
} else {
2019-07-17 20:16:19 +00:00
$request->setPathInfo($subPath);
$match = $request;
}
$res = $route->match($match, true);
if ($res === false) {
return false;
2019-07-17 20:08:50 +00:00
}
2019-07-17 20:16:19 +00:00
$matchedPath = $route->getMatchedPath();
if ($matchedPath !== null) {
$subPath = substr($subPath, strlen($matchedPath));
$separator = substr($subPath, 0, strlen($this->_separators[$key]));
}
2019-07-17 20:08:50 +00:00
$values = $res + $values;
2019-07-17 20:16:19 +00:00
}
$request->setPathInfo($path);
if ($subPath !== '' && $subPath !== false) {
return false;
2019-07-17 20:08:50 +00:00
}
return $values;
}
/**
* Assembles a URL path defined by this route
*
* @param array $data An array of variable and value pairs used as parameters
* @return string Route path with user submitted parameters
*/
public function assemble($data = array(), $reset = false, $encode = false)
{
2019-07-17 20:16:19 +00:00
$value = '';
$numRoutes = count($this->_routes);
2019-07-17 20:08:50 +00:00
foreach ($this->_routes as $key => $route) {
if ($key > 0) {
$value .= $this->_separators[$key];
}
2019-07-17 20:16:19 +00:00
$value .= $route->assemble($data, $reset, $encode, (($numRoutes - 1) > $key));
2019-07-17 20:08:50 +00:00
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);
}
}
}
}