added API functions to save meta fields (#1063)

src/API/CustomerController.php

@@ -12,6 +12,7 @@ declare(strict_types=1);
 namespace App\API;
 
 use App\Entity\Customer;
+use App\Event\CustomerMetaDefinitionEvent;
 use App\Form\API\CustomerApiEditForm;
 use App\Repository\CustomerRepository;
 use App\Repository\Query\CustomerQuery;
@@ -22,6 +23,7 @@ use FOS\RestBundle\View\View;
 use FOS\RestBundle\View\ViewHandlerInterface;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
 use Swagger\Annotations as SWG;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
@@ -36,16 +38,21 @@ class CustomerController extends BaseApiController
     /**
      * @var CustomerRepository
      */
-    protected $repository;
+    private $repository;
     /**
      * @var ViewHandlerInterface
      */
-    protected $viewHandler;
+    private $viewHandler;
+    /**
+     * @var EventDispatcherInterface
+     */
+    private $dispatcher;
 
-    public function __construct(ViewHandlerInterface $viewHandler, CustomerRepository $repository)
+    public function __construct(ViewHandlerInterface $viewHandler, CustomerRepository $repository, EventDispatcherInterface $dispatcher)
     {
         $this->viewHandler = $viewHandler;
         $this->repository = $repository;
+        $this->dispatcher = $dispatcher;
     }
 
     /**
@@ -148,14 +155,15 @@ class CustomerController extends BaseApiController
 
         $customer = new Customer();
 
+        $event = new CustomerMetaDefinitionEvent($customer);
+        $this->dispatcher->dispatch($event, CustomerMetaDefinitionEvent::class);
+
         $form = $this->createForm(CustomerApiEditForm::class, $customer);
 
         $form->submit($request->request->all());
 
         if ($form->isValid()) {
-            $entityManager = $this->getDoctrine()->getManager();
-            $entityManager->persist($customer);
-            $entityManager->flush();
+            $this->repository->saveCustomer($customer);
 
             $view = new View($customer, 200);
             $view->getContext()->setGroups(['Default', 'Entity', 'Customer']);
@@ -197,6 +205,8 @@ class CustomerController extends BaseApiController
      * @param Request $request
      * @param string $id
      * @return Response
+     * @throws \Doctrine\ORM\ORMException
+     * @throws \Doctrine\ORM\OptimisticLockException
      */
     public function patchAction(Request $request, string $id)
     {
@@ -210,6 +220,9 @@ class CustomerController extends BaseApiController
             throw new AccessDeniedHttpException('User cannot update customer');
         }
 
+        $event = new CustomerMetaDefinitionEvent($customer);
+        $this->dispatcher->dispatch($event, CustomerMetaDefinitionEvent::class);
+
         $form = $this->createForm(CustomerApiEditForm::class, $customer);
 
         $form->setData($customer);
@@ -222,13 +235,67 @@ class CustomerController extends BaseApiController
             return $this->viewHandler->handle($view);
         }
 
-        $entityManager = $this->getDoctrine()->getManager();
-        $entityManager->persist($customer);
-        $entityManager->flush();
+        $this->repository->saveCustomer($customer);
 
         $view = new View($customer, Response::HTTP_OK);
         $view->getContext()->setGroups(['Default', 'Entity', 'Customer']);
 
         return $this->viewHandler->handle($view);
     }
+
+    /**
+     * Sets the value of a meta-field for an existing customer.
+     *
+     * @SWG\Response(
+     *      response=200,
+     *      description="Sets the value of an existing/configured meta-field. You cannot create unknown meta-fields, if the given name is not a configured meta-field, this will return an exception.",
+     *      @SWG\Schema(ref="#/definitions/CustomerEntity")
+     * )
+     * @SWG\Parameter(
+     *      name="id",
+     *      in="path",
+     *      type="integer",
+     *      description="Customer record ID to set the meta-field value for",
+     *      required=true,
+     * )
+     * @Rest\RequestParam(name="name", strict=true, nullable=false, description="The meta-field name")
+     * @Rest\RequestParam(name="value", strict=true, nullable=false, description="The meta-field value")
+     *
+     * @param int $id
+     * @param ParamFetcherInterface $paramFetcher
+     * @return Response
+     * @throws \Doctrine\ORM\ORMException
+     * @throws \Doctrine\ORM\OptimisticLockException
+     */
+    public function metaAction($id, ParamFetcherInterface $paramFetcher)
+    {
+        $customer = $this->repository->find($id);
+
+        if (null === $customer) {
+            throw new NotFoundException();
+        }
+
+        if (!$this->isGranted('edit', $customer)) {
+            throw new AccessDeniedHttpException('You are not allowed to update this customer');
+        }
+
+        $event = new CustomerMetaDefinitionEvent($customer);
+        $this->dispatcher->dispatch($event, CustomerMetaDefinitionEvent::class);
+
+        $name = $paramFetcher->get('name');
+        $value = $paramFetcher->get('value');
+
+        if (null === ($meta = $customer->getMetaField($name))) {
+            throw new \InvalidArgumentException('Unknown meta-field requested');
+        }
+
+        $meta->setValue($value);
+
+        $this->repository->saveCustomer($customer);
+
+        $view = new View($customer, 200);
+        $view->getContext()->setGroups(['Default', 'Entity', 'Customer']);
+
+        return $this->viewHandler->handle($view);
+    }
 }