Mostafaznv\Larupload\Concerns\Storage\UploadEntity\BaseUploadEntity

Complexity

Total Complexity

13

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getMode()	0	3	1
A	getBasePath()	0	12	3
A	make()	0	3	1
A	outputToObject()	0	15	2
A	setOutput()	0	15	5
A	__construct()	0	26	1

<?php

namespace Mostafaznv\Larupload\Concerns\Storage\UploadEntity;


use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;
use Mostafaznv\Larupload\Actions\GenerateFileIdAction;
use Mostafaznv\Larupload\Enums\LaruploadMode;
use Mostafaznv\Larupload\UploadEntities;

trait BaseUploadEntity
{
    public function __construct(string $name, LaruploadMode $mode)
    {
        $config = config('larupload');

        $this->name = $name;

The property name does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->nameKebab = str_replace('_', '-', Str::kebab($name));

The property nameKebab does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->mode = $mode;

The property mode does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->disk = $config['disk'];

The property disk does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->localDisk = $config['local-disk'];

The property localDisk does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->secureIdsMethod = $config['secure-ids'];

The property secureIdsMethod does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->withMeta = $config['with-meta'];

The property withMeta does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->camelCaseResponse = $config['camel-case-response'];

The property camelCaseResponse does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->namingMethod = $config['naming-method'];

The property namingMethod does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->lang = $config['lang'];

The property lang does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->imageProcessingLibrary = $config['image-processing-library'];

The property imageProcessingLibrary does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->generateCover = $config['generate-cover'];

The property generateCover does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->coverStyle = $config['cover-style'];

The property coverStyle does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->dominantColor = $config['dominant-color'];

The property dominantColor does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->dominantColorQuality = $config['dominant-color-quality'];

The property dominantColorQuality does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->keepOldFiles = $config['keep-old-files'];

The property keepOldFiles does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->preserveFiles = $config['preserve-files'];

The property preserveFiles does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        // todo - remove it and store original file name by default in the next major version
        $this->storeOriginalFileName = $config['store-original-file-name'] ?? false;

The property storeOriginalFileName does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->optimizeImage = $config['optimize-image']['enable'] ?? false;

The property optimizeImage does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->ffmpegQueue = $config['ffmpeg']['queue'];

The property ffmpegQueue does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->ffmpegMaxQueueNum = $config['ffmpeg']['max-queue-num'];

The property ffmpegMaxQueueNum does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    public static function make(string $name, LaruploadMode $mode = LaruploadMode::HEAVY): UploadEntities
    {
        return new static($name, $mode);

The expression return new static($name, $mode) returns the type Mostafaznv\Larupload\Concerns\Storage\UploadEntity\BaseUploadEntity which includes types incompatible with the type-hinted return Mostafaznv\Larupload\UploadEntities.

    }


    public function getMode(): LaruploadMode
    {
        return $this->mode;
    }

    public function setOutput(Model $model): void
    {
        $this->id = GenerateFileIdAction::make($model, $this->secureIdsMethod, $this->mode, $this->name)->run();

The property id does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        if ($this->mode === LaruploadMode::HEAVY) {
            foreach ($this->output as $key => $value) {
                $this->output[$key] = $model->{"{$this->name}_file_$key"};

The property output does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            }
        }
        else {
            $meta = json_decode($model->{"{$this->name}_file_meta"}, true);

            if (is_array($meta)) {
                foreach ($meta as $key => $value) {
                    $this->output[$key] = $value;
                }
            }
        }
    }

    /**
     * Prepare output array to response
     *
     * @return object
     */
    protected function outputToObject(): object
    {
        $output = (object)$this->output;

        if ($this->camelCaseResponse) {
            $output->mimeType = $output->mime_type;
            $output->dominantColor = $output->dominant_color;
            $output->originalName = $output->original_name;

            unset($output->mime_type);
            unset($output->dominant_color);
            unset($output->original_name);
        }

        return $output;
    }

    /**
     * Path Helper to generate relative path string
     *
     * @param string $id
     * @param string|null $folder
     * @return string
     */
    protected function getBasePath(string $id, ?string $folder = null): string
    {
        $path = $this->mode == LaruploadMode::STANDALONE ? "$this->folder/$this->nameKebab" : "$this->folder/$id/$this->nameKebab";
        $path = trim($path, '/');

        if ($folder) {
            $folder = strtolower(str_replace('_', '-', trim($folder)));

            return "$path/$folder";
        }

        return $path;
    }
}