Jaxon\Plugin\Response\DataBag\DataBagPlugin

Complexity

Total Complexity

12

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	getHash()	0	4	1
A	getReadyScript()	0	3	1
A	bag()	0	3	1
A	getName()	0	3	1
A	readData()	0	8	4
A	writeCommand()	0	5	2

<?php

Missing file doc comment

namespace Jaxon\Plugin\Response\DataBag;

use Jaxon\Di\Container;
use Jaxon\Plugin\ResponsePlugin;

use function is_array;
use function is_string;
use function json_decode;

class DataBagPlugin extends ResponsePlugin

Missing doc comment for class DataBagPlugin

{
    /**
     * @const The plugin name
     */
    const NAME = 'bags';

    /**
     * @var DataBag
     */
    protected $xDataBag;

    /**

Parameter $di should have a doc-comment as per coding-style.

     * The constructor
     */
    public function __construct(Container $di)

Expected 2 blank lines before function; 1 found

    {
        $xRequest = $di->getRequest();

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

        $aBody = $xRequest->getParsedBody();

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

        $aParams = $xRequest->getQueryParams();

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

        $aData = is_array($aBody) ?

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

Expected 1 space after "?"; newline found

            $this->readData($aBody['jxnbags'] ?? []) :

Expected 1 space after ":"; newline found

            $this->readData($aParams['jxnbags'] ?? []);
        $this->xDataBag = new DataBag($aData);
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return self::NAME;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @param mixed $xData

Missing parameter comment

     *
     * @return array
     */
    private function readData($xData): array
    {
        // Todo: clean input data.
        if(is_string($xData))
        {
            return json_decode($xData, true) ?: [];
        }
        return is_array($xData) ? $xData : [];
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getHash(): string
    {
        // Use the version number as hash
        return '4.0.0';
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getReadyScript(): string
    {
        return '
    jaxon.command.handler.register("bags.set", function(args) {
        for (const bag in args.data) {
            jaxon.ajax.parameters.bags[bag] = args.data[bag];
        }
    });
';
    }

Expected 2 blank lines after function; 1 found

    /**
     * @return void
     */
    public function writeCommand()
    {
        if($this->xDataBag->touched())
        {
            $this->addCommand(['cmd' => 'bags.set'], $this->xDataBag->getAll());
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * @param string $sName

Missing parameter comment

     *
     * @return DataBagContext
     */
    public function bag(string $sName): DataBagContext
    {
        return new DataBagContext($this->xDataBag, $sName);
    }

Expected 2 blank lines after function; 0 found

}