Jaxon\Request\Handler\UploadHandler

Complexity

Total Complexity

12

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	canProcessRequest()	0	3	2
A	files()	0	3	1
A	__construct()	0	13	3
A	isHttpUpload()	0	3	1
A	sanitizer()	0	3	1
A	processRequest()	0	32	4

<?php

/**
 * UploadHandler.php - This class implements file upload with Ajax.
 *
 * @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\Handler;

use Jaxon\Request\Upload\UploadManager;
use Jaxon\Response\ResponseManager;
use Jaxon\Response\UploadResponse;
use Jaxon\Utils\Translation\Translator;
use Jaxon\Exception\RequestException;

use Closure;
use Exception;

use function count;
use function trim;

class UploadHandler

Missing doc comment for class UploadHandler

{
    /**
     * The response manager
     *
     * @var ResponseManager
     */
    protected $xResponseManager;

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

    /**
     * HTTP file upload manager
     *
     * @var UploadManager
     */
    protected $xUploadManager = null;

    /**
     * @var Translator
     */
    protected $xTranslator;

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

    /**
     * The name of file containing upload data
     *
     * @var string
     */
    protected $sTempFile = '';

    /**
     * Is the current request an HTTP upload
     *
     * @var bool

Expected "boolean" but found "bool" for @var tag in member variable comment

     */
    protected $bIsAjaxRequest = true;

    /**
     * The constructor
     *
     * @param UploadManager $xUploadManager    HTTP file upload manager

Expected 3 spaces after parameter name; 4 found

Expected 3 spaces after parameter type; 1 found

     * @param Translator $xTranslator

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

     * @param ResponseManager $xResponseManager

Missing parameter comment

     */
    public function __construct(UploadManager $xUploadManager, Translator $xTranslator, ResponseManager $xResponseManager)

Expected 2 blank lines before function; 1 found

    {
        $this->xResponseManager = $xResponseManager;
        $this->xUploadManager = $xUploadManager;

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

        $this->xTranslator = $xTranslator;

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

        if(isset($_POST['jxnupl']))
        {
            $this->sTempFile = trim($_POST['jxnupl']);
        }
        elseif(isset($_GET['jxnupl']))
        {
            $this->sTempFile = trim($_GET['jxnupl']);
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the uploaded file name sanitizer
     *
     * @param Closure $cSanitizer    The closure

Expected 1 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function sanitizer(Closure $cSanitizer)
    {
        $this->xUploadManager->setNameSanitizer($cSanitizer);
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Inform this plugin that other plugin can process the current request
     *
     * @return void
     */
    public function isHttpUpload()
    {
        $this->bIsAjaxRequest = false;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if the current request contains uploaded files
     *
     * @return bool
     */
    public function canProcessRequest(): bool
    {
        return (count($_FILES) > 0 || ($this->sTempFile));
    }

Expected 2 blank lines after function; 1 found

    /**
     * Process the uploaded files in the HTTP request
     *
     * @return bool
     * @throws RequestException
     */
    public function processRequest(): bool
    {
        if(($this->sTempFile))
        {
            // Ajax request following a normal HTTP upload.
            // Copy the previously uploaded files' location from the temp file.
            $this->aUserFiles = $this->xUploadManager->readFromTempFile($this->sTempFile);
            return true;
        }

        // Ajax or Http request with upload; copy the uploaded files.
        $this->aUserFiles = $this->xUploadManager->readFromHttpData();

        // For Ajax requests, there is nothing else to do here.
        if($this->bIsAjaxRequest)
        {
            return true;
        }
        // For HTTP requests, save the files' location to a temp file,
        // and return a response with a reference to this temp file.
        $xResponse = new UploadResponse();
        try
        {
            $sTempFile = $this->xUploadManager->saveToTempFile($this->aUserFiles);
            $xResponse->setUploadedFile($sTempFile);
        }
        catch(Exception $e)
        {
            $xResponse->setErrorMessage($e->getMessage());
        }
        $this->xResponseManager->append($xResponse);
        return true;
    }

Expected 2 blank lines after function; 0 found

}