2010-02-17 13:53:31 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
2011-01-15 13:29:43 +00:00
|
|
|
* This file is part of the Symfony package.
|
2010-02-17 13:53:31 +00:00
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2010-02-17 13:53:31 +00:00
|
|
|
*
|
2011-01-15 13:29:43 +00:00
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
2010-02-17 13:53:31 +00:00
|
|
|
*/
|
|
|
|
|
2011-01-15 13:29:43 +00:00
|
|
|
namespace Symfony\Component\Routing;
|
|
|
|
|
2010-02-17 13:53:31 +00:00
|
|
|
/**
|
|
|
|
* A Route describes a route and its parameters.
|
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
2011-06-14 14:35:32 +01:00
|
|
|
*
|
|
|
|
* @api
|
2010-02-17 13:53:31 +00:00
|
|
|
*/
|
|
|
|
class Route
|
|
|
|
{
|
2011-03-23 18:24:18 +00:00
|
|
|
private $pattern;
|
|
|
|
private $defaults;
|
|
|
|
private $requirements;
|
|
|
|
private $options;
|
|
|
|
private $compiled;
|
2010-05-06 12:25:53 +01:00
|
|
|
|
2011-03-23 18:24:18 +00:00
|
|
|
static private $compilers = array();
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
|
|
|
* Available options:
|
|
|
|
*
|
2011-04-25 11:03:41 +01:00
|
|
|
* * compiler_class: A class name able to compile this route instance (RouteCompiler by default)
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
2012-05-15 21:19:31 +01:00
|
|
|
* @param string $pattern The pattern to match
|
|
|
|
* @param array $defaults An array of default parameter values
|
|
|
|
* @param array $requirements An array of requirements for parameters (regexes)
|
|
|
|
* @param array $options An array of options
|
2011-06-14 14:35:32 +01:00
|
|
|
*
|
|
|
|
* @api
|
2010-05-06 12:25:53 +01:00
|
|
|
*/
|
|
|
|
public function __construct($pattern, array $defaults = array(), array $requirements = array(), array $options = array())
|
2010-02-17 13:53:31 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->setPattern($pattern);
|
|
|
|
$this->setDefaults($defaults);
|
|
|
|
$this->setRequirements($requirements);
|
|
|
|
$this->setOptions($options);
|
2010-02-17 13:53:31 +00:00
|
|
|
}
|
|
|
|
|
2011-10-24 10:39:31 +01:00
|
|
|
public function __clone()
|
|
|
|
{
|
|
|
|
$this->compiled = null;
|
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Returns the pattern.
|
|
|
|
*
|
|
|
|
* @return string The pattern
|
|
|
|
*/
|
|
|
|
public function getPattern()
|
2010-02-17 13:53:31 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->pattern;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the pattern.
|
|
|
|
*
|
|
|
|
* This method implements a fluent interface.
|
|
|
|
*
|
2010-07-01 19:17:03 +01:00
|
|
|
* @param string $pattern The pattern
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
|
|
|
*/
|
|
|
|
public function setPattern($pattern)
|
|
|
|
{
|
|
|
|
$this->pattern = trim($pattern);
|
|
|
|
|
|
|
|
// a route must start with a slash
|
2012-04-01 11:32:28 +01:00
|
|
|
if ('' === $this->pattern || '/' !== $this->pattern[0]) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->pattern = '/'.$this->pattern;
|
|
|
|
}
|
2010-02-17 13:53:31 +00:00
|
|
|
|
2012-04-01 11:32:28 +01:00
|
|
|
$this->compiled = null;
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this;
|
|
|
|
}
|
2010-02-17 13:53:31 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Returns the options.
|
|
|
|
*
|
|
|
|
* @return array The options
|
|
|
|
*/
|
|
|
|
public function getOptions()
|
|
|
|
{
|
|
|
|
return $this->options;
|
2010-02-17 13:53:31 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Sets the options.
|
|
|
|
*
|
|
|
|
* This method implements a fluent interface.
|
|
|
|
*
|
2010-07-01 19:17:03 +01:00
|
|
|
* @param array $options The options
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
|
|
|
*/
|
|
|
|
public function setOptions(array $options)
|
2010-02-17 13:53:31 +00:00
|
|
|
{
|
2012-04-04 02:35:48 +01:00
|
|
|
$this->options = array(
|
2011-05-13 17:17:57 +01:00
|
|
|
'compiler_class' => 'Symfony\\Component\\Routing\\RouteCompiler',
|
2012-04-04 02:35:48 +01:00
|
|
|
);
|
|
|
|
|
|
|
|
return $this->addOptions($options);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds options.
|
|
|
|
*
|
|
|
|
* This method implements a fluent interface.
|
|
|
|
*
|
|
|
|
* @param array $options The options
|
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
|
|
|
*/
|
|
|
|
public function addOptions(array $options)
|
|
|
|
{
|
|
|
|
foreach ($options as $name => $option) {
|
|
|
|
$this->options[(string) $name] = $option;
|
|
|
|
}
|
2012-04-01 11:32:28 +01:00
|
|
|
$this->compiled = null;
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
return $this;
|
2010-02-17 13:53:31 +00:00
|
|
|
}
|
|
|
|
|
2011-05-13 17:17:57 +01:00
|
|
|
/**
|
|
|
|
* Sets an option value.
|
|
|
|
*
|
|
|
|
* This method implements a fluent interface.
|
|
|
|
*
|
|
|
|
* @param string $name An option name
|
|
|
|
* @param mixed $value The option value
|
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
2011-06-14 14:35:32 +01:00
|
|
|
*
|
|
|
|
* @api
|
2011-05-13 17:17:57 +01:00
|
|
|
*/
|
|
|
|
public function setOption($name, $value)
|
|
|
|
{
|
|
|
|
$this->options[$name] = $value;
|
2012-04-01 11:32:28 +01:00
|
|
|
$this->compiled = null;
|
2011-05-13 17:17:57 +01:00
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Get an option value.
|
|
|
|
*
|
|
|
|
* @param string $name An option name
|
|
|
|
*
|
|
|
|
* @return mixed The option value
|
|
|
|
*/
|
|
|
|
public function getOption($name)
|
|
|
|
{
|
|
|
|
return isset($this->options[$name]) ? $this->options[$name] : null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the defaults.
|
|
|
|
*
|
|
|
|
* @return array The defaults
|
|
|
|
*/
|
|
|
|
public function getDefaults()
|
|
|
|
{
|
|
|
|
return $this->defaults;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the defaults.
|
|
|
|
*
|
|
|
|
* This method implements a fluent interface.
|
|
|
|
*
|
2010-07-01 19:17:03 +01:00
|
|
|
* @param array $defaults The defaults
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
|
|
|
*/
|
|
|
|
public function setDefaults(array $defaults)
|
|
|
|
{
|
2011-07-17 16:29:41 +01:00
|
|
|
$this->defaults = array();
|
2011-10-23 10:56:23 +01:00
|
|
|
|
|
|
|
return $this->addDefaults($defaults);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds defaults.
|
|
|
|
*
|
|
|
|
* This method implements a fluent interface.
|
|
|
|
*
|
|
|
|
* @param array $defaults The defaults
|
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
|
|
|
*/
|
|
|
|
public function addDefaults(array $defaults)
|
|
|
|
{
|
2011-07-17 16:29:41 +01:00
|
|
|
foreach ($defaults as $name => $default) {
|
2011-07-19 18:18:29 +01:00
|
|
|
$this->defaults[(string) $name] = $default;
|
2011-07-17 16:29:41 +01:00
|
|
|
}
|
2012-04-01 11:32:28 +01:00
|
|
|
$this->compiled = null;
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
2010-02-17 13:53:31 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
2010-08-09 14:05:54 +01:00
|
|
|
* Gets a default value.
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @param string $name A variable name
|
|
|
|
*
|
|
|
|
* @return mixed The default value
|
|
|
|
*/
|
|
|
|
public function getDefault($name)
|
2010-02-17 13:53:31 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return isset($this->defaults[$name]) ? $this->defaults[$name] : null;
|
2010-02-17 13:53:31 +00:00
|
|
|
}
|
|
|
|
|
2011-04-15 11:04:48 +01:00
|
|
|
/**
|
|
|
|
* Checks if a default value is set for the given variable.
|
|
|
|
*
|
|
|
|
* @param string $name A variable name
|
|
|
|
*
|
|
|
|
* @return Boolean true if the default value is set, false otherwise
|
|
|
|
*/
|
|
|
|
public function hasDefault($name)
|
|
|
|
{
|
|
|
|
return array_key_exists($name, $this->defaults);
|
|
|
|
}
|
|
|
|
|
2010-08-09 14:05:54 +01:00
|
|
|
/**
|
|
|
|
* Sets a default value.
|
|
|
|
*
|
|
|
|
* @param string $name A variable name
|
|
|
|
* @param mixed $default The default value
|
2011-05-13 17:40:40 +01:00
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
2011-06-14 14:35:32 +01:00
|
|
|
*
|
|
|
|
* @api
|
2010-08-09 14:05:54 +01:00
|
|
|
*/
|
|
|
|
public function setDefault($name, $default)
|
|
|
|
{
|
2011-07-19 18:18:29 +01:00
|
|
|
$this->defaults[(string) $name] = $default;
|
2012-04-01 11:32:28 +01:00
|
|
|
$this->compiled = null;
|
2011-05-13 17:40:40 +01:00
|
|
|
|
|
|
|
return $this;
|
2010-08-09 14:05:54 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Returns the requirements.
|
|
|
|
*
|
|
|
|
* @return array The requirements
|
|
|
|
*/
|
|
|
|
public function getRequirements()
|
|
|
|
{
|
|
|
|
return $this->requirements;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the requirements.
|
|
|
|
*
|
|
|
|
* This method implements a fluent interface.
|
|
|
|
*
|
2010-07-01 19:17:03 +01:00
|
|
|
* @param array $requirements The requirements
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
|
|
|
*/
|
|
|
|
public function setRequirements(array $requirements)
|
|
|
|
{
|
|
|
|
$this->requirements = array();
|
2011-10-23 10:56:23 +01:00
|
|
|
|
|
|
|
return $this->addRequirements($requirements);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds requirements.
|
|
|
|
*
|
|
|
|
* This method implements a fluent interface.
|
|
|
|
*
|
|
|
|
* @param array $requirements The requirements
|
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
|
|
|
*/
|
|
|
|
public function addRequirements(array $requirements)
|
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($requirements as $key => $regex) {
|
2010-11-30 13:00:36 +00:00
|
|
|
$this->requirements[$key] = $this->sanitizeRequirement($key, $regex);
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
2012-04-01 11:32:28 +01:00
|
|
|
$this->compiled = null;
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the requirement for the given key.
|
|
|
|
*
|
2011-04-23 16:05:44 +01:00
|
|
|
* @param string $key The key
|
2011-12-13 07:50:54 +00:00
|
|
|
*
|
2010-05-06 12:25:53 +01:00
|
|
|
* @return string The regex
|
|
|
|
*/
|
|
|
|
public function getRequirement($key)
|
|
|
|
{
|
|
|
|
return isset($this->requirements[$key]) ? $this->requirements[$key] : null;
|
|
|
|
}
|
|
|
|
|
2010-11-30 13:00:36 +00:00
|
|
|
/**
|
|
|
|
* Sets a requirement for the given key.
|
|
|
|
*
|
2012-05-15 21:19:31 +01:00
|
|
|
* @param string $key The key
|
2011-04-23 16:05:44 +01:00
|
|
|
* @param string $regex The regex
|
2011-05-13 17:40:40 +01:00
|
|
|
*
|
|
|
|
* @return Route The current Route instance
|
2011-06-14 14:35:32 +01:00
|
|
|
*
|
|
|
|
* @api
|
2010-11-30 13:00:36 +00:00
|
|
|
*/
|
|
|
|
public function setRequirement($key, $regex)
|
|
|
|
{
|
2011-05-13 17:40:40 +01:00
|
|
|
$this->requirements[$key] = $this->sanitizeRequirement($key, $regex);
|
2012-04-01 11:32:28 +01:00
|
|
|
$this->compiled = null;
|
2011-05-13 17:40:40 +01:00
|
|
|
|
|
|
|
return $this;
|
2010-11-30 13:00:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Compiles the route.
|
|
|
|
*
|
|
|
|
* @return CompiledRoute A CompiledRoute instance
|
|
|
|
*/
|
|
|
|
public function compile()
|
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (null !== $this->compiled) {
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->compiled;
|
|
|
|
}
|
|
|
|
|
|
|
|
$class = $this->getOption('compiler_class');
|
|
|
|
|
2011-12-12 16:52:53 +00:00
|
|
|
if (!isset(self::$compilers[$class])) {
|
|
|
|
self::$compilers[$class] = new $class;
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
|
|
|
|
2011-12-12 16:52:53 +00:00
|
|
|
return $this->compiled = self::$compilers[$class]->compile($this);
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
2010-11-30 13:00:36 +00:00
|
|
|
|
2011-03-23 18:24:18 +00:00
|
|
|
private function sanitizeRequirement($key, $regex)
|
2010-11-30 13:00:36 +00:00
|
|
|
{
|
2012-04-01 11:32:28 +01:00
|
|
|
if (!is_string($regex)) {
|
|
|
|
throw new \InvalidArgumentException(sprintf('Routing requirement for "%s" must be a string', $key));
|
|
|
|
}
|
|
|
|
|
|
|
|
if ('' === $regex) {
|
|
|
|
throw new \InvalidArgumentException(sprintf('Routing requirement for "%s" cannot be empty', $key));
|
2010-11-30 13:00:36 +00:00
|
|
|
}
|
|
|
|
|
2012-04-01 11:32:28 +01:00
|
|
|
if ('^' === $regex[0]) {
|
2010-11-30 13:00:36 +00:00
|
|
|
$regex = substr($regex, 1);
|
|
|
|
}
|
|
|
|
|
2012-04-01 11:32:28 +01:00
|
|
|
if ('$' === substr($regex, -1)) {
|
2010-11-30 13:00:36 +00:00
|
|
|
$regex = substr($regex, 0, -1);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $regex;
|
|
|
|
}
|
2010-02-17 13:53:31 +00:00
|
|
|
}
|