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