123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288 |
- <?php
- /*
- * This file is part of the Sonata Project package.
- *
- * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Sonata\AdminBundle\Route;
- use Symfony\Component\Routing\Route;
- /**
- * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
- */
- class RouteCollection
- {
- /**
- * @var Route[]
- */
- protected $elements = array();
- /**
- * @var string
- */
- protected $baseCodeRoute;
- /**
- * @var string
- */
- protected $baseRouteName;
- /**
- * @var string
- */
- protected $baseControllerName;
- /**
- * @var string
- */
- protected $baseRoutePattern;
- /**
- * @param string $baseCodeRoute
- * @param string $baseRouteName
- * @param string $baseRoutePattern
- * @param string $baseControllerName
- */
- public function __construct($baseCodeRoute, $baseRouteName, $baseRoutePattern, $baseControllerName)
- {
- $this->baseCodeRoute = $baseCodeRoute;
- $this->baseRouteName = $baseRouteName;
- $this->baseRoutePattern = $baseRoutePattern;
- $this->baseControllerName = $baseControllerName;
- }
- /**
- * Add route.
- *
- * @param string $name Name
- * @param string $pattern Pattern (will be automatically combined with @see $this->baseRoutePattern and $name
- * @param array $defaults Defaults
- * @param array $requirements Requirements
- * @param array $options Options
- * @param string $host Host
- * @param array $schemes Schemes
- * @param array $methods Methods
- * @param string $condition Condition
- *
- * @return RouteCollection
- */
- public function add($name, $pattern = null, array $defaults = array(), array $requirements = array(), array $options = array(), $host = '', array $schemes = array(), array $methods = array(), $condition = '')
- {
- $pattern = $this->baseRoutePattern.'/'.($pattern ?: $name);
- $code = $this->getCode($name);
- $routeName = $this->baseRouteName.'_'.$name;
- if (!isset($defaults['_controller'])) {
- $defaults['_controller'] = $this->baseControllerName.':'.$this->actionify($code);
- }
- if (!isset($defaults['_sonata_admin'])) {
- $defaults['_sonata_admin'] = $this->baseCodeRoute;
- }
- $defaults['_sonata_name'] = $routeName;
- $this->elements[$this->getCode($name)] = function () use (
- $pattern, $defaults, $requirements, $options, $host, $schemes, $methods, $condition) {
- return new Route($pattern, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
- };
- return $this;
- }
- /**
- * @param string $name
- *
- * @return string
- */
- public function getCode($name)
- {
- if (strrpos($name, '.') !== false) {
- return $name;
- }
- return $this->baseCodeRoute.'.'.$name;
- }
- /**
- * @param RouteCollection $collection
- *
- * @return RouteCollection
- */
- public function addCollection(RouteCollection $collection)
- {
- foreach ($collection->getElements() as $code => $route) {
- $this->elements[$code] = $route;
- }
- return $this;
- }
- /**
- * @return Route[]
- */
- public function getElements()
- {
- foreach ($this->elements as $name => $element) {
- $this->elements[$name] = $this->resolve($element);
- }
- return $this->elements;
- }
- /**
- * @param string $name
- *
- * @return bool
- */
- public function has($name)
- {
- return array_key_exists($this->getCode($name), $this->elements);
- }
- /**
- * @param string $name
- *
- * @throws \InvalidArgumentException
- *
- * @return Route
- */
- public function get($name)
- {
- if ($this->has($name)) {
- $code = $this->getCode($name);
- $this->elements[$code] = $this->resolve($this->elements[$code]);
- return $this->elements[$code];
- }
- throw new \InvalidArgumentException(sprintf('Element "%s" does not exist.', $name));
- }
- /**
- * @param string $name
- *
- * @return RouteCollection
- */
- public function remove($name)
- {
- unset($this->elements[$this->getCode($name)]);
- return $this;
- }
- /**
- * Remove all routes except routes in $routeList.
- *
- * @param string[]|string $routeList
- *
- * @return RouteCollection
- */
- public function clearExcept($routeList)
- {
- if (!is_array($routeList)) {
- $routeList = array($routeList);
- }
- $routeCodeList = array();
- foreach ($routeList as $name) {
- $routeCodeList[] = $this->getCode($name);
- }
- $elements = $this->elements;
- foreach ($elements as $key => $element) {
- if (!in_array($key, $routeCodeList)) {
- unset($this->elements[$key]);
- }
- }
- return $this;
- }
- /**
- * Remove all routes.
- *
- * @return RouteCollection
- */
- public function clear()
- {
- $this->elements = array();
- return $this;
- }
- /**
- * Convert a word in to the format for a symfony action action_name => actionName.
- *
- * @param string $action Word to actionify
- *
- * @return string Actionified word
- */
- public function actionify($action)
- {
- if (($pos = strrpos($action, '.')) !== false) {
- $action = substr($action, $pos + 1);
- }
- // if this is a service rather than just a controller name, the suffix
- // Action is not automatically appended to the method name
- if (strpos($this->baseControllerName, ':') === false) {
- $action .= 'Action';
- }
- return lcfirst(str_replace(' ', '', ucwords(strtr($action, '_-', ' '))));
- }
- /**
- * @return string
- */
- public function getBaseCodeRoute()
- {
- return $this->baseCodeRoute;
- }
- /**
- * @return string
- */
- public function getBaseControllerName()
- {
- return $this->baseControllerName;
- }
- /**
- * @return string
- */
- public function getBaseRouteName()
- {
- return $this->baseRouteName;
- }
- /**
- * @return string
- */
- public function getBaseRoutePattern()
- {
- return $this->baseRoutePattern;
- }
- /**
- * @param $element
- *
- * @return Route
- */
- private function resolve($element)
- {
- if (is_callable($element)) {
- return call_user_func($element);
- }
- return $element;
- }
- }
|