Jaxon\Response\Plugin\DataBag

Complexity

Total Complexity

11

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

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

<?php

Missing file doc comment

namespace Jaxon\Response\Plugin;

use function is_array;

class DataBag extends \Jaxon\Plugin\Response

Missing doc comment for class DataBag

{
    /**
     * @var DataBag\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

    {
        // Todo: clean input data.
        $aData = [];
        if(isset($_POST['jxnbags']) && is_array($_POST['jxnbags']))
        {
            $aData = $_POST['jxnbags'];
        }
        elseif(isset($_GET['jxnbags']) && is_array($_GET['jxnbags']))
        {
            $aData = $_GET['jxnbags'];
        }
        $this->xBag = new DataBag\Bag($aData);
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getHash()
    {
        // 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()
    {
        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 bool
     */
    public function writeCommand()
    {
        if($this->xBag->touched())
        {
            $this->addCommand(['cmd' => 'bags.set'], $this->xBag->getAll());

$this->xBag->getAll() of type array is incompatible with the type string expected by parameter $sData of Jaxon\Plugin\Response::addCommand().

        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * @param string $sName

Missing parameter comment

     *
     * @return DataBag\Bag
     */
    public function bag($sName)
    {
        return $this->xBag->setName($sName);
    }

Expected 2 blank lines after function; 0 found

}