vendor/friendsofsymfony/rest-bundle/Routing/Loader/Reader/RestControllerReader.php line 105

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\Loader\Reader;
  14. use Doctrine\Common\Annotations\Reader;
  15. use FOS\RestBundle\Controller\Annotations;
  16. use FOS\RestBundle\Routing\ClassResourceInterface;
  17. use FOS\RestBundle\Routing\RestRouteCollection;
  18. use Symfony\Component\Config\Resource\FileResource;
  20. /**
  21.  * REST controller reader.
  22.  *
  23.  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  24.  */
  25. class RestControllerReader
  26. {
  27.     private $actionReader;
  28.     private $annotationReader;
  30.     /**
  31.      * Initializes controller reader.
  32.      *
  33.      * @param RestActionReader $actionReader     action reader
  34.      * @param Reader           $annotationReader annotation reader
  35.      */
  36.     public function __construct(RestActionReader $actionReader, Reader $annotationReader)
  37.     {
  38.         $this->actionReader = $actionReader;
  39.         $this->annotationReader = $annotationReader;
  40.     }
  42.     /**
  43.      * Returns action reader.
  44.      *
  45.      * @return RestActionReader
  46.      */
  47.     public function getActionReader()
  48.     {
  49.         return $this->actionReader;
  50.     }
  52.     /**
  53.      * Reads controller routes.
  54.      *
  55.      * @param \ReflectionClass $reflectionClass
  56.      *
  57.      * @throws \InvalidArgumentException
  58.      *
  59.      * @return RestRouteCollection
  60.      */
  61.     public function read(\ReflectionClass $reflectionClass)
  62.     {
  63.         $collection = new RestRouteCollection();
  64.         $collection->addResource(new FileResource($reflectionClass->getFileName()));
  66.         // read prefix annotation
  67.         if ($annotation = $this->annotationReader->getClassAnnotation($reflectionClass, Annotations\Prefix::class)) {
  68.             $this->actionReader->setRoutePrefix($annotation->value);
  69.         }
  71.         // read name-prefix annotation
  72.         if ($annotation = $this->annotationReader->getClassAnnotation($reflectionClass, Annotations\NamePrefix::class)) {
  73.             $this->actionReader->setNamePrefix($annotation->value);
  74.         }
  76.         // read version annotation
  77.         if ($annotation = $this->annotationReader->getClassAnnotation($reflectionClass, Annotations\Version::class)) {
  78.             $this->actionReader->setVersions($annotation->value);
  79.         }
  81.         $resource = [];
  82.         // read route-resource annotation
  83.         if ($annotation = $this->annotationReader->getClassAnnotation($reflectionClass, Annotations\RouteResource::class)) {
  84.             $resource = explode('_', $annotation->resource);
  85.             $this->actionReader->setPluralize($annotation->pluralize);
  86.         } elseif ($reflectionClass->implementsInterface(ClassResourceInterface::class)) {
  87.             $resource = preg_split(
  88.                 '/([A-Z][^A-Z]*)Controller/',
  89.                 $reflectionClass->getShortName(),
  90.                 -1,
  91.                 PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE
  92.             );
  93.             if (empty($resource)) {
  94.                 throw new \InvalidArgumentException("Controller '{$reflectionClass->name}' does not identify a resource");
  95.             }
  96.         }
  98.         // trim '/' at the start of the prefix
  99.         if ('/' === substr($prefix = $this->actionReader->getRoutePrefix(), 0, 1)) {
  100.             $this->actionReader->setRoutePrefix(substr($prefix, 1));
  101.         }
  103.         // read action routes into collection
  104.         foreach ($reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) {
  105.             $this->actionReader->read($collection, $method, $resource);
  106.         }
  108.         $this->actionReader->setRoutePrefix(null);
  109.         $this->actionReader->setNamePrefix(null);
  110.         $this->actionReader->setVersions(null);
  111.         $this->actionReader->setPluralize(null);
  112.         $this->actionReader->setParents([]);
  114.         return $collection;
  115.     }
  116. }