added return types

Author: igor-chepurnoi

controllers/AssignmentController.php

@@ -46,7 +46,7 @@ class AssignmentController extends Controller
     /**
      * @inheritdoc
      */
-    public function init()
+    public function init(): void
     {
         parent::init();
 
@@ -65,7 +65,7 @@ public function init()
     /**
      * @inheritdoc
      */
-    public function behaviors()
+    public function behaviors(): array
     {
         return [
             'verbs' => [
@@ -117,7 +117,7 @@ public function actionIndex()
      *
      * @return mixed
      */
-    public function actionView($id)
+    public function actionView(int $id)
     {
         $model = $this->findModel($id);
 
@@ -130,11 +130,11 @@ public function actionView($id)
     /**
      * Assign items
      *
-     * @param string $id
+     * @param int $id
      *
      * @return array
      */
-    public function actionAssign($id)
+    public function actionAssign(int $id)
     {
         $items = Yii::$app->getRequest()->post('items', []);
         $assignmentModel = $this->findModel($id);
@@ -146,11 +146,11 @@ public function actionAssign($id)
     /**
      * Remove items
      *
-     * @param string $id
+     * @param int $id
      *
      * @return array
      */
-    public function actionRemove($id)
+    public function actionRemove(int $id)
     {
         $items = Yii::$app->getRequest()->post('items', []);
         $assignmentModel = $this->findModel($id);
@@ -169,7 +169,7 @@ public function actionRemove($id)
      *
      * @throws NotFoundHttpException if the model cannot be found
      */
-    protected function findModel($id)
+    protected function findModel(int $id)
     {
         $class = $this->userIdentityClass;
 

controllers/RouteController.php

@@ -27,7 +27,7 @@ class RouteController extends Controller
      *
      * @return array
      */
-    public function behaviors()
+    public function behaviors(): array
     {
         return [
             'verbs' => [
@@ -67,7 +67,7 @@ public function actionIndex()
      *
      * @return array
      */
-    public function actionAssign()
+    public function actionAssign(): array
     {
         $routes = Yii::$app->getRequest()->post('routes', []);
         $model = Yii::createObject($this->modelClass);
@@ -81,7 +81,7 @@ public function actionAssign()
      *
      * @return array
      */
-    public function actionRemove()
+    public function actionRemove(): array
     {
         $routes = Yii::$app->getRequest()->post('routes', []);
         $model = Yii::createObject($this->modelClass);
@@ -92,8 +92,10 @@ public function actionRemove()
 
     /**
      * Refresh cache of routes
+     *
+     * @return array
      */
-    public function actionRefresh()
+    public function actionRefresh(): array
     {
         $model = Yii::createObject($this->modelClass);
         $model->invalidate();

controllers/RuleController.php

@@ -28,7 +28,7 @@ class RuleController extends Controller
      *
      * @return array
      */
-    public function behaviors()
+    public function behaviors(): array
     {
         return [
             'verbs' => [
@@ -63,11 +63,11 @@ public function actionIndex()
     /**
      * Displays a single Rule item.
      *
-     * @param string $id
+     * @param int $id
      *
      * @return mixed
      */
-    public function actionView($id)
+    public function actionView(int $id)
     {
         $model = $this->findModel($id);
 
@@ -99,11 +99,11 @@ public function actionCreate()
      *
      * If update is successful, the browser will be redirected to the 'view' page.
      *
-     * @param string $id
+     * @param int $id
      *
      * @return mixed
      */
-    public function actionUpdate($id)
+    public function actionUpdate(int $id)
     {
         $model = $this->findModel($id);
 
@@ -121,11 +121,11 @@ public function actionUpdate($id)
      *
      * If deletion is successful, the browser will be redirected to the 'index' page.
      *
-     * @param string $id
+     * @param int $id
      *
      * @return mixed
      */
-    public function actionDelete($id)
+    public function actionDelete(int $id)
     {
         $model = $this->findModel($id);
         Yii::$app->authManager->remove($model->item);
@@ -139,19 +139,20 @@ public function actionDelete($id)
      *
      * If the model is not found, a 404 HTTP exception will be thrown.
      *
-     * @param string $id
+     * @param int $id
      *
      * @return BizRuleModel the loaded model
      *
      * @throws \yii\web\NotFoundHttpException
      */
-    protected function findModel($id)
+    protected function findModel(int $id)
     {
         $item = Yii::$app->authManager->getRule($id);
-        if ($item) {
+
+        if (!empty($item)) {
             return new BizRuleModel($item);
-        } else {
-            throw new NotFoundHttpException(Yii::t('yii2mod.rbac', 'The requested page does not exist.'));
         }
+
+        throw new NotFoundHttpException(Yii::t('yii2mod.rbac', 'The requested page does not exist.'));
     }
 }

models/RouteModel.php

@@ -3,6 +3,8 @@
 namespace yii2mod\rbac\models;
 
 use Yii;
+use yii\base\Controller;
+use yii\base\Module;
 use yii\base\Object;
 use yii\caching\TagDependency;
 use yii\helpers\VarDumper;
@@ -44,7 +46,7 @@ class RouteModel extends Object
      *
      * @param array $config
      */
-    public function __construct($config = [])
+    public function __construct(array $config = [])
     {
         $this->cache = Yii::$app->cache;
         $this->manager = Yii::$app->authManager;
@@ -59,7 +61,7 @@ public function __construct($config = [])
      *
      * @return bool
      */
-    public function addNew($routes): bool
+    public function addNew(array $routes): bool
     {
         foreach ($routes as $route) {
             $this->manager->add($this->manager->createPermission('/' . trim($route, ' /')));
@@ -77,7 +79,7 @@ public function addNew($routes): bool
      *
      * @return bool
      */
-    public function remove($routes): bool
+    public function remove(array $routes): bool
     {
         foreach ($routes as $route) {
             $item = $this->manager->createPermission('/' . trim($route, '/'));
@@ -115,15 +117,15 @@ public function getRoutes(): array
     /**
      * Get list of application routes
      *
-     * @param string|null $module
+     * @param null|string $module
      *
      * @return array
      */
-    public function getAppRoutes($module = null): array
+    public function getAppRoutes(string $module = null): array
     {
         if ($module === null) {
             $module = Yii::$app;
-        } elseif (is_string($module)) {
+        } else {
             $module = Yii::$app->getModule($module);
         }
 
@@ -156,10 +158,10 @@ public function invalidate(): void
     /**
      * Get route(s) recursive
      *
-     * @param \yii\base\Module $module
+     * @param Module $module
      * @param array $result
      */
-    protected function getRouteRecursive($module, &$result): void
+    protected function getRouteRecursive(Module $module, &$result): void
     {
         if (!in_array($module->id, $this->excludeModules)) {
             $token = "Get Route of '" . get_class($module) . "' with id '" . $module->uniqueId . "'";
@@ -191,14 +193,12 @@ protected function getRouteRecursive($module, &$result): void
     /**
      * Get list controllers under module
      *
-     * @param \yii\base\Module $module
+     * @param Module $module
      * @param string $namespace
      * @param string $prefix
      * @param mixed $result
-     *
-     * @return mixed
      */
-    protected function getControllerFiles($module, $namespace, $prefix, &$result)
+    protected function getControllerFiles(Module $module, string $namespace, string $prefix, &$result): void
     {
         $path = Yii::getAlias('@' . str_replace('\\', '/', $namespace), false);
         $token = "Get controllers from '$path'";
@@ -237,16 +237,16 @@ protected function getControllerFiles($module, $namespace, $prefix, &$result)
      *
      * @param mixed $type
      * @param string $id
-     * @param \yii\base\Module $module
-     * @param string $result
+     * @param Module $module
+     * @param mixed $result
      */
-    protected function getControllerActions($type, $id, $module, &$result)
+    protected function getControllerActions($type, $id, Module $module, &$result): void
     {
-        $token = 'Create controller with cofig=' . VarDumper::dumpAsString($type) . " and id='$id'";
+        $token = 'Create controller with config=' . VarDumper::dumpAsString($type) . " and id='$id'";
         Yii::beginProfile($token, __METHOD__);
 
         try {
-            /* @var $controller \yii\base\Controller */
+            /* @var $controller Controller */
             $controller = Yii::createObject($type, [$id, $module]);
             $this->getActionRoutes($controller, $result);
             $all = "/{$controller->uniqueId}/*";
@@ -261,13 +261,14 @@ protected function getControllerActions($type, $id, $module, &$result)
     /**
      * Get route of action
      *
-     * @param \yii\base\Controller $controller
+     * @param Controller $controller
      * @param array $result all controller action
      */
-    protected function getActionRoutes($controller, &$result)
+    protected function getActionRoutes(Controller $controller, &$result): void
     {
         $token = "Get actions of controller '" . $controller->uniqueId . "'";
         Yii::beginProfile($token, __METHOD__);
+
         try {
             $prefix = '/' . $controller->uniqueId . '/';
             foreach ($controller->actions() as $id => $value) {
@@ -286,6 +287,7 @@ protected function getActionRoutes($controller, &$result)
         } catch (\Exception $exc) {
             Yii::error($exc->getMessage(), __METHOD__);
         }
+
         Yii::endProfile($token, __METHOD__);
     }
 }