vendor/friendsofsymfony/rest-bundle/Routing/RestRouteCollection.php line 14

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSRestBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\RestBundle\Routing;
  14. @trigger_error(sprintf('The %s\RestRouteCollection class is deprecated since FOSRestBundle 2.8.', __NAMESPACE__), E_USER_DEPRECATED);
  16. use Symfony\Component\Routing\RouteCollection;
  18. /**
  19.  * Restful route collection.
  20.  *
  21.  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  22.  *
  23.  * @deprecated since 2.8
  24.  */
  25. class RestRouteCollection extends RouteCollection
  26. {
  27.     private $singularName;
  29.     /**
  30.      * @param string $name
  31.      */
  32.     public function setSingularName($name)
  33.     {
  34.         $this->singularName = $name;
  35.     }
  37.     /**
  38.      * @return string
  39.      */
  40.     public function getSingularName()
  41.     {
  42.         return $this->singularName;
  43.     }
  45.     /**
  46.      * @param string $prefix
  47.      */
  48.     public function prependRouteControllersWithPrefix($prefix)
  49.     {
  50.         foreach (parent::all() as $route) {
  51.             $route->setDefault('_controller', $prefix.$route->getDefault('_controller'));
  52.         }
  53.     }
  55.     /**
  56.      * @param string $format
  57.      */
  58.     public function setDefaultFormat($format)
  59.     {
  60.         foreach (parent::all() as $route) {
  61.             // Set default format only if not set already (could be defined in annotation)
  62.             if (!$route->getDefault('_format')) {
  63.                 $route->setDefault('_format', $format);
  64.             }
  65.         }
  66.     }
  68.     /**
  69.      * Returns routes sorted by custom HTTP methods first.
  70.      *
  71.      * @return array
  72.      */
  73.     public function all()
  74.     {
  75.         $regex = '/'.
  76.             '(_|^)'.
  77.             '(get|post|put|delete|patch|head|options|mkcol|propfind|proppatch|lock|unlock|move|copy|link|unlink)_'. // allowed http methods
  78.             '/i';
  80.         $routes = parent::all();
  81.         $customMethodRoutes = [];
  82.         foreach ($routes as $routeName => $route) {
  83.             if (!preg_match($regex, $routeName)) {
  84.                 $customMethodRoutes[$routeName] = $route;
  85.                 unset($routes[$routeName]);
  86.             }
  87.         }
  89.         return $customMethodRoutes + $routes;
  90.     }
  91. }