Source of file Hostname.php
Size: 9,387 Bytes - Last Modified: 2014-03-12T23:21:18+01:00
/home/theseer/Downloads/ZendFramework-2.3.0/library/Zend/Mvc/Router/Http/Hostname.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329 | <?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\Mvc\Router\Http; use Traversable; use Zend\Mvc\Router\Exception; use Zend\Stdlib\ArrayUtils; use Zend\Stdlib\RequestInterface as Request; /** * Hostname route. */ class Hostname implements RouteInterface { /** * Parts of the route. * * @var array */ protected $parts; /** * Regex used for matching the route. * * @var string */ protected $regex; /** * Map from regex groups to parameter names. * * @var array */ protected $paramMap = array(); /** * Default values. * * @var array */ protected $defaults; /** * List of assembled parameters. * * @var array */ protected $assembledParams = array(); /** * Create a new hostname route. * * @param string $route * @param array $constraints * @param array $defaults */ public function __construct($route, array $constraints = array(), array $defaults = array()) { $this->defaults = $defaults; $this->parts = $this->parseRouteDefinition($route); $this->regex = $this->buildRegex($this->parts, $constraints); } /** * factory(): defined by RouteInterface interface. * * @see \Zend\Mvc\Router\RouteInterface::factory() * @param array|Traversable $options * @return Hostname * @throws Exception\InvalidArgumentException */ public static function factory($options = array()) { if ($options instanceof Traversable) { $options = ArrayUtils::iteratorToArray($options); } elseif (!is_array($options)) { throw new Exception\InvalidArgumentException(__METHOD__ . ' expects an array or Traversable set of options'); } if (!isset($options['route'])) { throw new Exception\InvalidArgumentException('Missing "route" in options array'); } if (!isset($options['constraints'])) { $options['constraints'] = array(); } if (!isset($options['defaults'])) { $options['defaults'] = array(); } return new static($options['route'], $options['constraints'], $options['defaults']); } /** * Parse a route definition. * * @param string $def * @return array * @throws Exception\RuntimeException */ protected function parseRouteDefinition($def) { $currentPos = 0; $length = strlen($def); $parts = array(); $levelParts = array(&$parts); $level = 0; while ($currentPos < $length) { preg_match('(\G(?P<literal>[a-z0-9-.]*)(?P<token>[:{\[\]]|$))', $def, $matches, 0, $currentPos); $currentPos += strlen($matches[0]); if (!empty($matches['literal'])) { $levelParts[$level][] = array('literal', $matches['literal']); } if ($matches['token'] === ':') { if (!preg_match('(\G(?P<name>[^:.{\[\]]+)(?:{(?P<delimiters>[^}]+)})?:?)', $def, $matches, 0, $currentPos)) { throw new Exception\RuntimeException('Found empty parameter name'); } $levelParts[$level][] = array('parameter', $matches['name'], isset($matches['delimiters']) ? $matches['delimiters'] : null); $currentPos += strlen($matches[0]); } elseif ($matches['token'] === '[') { $levelParts[$level][] = array('optional', array()); $levelParts[$level + 1] = &$levelParts[$level][count($levelParts[$level]) - 1][1]; $level++; } elseif ($matches['token'] === ']') { unset($levelParts[$level]); $level--; if ($level < 0) { throw new Exception\RuntimeException('Found closing bracket without matching opening bracket'); } } else { break; } } if ($level > 0) { throw new Exception\RuntimeException('Found unbalanced brackets'); } return $parts; } /** * Build the matching regex from parsed parts. * * @param array $parts * @param array $constraints * @param int $groupIndex * @return string * @throws Exception\RuntimeException */ protected function buildRegex(array $parts, array $constraints, &$groupIndex = 1) { $regex = ''; foreach ($parts as $part) { switch ($part[0]) { case 'literal': $regex .= preg_quote($part[1]); break; case 'parameter': $groupName = '?P<param' . $groupIndex . '>'; if (isset($constraints[$part[1]])) { $regex .= '(' . $groupName . $constraints[$part[1]] . ')'; } elseif ($part[2] === null) { $regex .= '(' . $groupName . '[^.]+)'; } else { $regex .= '(' . $groupName . '[^' . $part[2] . ']+)'; } $this->paramMap['param' . $groupIndex++] = $part[1]; break; case 'optional': $regex .= '(?:' . $this->buildRegex($part[1], $constraints, $groupIndex) . ')?'; break; } } return $regex; } /** * Build host. * * @param array $parts * @param array $mergedParams * @param bool $isOptional * @return string * @throws Exception\RuntimeException * @throws Exception\InvalidArgumentException */ protected function buildHost(array $parts, array $mergedParams, $isOptional) { $host = ''; $skip = true; $skippable = false; foreach ($parts as $part) { switch ($part[0]) { case 'literal': $host .= $part[1]; break; case 'parameter': $skippable = true; if (!isset($mergedParams[$part[1]])) { if (!$isOptional) { throw new Exception\InvalidArgumentException(sprintf('Missing parameter "%s"', $part[1])); } return ''; } elseif (!$isOptional || !isset($this->defaults[$part[1]]) || $this->defaults[$part[1]] !== $mergedParams[$part[1]]) { $skip = false; } $host .= $mergedParams[$part[1]]; $this->assembledParams[] = $part[1]; break; case 'optional': $skippable = true; $optionalPart = $this->buildHost($part[1], $mergedParams, true); if ($optionalPart !== '') { $host .= $optionalPart; $skip = false; } break; } } if ($isOptional && $skippable && $skip) { return ''; } return $host; } /** * match(): defined by RouteInterface interface. * * @see \Zend\Mvc\Router\RouteInterface::match() * @param Request $request * @return RouteMatch|null */ public function match(Request $request) { if (!method_exists($request, 'getUri')) { return null; } $uri = $request->getUri(); $host = $uri->getHost(); $result = preg_match('(^' . $this->regex . '$)', $host, $matches); if (!$result) { return null; } $params = array(); foreach ($this->paramMap as $index => $name) { if (isset($matches[$index]) && $matches[$index] !== '') { $params[$name] = $matches[$index]; } } return new RouteMatch(array_merge($this->defaults, $params)); } /** * assemble(): Defined by RouteInterface interface. * * @see \Zend\Mvc\Router\RouteInterface::assemble() * @param array $params * @param array $options * @return mixed */ public function assemble(array $params = array(), array $options = array()) { $this->assembledParams = array(); if (isset($options['uri'])) { $host = $this->buildHost( $this->parts, array_merge($this->defaults, $params), false ); $options['uri']->setHost($host); } // A hostname does not contribute to the path, thus nothing is returned. return ''; } /** * getAssembledParams(): defined by RouteInterface interface. * * @see RouteInterface::getAssembledParams * @return array */ public function getAssembledParams() { return $this->assembledParams; } } |