SaasReady\Services\FileManager\UploadOption

Complexity

Total Complexity

3

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	prepareFromUploadedFile()	0	9	1
A	prepareFromPath()	0	13	2

<?php

namespace SaasReady\Services\FileManager;

use Illuminate\Database\Eloquent\Model;

The type Illuminate\Database\Eloquent\Model was not found. Maybe you did not declare it correctly or list all dependencies?

use Illuminate\Http\UploadedFile;

The type Illuminate\Http\UploadedFile was not found. Maybe you did not declare it correctly or list all dependencies?

use RuntimeException;
use SplFileInfo;

final class UploadOption
{
    /**
     * The file that will be uploaded to storage disk
     */
    public SplFileInfo $file;

    public ?string $originalFileName = null;
    public ?string $fileMimeType = null;
    public ?int $fileSize = null;

    /**
     * Desired path to store the file
     *
     * @note: require a '/' at the end
     * @example user/$user->id/avatar/
     */
    public string $storePath = 'files/';

    /**
     * New filename after uploaded
     *
     * By default, auto generate by Ready
     */
    public ?string $newFileName = null;

    /**
     * Source model of the File
     */
    public ?Model $source = null;

    /**
     * Category name of the file.
     */
    public string $category = 'file';

    /**
     * Custom driver of the file.
     *
     * By default, it will use the default driver from ENV
     */
    public ?string $driver = null;

    /**
     * Create the upload option from UploadedFile
     */
    public static function prepareFromUploadedFile(UploadedFile $uploadedFile): self
    {
        $option = new self();
        $option->file = $uploadedFile->getFileInfo();
        $option->originalFileName = $uploadedFile->getClientOriginalName();
        $option->fileMimeType = $uploadedFile->getMimeType();
        $option->fileSize = $uploadedFile->getSize();

        return $option;
    }

    /**
     * Create the upload option from a specific file in your server/machine
     */
    public static function prepareFromPath(string $filePath): self
    {
        $option = new self();
        $option->file = new SplFileInfo($filePath);

        if (!$option->file->isReadable()) {
            throw new RuntimeException("The file $filePath is not readable. Cannot process further.");
        }

        $option->originalFileName = basename($filePath);
        $option->fileSize = $option->file->getSize();

        return $option;
    }
}