hyperf-3.1: Update code with detailed comments and improve code style

Author: alexsyvolap

composer.json

@@ -21,23 +21,22 @@
         "php": ">=8.1",
         "ext-json": "*",
         "fakerphp/faker": "^1.0",
-        "hyperf/async-queue": "^3.0",
-        "hyperf/event": "^3.0",
-        "hyperf/command": "^3.0",
-        "hyperf/config": "^3.0",
-        "hyperf/constants": "^3.0",
-        "hyperf/contract": "^3.0",
-        "hyperf/database": "^3.0",
-        "hyperf/db-connection": "^3.0",
-        "hyperf/di": "^3.0",
-        "hyperf/framework": "^3.0",
-        "hyperf/http-server": "^3.0",
-        "hyperf/logger": "^3.0",
-        "hyperf/resource": "^3.0",
-        "hyperf/socketio-server": "^3.0",
-        "hyperf/testing": "^3.0",
-        "hyperf/validation": "^3.0",
-        "hyperf/utils": "^3.0",
+        "hyperf/async-queue": "^3.1",
+        "hyperf/event": "^3.1",
+        "hyperf/command": "^3.1",
+        "hyperf/config": "^3.1",
+        "hyperf/constants": "^3.1",
+        "hyperf/contract": "^3.1",
+        "hyperf/database": "^3.1",
+        "hyperf/db-connection": "^3.1",
+        "hyperf/di": "^3.1",
+        "hyperf/framework": "^3.1",
+        "hyperf/http-server": "^3.1",
+        "hyperf/logger": "^3.1",
+        "hyperf/resource": "^3.1",
+        "hyperf/socketio-server": "^3.1",
+        "hyperf/testing": "^3.1",
+        "hyperf/validation": "^3.1",
         "yzen.dev/plain-to-class": "^1.0",
         "zircote/swagger-php": "^4.5"
     },

publish/anonymization.php

@@ -1,6 +1,14 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
 return [
     // Use array key as anonymization config name
     'main' => [

publish/core.php

@@ -1,7 +1,14 @@
 <?php
 
 declare(strict_types=1);
-
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
 return [
     'user_model' => \App\User\Model\User::class,
 ];

publish/swagger.php

@@ -1,6 +1,14 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
 return [
     'app/',
     'vendor/onix-systems-php/hyperf-core/',

src/Command/AnonymizeDataCommand.php

@@ -1,6 +1,15 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfCore\Command;
 
 use Hyperf\Command\Annotation\Command;
@@ -17,13 +26,13 @@ public function __construct(
         parent::__construct('seed:anonymize');
     }
 
-    public function configure()
+    public function configure(): void
     {
         parent::configure();
         $this->setDescription('Anonymize sensitive data');
     }
 
-    public function handle()
+    public function handle(): void
     {
         $mode = $this->input->getArgument('mode');
         if (empty($mode)) {

src/Command/SwaggerGenCommand.php

@@ -1,16 +1,23 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfCore\Command;
 
 use Hyperf\Command\Annotation\Command;
 use Hyperf\Command\Command as HyperfCommand;
 use Hyperf\Contract\ConfigInterface;
-use OpenApi\Analysers\TokenAnalyser;
 use OpenApi\Generator;
 use Symfony\Component\Console\Input\InputOption;
 
-
 #[Command]
 class SwaggerGenCommand extends HyperfCommand
 {
@@ -20,13 +27,13 @@ public function __construct(
         parent::__construct('swagger:gen');
     }
 
-    public function configure()
+    public function configure(): void
     {
         parent::configure();
         $this->setDescription('Generate swagger API doc');
     }
 
-    public function handle()
+    public function handle(): void
     {
         $outputDir = $this->input->getOption('output');
         $format = $this->input->getOption('format');

src/ConfigProvider.php

@@ -1,6 +1,15 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfCore;
 
 class ConfigProvider

src/Constants/ErrorCode.php

@@ -1,5 +1,14 @@
 <?php
+
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
 
 namespace OnixSystemsPHP\HyperfCore\Constants;
 
@@ -19,7 +28,6 @@ class ErrorCode extends AbstractConstants
      */
     public const UNAUTHORIZED_ERROR = 401;
 
-
     /**
      * @Message("Forbidden！")
      */

src/Constants/Time.php

@@ -1,6 +1,15 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfCore\Constants;
 
 use Hyperf\Constants\AbstractConstants;

src/Contract/CoreAuthenticatable.php

@@ -1,6 +1,15 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfCore\Contract;
 
 interface CoreAuthenticatable

src/Contract/CoreAuthenticatableProvider.php

@@ -1,9 +1,18 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfCore\Contract;
 
 interface CoreAuthenticatableProvider
 {
-    public function user(): CoreAuthenticatable|null;
+    public function user(): null|CoreAuthenticatable;
 }

src/Contract/CoreDataGuard.php

@@ -1,6 +1,15 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfCore\Contract;
 
 use Hyperf\Database\Model\Builder;

src/Contract/CorePolicyGuard.php

@@ -1,6 +1,15 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfCore\Contract;
 
 use OnixSystemsPHP\HyperfCore\Exception\BusinessException;

src/Controller/AbstractController.php

@@ -1,6 +1,15 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfCore\Controller;
 
 use Hyperf\Di\Annotation\Inject;
@@ -11,7 +20,7 @@
 
 /**
  * Documentation Init
- * https://editor.swagger.io
+ * https://editor.swagger.io.
  */
 #[OA\Server(url: 'http://localhost/', description: 'Local Server')]
 #[OA\SecurityScheme(securityScheme: 'bearerAuth', type: 'http', bearerFormat: 'JWT', scheme: 'bearer')]
@@ -33,43 +42,55 @@
     example: 'en-US',
 )]
 #[OA\Response(response: 200, description: 'Success')]
-#[OA\Response(response: 400, description: 'Bad Request', content:
-    new OA\JsonContent(properties: [
+#[OA\Response(
+    response: 400,
+    description: 'Bad Request',
+    content: new OA\JsonContent(properties: [
         new OA\Property(property: 'status', type: 'number'),
         new OA\Property(property: 'title', type: 'string'),
         new OA\Property(property: 'data', type: 'array', items: new OA\Items()),
     ])
 )]
-#[OA\Response(response: 401, description: 'Unauthorized', content:
-    new OA\JsonContent(properties: [
+#[OA\Response(
+    response: 401,
+    description: 'Unauthorized',
+    content: new OA\JsonContent(properties: [
         new OA\Property(property: 'status', type: 'number'),
         new OA\Property(property: 'title', type: 'string'),
         new OA\Property(property: 'data', type: 'array', items: new OA\Items()),
     ])
 )]
-#[OA\Response(response: 403, description: 'Forbidden', content:
-    new OA\JsonContent(properties: [
+#[OA\Response(
+    response: 403,
+    description: 'Forbidden',
+    content: new OA\JsonContent(properties: [
         new OA\Property(property: 'status', type: 'number'),
         new OA\Property(property: 'title', type: 'string'),
         new OA\Property(property: 'data', type: 'array', items: new OA\Items()),
     ])
 )]
-#[OA\Response(response: 404, description: 'Not Found', content:
-    new OA\JsonContent(properties: [
+#[OA\Response(
+    response: 404,
+    description: 'Not Found',
+    content: new OA\JsonContent(properties: [
         new OA\Property(property: 'status', type: 'number'),
         new OA\Property(property: 'title', type: 'string'),
         new OA\Property(property: 'data', type: 'array', items: new OA\Items()),
     ])
 )]
-#[OA\Response(response: 422, description: 'Validation error.', content:
-    new OA\JsonContent(properties: [
+#[OA\Response(
+    response: 422,
+    description: 'Validation error.',
+    content: new OA\JsonContent(properties: [
         new OA\Property(property: 'status', type: 'number'),
         new OA\Property(property: 'title', type: 'string'),
         new OA\Property(property: 'data', type: 'array', items: new OA\Items()),
     ])
 )]
-#[OA\Response(response: 500, description: 'Server error.', content:
-    new OA\JsonContent(properties: [
+#[OA\Response(
+    response: 500,
+    description: 'Server error.',
+    content: new OA\JsonContent(properties: [
         new OA\Property(property: 'status', type: 'number'),
         new OA\Property(property: 'title', type: 'string'),
         new OA\Property(property: 'data', type: 'array', items: new OA\Items()),