Jaxon\Response\Plugin\DataBag\DataBagPlugin

Complexity

Total Complexity

13

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

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

<?php

Missing file doc comment

namespace Jaxon\Response\Plugin\DataBag;

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

class DataBagPlugin extends \Jaxon\Plugin\Response

Missing doc comment for class DataBagPlugin

{
    /**
     * @var Bag
     */
    protected $xBag;

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

    /**
     * The constructor
     */
    public function __construct()

Expected 2 blank lines before function; 1 found

    {
        $aData = isset($_POST['jxnbags']) ? $this->readData($_POST) :

Expected 1 space after ":"; newline found

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

            (isset($_GET['jxnbags']) ? $this->readData($_GET) : []);
        $this->xBag = new Bag($aData);
    }

Expected 2 blank lines after function; 1 found

    /**
     * @param array $aFrom

Missing parameter comment

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return 'bags';
    }

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 '1.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->xBag->touched())
        {
            $this->addCommand(['cmd' => 'bags.set'], $this->xBag->getAll());
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * @param string $sName

Missing parameter comment

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

Expected 2 blank lines after function; 0 found

}