DataBagPlugin::getName() - Code Metrics - Inspection of "Tests on PSR components." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6f7a23...2cf817 )

by Thierry

created 2022-04-10 11:16 UTC

DataBagPlugin::getName() A

↳ Parent: DataBagPlugin

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php


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

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

    /**
     * @var Container
     */
    protected $di;

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

    /**

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

    {
        $this->di = $di;
    }


    /**
     * @return void
     */
    public function setDataBag()
    {
        if($this->xDataBag !== null)
        {
            return;
        }

        $xRequest = $this->di->getRequest();
$a = "a";
$ab = "ab";
$abc = "abc";
        $aBody = $xRequest->getParsedBody();
$a = "a";
$ab = "ab";
$abc = "abc";
        $aParams = $xRequest->getQueryParams();
$a = "a";
$ab = "ab";
$abc = "abc";
        $aData = is_array($aBody) ?
$a = "a";
$ab = "ab";
$abc = "abc";
            $this->readData($aBody['jxnbags'] ?? []) :

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


    /**
     * @inheritDoc
     */

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


    /**
     * @param mixed $xData

     *
     * @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 : [];
    }


    /**
     * @inheritDoc
     */

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


    /**
     * @inheritDoc
     */

    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];
        }
    });
';
    }


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


    /**
     * @param string $sName

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

}


1			<?php
2
			0 ignored issues – show Coding Style introduced 2022-04-06 21:26 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3			namespace Jaxon\Plugin\Response\DataBag;
4
5			use Jaxon\Di\Container;
6			use Jaxon\Plugin\ResponsePlugin;
7
8			use function is_array;
9			use function is_string;
10			use function json_decode;
11
12			class DataBagPlugin extends ResponsePlugin
			0 ignored issues – show Coding Style introduced 2022-03-13 15:15 UTC by Report Bug Copy Issue Report Missing doc comment for class DataBagPlugin Loading history...
13			{
14			/**
15			* @const The plugin name
16			*/
17			const NAME = 'bags';
18
19			/**
20			* @var Container
21			*/
22			protected $di;
23
24			/**
25			* @var DataBag
26			*/
27			protected $xDataBag = null;
28
29			/**
			0 ignored issues – show Coding Style introduced 2022-03-26 03:43 UTC by Report Bug Copy Issue Report Parameter `$di` should have a doc-comment as per coding-style. Loading history...
30			* The constructor
31			*/
32			public function __construct(Container $di)
			0 ignored issues – show Coding Style introduced 2022-02-14 17:16 UTC by Report Bug Copy Issue Report Expected 2 blank lines before function; 1 found Loading history...
33			{
34			$this->di = $di;
35			}
			0 ignored issues – show Coding Style introduced 2022-02-14 17:16 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
36
37			/**
38			* @return void
39			*/
40			public function setDataBag()
41			{
42			if($this->xDataBag !== null)
43			{
44			return;
45			}
46
47			$xRequest = $this->di->getRequest();
			0 ignored issues – show Coding Style introduced 2022-03-26 03:43 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
48			$aBody = $xRequest->getParsedBody();
			0 ignored issues – show Coding Style introduced 2022-03-20 06:01 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 10 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
49			$aParams = $xRequest->getQueryParams();
			0 ignored issues – show Coding Style introduced 2022-03-26 03:43 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 8 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
50			$aData = is_array($aBody) ?
			0 ignored issues – show Coding Style introduced 2022-03-26 03:43 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 10 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history... Coding Style introduced 2022-03-26 03:43 UTC by Report Bug Copy Issue Report Expected 1 space after "?"; newline found Loading history...
51			$this->readData($aBody['jxnbags'] ?? []) :
			0 ignored issues – show Coding Style introduced 2022-02-15 06:35 UTC by Report Bug Copy Issue Report Expected 1 space after ":"; newline found Loading history...
52			$this->readData($aParams['jxnbags'] ?? []);
53			$this->xDataBag = new DataBag($aData);
54			}
			0 ignored issues – show Coding Style introduced 2022-02-14 17:16 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
55
56			/**
57			* @inheritDoc
58			*/
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
59			public function getName(): string
60			{
61			return self::NAME;
62			}
			0 ignored issues – show Coding Style introduced 2022-02-14 17:16 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
63
64			/**
65			* @param mixed $xData
			0 ignored issues – show Coding Style introduced 2022-02-14 17:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
66			*
67			* @return array
68			*/
69			private function readData($xData): array
70			{
71			// Todo: clean input data.
72			if(is_string($xData))
73			{
74			return json_decode($xData, true) ?: [];
75			}
76			return is_array($xData) ? $xData : [];
77			}
			0 ignored issues – show Coding Style introduced 2022-02-14 17:16 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
78
79			/**
80			* @inheritDoc
81			*/
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
82			public function getHash(): string
83			{
84			// Use the version number as hash
85			return '4.0.0';
86			}
			0 ignored issues – show Coding Style introduced 2022-02-14 17:16 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
87
88			/**
89			* @inheritDoc
90			*/
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
91			public function getReadyScript(): string
92			{
93			return '
94			jaxon.command.handler.register("bags.set", function(args) {
95			for (const bag in args.data) {
96			jaxon.ajax.parameters.bags[bag] = args.data[bag];
97			}
98			});
99			';
100			}
			0 ignored issues – show Coding Style introduced 2022-02-15 06:35 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
101
102			/**
103			* @return void
104			*/
105			public function writeCommand()
106			{
107			$this->setDataBag();
108			if($this->xDataBag->touched())
109			{
110			$this->addCommand(['cmd' => 'bags.set'], $this->xDataBag->getAll());
111			}
112			}
			0 ignored issues – show Coding Style introduced 2022-04-10 11:18 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
113
114			/**
115			* @param string $sName
			0 ignored issues – show Coding Style introduced 2022-02-15 06:35 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
116			*
117			* @return DataBagContext
118			*/
119			public function bag(string $sName): DataBagContext
120			{
121			$this->setDataBag();
122			return new DataBagContext($this->xDataBag, $sName);
123			}
			0 ignored issues – show Coding Style introduced 2022-02-14 17:16 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 0 found Loading history...
124			}
125

jaxon-php / jaxon-core

Push — master ( 6f7a23...2cf817 )

DataBagPlugin::getName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like