maxpou / symfony-rest-beer-edition

src/ApiBundle/Controller/BreweryController.php

<?php

namespace ApiBundle\Controller;

use FOS\RestBundle\Context\Context;
use FOS\RestBundle\Controller\Annotations\QueryParam;
use FOS\RestBundle\Controller\Annotations\Route;
use FOS\RestBundle\Controller\Annotations\RouteResource;
use FOS\RestBundle\Controller\FOSRestController;
use FOS\RestBundle\Request\ParamFetcher;
use Maxpou\BeerBundle\Entity\Brewery;
use Maxpou\BeerBundle\Form\Type\BreweryType;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\HttpException;

/**
 * Branche controller.
 *
 * @RouteResource("brewery")
 */
class BreweryController extends FOSRestController
{
    /**
     * Get all Breweries entities.
     *
     * @ApiDoc(
     *  statusCodes={
     *      200="Returned when successful"
     * })
     * @QueryParam(name="offset", requirements="\d+", nullable=true,
     *     description="Offset from which to start listing breweries.")
     * @QueryParam(name="limit", requirements="\d+", nullable=true,
     *     description="How many breweries to return.")
     */
    public function cgetAction(ParamFetcher $paramFetcher)
    {
        $offset = $paramFetcher->get('offset');
        $limit = $paramFetcher->get('limit');

        $em = $this->getDoctrine()->getManager();
        $breweries = $em->getRepository('MaxpouBeerBundle:Brewery')
                          ->findBy([], ['name' => 'ASC'], $limit, $offset);

        $context = new Context();
        $context->addGroups(array('Default', 'list'));

        $view = $this->view($breweries, 200);
        $view->setContext($context);

        return $this->handleView($view);
    }

    /**
     * Get a Brewery entity.
     *
     * @ApiDoc(
     *  statusCodes={
     *      200="Returned when successful",
     *      400="Returned when parameter is wrong",
     *      404="Returned when not found"
     * })
     *
     * @param UUID $breweryId Brewery Id
     */
    public function getAction($breweryId)
    {
        $brewery = $this->getDoctrine()->getManager()
                        ->getRepository('MaxpouBeerBundle:Brewery')
                        ->find($breweryId);

        if (!$brewery) {
            throw new HttpException(404, 'Unable to find this Brewery entity');
        }

        $context = new Context();
        $context->addGroups(array('Default', 'details'));
        $view = $this->view($brewery, 200);
        $view->setContext($context);

        return $this->handleView($view);
    }

    /**
     * Add a Brewery.
     *
     * @ApiDoc(
     *  statusCodes={
     *      201="Returned when successful",
     *      400="Returned when parameter is wrong"
     *  },
     *  input = {
     *      "class" = "Maxpou\BeerBundle\Form\Type\BreweryType",
     *      "groups"={"list"},
     *      "name" = ""
     *  }
     * )
     */
    public function postAction(Request $request)
    {
        $brewery = new Brewery();

        $form = $this->createForm(BreweryType::class, $brewery);

        $form->submit($request->request->all());

        if ($form->isValid()) {
            $em = $this->getDoctrine()->getManager();
            $em->persist($brewery);
            $em->flush();

            $view = $this->view($brewery, 201);
            $context = new Context();
            $context->addGroups(array('Default', 'details'));
            $view->setContext($context);
        } else {
            $view = $this->view($form, 400);
        }

        return $this->handleView($view);
    }

    /**
     * Update an existing Brewery (cannot create here, sorry).
     *
     * @ApiDoc(
     *  statusCodes={
     *      204="Returned when successful",
     *      404="Returned when not found",
     *      400="Returned when parameter is wrong"
     * },
     * input = {
     *     "class" = "Maxpou\BeerBundle\Form\Type\BreweryType",
     *     "name" = ""
     * })
     *
     * @param UUID $breweryId Brewery Id
     */
    public function putAction(Request $request, $breweryId)

This method seems to be duplicated in your project.

    {
        $brewery = $this->getDoctrine()->getManager()
                        ->getRepository('MaxpouBeerBundle:Brewery')
                        ->find($breweryId);

        if (!$brewery) {
            throw new HttpException(404, 'Unable to find this Brewery entity');
        }

        $form = $this->createForm(BreweryType::class, $brewery);
        $form->submit($request->request->all());

        if ($form->isValid()) {
            $em = $this->getDoctrine()->getManager();
            $em->persist($brewery);
            $em->flush();

            $view = $this->view(null, 204);

            return $this->handleView($view);
        } else {
            $view = $this->view($form, 400);
        }

        return $view;
    }

    /**
     * Delete brewery.
     *
     * @ApiDoc(
     *  statusCodes={
     *      204="Returned when successful"
     * })
     * @Route(requirements={
     *   "breweryId": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
     * })
     *
     * @param UUID $breweryId Brewery Id
     */
    public function deleteAction($breweryId)
    {
        $brewery = $this->getDoctrine()->getManager()
                        ->getRepository('MaxpouBeerBundle:Brewery')
                        ->find($breweryId);

        if ($brewery) {
            $em = $this->getDoctrine()->getManager();
            $em->remove($brewery);
            $em->flush();
        }

        return $this->view(null, 204);
    }

    /**
     * Delete all breweries.
     *
     * @ApiDoc(
     *  statusCodes={
     *      204="Returned when successful"
     * })
     */
    public function cdeleteAction()
    {
        $this->getDoctrine()->getManager()
             ->getRepository('MaxpouBeerBundle:Brewery')
             ->deleteAll();

        return $this->view(null, 204);
    }

    /**
     * Options.
     *
     * @ApiDoc(
     *  statusCodes={
     *      200="Returned when successful"
     * })
     */
    public function coptionsAction()
    {
        $response = new Response();
        $response->headers->set('Allow', 'OPTIONS, GET, POST, DELETE');

        return $response;
    }
}