Jaxon\Request\Upload\File

Complexity

Total Complexity

12

Size/Duplication

Total Lines	198
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	toTempData()	0	9	1
A	extension()	0	3	1
A	setNameSanitizer()	0	3	1
A	fromHttpFile()	0	17	2
A	slugify()	0	4	1
A	path()	0	3	1
A	filename()	0	3	1
A	size()	0	3	1
A	fromTempFile()	0	10	1
A	type()	0	3	1
A	name()	0	3	1

<?php

/**
 * File.php - This class represents an uploaded file.
 *
 * @package jaxon-core

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2017 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

Missing @category tag in file comment

PHP version not specified

namespace Jaxon\Request\Upload;

use Nyholm\Psr7\UploadedFile;

use Closure;

use function call_user_func_array;
use function pathinfo;

class File

Missing doc comment for class File

{
    /**
     * The uploaded file type
     *
     * @var string
     */
    protected $sType;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * The uploaded file name, without the extension and slugified
     *
     * @var string
     */
    protected $sName;

    /**
     * The uploaded file name, with the extension
     *
     * @var string
     */
    protected $sFilename;

    /**
     * The uploaded file path
     *
     * @var string
     */
    protected $sPath;

    /**
     * The uploaded file size
     *
     * @var string
     */
    protected $sSize;

    /**
     * The uploaded file extension
     *
     * @var string
     */
    protected $sExtension;

    /**
     * A user defined function to transform uploaded file names
     *
     * @var Closure
     */
    protected static $cNameSanitizer = null;

    /**
     * Filter uploaded file name
     *
     * @param Closure $cNameSanitizer    The closure which filters filenames

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    public static function setNameSanitizer(Closure $cNameSanitizer)

Expected 2 blank lines before function; 1 found

    {
        self::$cNameSanitizer = $cNameSanitizer;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Slugify a text
     *
     * @param string  $sText

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     *
     * @return string
     */
    protected static function slugify(string $sText): string
    {
        // Todo: slugify the text.
        return $sText;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Create an instance of this class using data from an uploaded file.
     *
     * @param string $sVarName

Expected 7 spaces after parameter type; 1 found

Missing parameter comment

     * @param string $sUploadDir    The directory where to save the uploaded file

Expected 1 spaces after parameter name; 4 found

Expected 7 spaces after parameter type; 1 found

     * @param UploadedFile $xHttpFile    The uploaded file

Expected 2 spaces after parameter name; 4 found

     *
     * @return File
     */
    public static function fromHttpFile(string $sVarName, string $sUploadDir, UploadedFile $xHttpFile): File
    {
        // Filename without the extension
        $sName = pathinfo($xHttpFile->getClientFilename(), PATHINFO_FILENAME);
        if(self::$cNameSanitizer !== null)
        {
            $sName = (string)call_user_func_array(self::$cNameSanitizer, [$sName, $sVarName]);
        }

        $xFile = new File();

Equals sign not aligned with surrounding assignments; expected 13 spaces but found 1 space

        $xFile->sType = $xHttpFile->getClientMediaType();

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        $xFile->sName = self::slugify($sName);

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

It seems like $sName can also be of type array; however, parameter $sText of Jaxon\Request\Upload\File::slugify() does only seem to accept string, maybe add an additional type check?

        $xFile->sFilename = $xHttpFile->getClientFilename();
        $xFile->sExtension = pathinfo($xHttpFile->getClientFilename(), PATHINFO_EXTENSION);

It seems like pathinfo($xHttpFile->getClientFilename(), Jaxon\Request\Upload\PATHINFO_EXTENSION) can also be of type array. However, the property $sExtension is declared as type string. Maybe add an additional type check?

        $xFile->sSize = $xHttpFile->getSize();

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        $xFile->sPath = $sUploadDir . $xFile->sName . '.' . $xFile->sExtension;

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

Are you sure $xFile->sExtension of type array|string can be used in concatenation?

        return $xFile;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Create an instance of this class using data from a temp file
     *
     * @param array $aFile    The uploaded file data

Expected 1 spaces after parameter name; 4 found

     *
     * @return File
     */
    public static function fromTempFile(array $aFile): File
    {
        $xFile = new File();

Equals sign not aligned with surrounding assignments; expected 13 spaces but found 1 space

        $xFile->sType = $aFile['type'];

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        $xFile->sName = $aFile['name'];

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        $xFile->sFilename = $aFile['filename'];
        $xFile->sExtension = $aFile['extension'];
        $xFile->sSize = $aFile['size'];

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        $xFile->sPath = $aFile['path'];

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        return $xFile;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Convert the File instance to array.
     *
     * @return array<string,string>
     */
    public function toTempData(): array
    {
        return [
            'type' => $this->sType,
            'name' => $this->sName,
            'filename' => $this->sFilename,
            'extension' => $this->sExtension,
            'size' => $this->sSize,
            'path' => $this->sPath,
        ];
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the uploaded file type
     *
     * @return string
     */
    public function type(): string
    {
        return $this->sType;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the uploaded file name, without the extension and slugified
     *
     * @return string
     */
    public function name(): string
    {
        return $this->sName;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the uploaded file name, with the extension
     *
     * @return string
     */
    public function filename(): string
    {
        return $this->sFilename;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the uploaded file path
     *
     * @return string
     */
    public function path(): string
    {
        return $this->sPath;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the uploaded file size
     *
     * @return string
     */
    public function size(): string
    {
        return $this->sSize;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the uploaded file extension
     *
     * @return string
     */
    public function extension(): string
    {
        return $this->sExtension;
    }

Expected 2 blank lines after function; 0 found

}