add cs fixer and PHPStan and activate it (build 436)

src/ZM/Annotation/AnnotationParser.php

@@ -1,13 +1,10 @@
 <?php
 
+declare(strict_types=1);
 
 namespace ZM\Annotation;
 
 use Doctrine\Common\Annotations\AnnotationReader;
-use ZM\Annotation\CQ\CQCommand;
-use ZM\Annotation\Interfaces\ErgodicAnnotation;
-use ZM\Config\ZMConfig;
-use ZM\Console\Console;
 use ReflectionClass;
 use ReflectionException;
 use ReflectionMethod;
@@ -17,8 +14,11 @@ use ZM\Annotation\Http\HandleException;
 use ZM\Annotation\Http\Middleware;
 use ZM\Annotation\Http\MiddlewareClass;
 use ZM\Annotation\Http\RequestMapping;
+use ZM\Annotation\Interfaces\ErgodicAnnotation;
 use ZM\Annotation\Interfaces\Level;
 use ZM\Annotation\Module\Closed;
+use ZM\Config\ZMConfig;
+use ZM\Console\Console;
 use ZM\Exception\AnnotationException;
 use ZM\Utils\Manager\RouteManager;
 use ZM\Utils\ZMUtil;
@@ -30,23 +30,27 @@ class AnnotationParser
     private $start_time;
 
     private $annotation_map = [];
+
     private $middleware_map = [];
+
     private $middlewares = [];
 
     /** @var null|AnnotationReader */
-    private $reader = null;
+    private $reader;
+
     private $req_mapping = [];
 
     /**
      * AnnotationParser constructor.
      */
-    public function __construct() {
+    public function __construct()
+    {
         $this->start_time = microtime(true);
         //$this->loadAnnotationClasses();
         $this->req_mapping[0] = [
             'id' => 0,
             'pid' => -1,
-            'name' => '/'
+            'name' => '/',
         ];
     }
 
@@ -54,13 +58,14 @@ class AnnotationParser
      * 注册各个模块类的注解和模块level的排序
      * @throws ReflectionException
      */
-    public function registerMods() {
+    public function registerMods()
+    {
         foreach ($this->path_list as $path) {
-            Console::debug("parsing annotation in " . $path[0].":".$path[1]);
+            Console::debug('parsing annotation in ' . $path[0] . ':' . $path[1]);
             $all_class = ZMUtil::getClassesPsr4($path[0], $path[1]);
             $this->reader = new AnnotationReader();
             foreach ($all_class as $v) {
-                Console::debug("正在检索 " . $v);
+                Console::debug('正在检索 ' . $v);
                 $reflection_class = new ReflectionClass($v);
                 $methods = $reflection_class->getMethods(ReflectionMethod::IS_PUBLIC);
                 $class_annotations = $this->reader->getClassAnnotations($reflection_class);
@@ -85,22 +90,21 @@ class AnnotationParser
                 */
 
                 // 生成主树
-                $this->annotation_map[$v]["class_annotations"] = $class_annotations;
-                $this->annotation_map[$v]["methods"] = $methods;
+                $this->annotation_map[$v]['class_annotations'] = $class_annotations;
+                $this->annotation_map[$v]['methods'] = $methods;
                 foreach ($methods as $method) {
-                    $this->annotation_map[$v]["methods_annotations"][$method->getName()] = $this->reader->getMethodAnnotations($method);
+                    $this->annotation_map[$v]['methods_annotations'][$method->getName()] = $this->reader->getMethodAnnotations($method);
                 }
 
-
-                foreach ($this->annotation_map[$v]["class_annotations"] as $vs) {
+                foreach ($this->annotation_map[$v]['class_annotations'] as $vs) {
                     $vs->class = $v;
 
                     //预处理1：将适用于每一个函数的注解到类注解重新注解到每个函数下面
                     if ($vs instanceof ErgodicAnnotation) {
-                        foreach (($this->annotation_map[$v]["methods"] ?? []) as $method) {
+                        foreach (($this->annotation_map[$v]['methods'] ?? []) as $method) {
                             $copy = clone $vs;
                             $copy->method = $method->getName();
-                            $this->annotation_map[$v]["methods_annotations"][$method->getName()][] = $copy;
+                            $this->annotation_map[$v]['methods_annotations'][$method->getName()][] = $copy;
                         }
                     }
 
@@ -108,23 +112,24 @@ class AnnotationParser
                     if ($vs instanceof Closed) {
                         unset($this->annotation_map[$v]);
                         continue 2;
-                    } elseif ($vs instanceof MiddlewareClass) {
+                    }
+                    if ($vs instanceof MiddlewareClass) {
                         //注册中间件本身的类，标记到 middlewares 属性中
-                        Console::debug("正在注册中间件 " . $reflection_class->getName());
+                        Console::debug('正在注册中间件 ' . $reflection_class->getName());
                         $rs = $this->registerMiddleware($vs, $reflection_class);
-                        $this->middlewares[$rs["name"]] = $rs;
+                        $this->middlewares[$rs['name']] = $rs;
                     }
                 }
 
                 $inserted = [];
 
                 //预处理3：处理每个函数上面的特殊注解，就是需要操作一些东西的
-                foreach (($this->annotation_map[$v]["methods_annotations"] ?? []) as $method_name => $methods_annotations) {
+                foreach (($this->annotation_map[$v]['methods_annotations'] ?? []) as $method_name => $methods_annotations) {
                     foreach ($methods_annotations as $method_anno) {
-                        /** @var AnnotationBase $method_anno */
+                        /* @var AnnotationBase $method_anno */
                         $method_anno->class = $v;
                         $method_anno->method = $method_name;
-                        if (!($method_anno instanceof Middleware) && ($middlewares = ZMConfig::get("global", "runtime")["global_middleware_binding"][get_class($method_anno)] ?? []) !== []) {
+                        if (!($method_anno instanceof Middleware) && ($middlewares = ZMConfig::get('global', 'runtime')['global_middleware_binding'][get_class($method_anno)] ?? []) !== []) {
                             if (!isset($inserted[$v][$method_name])) {
                                 // 在这里在其他中间件前插入插入全局的中间件
                                 foreach ($middlewares as $middleware) {
@@ -146,23 +151,25 @@ class AnnotationParser
                 }
             }
         }
-        Console::debug("解析注解完毕！");
+        Console::debug('解析注解完毕！');
     }
 
-    public function generateAnnotationEvents(): array {
+    public function generateAnnotationEvents(): array
+    {
         $o = [];
         foreach ($this->annotation_map as $obj) {
             // 这里的ErgodicAnnotation是为了解决类上的注解可穿透到方法上的问题
-            foreach (($obj["class_annotations"] ?? []) as $class_annotation) {
-                if ($class_annotation instanceof ErgodicAnnotation) continue;
-                else $o[get_class($class_annotation)][] = $class_annotation;
+            foreach (($obj['class_annotations'] ?? []) as $class_annotation) {
+                if ($class_annotation instanceof ErgodicAnnotation) {
+                    continue;
+                }
+                $o[get_class($class_annotation)][] = $class_annotation;
             }
-            foreach (($obj["methods_annotations"] ?? []) as $methods_annotations) {
+            foreach (($obj['methods_annotations'] ?? []) as $methods_annotations) {
                 foreach ($methods_annotations as $annotation) {
                     $o[get_class($annotation)][] = $annotation;
                 }
             }
-
         }
         foreach ($o as $k => $v) {
             $this->sortByLevel($o, $k);
@@ -170,55 +177,36 @@ class AnnotationParser
         return $o;
     }
 
-    /**
-     * @return array
-     */
-    public function getMiddlewares(): array { return $this->middlewares; }
+    public function getMiddlewares(): array
+    {
+        return $this->middlewares;
+    }
 
-    /**
-     * @return array
-     */
-    public function getMiddlewareMap(): array { return $this->middleware_map; }
+    public function getMiddlewareMap(): array
+    {
+        return $this->middleware_map;
+    }
 
-    /**
-     * @return array
-     */
-    public function getReqMapping(): array { return $this->req_mapping; }
+    public function getReqMapping(): array
+    {
+        return $this->req_mapping;
+    }
 
     /**
      * @param $path
      * @param $indoor_name
      */
-    public function addRegisterPath($path, $indoor_name) { $this->path_list[] = [$path, $indoor_name]; }
-
-    //private function below
-
-    private function registerMiddleware(MiddlewareClass $vs, ReflectionClass $reflection_class): array {
-        $result = [
-            "class" => "\\" . $reflection_class->getName(),
-            "name" => $vs->name
-        ];
-
-        foreach ($reflection_class->getMethods() as $vss) {
-            $method_annotations = $this->reader->getMethodAnnotations($vss);
-            foreach ($method_annotations as $vsss) {
-                if ($vsss instanceof HandleBefore) $result["before"] = $vss->getName();
-                if ($vsss instanceof HandleAfter) $result["after"] = $vss->getName();
-                if ($vsss instanceof HandleException) {
-                    $result["exceptions"][$vsss->class_name] = $vss->getName();
-                }
-            }
-        }
-        return $result;
+    public function addRegisterPath($path, $indoor_name)
+    {
+        $this->path_list[] = [$path, $indoor_name];
     }
 
     /**
-     * @internal 用于 level 排序
      * @param $events
-     * @param string $class_name
-     * @param string $prefix
+     * @internal 用于 level 排序
      */
-    public function sortByLevel(&$events, string $class_name, $prefix = "") {
+    public function sortByLevel(&$events, string $class_name, string $prefix = '')
+    {
         if (is_a($class_name, Level::class, true)) {
             $class_name .= $prefix;
             usort($events[$class_name], function ($a, $b) {
@@ -232,12 +220,13 @@ class AnnotationParser
     /**
      * @throws AnnotationException
      */
-    public function verifyMiddlewares() {
-        if ((ZMConfig::get("global", "runtime")["middleware_error_policy"] ?? 1) === 2) {
+    public function verifyMiddlewares()
+    {
+        if ((ZMConfig::get('global', 'runtime')['middleware_error_policy'] ?? 1) === 2) {
             //我承认套三层foreach很不优雅，但是这个会很快的。
-            foreach($this->middleware_map as $class => $v) {
-                foreach ($v as $method => $vs) {
-                    foreach($vs as $mid) {
+            foreach ($this->middleware_map as $v) {
+                foreach ($v as $vs) {
+                    foreach ($vs as $mid) {
                         if (!isset($this->middlewares[$mid->middleware])) {
                             throw new AnnotationException("Annotation parse error: Unknown MiddlewareClass named \"{$mid->middleware}\"!");
                         }
@@ -246,4 +235,35 @@ class AnnotationParser
             }
         }
     }
+
+    public function getRunTime()
+    {
+        return microtime(true) - $this->start_time;
+    }
+
+    //private function below
+
+    private function registerMiddleware(MiddlewareClass $vs, ReflectionClass $reflection_class): array
+    {
+        $result = [
+            'class' => '\\' . $reflection_class->getName(),
+            'name' => $vs->name,
+        ];
+
+        foreach ($reflection_class->getMethods() as $vss) {
+            $method_annotations = $this->reader->getMethodAnnotations($vss);
+            foreach ($method_annotations as $vsss) {
+                if ($vsss instanceof HandleBefore) {
+                    $result['before'] = $vss->getName();
+                }
+                if ($vsss instanceof HandleAfter) {
+                    $result['after'] = $vss->getName();
+                }
+                if ($vsss instanceof HandleException) {
+                    $result['exceptions'][$vsss->class_name] = $vss->getName();
+                }
+            }
+        }
+        return $result;
+    }
 }