175 lines
3.5 KiB
PHP
175 lines
3.5 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Routing\Loader\Configurator\Traits;
|
|
|
|
use Symfony\Component\Routing\Route;
|
|
use Symfony\Component\Routing\RouteCollection;
|
|
|
|
trait RouteTrait
|
|
{
|
|
/**
|
|
* @var RouteCollection|Route
|
|
*/
|
|
protected $route;
|
|
|
|
/**
|
|
* Adds defaults.
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function defaults(array $defaults): self
|
|
{
|
|
$this->route->addDefaults($defaults);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds requirements.
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function requirements(array $requirements): self
|
|
{
|
|
$this->route->addRequirements($requirements);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds options.
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function options(array $options): self
|
|
{
|
|
$this->route->addOptions($options);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Whether paths should accept utf8 encoding.
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function utf8(bool $utf8 = true): self
|
|
{
|
|
$this->route->addOptions(['utf8' => $utf8]);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets the condition.
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function condition(string $condition): self
|
|
{
|
|
$this->route->setCondition($condition);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets the pattern for the host.
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function host(string $pattern): self
|
|
{
|
|
$this->route->setHost($pattern);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets the schemes (e.g. 'https') this route is restricted to.
|
|
* So an empty array means that any scheme is allowed.
|
|
*
|
|
* @param string[] $schemes
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function schemes(array $schemes): self
|
|
{
|
|
$this->route->setSchemes($schemes);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets the HTTP methods (e.g. 'POST') this route is restricted to.
|
|
* So an empty array means that any method is allowed.
|
|
*
|
|
* @param string[] $methods
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function methods(array $methods): self
|
|
{
|
|
$this->route->setMethods($methods);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds the "_controller" entry to defaults.
|
|
*
|
|
* @param callable|string $controller a callable or parseable pseudo-callable
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function controller($controller): self
|
|
{
|
|
$this->route->addDefaults(['_controller' => $controller]);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds the "_locale" entry to defaults.
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function locale(string $locale): self
|
|
{
|
|
$this->route->addDefaults(['_locale' => $locale]);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds the "_format" entry to defaults.
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function format(string $format): self
|
|
{
|
|
$this->route->addDefaults(['_format' => $format]);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds the "_stateless" entry to defaults.
|
|
*
|
|
* @return $this
|
|
*/
|
|
final public function stateless(bool $stateless = true): self
|
|
{
|
|
$this->route->addDefaults(['_stateless' => $stateless]);
|
|
|
|
return $this;
|
|
}
|
|
}
|