Issues in UploadHandler.php - Fixed Issues - Inspection of "add testcase" - slince/upload - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4dd6d0...6c40dd )

by Taosikai

created 2018-09-04 14:32 UTC

src/UploadHandler.php (1 issue)

Labels

Coding Style 1

Severity

Minor 1

slince 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/*
 * This file is part of the slince/upload package.
 *
 * (c) Slince <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slince\Upload;

use Slince\Upload\Filesystem\FilesystemInterface;
use Slince\Upload\Naming\NamerInterface;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use Symfony\Component\HttpFoundation\FileBag;
use Symfony\Component\HttpFoundation\Request as SymfonyRequest;

class UploadHandler
{
    /**
     * @var NamerInterface
     */
    protected $namer;

    /**
     * @var FilesystemInterface
     */
    protected $filesystem;

    /**
     * @var Validator
     */
    protected $validator;

    /**
     * @var boolean
     */
    protected $overwrite;

    public function __construct(
        FilesystemInterface $filesystem,
        NamerInterface $namer,
        $overwrite = false
    ) {
        $this->filesystem = $filesystem;
        $this->namer = $namer;
        $this->overwrite = $overwrite;
        $this->validator = new Validator();
    }

    /**
     * Gets the validator
     *
     * @return Validator
     */
    public function getValidator()
    {
        return $this->validator;
    }

    /**
     * Process request
     * @param SymfonyRequest|null $request
     *
     * @return UploadedFile[]|\Exception[]|UploadedFile
     */
    public function handle($request = null)
    {
        $files = [];
        foreach ($this->createFiles($request) as $uploadedFile) {
            $files[] = $this->processFile($uploadedFile);
        }
        return count($files) === 1 ? $files[0] : $files;
    }

    protected function processFile(UploadedFile $file)
    {
        try {
            // validate the file
            $this->validator->validate($file);
            return $this->filesystem
                ->upload($this->namer->generate($file), $file, $this->overwrite);
        } catch (\Exception $exception) {
            return $exception;
        }
    }

    /**
     * @param SymfonyRequest|null $request
     * @return FileBag
     */
    protected function createFiles($request = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if ($request instanceof SymfonyRequest) {
            $files = $request->files;
        } else {
            $files = new FileBag($_FILES);
        }
        return $files;
    }
}

1			<?php
2
3			/*
4			* This file is part of the slince/upload package.
5			*
6			* (c) Slince <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Slince\Upload;
13
14			use Slince\Upload\Filesystem\FilesystemInterface;
15			use Slince\Upload\Naming\NamerInterface;
16			use Symfony\Component\HttpFoundation\File\UploadedFile;
17			use Symfony\Component\HttpFoundation\FileBag;
18			use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
19
20			class UploadHandler
21			{
22			/**
23			* @var NamerInterface
24			*/
25			protected $namer;
26
27			/**
28			* @var FilesystemInterface
29			*/
30			protected $filesystem;
31
32			/**
33			* @var Validator
34			*/
35			protected $validator;
36
37			/**
38			* @var boolean
39			*/
40			protected $overwrite;
41
42			public function __construct(
43			FilesystemInterface $filesystem,
44			NamerInterface $namer,
45			$overwrite = false
46			) {
47			$this->filesystem = $filesystem;
48			$this->namer = $namer;
49			$this->overwrite = $overwrite;
50			$this->validator = new Validator();
51			}
52
53			/**
54			* Gets the validator
55			*
56			* @return Validator
57			*/
58			public function getValidator()
59			{
60			return $this->validator;
61			}
62
63			/**
64			* Process request
65			* @param SymfonyRequest\|null $request
66			*
67			* @return UploadedFile[]\|\Exception[]\|UploadedFile
68			*/
69			public function handle($request = null)
70			{
71			$files = [];
72			foreach ($this->createFiles($request) as $uploadedFile) {
73			$files[] = $this->processFile($uploadedFile);
74			}
75			return count($files) === 1 ? $files[0] : $files;
76			}
77
78			protected function processFile(UploadedFile $file)
79			{
80			try {
81			// validate the file
82			$this->validator->validate($file);
83			return $this->filesystem
84			->upload($this->namer->generate($file), $file, $this->overwrite);
85			} catch (\Exception $exception) {
86			return $exception;
87			}
88			}
89
90			/**
91			* @param SymfonyRequest\|null $request
92			* @return FileBag
93			*/
94			protected function createFiles($request = null)
			0 ignored issues – show Coding Style introduced 2018-09-04 13:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this `createFiles` uses the super-global variable `$_FILES` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
95			{
96			if ($request instanceof SymfonyRequest) {
97			$files = $request->files;
98			} else {
99			$files = new FileBag($_FILES);
100			}
101			return $files;
102			}
103			}

slince / upload

Push — master ( 4dd6d0...6c40dd )

src/UploadHandler.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like