Uploader::setFileInfos() - Code Metrics - Inspection of "test/nymfonia : Test Controller upload action" - pierre-fromager/nymfonya - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 12c411...515d4c )

by Pierre

created 2019-10-29 15:28 UTC

Uploader::setFileInfos() A

↳ Parent: Uploader

Complexity

Conditions	4
Paths	6

Size

Total Lines	21
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	6.7441

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	18
c	1
b	0
f	0
nc	6
nop	0
dl	0
loc	21
ccs	8
cts	18
cp	0.4444
crap	6.7441
rs	9.6666

<?php

namespace App\Tools\File;

use App\Container;

class Uploader
{

    const FIELD = 'file';
    const UPLOAD_ERR_INI_SIZE = 'La taille du fichier dépasse celle autorisée , upload_max_filesize = ';
    const UPLOAD_ERR_FORM_SIZE = 'La taille du fichier est trops importante.';
    const UPLOAD_ERR_NO_TMP_DIR = 'Le paramétrage du répertoire temporaire est incorrecte.';
    const UPLOAD_ERR_CANT_WRITE = 'Échec de l\'écriture du fichier sur le disque.';
    const UPLOAD_ERR_EXTENSION = 'Ce type de fichier n\'est pas autorisé.';
    const UPLOAD_ERR_PARTIAL = 'Le fichier n\'a été que partiellement téléchargé.';
    const UPLOAD_ERR_NO_FILE = 'Aucun fichier n\'a été téléchargé.';
    const UPLOAD_ERR_UNKOWN = 'Erreur inconnue.';

    /**
     * file
     *
     * @var array
     */
    protected $file;

    /**
     * target path
     *
     * @var string
     */
    protected $targetPath = 'assets/upload/';

    /**
     * error flag
     *
     * @var Boolean
     */
    protected $error;

    /**
     * error code
     *
     * @var Int
     */
    protected $errorCode;

    /**
     * error message
     *
     * @var String
     */
    protected $errorMsg;

    /**
     * file name
     *
     * @var String
     */
    protected $filename;

    /**
     * file extension
     *
     * @var String
     */
    protected $fileext;

    /**
     * tmp file name
     *
     * @var String
     */
    protected $filetmpname;

    /**
     * file target name
     *
     * @var String
     */
    protected $filetarget;

    /**
     * file type
     *
     * @var String
     */
    protected $filetype;

    /**
     * file size
     *
     * @var Int
     */
    protected $filesize;


    /**
     * instanciate
     *
     */
    public function __construct()
    {
        $this->file = $_FILES;
        $this->error = false;
        $this->errorMsg = '';
        $this->setFileInfos();
        $this->setErrorMessage();
    }

    /**
     * return error
     *
     * @return boolean
     */
    public function getError(): bool
    {
        return $this->error;
    }

    /**
     * set target path
     *
     * @param string $path
     * @return Uploader
     */
    public function setTargetPath(string $path): Uploader
    {
        $this->targetPath = $path;
        $this->setFileInfos();
        return $this;
    }

    /**
     * move file from tmp path to target
     *
     * @return Uploader
     */
    public function process(): Uploader
    {
        if (false === $this->error) {
            $destFilename = $this->targetPath . $this->filename;
            $result = move_uploaded_file($this->filetmpname, $destFilename);
            if (false === $result) {
                $this->error = true;
                $this->errorCode = UPLOAD_ERR_CANT_WRITE;
                $this->setErrorMessage();
            }
        }
        return $this;
    }

    /**
     * get upload file infos
     *
     * @return array
     */
    public function getInfos(): array
    {
        return [
            'error' => $this->error,
            'errorCode' => $this->errorCode,
            'errorMsg' => $this->errorMsg,
            'datas' => [
                'name' => $this->filename,
                'ext' => $this->fileext,
                'tmp' => $this->filetmpname,
                'target' => $this->filetarget,
                'type' => $this->filetype,
                'size' => $this->filesize
            ],
        ];
    }

    /**
     * set error message from error code
     *
     * @return Uploader
     */
    protected function setErrorMessage(): Uploader
    {
        if ($this->error === false) {
            return $this;
        }
        $maxSize = ini_get('upload_max_filesize');
        switch ($this->errorCode) {
            case UPLOAD_ERR_INI_SIZE:
                $this->errorMsg = self::UPLOAD_ERR_INI_SIZE . $maxSize . '.';
                break;
            case UPLOAD_ERR_FORM_SIZE:
                $this->errorMsg = self::UPLOAD_ERR_FORM_SIZE . $maxSize . '.';
                break;
            case UPLOAD_ERR_NO_TMP_DIR:
                $this->errorMsg = self::UPLOAD_ERR_NO_TMP_DIR;
                break;
            case UPLOAD_ERR_CANT_WRITE:
                $this->errorMsg = self::UPLOAD_ERR_CANT_WRITE;
                break;
            case UPLOAD_ERR_EXTENSION:
                $this->errorMsg = self::UPLOAD_ERR_EXTENSION;
                break;
            case UPLOAD_ERR_PARTIAL:
                $this->errorMsg = self::UPLOAD_ERR_PARTIAL;
                break;
            case UPLOAD_ERR_NO_FILE:
                $this->errorMsg = self::UPLOAD_ERR_NO_FILE;
                break;
            default:
                $this->errorMsg = 'Unknown Error';
                break;
        }
        return $this;
    }

    /**
     * set files infos
     *
     */
    protected function setFileInfos(): Uploader
    {
        $isValid = isset($this->file[self::FIELD])
            && !empty($this->file[self::FIELD]);
        $this->error = (false === $isValid);
        if ($isValid) {
            $fileInfo = $this->file[self::FIELD];
            $this->filename = $fileInfo['name'];
            $basename = basename($this->filename);
            $this->fileext = (!empty($basename)) ? substr($basename, -4) : '';
            $this->filetmpname = $fileInfo['tmp_name'];
            $this->filetarget = $this->targetPath . $basename;
            $this->errorCode = $fileInfo['error'];
            $this->filetype = $fileInfo['type'];
            $this->filesize = $fileInfo['size'];
            unset($fileInfo);
        } else {
            $this->errorCode = UPLOAD_ERR_NO_FILE;
            $this->setErrorMessage();
        }
        return $this;
    }
}


1		<?php
2
3		namespace App\Tools\File;
4
5		use App\Container;
6
7		class Uploader
8		{
9
10		const FIELD = 'file';
11		const UPLOAD_ERR_INI_SIZE = 'La taille du fichier dépasse celle autorisée , upload_max_filesize = ';
12		const UPLOAD_ERR_FORM_SIZE = 'La taille du fichier est trops importante.';
13		const UPLOAD_ERR_NO_TMP_DIR = 'Le paramétrage du répertoire temporaire est incorrecte.';
14		const UPLOAD_ERR_CANT_WRITE = 'Échec de l\'écriture du fichier sur le disque.';
15		const UPLOAD_ERR_EXTENSION = 'Ce type de fichier n\'est pas autorisé.';
16		const UPLOAD_ERR_PARTIAL = 'Le fichier n\'a été que partiellement téléchargé.';
17		const UPLOAD_ERR_NO_FILE = 'Aucun fichier n\'a été téléchargé.';
18		const UPLOAD_ERR_UNKOWN = 'Erreur inconnue.';
19
20		/**
21		* file
22		*
23		* @var array
24		*/
25		protected $file;
26
27		/**
28		* target path
29		*
30		* @var string
31		*/
32		protected $targetPath = 'assets/upload/';
33
34		/**
35		* error flag
36		*
37		* @var Boolean
38		*/
39		protected $error;
40
41		/**
42		* error code
43		*
44		* @var Int
45		*/
46		protected $errorCode;
47
48		/**
49		* error message
50		*
51		* @var String
52		*/
53		protected $errorMsg;
54
55		/**
56		* file name
57		*
58		* @var String
59		*/
60		protected $filename;
61
62		/**
63		* file extension
64		*
65		* @var String
66		*/
67		protected $fileext;
68
69		/**
70		* tmp file name
71		*
72		* @var String
73		*/
74		protected $filetmpname;
75
76		/**
77		* file target name
78		*
79		* @var String
80		*/
81		protected $filetarget;
82
83		/**
84		* file type
85		*
86		* @var String
87		*/
88		protected $filetype;
89
90		/**
91		* file size
92		*
93		* @var Int
94		*/
95		protected $filesize;
96
97
98		/**
99		* instanciate
100		*
101		*/
102	7	public function __construct()
103		{
104	7	$this->file = $_FILES;
105	7	$this->error = false;
106	7	$this->errorMsg = '';
107	7	$this->setFileInfos();
108	7	$this->setErrorMessage();
109		}
110
111		/**
112		* return error
113		*
114		* @return boolean
115		*/
116	2	public function getError(): bool
117		{
118	2	return $this->error;
119		}
120
121		/**
122		* set target path
123		*
124		* @param string $path
125		* @return Uploader
126		*/
127	1	public function setTargetPath(string $path): Uploader
128		{
129	1	$this->targetPath = $path;
130	1	$this->setFileInfos();
131	1	return $this;
132		}
133
134		/**
135		* move file from tmp path to target
136		*
137		* @return Uploader
138		*/
139	1	public function process(): Uploader
140		{
141	1	if (false === $this->error) {
142		$destFilename = $this->targetPath . $this->filename;
143		$result = move_uploaded_file($this->filetmpname, $destFilename);
144		if (false === $result) {
145		$this->error = true;
146		$this->errorCode = UPLOAD_ERR_CANT_WRITE;
147		$this->setErrorMessage();
148		}
149		}
150	1	return $this;
151		}
152
153		/**
154		* get upload file infos
155		*
156		* @return array
157		*/
158	1	public function getInfos(): array
159		{
160		return [
161	1	'error' => $this->error,
162	1	'errorCode' => $this->errorCode,
163	1	'errorMsg' => $this->errorMsg,
164		'datas' => [
165	1	'name' => $this->filename,
166	1	'ext' => $this->fileext,
167	1	'tmp' => $this->filetmpname,
168	1	'target' => $this->filetarget,
169	1	'type' => $this->filetype,
170	1	'size' => $this->filesize
171		],
172		];
173		}
174
175		/**
176		* set error message from error code
177		*
178		* @return Uploader
179		*/
180	1	protected function setErrorMessage(): Uploader
181		{
182	1	if ($this->error === false) {
183		return $this;
184		}
185	1	$maxSize = ini_get('upload_max_filesize');
186	1	switch ($this->errorCode) {
187	1	case UPLOAD_ERR_INI_SIZE:
188		$this->errorMsg = self::UPLOAD_ERR_INI_SIZE . $maxSize . '.';
189		break;
190	1	case UPLOAD_ERR_FORM_SIZE:
191		$this->errorMsg = self::UPLOAD_ERR_FORM_SIZE . $maxSize . '.';
192		break;
193	1	case UPLOAD_ERR_NO_TMP_DIR:
194		$this->errorMsg = self::UPLOAD_ERR_NO_TMP_DIR;
195		break;
196	1	case UPLOAD_ERR_CANT_WRITE:
197		$this->errorMsg = self::UPLOAD_ERR_CANT_WRITE;
198		break;
199	1	case UPLOAD_ERR_EXTENSION:
200		$this->errorMsg = self::UPLOAD_ERR_EXTENSION;
201		break;
202	1	case UPLOAD_ERR_PARTIAL:
203		$this->errorMsg = self::UPLOAD_ERR_PARTIAL;
204		break;
205	1	case UPLOAD_ERR_NO_FILE:
206	1	$this->errorMsg = self::UPLOAD_ERR_NO_FILE;
207	1	break;
208		default:
209		$this->errorMsg = 'Unknown Error';
210		break;
211		}
212	1	return $this;
213		}
214
215		/**
216		* set files infos
217		*
218		*/
219	1	protected function setFileInfos(): Uploader
220		{
221	1	$isValid = isset($this->file[self::FIELD])
222	1	&& !empty($this->file[self::FIELD]);
223	1	$this->error = (false === $isValid);
224	1	if ($isValid) {
225		$fileInfo = $this->file[self::FIELD];
226		$this->filename = $fileInfo['name'];
227		$basename = basename($this->filename);
228		$this->fileext = (!empty($basename)) ? substr($basename, -4) : '';
229		$this->filetmpname = $fileInfo['tmp_name'];
230		$this->filetarget = $this->targetPath . $basename;
231		$this->errorCode = $fileInfo['error'];
232		$this->filetype = $fileInfo['type'];
233		$this->filesize = $fileInfo['size'];
234		unset($fileInfo);
235		} else {
236	1	$this->errorCode = UPLOAD_ERR_NO_FILE;
237	1	$this->setErrorMessage();
238		}
239	1	return $this;
240		}
241		}
242

pierre-fromager / nymfonya

Push — master ( 12c411...515d4c )

Uploader::setFileInfos() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like