initial rest controller, added possibility to specify valid http methods for controllers

degami · degami · commit 71485bd067ca · 2020-02-28T01:46:29.000+01:00
diff --git a/app/base/abstracts/AdminPage.php b/app/base/abstracts/AdminPage.php
@@ -53,6 +53,16 @@ public function __construct(ContainerInterface $container)
         }
     }
 
+    /**
+     * returns valid route HTTP verbs
+     *
+     * @return array
+     */
+    public function getRouteVerbs()
+    {
+        return ['GET','POST'];
+    }
+
     /**
      * before render hook
      *
diff --git a/app/base/abstracts/BaseRestPage.php b/app/base/abstracts/BaseRestPage.php
@@ -0,0 +1,155 @@
+<?php
+/**
+ * SiteBase
+ * PHP Version 7.0
+ *
+ * @category CMS / Framework
+ * @package  Degami\Sitebase
+ * @author   Mirko De Grandis <degami@github.com>
+ * @license  MIT https://opensource.org/licenses/mit-license.php
+ * @link     https://github.com/degami/sitebase
+ */
+namespace App\Base\Abstracts;
+
+use \Psr\Container\ContainerInterface;
+use \App\App;
+use \App\Site\Routing\RouteInfo;
+use \Symfony\Component\HttpFoundation\Response;
+use \Symfony\Component\HttpFoundation\JsonResponse;
+use \Exception;
+
+/**
+ * Base for rest endopoints
+ */
+abstract class BaseRestPage extends BasePage
+{
+    /**
+     * {@inheritdocs}
+     *
+     * @param ContainerInterface $container
+     */
+    public function __construct(ContainerInterface $container)
+    {
+        parent::__construct($container);
+        $this->response = $this->getContainer()->get(JsonResponse::class);
+    }
+
+    /**
+     * returns valid route HTTP verbs
+     *
+     * @return array
+     */
+    public function getRouteVerbs()
+    {
+        return ['DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST', 'PUT'];
+    }
+
+    /**
+     * before render hook
+     *
+     * @return Response|self
+     */
+    protected function beforeRender()
+    {
+        $return = parent::beforeRender();
+        if ($return instanceof Response) {
+            return $return;
+        }
+
+        if ($this->getRequest()->getContentType() != 'application/json') {
+            return $this->getUtils()->errorPage(403);
+        }
+
+        return $this;
+    }
+
+    /**
+     * get Request HTTP verb
+     *
+     * @return string
+     */
+    protected function getVerb()
+    {
+        return $this->getRequest()->getMethod();
+    }
+
+    /**
+     * loads object by id
+     *
+     * @param  integer $id
+     * @return \App\Base\Abstracts\Model
+     */
+    protected function loadObject($id)
+    {
+        if (!is_subclass_of($this->getObjectClass(), \App\Base\Abstracts\Model::class)) {
+            return null;
+        }
+
+        return $this->getContainer()->call([$this->getObjectClass(), 'load'], [ 'id' => $id]);
+    }
+
+    /**
+     * {@inheritdocs}
+     *
+     * @param  RouteInfo|null $route_info
+     * @param  array          $route_data
+     * @return Response
+     */
+    public function process(RouteInfo $route_info = null, $route_data = [])
+    {
+        $return = parent::process($route_info, $route_data);
+
+        if (!empty($data = json_decode($this->getRequest()->getContent(), true))) {
+            if (isset($data['id'])) {
+                unset($data['id']);
+            }
+        }
+
+        $object = $this->getContainer()->call([$this->getObjectClass(), 'new']);
+        if (in_array($this->getVerb(), ['GET', 'PUT', 'DELETE'])) {
+            $object = $this->loadObject($route_data['id']);
+        }
+
+        switch ($this->getVerb()) {
+            case 'POST':
+            case 'PUT':
+                // Create
+                // Update
+
+                $object->setData($data);
+                $object->save();
+                return $this
+                    ->getResponse()
+                    ->prepare($this->getRequest())
+                    ->setData($object->getData());
+                break;
+            case 'GET':
+                // Read
+                return $this
+                    ->getResponse()
+                    ->prepare($this->getRequest())
+                    ->setData($object->getData());
+                break;
+            case 'DELETE':
+                // Delete
+                $old_data = $object->getData();
+                unset($old_data['id']);
+                $object->delete();
+
+                return $this
+                    ->getResponse()
+                    ->prepare($this->getRequest())
+                    ->setData($old_data);
+                break;
+        }
+
+        return $return;
+    }
+
+    /**
+     * gets object class name for method
+     *
+     * @return string
+     */
+    abstract public static function getObjectClass();
+}
diff --git a/app/site/controllers/Frontend/ContactForm.php b/app/site/controllers/Frontend/ContactForm.php
@@ -70,6 +70,16 @@ public static function getRoutePath()
         return 'contact/{id:\d+}';
     }
 
+    /**
+     * returns valid route HTTP verbs
+     *
+     * @return array
+     */
+    public function getRouteVerbs()
+    {
+        return ['GET', 'POST'];
+    }
+
     /**
      * {@inheritdocs}
      *
diff --git a/app/site/controllers/Frontend/Links.php b/app/site/controllers/Frontend/Links.php
@@ -39,6 +39,16 @@ public static function getRouteGroup()
         return '';
     }
 
+    /**
+     * returns valid route HTTP verbs
+     *
+     * @return array
+     */
+    public function getRouteVerbs()
+    {
+        return ['GET','POST'];
+    }
+
     /**
      * return route path
      *
@@ -153,7 +163,7 @@ public function formValidate(FAPI\Form $form, &$form_state)
     public function formSubmitted(FAPI\Form $form, &$form_state)
     {
         $values = $form->getValues();
-        
+
         $link = $this->getContainer()->call([LinkExchange::class, 'new']);
         $link->url = $values->url;
         $link->email = $values->email;
diff --git a/app/site/controllers/Frontend/Login.php b/app/site/controllers/Frontend/Login.php
@@ -52,6 +52,16 @@ public static function getRoutePath()
         return 'login';
     }
 
+    /**
+     * returns valid route HTTP verbs
+     *
+     * @return array
+     */
+    public function getRouteVerbs()
+    {
+        return ['GET','POST'];
+    }
+
     /**
      * {@inheritdocs}
      *
diff --git a/app/site/controllers/Frontend/NewsDetail.php b/app/site/controllers/Frontend/NewsDetail.php
@@ -35,6 +35,16 @@ public static function getRoutePath()
         return 'news/{id:\d+}';
     }
 
+    /**
+     * returns valid route HTTP verbs
+     *
+     * @return array
+     */
+    public function getRouteVerbs()
+    {
+        return ['GET'];
+    }
+
     /**
      * {@inheritdocs}
      *
diff --git a/app/site/controllers/Frontend/Page.php b/app/site/controllers/Frontend/Page.php
@@ -35,6 +35,16 @@ public static function getRoutePath()
         return 'page/{id:\d+}';
     }
 
+    /**
+     * returns valid route HTTP verbs
+     *
+     * @return array
+     */
+    public function getRouteVerbs()
+    {
+        return ['GET'];
+    }
+
     /**
      * {@inheritdocs}
      *
diff --git a/app/site/controllers/Frontend/Taxonomy.php b/app/site/controllers/Frontend/Taxonomy.php
@@ -34,6 +34,16 @@ public static function getRoutePath()
         return 'taxonomy/{id:\d+}';
     }
 
+    /**
+     * returns valid route HTTP verbs
+     *
+     * @return array
+     */
+    public function getRouteVerbs()
+    {
+        return ['GET'];
+    }
+
     /**
      * {@inheritdocs}
      *
diff --git a/app/site/routing/Web.php b/app/site/routing/Web.php
@@ -26,6 +26,9 @@
  */
 class Web extends ContainerAwareObject
 {
+    const CLASS_METHOD = 'renderPage';
+    const HTTP_VERBS = ['GET', 'POST'];
+
     /**
      * @var Dispatcher dispatcher
      */
@@ -57,6 +60,9 @@ public function __construct(ContainerInterface $container)
                 $path = str_replace("app/site/controllers/", "", str_replace("\\", "/", strtolower($controllerClass)));
                 $route_name = str_replace("/", ".", trim($path, "/"));
 
+                $classMethod = self::CLASS_METHOD;
+                $verbs = self::HTTP_VERBS;
+
                 if (($tmp = explode("/", $path, 2)) && count($tmp) > 1) {
                     $tmp = array_map(
                         function ($el) {
@@ -78,14 +84,24 @@ function ($el) {
                     $group = call_user_func([$controllerClass, 'getRouteGroup']) ?? $group;
                 }
 
+                if (method_exists($controllerClass, 'getRouteVerbs')) {
+                    $verbs = call_user_func([$controllerClass, 'getRouteVerbs']) ?? $verbs;
+                    if (!is_array($verbs)) {
+                        $verbs = [$verbs];
+                    }
+                    if (!empty($errors = $this->checkRouteVerbs($verbs))) {
+                        throw new InvalidValueException(implode(',', $errors).": Invalid route verbs", 1);
+                    }
+                }
+
                 if (method_exists($controllerClass, 'getRoutePath')) {
                     $path = call_user_func([$controllerClass, 'getRoutePath']) ?? $path;
                     if (!$this->checkRouteParameters($path)) {
                         throw new InvalidValueException("'{$path}': Invalid route string", 1);
                     }
                 }
 
-                $this->addRoute($group, $route_name, "/".ltrim($path, "/ "), $controllerClass);
+                $this->addRoute($group, $route_name, "/".ltrim($path, "/ "), $controllerClass, $classMethod, $verbs);
             }
         }
 
@@ -123,6 +139,24 @@ protected function checkRouteParameters($route)
         return true;
     }
 
+    /**
+     * checks route http verbs
+     *
+     * @param  array $verbs
+     * @return array
+     */
+    protected function checkRouteVerbs($verbs)
+    {
+        if (!is_array($verbs)) {
+            $verbs = [$verbs];
+        }
+
+        return array_diff(
+            array_filter(array_map('strtoupper', array_map('trim', $verbs))),
+            ['DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST', 'PUT']
+        );
+    }
+
     /**
      * adds routes
      *
@@ -148,7 +182,7 @@ private function _insertRoutes(RouteCollector $r, array $paths)
      */
     private function _insertRoute(RouteCollector $r, array $p)
     {
-        $r->addRoute(['GET','POST'], $p['path'], [$p['class'], $p['method']]);
+        $r->addRoute($p['verbs'], $p['path'], [$p['class'], $p['method']]);
 
         return $this;
     }
@@ -185,9 +219,15 @@ function ($el) use ($class) {
      * @param string $class
      * @param string $method
      */
-    public function addRoute($group, $name, $path, $class, $method = 'renderPage')
+    public function addRoute($group, $name, $path, $class, $method = 'renderPage', $verbs = ['GET', 'POST'])
     {
-        $this->routes[$group][] = ['path' => $path, 'class' => $class, 'method' => $method, 'name' => $name];
+        $this->routes[$group][] = [
+            'path' => $path,
+            'class' => $class,
+            'method' => $method,
+            'name' => $name,
+            'verbs' => $verbs
+        ];
         return $this;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,16 @@ public function __construct(ContainerInterface $container)`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`
	`56`	`+ /**`
	`57`	`+ * returns valid route HTTP verbs`
	`58`	`+ *`
	`59`	`+ * @return array`
	`60`	`+ */`
	`61`	`+ public function getRouteVerbs()`
	`62`	`+ {`
	`63`	`+ return ['GET','POST'];`
	`64`	`+ }`
	`65`	`+`
`56`	`66`	`/**`
`57`	`67`	`* before render hook`
`58`	`68`	`*`