Пользовательская аннотация в контроллере Symfony 3

Question

Пользовательская аннотация в контроллере Symfony 3

Так что вопрос довольно простой. У меня есть код в моем контроллере, который стал избыточным, и я решил сделать для него аннотацию.

if (!$request->getContentType() === 'json' ) {
return new JsonResponse(array('success' => false));
}
$content = $request->getContent();

if(empty($content)){
throw new BadRequestHttpException("Content is empty");
}
$data = json_decode($content, true);
if(empty($data) || !array_key_exists('type', $data)) {
return new JsonResponse(array('success' => false));
}

Как сделать пользовательскую аннотацию @CheckRequest, в которой я могу использовать объект $ request в качестве параметра?

8

annotations doctrine php symfony

Решение

Другие решения

Других решений пока нет …

Источник

Accepted Answer

Вам нужно сделать пользовательскую аннотацию, а затем прослушиватель, который вставляет средство чтения аннотаций и обрабатывает kernel.controller событие:

аннотирование

/**
* @Annotation
*/
class CheckRequest
{
}

Определение сервиса

services:
controller_check_request:
class: AppBundle\EventListener\ControllerCheckRequestListener
tags:
- { name: kernel.event_listener, event: kernel.controller, method: onKernelController}
arguments:
- "@annotation_reader"

Слушатель:

namespace AppBundle\EventListener;

use AppBundle\Annotation\CheckRequest;
use Doctrine\Common\Annotations\Reader;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;

class ControllerCheckRequestListener
{
/** @var Reader */
private $reader;

/**
* @param Reader $reader
*/
public function __construct(Reader $reader)
{
$this->reader = $reader;
}

/**
* {@inheritdoc}
*/
public function onKernelController(FilterControllerEvent $event)
{
if (!is_array($controllers = $event->getController())) {
return;
}

$request = $event->getRequest();
$content = $request->getContent();

list($controller, $methodName) = $controllers;

$reflectionClass = new \ReflectionClass($controller);
$classAnnotation = $this->reader
->getClassAnnotation($reflectionClass, CheckRequest::class);

$reflectionObject = new \ReflectionObject($controller);
$reflectionMethod = $reflectionObject->getMethod($methodName);
$methodAnnotation = $this->reader
->getMethodAnnotation($reflectionMethod, CheckRequest::class);

if (!($classAnnotation || $methodAnnotation)) {
return;
}

if ($request->getContentType() !== 'json' ) {
return $event->setController(
function() {
return new JsonResponse(['success' => false]);
}
);
}

if (empty($content)) {
throw new BadRequestHttpException('Content is empty');
}

$data = json_decode($content, true);

if ($request->getContentType() !== 'json' ) {
return $event->setController(
function() {
return new JsonResponse(['success' => false]);
}
);
}
}
}

Обратите внимание, что вместо возврата ответа вы устанавливаете весь контроллер с $event->setController();и вы тоже должны return при совершении этого звонка.

Тогда в вашем контроллере вы можете установить его на весь класс:

use AppBundle\Annotation\CheckRequest;

/**
* @CheckRequest
*/
class YourController extends Controller
{
}

или отдельные методы / действия:

use AppBundle\Annotation\CheckRequest;

class TestController extends Controller
{
/**
* @Route("/", name="index")
* @CheckRequest
*/
public function indexAction(Request $request)
{
// ...
}
}

8