src/Controller/Api/ApiController.php line 67

Open in your IDE?
  1. <?php
  3. namespace App\Controller\Api;
  5. use Doctrine\ORM\EntityManagerInterface;
  6. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  7. use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
  8. use Symfony\Component\HttpFoundation\JsonResponse;
  9. use Symfony\Component\Routing\Annotation\Route;
  11. class ApiController extends AbstractController
  12. {
  14.   /**
  15.    * @var integer HTTP status code - 200 (OK) by default
  16.    */
  17.   protected $statusCode = 200;
  19.   /** @var EntityManagerInterface $em */
  20.   protected $em;
  22.   /** @var ParameterBagInterface $parameterBag */
  23.   protected $parameterBag;
  25.   /**
  26.    * ApiController constructor.
  27.    * @param ParameterBagInterface $parameterBag
  28.    */
  29.   public function __construct(EntityManagerInterface $em, ParameterBagInterface $parameterBag)
  30.   {
  31.     $this->em = $em;
  32.     $this->parameterBag = $parameterBag;
  33.   }
  35.   /**
  36.    * Gets the value of statusCode.
  37.    *
  38.    * @return integer
  39.    */
  40.   public function getStatusCode()
  41.   {
  42.     return $this->statusCode;
  43.   }
  45.   /**
  46.    * Sets the value of statusCode.
  47.    *
  48.    * @param integer $statusCode the status code
  49.    *
  50.    * @return self
  51.    */
  52.   protected function setStatusCode($statusCode)
  53.   {
  54.     $this->statusCode = $statusCode;
  56.     return $this;
  57.   }
  59.   /**
  60.    * Returns a JSON response
  61.    *
  62.    * @param array $data
  63.    * @param array $headers
  64.    *
  65.    * @return JsonResponse
  66.    */
  67.   public function response($data, $headers = [])
  68.   {
  69.     return new JsonResponse($data, $this->getStatusCode(), $headers);
  70.   }
  72.   /**
  73.    * Sets an error message and returns a JSON response
  74.    *
  75.    * @param string $errors
  76.    * @param $headers
  77.    * @return JsonResponse
  78.    */
  79.   public function respondWithErrors($errors, $headers = [])
  80.   {
  81.     $data = [
  82.       'status' => $this->getStatusCode(),
  83.       'errors' => $errors,
  84.     ];
  86.     return new JsonResponse($data, $this->getStatusCode(), $headers);
  87.   }
  90.   /**
  91.    * Sets an error message and returns a JSON response
  92.    *
  93.    * @param string $success
  94.    * @param $headers
  95.    * @return JsonResponse
  96.    */
  97.   public function respondWithSuccess($success, $headers = [])
  98.   {
  99.     $data = [
  100.       'status' => $this->getStatusCode(),
  101.       'success' => $success,
  102.     ];
  104.     return new JsonResponse($data, $this->getStatusCode(), $headers);
  105.   }
  108.   /**
  109.    * Returns a 401 Unauthorized http response
  110.    *
  111.    * @param string $message
  112.    *
  113.    * @return JsonResponse
  114.    */
  115.   public function respondUnauthorized($message = 'Not authorized!')
  116.   {
  117.     return $this->setStatusCode(401)->respondWithErrors($message);
  118.   }
  120.   /**
  121.    * Returns a 422 Unprocessable Entity
  122.    *
  123.    * @param string $message
  124.    *
  125.    * @return JsonResponse
  126.    */
  127.   public function respondValidationError($message = 'Validation errors')
  128.   {
  129.     return $this->setStatusCode(422)->respondWithErrors($message);
  130.   }
  132.   /**
  133.    * Returns a 404 Not Found
  134.    *
  135.    * @param string $message
  136.    *
  137.    * @return JsonResponse
  138.    */
  139.   public function respondNotFound($message = 'Not found!')
  140.   {
  141.     return $this->setStatusCode(404)->respondWithErrors($message);
  142.   }
  144.   /**
  145.    * Returns a 201 Created
  146.    *
  147.    * @param array $data
  148.    *
  149.    * @return JsonResponse
  150.    */
  151.   public function respondCreated($data = [])
  152.   {
  153.     return $this->setStatusCode(201)->response($data);
  154.   }
  156.   // this method allows us to accept JSON payloads in POST requests
  157.   // since Symfony 4 doesn’t handle that automatically:
  159.   protected function transformJsonBody(\Symfony\Component\HttpFoundation\Request $request)
  160.   {
  161.     $data = json_decode($request->getContent(), true);
  163.     if ($data === null) {
  164.       return $request;
  165.     }
  167.     $request->request->replace($data);
  169.     return $request;
  170.   }
  172. }