Sco\Admin\Form\Elements\File

Complexity

Total Complexity

49

Size/Duplication

Total Lines	372
Duplicated Lines	2.69 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes	2
Bugs	0	Features	0

35 Methods

Rating	Name	Duplication	Size	Complexity
A	getValue()	0	12	2
A	getActionUrl()	0	19	3
A	setActionUrl()	0	6	1
A	isMultiSelect()	0	4	1
A	enableMultiSelect()	0	6	1
A	disableFileList()	0	6	1
A	withCredentials()	0	6	1
A	getMaxFileSize()	0	9	2
A	setMaxFileSize()	0	6	1
A	getFileExtensions()	0	9	2
A	setFileExtensions()	0	6	1
A	getDefaultExtensions()	0	4	1
A	getFileUploadsLimit()	0	4	1
A	setFileUploadsLimit()	0	6	1
A	getListType()	0	4	1
A	toArray()	0	12	1
A	getDisk()	0	8	2
A	setDisk()	0	6	1
A	getDefaultUploadPath()	0	4	1
A	getUploadPath()	0	11	3
A	setUploadPath()	0	6	1
A	getUploadFileName()	0	8	2
A	getDefaultFileName()	0	5	1
A	setUploadFileNameRule()	0	6	1
A	saveFile()	0	17	1
A	prepareValue()	0	7	3
A	existsFile()	0	4	1
A	getFileUrl()	0	4	1
A	getFileInfo()	0	8	1
A	addValidationRule()	0	10	2
A	addUploadValidationRule()	0	9	2
A	addUploadValidationMessage()	10	10	2
A	getUploadValidationRules()	0	4	1
A	getUploadValidationMessages()	0	4	1
A	getUploadValidationTitles()	0	4	1

<?php

namespace Sco\Admin\Form\Elements;

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Str;
use Storage;
use Validator;

class File extends NamedElement
{
    protected $type = 'file';

    protected $actionUrl;

    protected $multiSelect = false;

    protected $multiFile = true;

    protected $showFileList = true;

    protected $withCredentials = false;

    protected $maxFileSize;

    protected $fileUploadsLimit = 0;

    protected $fileExtensions;

    protected $listType = 'text';

    protected $disk;

    /**
     * @var string|\Closure|null
     */
    protected $uploadPath;

    /**
     * @var \Closure|null
     */
    protected $uploadFileNameRule;

    protected $uploadValidationRules = ['bail', 'file'];

    protected $uploadValidationMessages = [];

    public function getValue()
    {
        $value = parent::getValue();
        if (empty($value)) {
            return [];
        }
        return collect(explode(',', $value))->filter(function ($item) {
            return $this->existsFile($item);
        })->map(function ($item) {
            return $this->getFileInfo($item);
        });
    }

    public function getActionUrl()
    {
        if ($this->actionUrl) {
            return $this->actionUrl;
        }
        $model = app('admin.components')->get(get_class($this->getModel()));

        $params       = [
            'model' => $model->getName(),
            'field' => $this->getName(),
        ];
        $params['id'] = null;
        if ($this->getModel()->exists) {
            $params['id'] = $this->getModel()->getKey();
        }
        $params['_token'] = csrf_token();

        return route('admin.model.upload.file', $params);
    }

    public function setActionUrl($value)
    {
        $this->actionUrl = $value;

        return $this;
    }

    public function isMultiSelect()
    {
        return $this->multiSelect;
    }

    public function enableMultiSelect()
    {
        $this->multiSelect = true;

        return $this;
    }

    /**
     * Show file list
     *
     * @return $this
     */
    public function disableFileList()
    {
        $this->showFileList = false;

        return $this;
    }

    /**
     * Indicates whether or not cross-site Access-Control requests
     * should be made using credentials
     *
     * @return $this
     */
    public function withCredentials()
    {
        $this->withCredentials = true;

        return $this;
    }

    /**
     * The maximum size of an uploaded file in bytes
     * If didn't set maximum size, return maximum size as configured in php.ini.
     *
     * @return int
     */
    public function getMaxFileSize()
    {
        $size = UploadedFile::getMaxFilesize();
        if ($this->maxFileSize) {
            $size = $this->maxFileSize;
        }
        $this->addValidationRule('max:' . $size);
        return $size;
    }

    /**
     * The maximum size allowed for an uploaded file in bytes
     *
     * @param int $value
     *
     * @return $this
     */
    public function setMaxFileSize($value)
    {
        $this->maxFileSize = intval($value);

        return $this;
    }

    public function getFileExtensions()
    {
        $exts = $this->getDefaultExtensions();
        if ($this->fileExtensions) {
            $exts = $this->fileExtensions;
        }
        $this->addValidationRule('mimes:' . $exts);
        return $exts;
    }

    /**
     * A list of allowable extensions that can be uploaded.
     *
     * @param string $value
     *
     * @return $this
     */
    public function setFileExtensions($value)
    {
        $this->fileExtensions = $value;

        return $this;
    }

    protected function getDefaultExtensions()
    {
        return config('admin.upload.extensions.file');
    }

    public function getFileUploadsLimit()
    {
        return $this->fileUploadsLimit;
    }

    /**
     * The maximum number of files that can be uploaded.
     *
     * @param int $value
     *
     * @return $this
     */
    public function setFileUploadsLimit($value)
    {
        $this->fileUploadsLimit = intval($value);

        return $this;
    }

    public function getListType()
    {
        return $this->listType;
    }

    public function toArray()
    {
        return parent::toArray() + [
                'action'           => $this->getActionUrl(),
                'showFileList'     => $this->showFileList,
                'multiSelect'      => $this->isMultiSelect(),
                'maxFileSize'      => $this->getMaxFileSize(),
                'fileUploadsLimit' => $this->getFileUploadsLimit(),
                'fileExtensions'   => $this->getFileExtensions(),
                'listType'         => $this->getListType(),
            ];
    }

    public function getDisk()
    {
        if ($this->disk) {
            return $this->disk;
        }

        return config('admin.upload.disk', 'public');
    }

    public function setDisk($value)
    {
        $this->disk = $value;

        return $this;
    }

    protected function getDefaultUploadPath(UploadedFile $file)

The parameter $file is not used and could be removed.

    {
        return config('admin.upload.directory', 'admin/uploads');
    }

    public function getUploadPath(UploadedFile $file)
    {
        if (!($path = $this->uploadPath)) {
            $path = $this->getDefaultUploadPath($file);
        }
        if (is_callable($path)) {
            return call_user_func($path, $file);
        }

        return $path;
    }

    /**
     * The path of file save
     *
     * @param string|\Closure $value
     *
     * @return $this
     */
    public function setUploadPath($value)
    {
        $this->uploadPath = $value;

        return $this;
    }

    public function getUploadFileName(UploadedFile $file)
    {
        if (is_callable($this->uploadFileNameRule)) {
            return call_user_func($this->uploadFileNameRule, $file);
        }

        return $this->getDefaultFileName($file);
    }

    protected function getDefaultFileName(UploadedFile $file)
    {
        $hash = Str::random(40);
        return $hash . '.' . $file->guessExtension();
    }

    public function setUploadFileNameRule(\Closure $value)
    {
        $this->uploadFileNameRule = $value;

        return $this;
    }

    public function saveFile(UploadedFile $file)
    {
        Validator::validate(
            [$this->getName() => $file],
            $this->getUploadValidationRules(),
            $this->getUploadValidationMessages(),
            $this->getUploadValidationTitles()
        );

        $path = $file->storeAs(
            $this->getUploadPath($file),
            $this->getUploadFileName($file),
            $this->getDisk()
        );

        return $this->getFileInfo($path);
    }

    protected function prepareValue($value)
    {
        if (empty($value) || !is_array($value)) {
            return '';
        }
        return collect($value)->implode('path', ',');
    }

    protected function existsFile($path)
    {
        return Storage::disk($this->getDisk())->exists($path);
    }

    protected function getFileUrl($path)
    {
        return Storage::disk($this->getDisk())->url($path);
    }

    protected function getFileInfo($path)
    {
        return [
            'name' => substr($path, strrpos($path, '/') + 1),
            'path' => $path,
            'url' => $this->getFileUrl($path),
        ];
    }

    public function addValidationRule($rule, $message = null)
    {
        $uploadRules = ['image', 'mimes', 'size', 'dimensions', 'max', 'min', 'between'];
        list($name,) = explode(':', $rule, 2);
        if (in_array($name, $uploadRules)) {
            return $this->addUploadValidationRule($rule, $message);
        }

        return parent::addValidationRule($rule, $message);
    }

    public function addUploadValidationRule($rule, $message = null)
    {
        $this->uploadValidationRules[] = $rule;

        if (is_null($message)) {
            return $this;
        }
        return $this->addUploadValidationMessage($rule, $message);
    }

    public function addUploadValidationMessage($rule, $message)

This method seems to be duplicated in your project.

    {
        if (($pos = strpos($rule, ':')) !== false) {
            $rule = substr($rule, 0, $pos);
        }

        $this->uploadValidationMessages[$this->getName() . '.' . $rule] = $message;

        return $this;
    }

    public function getUploadValidationRules()
    {
        return [$this->getName() => $this->uploadValidationRules];
    }

    public function getUploadValidationMessages()
    {
        return $this->uploadValidationMessages;
    }

    public function getUploadValidationTitles()
    {
        return $this->getValidationTitles();
    }
}