Merge pull request #3 from onix-systems-php/hyperf-3.1

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

Author: vmikhav

.php-cs-fixer.php

@@ -1,11 +1,8 @@
 <?php
 
 $header = <<<'EOF'
-This file is part of Hyperf.
+This file is part of the extension library for Hyperf.
 
-@link     https://www.hyperf.io
-@document https://hyperf.wiki
-@contact  [email protected]
 @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
 EOF;
 
@@ -23,13 +20,13 @@
             'location' => 'after_declare_strict',
         ],
         'array_syntax' => [
-            'syntax' => 'short'
+            'syntax' => 'short',
         ],
         'list_syntax' => [
-            'syntax' => 'short'
+            'syntax' => 'short',
         ],
         'concat_space' => [
-            'spacing' => 'one'
+            'spacing' => 'one',
         ],
         'blank_line_before_statement' => [
             'statements' => [
@@ -38,7 +35,7 @@
         ],
         'general_phpdoc_annotation_remove' => [
             'annotations' => [
-                'author'
+                'author',
             ],
         ],
         'ordered_imports' => [

composer.json

@@ -22,17 +22,16 @@
         "ext-fileinfo": "*",
         "ext-gd": "*",
         "ext-json": "*",
-        "onix-systems-php/hyperf-core": ">=1.1.0",
-        "onix-systems-php/hyperf-actions-log": "^1.1",
-        "hyperf/database": "^3.0",
-        "hyperf/config": "^3.0",
-        "hyperf/contract": "^3.0",
-        "hyperf/db-connection": "^3.0",
-        "hyperf/filesystem": "^3.0",
-        "hyperf/guzzle": "^3.0",
-        "hyperf/translation": "^3.0",
-        "hyperf/validation": "^3.0",
-        "hyperf/utils": "^3.0",
+        "onix-systems-php/hyperf-core": ">=1.2.0",
+        "onix-systems-php/hyperf-actions-log": "^1.2",
+        "hyperf/database": "^3.1",
+        "hyperf/config": "^3.1",
+        "hyperf/contract": "^3.1",
+        "hyperf/db-connection": "^3.1",
+        "hyperf/filesystem": "^3.1",
+        "hyperf/guzzle": "^3.1",
+        "hyperf/translation": "^3.1",
+        "hyperf/validation": "^3.1",
         "intervention/image": "^2.7",
         "league/flysystem": "^2.0|^3.0"
     },

publish/config/file_upload.php

@@ -1,9 +1,15 @@
 <?php
 
 declare(strict_types=1);
-
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
 use OnixSystemsPHP\HyperfCore\Constants\Time;
 
+use function Hyperf\Support\env;
+
 return [
     'mime_types' => [
         'image/png',

publish/migrations/2022_04_07_082256_files.php

@@ -1,6 +1,11 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
 use Hyperf\Database\Migrations\Migration;
 use Hyperf\Database\Schema\Blueprint;
 use Hyperf\Database\Schema\Schema;

publish/routes.php

@@ -1,6 +1,11 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
 use Hyperf\HttpServer\Router\Router;
 use OnixSystemsPHP\HyperfFileUpload\Controller\FileController;
 

src/ConfigProvider.php

@@ -1,13 +1,18 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload;
 
 class ConfigProvider
 {
     public function __invoke(): array
     {
-
         return [
             'dependencies' => [
             ],

src/Controller/FileController.php

@@ -1,6 +1,12 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload\Controller;
 
 use OnixSystemsPHP\HyperfCore\Contract\CoreAuthenticatableProvider;
@@ -16,16 +22,14 @@ class FileController extends AbstractController
 {
     public function __construct(
         private CoreAuthenticatableProvider $authenticatableProvider,
-    ) {
-    }
-
+    ) {}
 
     #[OA\Post(
         path: '/v1/file',
         operationId: 'upload',
         summary: 'Upload file',
         requestBody: new OA\RequestBody(required: true, content: [
-            new OA\MediaType(mediaType: 'multipart/form-data', schema: new OA\Schema(ref: '#/components/schemas/RequestFileUpload'))
+            new OA\MediaType(mediaType: 'multipart/form-data', schema: new OA\Schema(ref: '#/components/schemas/RequestFileUpload')),
         ]),
         tags: ['file'],
         parameters: [new OA\Parameter(ref: '#/components/parameters/Locale')],
@@ -34,8 +38,8 @@ public function __construct(
                 new OA\Property(property: 'status', type: 'string'),
                 new OA\Property(property: 'data', ref: '#/components/schemas/ResourceFile'),
             ])),
-            new OA\Response(response: 422, ref: '#/components/responses/422'),
-            new OA\Response(response: 500, ref: '#/components/responses/500'),
+            new OA\Response(ref: '#/components/responses/422', response: 422),
+            new OA\Response(ref: '#/components/responses/500', response: 500),
         ],
     )]
     public function create(RequestFileUpload $request, AddFileService $addFileService): ResourceFile
@@ -45,7 +49,6 @@ public function create(RequestFileUpload $request, AddFileService $addFileServic
         return new ResourceFile($file);
     }
 
-
     #[OA\Post(
         path: '/v1/file/url',
         operationId: 'uploadExternal',
@@ -58,9 +61,9 @@ public function create(RequestFileUpload $request, AddFileService $addFileServic
                 new OA\Property(property: 'status', type: 'string'),
                 new OA\Property(property: 'data', ref: '#/components/schemas/ResourceFile'),
             ])),
-            new OA\Response(response: 400, ref: '#/components/responses/400'),
-            new OA\Response(response: 422, ref: '#/components/responses/422'),
-            new OA\Response(response: 500, ref: '#/components/responses/500'),
+            new OA\Response(ref: '#/components/responses/400', response: 400),
+            new OA\Response(ref: '#/components/responses/422', response: 422),
+            new OA\Response(ref: '#/components/responses/500', response: 500),
         ],
     )]
     public function createFromUrl(

src/Model/Behaviour/FileRelations.php

@@ -1,19 +1,25 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload\Model\Behaviour;
 
 use Carbon\Carbon;
 use Hyperf\Config\Annotation\Value;
+use Hyperf\Context\ApplicationContext;
 use Hyperf\Contract\ConfigInterface;
 use Hyperf\Database\Model\Builder;
 use Hyperf\Database\Model\Events\Saved;
 use Hyperf\Database\Model\Events\Saving;
 use Hyperf\Database\Model\Model;
 use Hyperf\Filesystem\FilesystemFactory;
 use Hyperf\HttpMessage\Exception\BadRequestHttpException;
-use Hyperf\Utils\ApplicationContext;
-use Hyperf\Utils\Str;
+use Hyperf\Stringable\Str;
 use Intervention\Image\ImageManager;
 use OnixSystemsPHP\HyperfCore\Contract\CoreAuthenticatable;
 use OnixSystemsPHP\HyperfCore\Contract\CoreAuthenticatableProvider;
@@ -328,7 +334,7 @@ private function getAllowedToLinkFileModel(Saving $event, string $relationName,
         };
     }
 
-    private function getAuth(): CoreAuthenticatable|null
+    private function getAuth(): null|CoreAuthenticatable
     {
         return ApplicationContext::getContainer()->get(CoreAuthenticatableProvider::class)?->user();
     }

src/Model/File.php

@@ -1,6 +1,12 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload\Model;
 
 use Carbon\Carbon;

src/Repository/FileRepository.php

@@ -1,6 +1,12 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload\Repository;
 
 use Carbon\Carbon;
@@ -13,6 +19,7 @@
  * @method File update(File $model, array $data)
  * @method File save(File $model)
  * @method bool delete(File $model)
+ * @method bool forceDelete(File $model)
  * @method Builder|FileRepository finder(string $type, ...$parameters)
  * @method null|File fetchOne(bool $lock, bool $force)
  */

src/Request/RequestExternalFileUpload.php

@@ -1,6 +1,12 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload\Request;
 
 use Hyperf\Validation\Request\FormRequest;

src/Request/RequestFileUpload.php

@@ -1,6 +1,12 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload\Request;
 
 use Hyperf\Validation\Request\FormRequest;
@@ -15,7 +21,7 @@
     schema: 'RequestFileAssign',
     properties: [
         new OA\Property(property: 'id', type: 'integer'),
-        new OA\Property(property: 'delete_it', type: 'boolean', default: 'false')
+        new OA\Property(property: 'delete_it', type: 'boolean', default: 'false'),
     ],
     type: 'object',
 )]

src/Resource/ResourceFile.php

@@ -1,6 +1,12 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload\Resource;
 
 use OnixSystemsPHP\HyperfCore\Resource\AbstractResource;

src/Service/AddExternalFileService.php

@@ -1,6 +1,12 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload\Service;
 
 use Hyperf\DbConnection\Annotation\Transactional;
@@ -15,11 +21,10 @@ class AddExternalFileService
     public function __construct(
         private DownloadFileService $downloadFileService,
         private AddFileService $addFileService,
-    ) {
-    }
+    ) {}
 
     #[Transactional(attempts: 1)]
-    public function run(string $url, CoreAuthenticatable|null $user): File
+    public function run(string $url, null|CoreAuthenticatable $user): File
     {
         $filename = $this->downloadFileService->run($url, $user);
         $size = filesize($filename);

src/Service/AddFileService.php

@@ -1,13 +1,19 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * This file is part of the extension library for Hyperf.
+ *
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
 namespace OnixSystemsPHP\HyperfFileUpload\Service;
 
 use Hyperf\Contract\ConfigInterface;
 use Hyperf\DbConnection\Annotation\Transactional;
 use Hyperf\Filesystem\FilesystemFactory;
 use Hyperf\HttpMessage\Upload\UploadedFile;
-use Hyperf\Utils\Str;
+use Hyperf\Stringable\Str;
 use OnixSystemsPHP\HyperfActionsLog\Event\Action;
 use OnixSystemsPHP\HyperfCore\Contract\CoreAuthenticatable;
 use OnixSystemsPHP\HyperfCore\Contract\CorePolicyGuard;
@@ -17,6 +23,8 @@
 use OnixSystemsPHP\HyperfFileUpload\Repository\FileRepository;
 use Psr\EventDispatcher\EventDispatcherInterface;
 
+use function Hyperf\Translation\__;
+
 #[Service]
 class AddFileService
 {
@@ -28,19 +36,17 @@ public function __construct(
         private FileRepository $rFile,
         private EventDispatcherInterface $eventDispatcher,
         private ?CorePolicyGuard $policyGuard,
-    ) {
-    }
+    ) {}
 
     #[Transactional(attempts: 1)]
-    public function run(UploadedFile $uploadedFile, CoreAuthenticatable|null $user): File
+    public function run(UploadedFile $uploadedFile, null|CoreAuthenticatable $user): File
     {
         $this->validate($uploadedFile);
         $file = $this->storeFile($uploadedFile, $user);
         $this->eventDispatcher->dispatch(new Action(self::ACTION, $file, ['file' => $file->url], $user));
         return $file;
     }
 
-
     private function validate(UploadedFile $uploadedFile): void
     {
         if ($uploadedFile->getError() !== UPLOAD_ERR_OK) {
@@ -52,7 +58,7 @@ private function validate(UploadedFile $uploadedFile): void
         }
     }
 
-    private function storeFile(UploadedFile $uploadedFile, CoreAuthenticatable|null $user): File
+    private function storeFile(UploadedFile $uploadedFile, null|CoreAuthenticatable $user): File
     {
         $storage = $this->config->get('file.default');
         $domain = $this->config->get("file_upload.storage.{$storage}.domain");