src/App/Controller/CRUD/DetailsController.php line 67

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace App\Controller\CRUD;
  5. use App\Repository\AbstractRepository;
  6. use App\Response\ActionResult;
  7. use App\Response\JsonTextResponse;
  8. use JMS\Serializer\SerializationContext;
  9. use JMS\Serializer\SerializerInterface;
  10. use Symfony\Component\HttpFoundation\Request;
  11. use Symfony\Component\HttpFoundation\Response;
  12. use Symfony\Component\Validator\Exception\UnexpectedTypeException;
  14. /**
  15.  * @template TEntityClass of object
  16.  * @template-extends EntityController<TEntityClass>
  17.  */
  18. abstract class DetailsController extends EntityController
  19. {
  21.     /**
  22.      * @var class-string<TEntityClass>
  23.      */
  24.     private string $repository;
  26.     private string $template;
  28.     protected SerializerInterface $serializer;
  30.     protected bool $serializeNull = false;
  32.     /**
  33.      * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.UselessDocComment
  34.      * @param class-string<TEntityClass> $repository FQCN for entity class
  35.      */
  36.     public function __construct(string $repository, string $template)
  37.     {
  38.         $this->repository = $repository;
  39.         $this->template = $template;
  40.     }
  42.     /**
  43.      * @phpstan-param TEntityClass $entity
  44.      * @return string path to template
  45.      */
  46.     protected function getTemplate($entity): string
  47.     {
  48.         return $this->template;
  49.     }
  51.     /**
  52.      * @return AbstractRepository<TEntityClass> Repository for related entity
  53.      */
  54.     protected function getRepository(): AbstractRepository
  55.     {
  56.         /** @var AbstractRepository<TEntityClass> $repository */
  57.         $repository = $this->doctrine->getRepository($this->repository);
  59.         return $repository;
  60.     }
  62.     /**
  63.      * @return ActionResult|JsonTextResponse|Response
  64.      */
  65.     public function handleRequest(Request $request)
  66.     {
  67.         $result = $this->execute($this->getFilters($request));
  69.         if ($this->isHandlingJson($request) && $this->isAjaxRequest($request)) {
  70.             $entity = $result->getParams()['entity'];
  72.             $data = [
  73.                 'entity' => $entity,
  74.             ];
  75.             $context = $this->configureSerializationContext(new SerializationContext());
  77.             return new JsonTextResponse(
  78.                 function ($data) use ($context): string {
  79.                     return $this->serializer->serialize($data, 'json', $context);
  80.                 },
  81.                 $data
  82.             );
  83.         }
  85.         return $result;
  86.     }
  88.     /**
  89.      * @phpstan-return TEntityClass
  90.      * @param array<string, array<mixed>|bool|int|float|object|string|null> $filters
  91.      * @return mixed
  92.      */
  93.     public function provideEntity(array $filters)
  94.     {
  95.         if (!isset($filters['id']) || !is_numeric($filters['id'])) {
  96.             throw $this->createNotFoundException('Id parameter is required.');
  97.         }
  99.         return $this->getEntity((int) $filters['id']);
  100.     }
  102.     /**
  103.      * @return array<string, array<mixed>|bool|int|float|object|string|null>
  104.      */
  105.     protected function getFilters(Request $request): array
  106.     {
  107.         $id = $request->attributes->get('id');
  109.         if (null === $id) {
  110.             throw $this->createNotFoundException('Id parameter is required.');
  111.         }
  113.         if (!is_string($id) && !is_int($id)) {
  114.             throw new UnexpectedTypeException($id, 'string|int');
  115.         }
  117.         return ['id' => $id];
  118.     }
  120.     /**
  121.      * @param array<string, array<mixed>|bool|int|float|object|string|null> $filters
  122.      */
  123.     public function execute(array $filters = []): ActionResult
  124.     {
  125.         $entity = $this->provideEntity($filters);
  127.         $parameters = ['entity' => $entity];
  129.         foreach ($this->templateParams as $key => $value) {
  130.             $parameters[$key] = $value;
  131.         }
  133.         return new ActionResult($this->getTemplate($entity), $parameters);
  134.     }
  136.     protected function configureSerializationContext(SerializationContext $serializationContext): SerializationContext
  137.     {
  138.         if ($this->serializeNull) {
  139.             $serializationContext->setSerializeNull(true);
  140.         }
  142.         return $serializationContext;
  143.     }
  145.     /**
  146.      * @required
  147.      */
  148.     public function setSerializer(SerializerInterface $serializer): void
  149.     {
  150.         $this->serializer = $serializer;
  151.     }
  153. }