JQueryPlugin::selector() - Code Metrics - Inspection of "Converted the JQuery plugin to json calls." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v5.x ( 8eee51...080647 )

by Thierry

created 2024-03-01 04:50 UTC

JQueryPlugin::selector() A

↳ Parent: JQueryPlugin

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php


namespace Jaxon\Plugin\Response\JQuery;

use Jaxon\Plugin\ResponsePlugin;

class JQueryPlugin extends ResponsePlugin

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

    /**
     * @var string
     */
    protected $jQueryNs;

    /**
     * True if the next selector is a command
     *
     * @var bool

     */
    protected $bCommand = true;

    /**
     * The class constructor
     *
     * @param string $jQueryNs

     */
    public function __construct(string $jQueryNs)

    {
        $this->jQueryNs = $jQueryNs;
    }


    /**
     * @param bool $bCommand

     *
     * @return JQueryPlugin
     */
    public function command(bool $bCommand): JQueryPlugin
    {
        $this->bCommand = $bCommand;
        return $this;
    }


    /**
     * @inheritDoc
     */

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


    /**
     * @inheritDoc
     */

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


    /**
     * Create a JQueryPlugin DomSelector, and link it to the current response.
     *
     * Since this element is linked to a response, its code will be automatically sent to the client.
     * The returned object can be used to call jQuery functions on the selected elements.
     *
     * @param string $sPath    The jQuery selector path
     * @param mixed $xContext    A context associated to the selector

     *
     * @return DomSelector
     */
    public function selector(string $sPath = '', $xContext = null): DomSelector
    {
        $xSelector = new DomSelector($sPath, $xContext);
        if($this->bCommand && $this->response() !== null)
        {
            $this->addCommand('jquery', ['selector' => $xSelector]);
        }
        // Reset the command value.
        $this->bCommand = true;
        return $xSelector;
    }

}


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\JQuery;
4
5			use Jaxon\Plugin\ResponsePlugin;
6
7			class JQueryPlugin 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 JQueryPlugin Loading history...
8			{
9			/**
10			* @const The plugin name
11			*/
12			const NAME = 'jquery';
13
14			/**
15			* @var string
16			*/
17			protected $jQueryNs;
18
19			/**
20			* True if the next selector is a command
21			*
22			* @var bool
			0 ignored issues – show Bug introduced 2022-03-28 01:49 UTC by Report Bug Copy Issue Report Expected "boolean" but found "bool" for @var tag in member variable comment Loading history...
23			*/
24			protected $bCommand = true;
25
26			/**
27			* The class constructor
28			*
29			* @param string $jQueryNs
			0 ignored issues – show Coding Style introduced 2022-02-21 07:07 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
30			*/
31			public function __construct(string $jQueryNs)
			0 ignored issues – show Coding Style introduced 2022-02-21 07:07 UTC by Report Bug Copy Issue Report Expected 2 blank lines before function; 1 found Loading history...
32			{
33			$this->jQueryNs = $jQueryNs;
34			}
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
35
36			/**
37			* @param bool $bCommand
			0 ignored issues – show Coding Style introduced 2022-03-28 01:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
38			*
39			* @return JQueryPlugin
40			*/
41			public function command(bool $bCommand): JQueryPlugin
42			{
43			$this->bCommand = $bCommand;
44			return $this;
45			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
46
47			/**
48			* @inheritDoc
49			*/
			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...
50			public function getName(): string
51			{
52			return self::NAME;
53			}
			0 ignored issues – show Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
54
55			/**
56			* @inheritDoc
57			*/
			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...
58			public function getHash(): string
59			{
60			// Use the version number as hash
61			return '4.0.0';
62			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
63
64			/**
65			* Create a JQueryPlugin DomSelector, and link it to the current response.
66			*
67			* Since this element is linked to a response, its code will be automatically sent to the client.
68			* The returned object can be used to call jQuery functions on the selected elements.
69			*
70			* @param string $sPath The jQuery selector path
71			* @param mixed $xContext A context associated to the selector
			0 ignored issues – show Coding Style introduced 2023-10-04 02:45 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 1 found Loading history... Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 4 found Loading history...
72			*
73			* @return DomSelector
74			*/
75			public function selector(string $sPath = '', $xContext = null): DomSelector
76			{
77			$xSelector = new DomSelector($sPath, $xContext);
78			if($this->bCommand && $this->response() !== null)
79			{
80			$this->addCommand('jquery', ['selector' => $xSelector]);
81			}
82			// Reset the command value.
83			$this->bCommand = true;
84			return $xSelector;
85			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 0 found Loading history...
86			}
87

jaxon-php / jaxon-core

Push — v5.x ( 8eee51...080647 )

JQueryPlugin::selector() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like