onix-systems-php/hyperf-file-upload

An extension to maintain file upload and assignation

v1.2.1 2024-02-29 08:59 UTC

Requires

• php: >=8.1
• ext-fileinfo: *
• ext-gd: *
• ext-json: *
• hyperf/config: ^3.1
• hyperf/contract: ^3.1
• hyperf/database: ^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
• onix-systems-php/hyperf-actions-log: ^1.2
• onix-systems-php/hyperf-core: >=1.2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• mockery/mockery: ^1.0
• phpstan/phpstan: ^1.0
• phpunit/phpunit: >=7.0
• swoole/ide-helper: ^4.5|^5.0

Suggests

• swow/swow: Required to create swow components.

MIT

• php
• hyperf

README

Includes the following classes:

• Model:
  • File;
  • FileRelations trait.
• Repository:
  • FileRepository.
• Service:
  • AddExternalFileService;
  • AddFileService;
  • ClearUnusedDeletedFilesService;
  • DownloadFileService.

Install:

composer require onix-systems-php/hyperf-file-upload

Publish config and database migrations:

php bin/hyperf.php vendor:publish onix-systems-php/hyperf-file-upload

Fill file_upload config with file upload configuration, following existing examples.

Add $fileRelations config and FileRelations trait to models you want assign files to:

use FileRelations;

public $fileRelations = [
    'avatar' => [
        'limit' => 1,
        'required' => false,
        'mimeTypes' => [image/png', 'image/jpg', 'image/jpeg', 'image/bmp'],
        'presets' => [
            '150x150' => ['fit' => [150, 150]],
            '250x250' => ['fit' => [250, 250]],
        ],
    ],
    'documents' => [
        'limit' => null,
        'required' => false,
        'mimeTypes' => ['application/pdf'],
    ],
];

Methods you might need to redefine in FileRelations trait:

• getAuth: this method should return active user
• processFileActions: if you defined new extra actions in config, you'll need to define action's login in this method