Controllers common

Author: taguz91

src/AutoloadExample.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace taguz91\CommonRest;
+
+use taguz91\CommonRest\traits\ControllerBehavior;
+use Yii;
+use yii\web\Controller as WebController;
+use yii\web\Response;
+
+class Controller extends WebController
+{
+
+  use ControllerBehavior;
+
+  /**
+   * @inheritdoc
+   */
+  public function beforeAction($action)
+  {
+    date_default_timezone_set("America/Guayaquil");
+    Yii::$app->response->format = Response::FORMAT_JSON;
+    Yii::$app->response->headers->add('Content-Type', 'application/json');
+    $this->enableCsrfValidation = false;
+    return parent::beforeAction($action);
+  }
+
+  /**
+   * @inheritdoc
+   */
+  public function afterAction($action, $result)
+  {
+    $result = parent::afterAction($action, $result);
+    if (is_null($result)) Yii::$app->response->content = '';
+
+    // Si no es un strign no validamos nada 
+    if (!is_string($result)) return $result;
+
+    if ($data = json_decode($result) !== false) {
+      if (is_object($data)) return $data;
+    }
+
+    // Si es un PDF lo mostramos ya no seteamos a json
+    if (Yii::$app->response->headers->get('Content-Type') === 'application/pdf') {
+      return $result;
+    }
+
+    Yii::$app->response->format = Response::FORMAT_HTML;
+    Yii::$app->response->headers->remove('Content-Type', 'application/json');
+    return $result;
+  }
+
+  /**
+   * @inheritdoc
+   */
+  public function render($view, $params = [])
+  {
+    Yii::$app->response->format = Response::FORMAT_HTML;
+    Yii::$app->response->headers->remove('Content-Type', 'application/json');
+    return parent::render($view, $params);
+  }
+}

src/Controller.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace taguz91\CommonRest;
+
+use Yii;
+
+use yii\filters\Cors;
+
+class OptionsCors extends Cors
+{
+
+  /**
+   * @var array Basic headers handled for the CORS requests.
+   */
+  public $cors = [
+    'Origin' => ['*'],
+    'Access-Control-Allow-Origin' => ['*'],
+    'Access-Control-Request-Method' => ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS'],
+    'Access-Control-Request-Headers' => ['*'],
+    'Access-Control-Allow-Credentials' => false,
+    'Credentials' => false,
+    'Access-Control-Max-Age' => 86400,
+    'Access-Control-Expose-Headers' => ['X-Pagination-Current-Page'],
+  ];
+
+  public function beforeAction($action)
+  {
+    parent::beforeAction($action);
+    $requestMethod = Yii::$app->getRequest()->getMethod();
+
+    if (strtoupper($requestMethod) === 'OPTIONS') {
+      Yii::$app->getResponse()->getHeaders()->set('Allow', 'POST GET PUT DELETE');
+      Yii::$app->end();
+    }
+
+    return true;
+  }
+}

src/OptionsCors.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace taguz91\CommonRest;
+
+use taguz91\CommonRest\traits\ControllerBehavior;
+use Yii;
+use yii\rest\Controller as BaseController;
+use yii\web\Response;
+
+class RestController extends BaseController
+{
+
+  use ControllerBehavior;
+
+  /**
+   * @inheritdoc
+   */
+  public function beforeAction($action)
+  {
+    date_default_timezone_set("America/Guayaquil");
+    Yii::$app->response->format = Response::FORMAT_JSON;
+    Yii::$app->response->headers->add('Content-Type', 'application/json');
+    $this->enableCsrfValidation = false;
+    return parent::beforeAction($action);
+  }
+}

src/RestController.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace taguz91\CommonRest\traits;
+
+use yii\filters\AccessControl;
+use yii\filters\auth\CompositeAuth;
+use yii\filters\RateLimiter;
+use yii\filters\VerbFilter;
+
+trait ControllerBehavior
+{
+
+  /**
+   * {@inheritdoc}
+   */
+  public function behaviors()
+  {
+    $behavior = [
+      'verbFilter' => [
+        'class' => VerbFilter::class,
+        'actions' => $this->verbs(),
+      ],
+      'authenticator' => [
+        'class' => CompositeAuth::class,
+      ],
+      'rateLimiter' => [
+        'class' => RateLimiter::class,
+      ],
+      'corsFilter' => [
+        'class' => OptionsCors::class,
+      ],
+    ];
+
+    $rules = $this->rules();
+    if (!empty($rules)) {
+      $behavior['access'] = [
+        'class' => AccessControl::class,
+        'rules' => $this->rules(),
+      ];
+    }
+    return $behavior;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function verbs()
+  {
+    return [];
+  }
+
+  protected function rules()
+  {
+    return [];
+  }
+}