From 23a4e1c679f48f796d6c4ac664a410eb8f6feb92 Mon Sep 17 00:00:00 2001
From: Kevin Frantz <mail@kevin-frantz.de>
Date: Sat, 5 Jan 2019 15:34:02 +0100
Subject: [PATCH] Implemented draft for API

---
 administration/test-everything.sh             |  2 +-
 .../Controller/API/APIControllerInterface.php | 19 +++++
 .../Controller/API/AbstractAPIController.php  | 10 +++
 .../API/CRUDControllerInterface.php           | 45 ++++++++++
 .../Controller/API/Meta/LawApiController.php  | 33 ++++++++
 .../API/Meta/RightApiController.php           | 30 +++++++
 .../API/Source/SourceApiController.php        | 79 ++++++++++++++++++
 application/src/Controller/LawController.php  | 60 --------------
 .../src/Controller/SourceController.php       | 82 -------------------
 9 files changed, 217 insertions(+), 143 deletions(-)
 create mode 100644 application/src/Controller/API/APIControllerInterface.php
 create mode 100644 application/src/Controller/API/AbstractAPIController.php
 create mode 100644 application/src/Controller/API/CRUDControllerInterface.php
 create mode 100644 application/src/Controller/API/Meta/LawApiController.php
 create mode 100644 application/src/Controller/API/Meta/RightApiController.php
 create mode 100644 application/src/Controller/API/Source/SourceApiController.php
 delete mode 100644 application/src/Controller/LawController.php
 delete mode 100644 application/src/Controller/SourceController.php

diff --git a/administration/test-everything.sh b/administration/test-everything.sh
index df55d66..233d119 100644
--- a/administration/test-everything.sh
+++ b/administration/test-everything.sh
@@ -3,5 +3,5 @@ cd "$(dirname "$(readlink -f "${0}")")/"  &&
 bash ./clear.sh &&
 bash ./schema-validate.sh &&
 bash ./test.sh &&
-bash ./test-code-format.sh
+bash ./test-code-format.sh &&
 bash ./shellcheck.sh
diff --git a/application/src/Controller/API/APIControllerInterface.php b/application/src/Controller/API/APIControllerInterface.php
new file mode 100644
index 0000000..e98e9fe
--- /dev/null
+++ b/application/src/Controller/API/APIControllerInterface.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Controller\API;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @author kevinfrantz
+ */
+interface APIControllerInterface extends CRUDControllerInterface
+{
+    /**
+     * @param Request $request HTTP Method GET with filtering parameters
+     *
+     * @return Response
+     */
+    public function list(Request $request): Response;
+}
diff --git a/application/src/Controller/API/AbstractAPIController.php b/application/src/Controller/API/AbstractAPIController.php
new file mode 100644
index 0000000..9681ea0
--- /dev/null
+++ b/application/src/Controller/API/AbstractAPIController.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Controller\API;
+
+/**
+ * @author kevinfrantz
+ */
+abstract class AbstractAPIController implements APIControllerInterface
+{
+}
diff --git a/application/src/Controller/API/CRUDControllerInterface.php b/application/src/Controller/API/CRUDControllerInterface.php
new file mode 100644
index 0000000..edac701
--- /dev/null
+++ b/application/src/Controller/API/CRUDControllerInterface.php
@@ -0,0 +1,45 @@
+<?php
+
+namespace App\Controller\API;
+
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @author kevinfrantz
+ *
+ * @see https://de.wikipedia.org/wiki/CRUD
+ */
+interface CRUDControllerInterface
+{
+    /**
+     * @param Request $request HTTP Method POST with the object attributes as parameters
+     *
+     * @return Response
+     */
+    public function create(Request $request): Response;
+
+    /**
+     * @param Request    $request    HTTP Method GET
+     * @param int|string $identifier The slug or id of the object
+     *
+     * @return Response
+     */
+    public function read(Request $request, $identifier): Response;
+
+    /**
+     * @param Request    $request    HTTP Method PUT
+     * @param int|string $identifier The slug or id of the object
+     *
+     * @return Response
+     */
+    public function update(Request $request, $identifier): Response;
+
+    /**
+     * @param Request    $request    HTTP Method DELETE with the object attributes as parameters
+     * @param int|string $identifier The slug or id of the object
+     *
+     * @return Response
+     */
+    public function delete(Request $request, $identifier): Response;
+}
diff --git a/application/src/Controller/API/Meta/LawApiController.php b/application/src/Controller/API/Meta/LawApiController.php
new file mode 100644
index 0000000..f638fab
--- /dev/null
+++ b/application/src/Controller/API/Meta/LawApiController.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Controller\API\Meta;
+
+use App\Controller\API\AbstractAPIController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @author kevinfrantz
+ */
+class LawApiController extends AbstractAPIController
+{
+    public function read(Request $request, $identifier): Response
+    {
+    }
+
+    public function create(Request $request): Response
+    {
+    }
+
+    public function update(Request $request, $identifier): Response
+    {
+    }
+
+    public function list(Request $request): Response
+    {
+    }
+
+    public function delete(Request $request, $identifier): Response
+    {
+    }
+}
diff --git a/application/src/Controller/API/Meta/RightApiController.php b/application/src/Controller/API/Meta/RightApiController.php
new file mode 100644
index 0000000..7e0949d
--- /dev/null
+++ b/application/src/Controller/API/Meta/RightApiController.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Controller\API\Meta;
+
+use App\Controller\API\AbstractAPIController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class RightApiController extends AbstractAPIController
+{
+    public function read(Request $request, $identifier): Response
+    {
+    }
+
+    public function create(Request $request): Response
+    {
+    }
+
+    public function update(Request $request, $identifier): Response
+    {
+    }
+
+    public function list(Request $request): Response
+    {
+    }
+
+    public function delete(Request $request, $identifier): Response
+    {
+    }
+}
diff --git a/application/src/Controller/API/Source/SourceApiController.php b/application/src/Controller/API/Source/SourceApiController.php
new file mode 100644
index 0000000..e2ccfb5
--- /dev/null
+++ b/application/src/Controller/API/Source/SourceApiController.php
@@ -0,0 +1,79 @@
+<?php
+
+namespace App\Controller\API\Source;
+
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\HttpFoundation\Request;
+use App\Controller\API\AbstractAPIController;
+
+/**
+ * @author kevinfrantz
+ */
+class SourceApiController extends AbstractAPIController
+{
+    /**
+     * @Route("/api/{_locale}/source/{identifier}.{_format}",
+     * defaults={"_format"="json"} ,
+     * methods={"GET"}
+     * )
+     * {@inheritdoc}
+     *
+     * @see \App\Controller\API\CRUDControllerInterface::read()
+     */
+    public function read(Request $request, $identifier): Response
+    {
+    }
+
+    /**
+     * @Route("/api/{_locale}/source/.{_format}",
+     * defaults={"_format"="json"} ,
+     * methods={"POST"}
+     * )
+     * {@inheritdoc}
+     *
+     * @see \App\Controller\API\CRUDControllerInterface::create()
+     */
+    public function create(Request $request): Response
+    {
+    }
+
+    /**
+     * @Route("/api/{_locale}/source/{identifier}.{_format}",
+     * defaults={"_format"="json"} ,
+     * methods={"PUT"}
+     * )
+     * {@inheritdoc}
+     *
+     * @see \App\Controller\API\CRUDControllerInterface::update()
+     */
+    public function update(Request $request, $identifier): Response
+    {
+    }
+
+    /**
+     * @Route("/api/{_locale}/sources/.{_format}",
+     * defaults={"_format"="json"} ,
+     * methods={"GET"}
+     * )
+     * {@inheritdoc}
+     *
+     * @see \App\Controller\API\APIControllerInterface::list()
+     */
+    public function list(Request $request): Response
+    {
+    }
+
+    /**
+     * @Route("/api/{_locale}/source/{identifier}.{_format}",
+     * defaults={"_format"="json"} ,
+     * methods={"DELETE"}
+     * )
+     * {@inheritdoc}
+     *
+     * @see \App\Controller\API\CRUDControllerInterface::delete()
+     */
+    public function delete(Request $request, $identifier): Response
+    {
+    }
+}
diff --git a/application/src/Controller/LawController.php b/application/src/Controller/LawController.php
deleted file mode 100644
index e6beaa1..0000000
--- a/application/src/Controller/LawController.php
+++ /dev/null
@@ -1,60 +0,0 @@
-<?php
-
-namespace App\Controller;
-
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpFoundation\RedirectResponse;
-use Symfony\Component\Routing\Annotation\Route;
-use App\Entity\Meta\Law;
-use App\Entity\Meta\LawInterface;
-
-/**
- * @author kevinfrantz
- *
- * @todo Implement security!
- */
-class LawController extends AbstractEntityController
-{
-    /**
-     * @Route("/law/{id}.{_format}", defaults={"_format"="html"})
-     */
-    public function show(int $id): Response
-    {
-        /**
-         * @var LawInterface
-         */
-        $law = $this->loadEntityById($id);
-        $view = $this->view($law, 200)
-            ->setTemplate('law/view/standard.html.twig')
-            ->setTemplateVar('law');
-
-        return $this->handleView($view);
-    }
-
-    /**
-     * @Route("/law/{id}/right.{_format}", defaults={"_format"="html"})
-     */
-    public function right(int $id): RedirectResponse
-    {
-        /*
-         *
-         * @todo Implement function!
-         */
-    }
-
-    /**
-     * @Route("/law/{id}/node.{_format}", defaults={"_format"="html"})
-     */
-    public function node(int $id): RedirectResponse
-    {
-        /*
-         *
-         * @todo Implement function!
-         */
-    }
-
-    protected function setEntityName(): void
-    {
-        $this->entityName = Law::class;
-    }
-}
diff --git a/application/src/Controller/SourceController.php b/application/src/Controller/SourceController.php
deleted file mode 100644
index 54f3fb2..0000000
--- a/application/src/Controller/SourceController.php
+++ /dev/null
@@ -1,82 +0,0 @@
-<?php
-
-namespace App\Controller;
-
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Routing\Annotation\Route;
-use Symfony\Component\HttpFoundation\Request;
-use App\Creator\Factory\Template\Source\SourceTemplateFactory;
-use App\Entity\Source\SourceInterface;
-use App\Creator\Factory\Template\Source\SourceTemplateFormFactory;
-use App\Creator\Factory\Form\Source\SourceFormFactory;
-use Symfony\Component\HttpFoundation\RedirectResponse;
-use App\Entity\Source\AbstractSource;
-use App\Entity\Meta\RelationInterface;
-
-/**
- * @todo IMPLEMENT SECURITY!
- *
- * @author kevinfrantz
- */
-class SourceController extends AbstractEntityController
-{
-    /**
-     * @Route("/source/{id}.{_format}", defaults={"_format"="html"})
-     */
-    public function show(Request $request, int $id): Response
-    {
-        $source = $this->loadEntityById($id);
-        // $assembler = $this->get(SourceDTOAssember::class);
-        // $dto = $assembler->build($source, $this->getUser());
-        $view = $this->view($source, 200)
-            ->setTemplate((new SourceTemplateFactory($source, $request))->getTemplatePath())
-            ->setTemplateVar('source');
-
-        return $this->handleView($view);
-    }
-
-    /**
-     * @Route("/source/{id}/edit.{_format}", defaults={"_format"="html"})
-     */
-    public function edit(Request $request, int $id): Response
-    {
-        $source = $this->loadEntityById($id);
-        $form = $this->createForm((new SourceFormFactory($source))->getNamespace(), $source);
-        $form->handleRequest($request);
-        if ($form->isSubmitted() && $form->isValid()) {
-            $source = $form->getData();
-            $this->saveSource($source);
-        }
-
-        return $this->render((new SourceTemplateFormFactory($source, $request))->getTemplatePath(), [
-            'form' => $form->createView(),
-        ]);
-    }
-
-    /**
-     * @Route("/source/{id}/node.{_format}", defaults={"_format"="html"})
-     */
-    public function node(int $id): RedirectResponse
-    {
-        $nodeId = $this->loadNodeById($id)->getId();
-
-        return $this->redirectToRouteById('app_node_show', $nodeId);
-    }
-
-    private function loadNodeById(int $id): RelationInterface
-    {
-        return $this->loadEntityById($id)->getNode();
-    }
-
-    private function saveSource(SourceInterface $source): void
-    {
-        $entityManager = $this->getDoctrine()->getManager();
-        $entityManager->persist($source);
-        $entityManager->flush();
-    }
-
-    protected function setEntityName(): void
-    {
-        $this->entityName = AbstractSource::class;
-    }
-}