UploadResponse::addPluginCommand() - Code Metrics - Inspection of "Updated the response class." - jaxon-php/jaxon-upload - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 2d573b...fc5697 )

by Thierry

created 2024-01-17 13:06 UTC

UploadResponse::addPluginCommand() A

↳ Parent: UploadResponse

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	3
dl	0
loc	3
rs	10

<?php

namespace Jaxon\Upload;

use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Response\ResponseInterface;
use Nyholm\Psr7\Factory\Psr17Factory;
use Nyholm\Psr7\Stream;
use Psr\Http\Message\ResponseInterface as PsrResponseInterface;

use function addslashes;
use function array_reduce;
use function json_encode;

class UploadResponse implements ResponseInterface
{
    use \Jaxon\Response\Traits\CommandTrait;
    use \Jaxon\Response\Traits\DomTrait;
    use \Jaxon\Response\Traits\JsTrait;


    /**
     * @var Psr17Factory
     */
    protected $xPsr17Factory;

    /**
     * The path to the uploaded file
     *
     * @var string
     */
    private $sUploadedFile = '';

    /**
     * The error message
     *
     * @var string
     */
    private $sErrorMessage = '';

    /**
     * The debug messages
     *
     * @var array
     */
    private $aDebugMessages = [];

    /**
     * The constructor
     *
     * @param Psr17Factory $xPsr17Factory
     * @param string $sUploadedFile
     * @param string $sErrorMessage
     */
    public function __construct(Psr17Factory $xPsr17Factory, string $sUploadedFile, string $sErrorMessage = '')
    {
        $this->xPsr17Factory = $xPsr17Factory;
        $this->sUploadedFile = $sUploadedFile;
        $this->sErrorMessage = $sErrorMessage;
    }

    /**
     * @inheritDoc
     */
    public function getContentType(): string
    {
        return 'text/html';
    }

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

    /**
     * Get the error message
     *
     * @return string
     */
    public function getErrorMessage(): string
    {
        return $this->sErrorMessage;
    }

    /**
     * @inheritDoc
     */
    public function debug(string $sMessage): ResponseInterface
    {
        $this->aDebugMessages[] = $sMessage;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getOutput(): string
    {
        $sResult = json_encode(($this->sUploadedFile) ?
            ['code' => 'success', 'upl' => $this->sUploadedFile] :
            ['code' => 'error', 'msg' => $this->sErrorMessage]) . ';';
        $sConsoleLog = array_reduce($this->aDebugMessages, function($sJsLog, $sMessage) {
            return "$sJsLog\n\t" . 'console.log("' . addslashes($sMessage) . '");';
        }, '');

        return '
<!DOCTYPE html>
<html>
<body>
<h1>HTTP Upload for Jaxon</h1>
</body>
<script>
    res = ' . $sResult . $sConsoleLog . '
</script>
</html>';
    }

    /**
     * Convert this response to a PSR7 response object
     *
     * @return PsrResponseInterface
     */
    public function toPsr(): PsrResponseInterface
    {
        return $this->xPsr17Factory->createResponse(($this->sUploadedFile) ? 200 : 500)
            ->withHeader('content-type', $this->getContentType())
            ->withBody(Stream::create($this->getOutput()));
    }

    /**
     * Empty method, just to have the ResponseInterface methods implemented.
     *
     * @param array $aAttributes
     * @param mixed $mData
     *
     * @return ResponseInterface
     */
    public function addCommand(array $aAttributes, $mData): ResponseInterface
    public function addCommand(array $aAttributes, /** @scrutinizer ignore-unused */ $mData): ResponseInterface
    {
        return $this;
    }

    /**
     * Empty method, just to have the ResponseInterface methods implemented.
     *
     * @param string $sName
     * @param array $aAttributes
     * @param mixed $mData
     * @param bool $bRemoveEmpty
     *
     * @return ResponseInterface
     */
    protected function _addCommand(string $sName, array $aAttributes,
    protected function _addCommand(/** @scrutinizer ignore-unused */ string $sName, array $aAttributes,
        $mData, bool $bRemoveEmpty = false): ResponseInterface
        /** @scrutinizer ignore-unused */ $mData, bool $bRemoveEmpty = false): ResponseInterface
    {
        return $this;
    }

    /**
     * Empty method, just to have the ResponseInterface methods implemented.
     *
     * @param ResponsePlugin $xPlugin
     * @param array $aAttributes
     * @param mixed $mData
     *
     * @return ResponseInterface
     */
    public function addPluginCommand(ResponsePlugin $xPlugin, array $aAttributes, $mData): ResponseInterface
    public function addPluginCommand(ResponsePlugin $xPlugin, array $aAttributes, /** @scrutinizer ignore-unused */ $mData): ResponseInterface
    {
        return $this;
    }
}


jaxon-php / jaxon-upload

Push — main ( 2d573b...fc5697 )

UploadResponse::addPluginCommand() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like