2010-02-17 13:53:31 +00:00
|
|
|
<?php
|
|
|
|
|
2010-08-20 22:09:55 +01:00
|
|
|
namespace Symfony\Component\Routing;
|
2010-02-17 13:53:31 +00:00
|
|
|
|
|
|
|
/*
|
2010-04-07 01:51:29 +01:00
|
|
|
* This file is part of the Symfony framework.
|
2010-02-17 13:53:31 +00:00
|
|
|
*
|
|
|
|
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*
|
|
|
|
* This source file is subject to the MIT license that is bundled
|
|
|
|
* with this source code in the file LICENSE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A Route describes a route and its parameters.
|
|
|
|
*
|
2010-10-17 12:45:15 +01:00
|
|
|
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
2010-02-17 13:53:31 +00:00
|
|
|
*/
|
|
|
|
class Route
|
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
protected $pattern;
|
|
|
|
protected $defaults;
|
|
|
|
protected $requirements;
|
|
|
|
protected $options;
|
|
|
|
protected $compiled;
|
|
|
|
|
|
|
|
static protected $compilers = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
|
|
|
* Available options:
|
|
|
|
*
|
|
|
|
* * segment_separators: An array of allowed characters for segment separators (/ by default)
|
2010-11-22 09:56:24 +00:00
|
|
|
* * text_regex: A regex that match a valid text name (.+? by default)
|
2010-05-06 12:25:53 +01:00
|
|
|
* * compiler_class: A class name able to compile this route instance (RouteCompiler by default)
|
|
|
|
*
|
|
|
|
* @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
|
|
|
|
*/
|
|
|
|
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
|
|
|
}
|
|
|
|
|
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
|
2010-05-07 15:09:11 +01:00
|
|
|
if (empty($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
|
|
|
|
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
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->options = array_merge(array(
|
|
|
|
'segment_separators' => array('/', '.'),
|
|
|
|
'text_regex' => '.+?',
|
2010-08-20 22:09:55 +01:00
|
|
|
'compiler_class' => 'Symfony\\Component\\Routing\\RouteCompiler',
|
2010-05-06 12:25:53 +01:00
|
|
|
), $options);
|
|
|
|
|
|
|
|
return $this;
|
2010-02-17 13:53:31 +00:00
|
|
|
}
|
|
|
|
|
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)
|
|
|
|
{
|
|
|
|
$this->defaults = $defaults;
|
|
|
|
|
|
|
|
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
|
|
|
}
|
|
|
|
|
2010-08-09 14:05:54 +01:00
|
|
|
/**
|
|
|
|
* Sets a default value.
|
|
|
|
*
|
|
|
|
* @param string $name A variable name
|
|
|
|
* @param mixed $default The default value
|
|
|
|
*/
|
|
|
|
public function setDefault($name, $default)
|
|
|
|
{
|
|
|
|
$this->defaults[$name] = $default;
|
|
|
|
}
|
|
|
|
|
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();
|
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
|
|
|
}
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the requirement for the given key.
|
|
|
|
*
|
|
|
|
* @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.
|
|
|
|
*
|
|
|
|
* @param string The key
|
|
|
|
* @param string The regex
|
|
|
|
*/
|
|
|
|
public function setRequirement($key, $regex)
|
|
|
|
{
|
|
|
|
return $this->requirements[$key] = $this->sanitizeRequirement($key, $regex);
|
|
|
|
}
|
|
|
|
|
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');
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!isset(static::$compilers[$class])) {
|
2010-05-06 12:25:53 +01:00
|
|
|
static::$compilers[$class] = new $class;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->compiled = static::$compilers[$class]->compile($this);
|
|
|
|
}
|
2010-11-30 13:00:36 +00:00
|
|
|
|
|
|
|
protected function sanitizeRequirement($key, $regex)
|
|
|
|
{
|
|
|
|
if (is_array($regex)) {
|
|
|
|
throw new \InvalidArgumentException(sprintf('Routing requirements must be a string, array given for "%s"', $key));
|
|
|
|
}
|
|
|
|
|
|
|
|
if ('^' == $regex[0]) {
|
|
|
|
$regex = substr($regex, 1);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ('$' == substr($regex, -1)) {
|
|
|
|
$regex = substr($regex, 0, -1);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $regex;
|
|
|
|
}
|
2010-02-17 13:53:31 +00:00
|
|
|
}
|