FileUpload::__construct() - Code Metrics - Inspection of "Added a file upload request plugin." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9a341d...f10304 )

by Thierry

created 2017-10-04 01:38 UTC

FileUpload::__construct() B

↳ Parent: FileUpload

Complexity

Conditions	4
Paths	3

Size

Total Lines	35
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	20
nc	3
nop	0
dl	0
loc	35
rs	8.5806
c	0
b	0
f	0

<?php

/**
 * FileUpload.php - Jaxon browser event
 *
 * This class adds server side event handling capabilities to Jaxon
 *
 * Events can be registered, then event handlers attached.
 *
 * @package jaxon-core
 * @author Jared White
 * @author J. Max Wilson
 * @author Joseph Woolley
 * @author Steffen Konerow
 * @author Thierry Feuzeu <[email protected]>
 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson
 * @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White  & J. Max Wilson
 * @copyright 2016 Thierry Feuzeu <[email protected]>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

namespace Jaxon\Request\Plugin;

use Jaxon\Jaxon;
use Jaxon\Plugin\Request as RequestPlugin;

class FileUpload extends RequestPlugin
{
    use \Jaxon\Utils\Traits\Validator;
    use \Jaxon\Utils\Traits\Translator;

    /**
     * The uploaded files copied in the user dir
     *
     * @var array
     */
    protected $aUserFiles;

    /**
     * The uploaded files received in the temp dir
     *
     * @var array
     */
    protected $aFiles;

    public function __construct()
// 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);
    }
}
    {
        $this->aUserFiles = [];
        $this->aFiles = [];

        foreach($_FILES as $var => $aFile)
        {
            $this->aFiles[$var] = [];
            if(is_array($aFile['name']))
            {
                for($i = 0; $i < count($aFile['name']); $i++)
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                {
                    // Copy the file data into the local array
                    $this->aFiles[$var][] = [
                        'name' => $aFile['name'][$i],
                        'type' => $aFile['type'][$i],
                        'tmp_name' => $aFile['tmp_name'][$i],
                        'error' => $aFile['error'][$i],
                        'size' => $aFile['size'][$i],
                    ];
                }
            }
            else
            {
                // Copy the file data into the local array
                $this->aFiles[$var][] = [
                    'name' => $aFile['name'],
                    'type' => $aFile['type'],
                    'tmp_name' => $aFile['tmp_name'],
                    'error' => $aFile['error'],
                    'size' => $aFile['size'],
                ];
            }
        }
    }

    /**
     * Return the name of this plugin
     *
     * @return string
     */
    public function getName()
    {
        return 'FileUpload';
    }

    /**
     * Get the uploaded files
     *
     * @return array
     */
    public function getUploadedFiles()
    {
        return $this->aUserFiles;
    }

    /**
     * Register a browser event
     *
     * @param array         $aArgs                An array containing the event specification
     *
     * @return \Jaxon\Request\Request
     */
    public function register($aArgs)
    {
        return false;
    }

    /**
     * Generate a hash for the registered browser events
     *
     * @return string
     */
    public function generateHash()
    {
        return '';
    }

    /**
     * Generate client side javascript code for the registered browser events
     *
     * @return string
     */
    public function getScript()
    {
        return '';
    }

    /**
     * Check if this plugin can process the incoming Jaxon request
     *
     * @return boolean
     */
    public function canProcessRequest()
    {
        // This plugin does not process a request all alone.
        // It provides complementary feature to other request plugins instead.
        return false;
    }

    /**
     * Process the uploaded files into the HTTP request
     *
     * @return boolean
     */
    public function processRequest()
    {
        // Default upload dir
        $sDefaultUploadDir = $this->getOption('upload.dir');
        // Check validity of the uploaded files
        foreach($this->aFiles as $var => &$aFiles)
        {
            $this->aUserFiles[$var] = [];
            foreach($aFiles as &$aFile)
            {
                // Verify upload result
                if($aFile['error'] != 0)
                {
                    throw new \Jaxon\Exception\Error($this->trans('errors.upload.failed', $aFile));
                }
                // Verify file validity (format, size)
                if(!$this->validateUploadedFile($aFile))
                {
                    throw new \Jaxon\Exception\Error($this->trans('errors.upload.invalid', $aFile));
                }
                // Verify that the upload dir exists and is writable
                $sUploadDir = trim($this->getOption('upload.files.' . $var . '.dir', $sDefaultUploadDir));
                $sUploadDir = rtrim($sUploadDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
                if(!is_writable($sUploadDir))
                {
                    throw new \Jaxon\Exception\Error($this->trans('errors.upload.access'));
                }
                // Set the user file data
                $this->aUserFiles[$var][] = [
                    'type' => $aFile['type'],
                    'name' => $aFile['name'],
                    'path' => $sUploadDir . $aFile["name"],
                    'size' => $aFile['size'],
                ];
            }
        }
        // Copy the uploaded files from the temp dir to the user dir
        foreach($this->aFiles as $var => $aFiles)
        {
            for($i = 0; $i < count($aFiles); $i++)
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            {
                // All's right, move the file to the user dir.
                move_uploaded_file($aFiles[$i]["tmp_name"], $this->aUserFiles[$var][$i]["path"]);
            }
        }
        return true;
    }
}


1			<?php
2
3			/**
4			* FileUpload.php - Jaxon browser event
5			*
6			* This class adds server side event handling capabilities to Jaxon
7			*
8			* Events can be registered, then event handlers attached.
9			*
10			* @package jaxon-core
11			* @author Jared White
12			* @author J. Max Wilson
13			* @author Joseph Woolley
14			* @author Steffen Konerow
15			* @author Thierry Feuzeu <[email protected]>
16			* @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson
17			* @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White & J. Max Wilson
18			* @copyright 2016 Thierry Feuzeu <[email protected]>
19			* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
20			* @link https://github.com/jaxon-php/jaxon-core
21			*/
22
23			namespace Jaxon\Request\Plugin;
24
25			use Jaxon\Jaxon;
26			use Jaxon\Plugin\Request as RequestPlugin;
27
28			class FileUpload extends RequestPlugin
29			{
30			use \Jaxon\Utils\Traits\Validator;
31			use \Jaxon\Utils\Traits\Translator;
32
33			/**
34			* The uploaded files copied in the user dir
35			*
36			* @var array
37			*/
38			protected $aUserFiles;
39
40			/**
41			* The uploaded files received in the temp dir
42			*
43			* @var array
44			*/
45			protected $aFiles;
46
47			public function __construct()
			0 ignored issues – show Coding Style introduced 2017-10-04 01:40 UTC by Report Bug Copy Issue Report `__construct` 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...
48			{
49			$this->aUserFiles = [];
50			$this->aFiles = [];
51
52			foreach($_FILES as $var => $aFile)
53			{
54			$this->aFiles[$var] = [];
55			if(is_array($aFile['name']))
56			{
57			for($i = 0; $i < count($aFile['name']); $i++)
			0 ignored issues – show Performance Best Practice introduced 2017-10-04 01:40 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
58			{
59			// Copy the file data into the local array
60			$this->aFiles[$var][] = [
61			'name' => $aFile['name'][$i],
62			'type' => $aFile['type'][$i],
63			'tmp_name' => $aFile['tmp_name'][$i],
64			'error' => $aFile['error'][$i],
65			'size' => $aFile['size'][$i],
66			];
67			}
68			}
69			else
70			{
71			// Copy the file data into the local array
72			$this->aFiles[$var][] = [
73			'name' => $aFile['name'],
74			'type' => $aFile['type'],
75			'tmp_name' => $aFile['tmp_name'],
76			'error' => $aFile['error'],
77			'size' => $aFile['size'],
78			];
79			}
80			}
81			}
82
83			/**
84			* Return the name of this plugin
85			*
86			* @return string
87			*/
88			public function getName()
89			{
90			return 'FileUpload';
91			}
92
93			/**
94			* Get the uploaded files
95			*
96			* @return array
97			*/
98			public function getUploadedFiles()
99			{
100			return $this->aUserFiles;
101			}
102
103			/**
104			* Register a browser event
105			*
106			* @param array $aArgs An array containing the event specification
107			*
108			* @return \Jaxon\Request\Request
109			*/
110			public function register($aArgs)
111			{
112			return false;
113			}
114
115			/**
116			* Generate a hash for the registered browser events
117			*
118			* @return string
119			*/
120			public function generateHash()
121			{
122			return '';
123			}
124
125			/**
126			* Generate client side javascript code for the registered browser events
127			*
128			* @return string
129			*/
130			public function getScript()
131			{
132			return '';
133			}
134
135			/**
136			* Check if this plugin can process the incoming Jaxon request
137			*
138			* @return boolean
139			*/
140			public function canProcessRequest()
141			{
142			// This plugin does not process a request all alone.
143			// It provides complementary feature to other request plugins instead.
144			return false;
145			}
146
147			/**
148			* Process the uploaded files into the HTTP request
149			*
150			* @return boolean
151			*/
152			public function processRequest()
153			{
154			// Default upload dir
155			$sDefaultUploadDir = $this->getOption('upload.dir');
156			// Check validity of the uploaded files
157			foreach($this->aFiles as $var => &$aFiles)
158			{
159			$this->aUserFiles[$var] = [];
160			foreach($aFiles as &$aFile)
161			{
162			// Verify upload result
163			if($aFile['error'] != 0)
164			{
165			throw new \Jaxon\Exception\Error($this->trans('errors.upload.failed', $aFile));
166			}
167			// Verify file validity (format, size)
168			if(!$this->validateUploadedFile($aFile))
169			{
170			throw new \Jaxon\Exception\Error($this->trans('errors.upload.invalid', $aFile));
171			}
172			// Verify that the upload dir exists and is writable
173			$sUploadDir = trim($this->getOption('upload.files.' . $var . '.dir', $sDefaultUploadDir));
174			$sUploadDir = rtrim($sUploadDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
175			if(!is_writable($sUploadDir))
176			{
177			throw new \Jaxon\Exception\Error($this->trans('errors.upload.access'));
178			}
179			// Set the user file data
180			$this->aUserFiles[$var][] = [
181			'type' => $aFile['type'],
182			'name' => $aFile['name'],
183			'path' => $sUploadDir . $aFile["name"],
184			'size' => $aFile['size'],
185			];
186			}
187			}
188			// Copy the uploaded files from the temp dir to the user dir
189			foreach($this->aFiles as $var => $aFiles)
190			{
191			for($i = 0; $i < count($aFiles); $i++)
			0 ignored issues – show Performance Best Practice introduced 2017-10-04 01:40 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
192			{
193			// All's right, move the file to the user dir.
194			move_uploaded_file($aFiles[$i]["tmp_name"], $this->aUserFiles[$var][$i]["path"]);
195			}
196			}
197			return true;
198			}
199			}
200

jaxon-php / jaxon-core

Push — master ( 9a341d...f10304 )

FileUpload::__construct() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like