FileRequest::prepareFile() - Code Metrics - Inspection of "Merge branch 'dev' of github.com:yanmarques/lincab..." - yanmarques/lincable - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev ( 44a5a9...75307b )

by Yan

created 2018-07-05 21:03 UTC

FileRequest::prepareFile() A

↳ Parent: FileRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	7
rs	10
c	0
b	0
f	0

<?php

namespace Lincable\Http;

use Illuminate\Http\Request;
filter:
    dependency_paths: ["lib/*"]
use Illuminate\Http\UploadedFile;
filter:
    dependency_paths: ["lib/*"]
use Lincable\Concerns\BuildClassnames;
use Illuminate\Contracts\Container\Container;
use Symfony\Component\HttpFoundation\File\File;
filter:
    dependency_paths: ["lib/*"]

abstract class FileRequest
{
    use BuildClassnames;

    /**
     * The uploaded file instance.
     *
     * @var \Illuminate\Http\File
filter:
    dependency_paths: ["lib/*"]
     */
    protected $file;

    /**
     * The request instance.
     *
     * @var \Illuminate\Http\Request
     */
    protected $request;

    /**
     * The directory where the uploaded file will be temporary moved.
     *
     * @var string
     */
    protected $tempDirectory = '/tmp';

    /**
     * Rules to validate the file on request.
     *
     * @param  \Illuminate\Http\UploadedFile $file
     * @return mixed
     */
    abstract protected function rules(UploadedFile $file): mixed;
filter:
    dependency_paths: ["lib/*"]

    /**
     * Boot the instance with the request.
     *
     * @param  \Illuminate\Http\Request $request
     * @return void
     */
    public function boot(Request $request)
    {
        $this->request = $request;

        $this->guardFile($request->file($this->getParameter()));
    }

    /**
     * Return the file on request.
     *
     * @return \Illuminate\Http\UploadedFile
     */
    public function getFile()
    {
        return $this->file;
    }

    /**
     * Return the current request instance.
     *
     * @return \Illuminate\Http\Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Prepared the file to send.
     *
     * @return \Symfony\Component\HttpFoundation\File\File
     */
    public function prepareFile()
    {
        $file = $this->moveFileToTempDirectory();

        $this->executeFileEvents(app(), $file);
        $this->executeFileEvents(/** @scrutinizer ignore-call */ app(), $file);

        return $file;
    }

    /**
     * Return the file parameter on request.
     *
     * @return string
     */
    protected function getParameter()
    {
        $className = static::class;

        return $this->nameFromClass($className);
    }

    /**
     * Guard the file through validations and then set
     * the file on class instance.
     *
     * @param  \Illuminate\Http\UploadedFile $file
     * @return void
     */
    protected function guardFile(UploadedFile $file)
    {
        $validationRules = $this->parseValidationRules($file);

        // Validate the request file from rules.
        $this->request->validate($validationRules);

        $this->file = $file;
    }

    /**
     * Get the rules for the file validation.
     *
     * @param  \Illuminate\Http\UploadedFile $file
     * @return array
     */
    protected function parseValidationRules(UploadedFile $file)
    {
        return [$this->getParameter() => $this->rules($file)];
    }

    /**
     * Move the file to a temporary destination.
     *
     * @return \Symfony\Component\HttpFoundation\File\File
     */
    protected function moveFileToTempDirectory()
    {
        $destination = $this->file->hashName($this->tempDirectory);

        return $this->file->move($destination);
    }

    /**
     * Execute some generic event methods on class if available.
     *
     * Here the file can be changed, optimized, etc...
     *
     * @return void
     */
    protected function executeFileEvents(Container $app, File $file)
    {
        $eventMethod = 'beforeSend';

        if (method_exists($this, $eventMethod)) {
            $app->call([$this, $method], $file);
            $app->call([$this, $method], /** @scrutinizer ignore-type */ $file);
        }
    }

    /**
     * Return the class suffix convention.
     *
     * @return string
     */
    protected function getSuffix()
    {
        return 'FileRequest';
    }
}


yanmarques / lincable

Push — dev ( 44a5a9...75307b )

FileRequest::prepareFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like