DomSelector::cb() - Code Metrics - Inspection of "Detect when a call to the jQuery plugin is a callb..." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 661f96...723415 )

by Thierry

created 2023-11-20 20:46 UTC

DomSelector::cb() A

↳ Parent: DomSelector

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * DomSelector.php - A jQuery selector
 *
 * This class is used to create client side requests to the Jaxon functions and callable objects.
 *
 * When inserted into a Jaxon response, a DomSelector object must be converted to the corresponding jQuery code.
 * Therefore, the DomSelector class implements the JsonSerializable interface.
 *
 * When used as a parameter of a Jaxon call, the DomSelector must be converted to Jaxon request parameter.
 * Therefore, the DomSelector class also implements the Jaxon\Request\Call\ParameterInterface interface.
 *
 * @package jaxon-jquery

 * @author Thierry Feuzeu <[email protected]>
 * @copyright 2016 Thierry Feuzeu <[email protected]>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-jquery
 */


namespace Jaxon\Plugin\Response\JQuery;

use Jaxon\Plugin\Response\JQuery\Call\AttrGet;
use Jaxon\Plugin\Response\JQuery\Call\AttrSet;
use Jaxon\Plugin\Response\JQuery\Call\Method;
use Jaxon\Request\Call\JsCall;
use Jaxon\Request\Call\ParameterInterface;

use JsonSerializable;

use function count;
use function implode;
use function is_a;
use function trim;

class DomSelector implements JsonSerializable, ParameterInterface

{
    /**
     * The jQuery selector path
     *
     * @var string
     */
    protected $sPath;


    /**
     * The actions to be applied on the selected element
     *
     * @var array
     */
    protected $aCalls;

    /**
     * Convert the selector value to integer
     *
     * @var bool

     */
    protected $bToInt = false;

    /**
     * True if this selector is a callback
     *
     * @var bool|null

     */
    protected $bIsCallback = null;

    /**
     * The constructor.
     *
     * @param string $jQueryNs    The jQuery symbol

     * @param string $sPath    The jQuery selector path
     * @param mixed $xContext    A context associated to the selector

     */
    public function __construct(string $jQueryNs, string $sPath, $xContext)

    {
        $sPath = trim($sPath, " \t");
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->aCalls = [];
        $this->sPath = $this->getPath($jQueryNs, $sPath, $xContext);
    }


    /**
     * Get the selector js.
     *
     * @param string $jQueryNs    The jQuery symbol

     * @param string $sPath    The jQuery selector path
     * @param mixed $xContext    A context associated to the selector

     */

    private function getPath(string $jQueryNs, string $sPath, $xContext)
    {
        if(!$sPath)
        {
            // If an empty selector is given, use the event target instead
            return "$jQueryNs(e.currentTarget)";
        }
        if(!$xContext)
        {
            return "$jQueryNs('" . $sPath . "')";
        }
        $sContext = is_a($xContext, self::class) ?

            $xContext->getScript() : "$jQueryNs('" . trim("$xContext") . "')";
        return "$jQueryNs('$sPath', $sContext)";
    }


    /**
     * Add a call to a jQuery method on the selected elements
     *
     * @param string  $sMethod

     * @param array  $aArguments

     *
     * @return DomSelector
     */
    public function __call(string $sMethod, array $aArguments)
    {
        if(count($aArguments) === 1)
        {
            // If the only parameter is a selector, and the first call
            // on that selector is a method, then the selector is a callback.
            $xArgument = $aArguments[0];
            if(is_a($xArgument, self::class) && $xArgument->bIsCallback === null &&
                count($xArgument->aCalls) > 0 && is_a($xArgument->aCalls[0], JsCall::class))
            {
                $xArgument->bIsCallback = true;
            }
        }
        // Push the action into the array
        $this->aCalls[] = new Method($sMethod, $aArguments);
        // Return $this so the calls can be chained
        return $this;
    }


    /**
     * Get the value of an attribute on the first selected element
     *
     * @param string  $sAttribute

     *
     * @return DomSelector
     */
    public function __get(string $sAttribute)
    {
        // Push the action into the array
        $this->aCalls[] = new AttrGet($sAttribute);
        // Return $this so the calls can be chained
        return $this;
    }


    /**
     * Set the value of an attribute on the first selected element
     *
     * @param string $sAttribute

     * @param $xValue

     *
     * @return void
     */
    public function __set(string $sAttribute, $xValue)
    {
        // Push the action into the array
        $this->aCalls[] = new AttrSet($sAttribute, $xValue);
        // No other call is allowed after a set
        // return $this;
    }


    /**
     * Explicitely declare the selector as a callback.
     *
     * @param bool $bIsCallback

     *
     * @return DomSelector
     */
    public function cb(bool $bIsCallback = true): DomSelector
    {
        $this->bIsCallback = $bIsCallback;
        return $this;
    }


    /**
     * @return DomSelector
     */
    public function toInt(): DomSelector
    {
        $this->bToInt = true;
        return $this;
    }


    /**
     * Generate the jQuery call.
     *
     * @return string
     */
    public function getScript(): string
    {
        $sScript = $this->sPath;
        if(count($this->aCalls) > 0)
        {
            $sScript .= '.' . implode('.', $this->aCalls);
        }
        return $this->bIsCallback ? '(e) => {' . $sScript . '}' :

            ($this->bToInt ? "parseInt($sScript)" : $sScript);
    }


    /**
     * Magic function to generate the jQuery call.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getScript();
    }


    /**
     * Generate the jQuery call, when converting the response into json.
     *
     * This is a method of the JsonSerializable interface.
     *
     * @return string
     */
    public function jsonSerialize(): string
    {
        return $this->getScript();
    }

}


1			<?php
2
3			/**
4			* DomSelector.php - A jQuery selector
5			*
6			* This class is used to create client side requests to the Jaxon functions and callable objects.
7			*
8			* When inserted into a Jaxon response, a DomSelector object must be converted to the corresponding jQuery code.
9			* Therefore, the DomSelector class implements the JsonSerializable interface.
10			*
11			* When used as a parameter of a Jaxon call, the DomSelector must be converted to Jaxon request parameter.
12			* Therefore, the DomSelector class also implements the Jaxon\Request\Call\ParameterInterface interface.
13			*
14			* @package jaxon-jquery
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Package name "jaxon-jquery" is not valid; consider "Jaxonjquery" instead Loading history...
15			* @author Thierry Feuzeu <[email protected]>
16			* @copyright 2016 Thierry Feuzeu <[email protected]>
17			* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
18			* @link https://github.com/jaxon-php/jaxon-jquery
19			*/
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history...
20
21			namespace Jaxon\Plugin\Response\JQuery;
22
23			use Jaxon\Plugin\Response\JQuery\Call\AttrGet;
24			use Jaxon\Plugin\Response\JQuery\Call\AttrSet;
25			use Jaxon\Plugin\Response\JQuery\Call\Method;
26			use Jaxon\Request\Call\JsCall;
27			use Jaxon\Request\Call\ParameterInterface;
28
29			use JsonSerializable;
30
31			use function count;
32			use function implode;
33			use function is_a;
34			use function trim;
35
36			class DomSelector implements JsonSerializable, ParameterInterface
			0 ignored issues – show Coding Style introduced 2022-03-14 23:14 UTC by Report Bug Copy Issue Report Missing doc comment for class DomSelector Loading history...
37			{
38			/**
39			* The jQuery selector path
40			*
41			* @var string
42			*/
43			protected $sPath;
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 blank line(s) before first member var; 0 found Loading history...
44
45			/**
46			* The actions to be applied on the selected element
47			*
48			* @var array
49			*/
50			protected $aCalls;
51
52			/**
53			* Convert the selector value to integer
54			*
55			* @var bool
			0 ignored issues – show Bug introduced 2022-07-12 22:53 UTC by Report Bug Copy Issue Report Expected "boolean" but found "bool" for @var tag in member variable comment Loading history...
56			*/
57			protected $bToInt = false;
58
59			/**
60			* True if this selector is a callback
61			*
62			* @var bool\|null
			0 ignored issues – show Bug introduced 2023-11-20 20:48 UTC by Report Bug Copy Issue Report Expected "boolean\|null" but found "bool\|null" for @var tag in member variable comment Loading history...
63			*/
64			protected $bIsCallback = null;
65
66			/**
67			* The constructor.
68			*
69			* @param string $jQueryNs The jQuery symbol
			0 ignored issues – show Coding Style introduced 2022-03-14 23:14 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 4 found Loading history...
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-14 23:14 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 4 found Loading history...
72			*/
73			public function __construct(string $jQueryNs, string $sPath, $xContext)
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 blank lines before function; 1 found Loading history...
74			{
75			$sPath = trim($sPath, " \t");
			0 ignored issues – show Coding Style introduced 2023-10-04 02:45 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...
76			$this->aCalls = [];
77			$this->sPath = $this->getPath($jQueryNs, $sPath, $xContext);
78			}
			0 ignored issues – show Coding Style introduced 2023-10-04 02:45 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
79
80			/**
81			* Get the selector js.
82			*
83			* @param string $jQueryNs The jQuery symbol
			0 ignored issues – show Coding Style introduced 2023-10-04 02:45 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 4 found Loading history...
84			* @param string $sPath The jQuery selector path
85			* @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...
86			*/
			0 ignored issues – show Coding Style introduced 2023-10-04 02:45 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
87			private function getPath(string $jQueryNs, string $sPath, $xContext)
88			{
89			if(!$sPath)
90			{
91			// If an empty selector is given, use the event target instead
92			return "$jQueryNs(e.currentTarget)";
93			}
94			if(!$xContext)
95			{
96			return "$jQueryNs('" . $sPath . "')";
97			}
98			$sContext = is_a($xContext, self::class) ?
			0 ignored issues – show Coding Style introduced 2023-10-04 02:45 UTC by Report Bug Copy Issue Report Expected 1 space after "?"; newline found Loading history...
99			$xContext->getScript() : "$jQueryNs('" . trim("$xContext") . "')";
100			return "$jQueryNs('$sPath', $sContext)";
101			}
			0 ignored issues – show Coding Style introduced 2023-10-04 02:45 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
102
103			/**
104			* Add a call to a jQuery method on the selected elements
105			*
106			* @param string $sMethod
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 2 found Loading history...
107			* @param array $aArguments
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
108			*
109			* @return DomSelector
110			*/
111			public function __call(string $sMethod, array $aArguments)
112			{
113			if(count($aArguments) === 1)
114			{
115			// If the only parameter is a selector, and the first call
116			// on that selector is a method, then the selector is a callback.
117			$xArgument = $aArguments[0];
118			if(is_a($xArgument, self::class) && $xArgument->bIsCallback === null &&
119			count($xArgument->aCalls) > 0 && is_a($xArgument->aCalls[0], JsCall::class))
120			{
121			$xArgument->bIsCallback = true;
122			}
123			}
124			// Push the action into the array
125			$this->aCalls[] = new Method($sMethod, $aArguments);
126			// Return $this so the calls can be chained
127			return $this;
128			}
			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...
129
130			/**
131			* Get the value of an attribute on the first selected element
132			*
133			* @param string $sAttribute
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 2 found Loading history...
134			*
135			* @return DomSelector
136			*/
137			public function __get(string $sAttribute)
138			{
139			// Push the action into the array
140			$this->aCalls[] = new AttrGet($sAttribute);
141			// Return $this so the calls can be chained
142			return $this;
143			}
			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...
144
145			/**
146			* Set the value of an attribute on the first selected element
147			*
148			* @param string $sAttribute
			0 ignored issues – show Coding Style introduced 2022-03-14 23:14 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
149			* @param $xValue
			0 ignored issues – show Coding Style introduced 2022-03-14 23:14 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
150			*
151			* @return void
152			*/
153			public function __set(string $sAttribute, $xValue)
154			{
155			// Push the action into the array
156			$this->aCalls[] = new AttrSet($sAttribute, $xValue);
157			// No other call is allowed after a set
158			// return $this;
159			}
			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...
160
161			/**
162			* Explicitely declare the selector as a callback.
163			*
164			* @param bool $bIsCallback
			0 ignored issues – show Coding Style introduced 2023-11-20 20:48 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
165			*
166			* @return DomSelector
167			*/
168			public function cb(bool $bIsCallback = true): DomSelector
169			{
170			$this->bIsCallback = $bIsCallback;
171			return $this;
172			}
			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...
173
174			/**
175			* @return DomSelector
176			*/
177			public function toInt(): DomSelector
178			{
179			$this->bToInt = true;
180			return $this;
181			}
			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...
182
183			/**
184			* Generate the jQuery call.
185			*
186			* @return string
187			*/
188			public function getScript(): string
189			{
190			$sScript = $this->sPath;
191			if(count($this->aCalls) > 0)
192			{
193			$sScript .= '.' . implode('.', $this->aCalls);
194			}
195			return $this->bIsCallback ? '(e) => {' . $sScript . '}' :
			0 ignored issues – show Coding Style introduced 2023-11-20 20:48 UTC by Report Bug Copy Issue Report Expected 1 space after ":"; newline found Loading history...
196			($this->bToInt ? "parseInt($sScript)" : $sScript);
197			}
			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...
198
199			/**
200			* Magic function to generate the jQuery call.
201			*
202			* @return string
203			*/
204			public function __toString()
205			{
206			return $this->getScript();
207			}
			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...
208
209			/**
210			* Generate the jQuery call, when converting the response into json.
211			*
212			* This is a method of the JsonSerializable interface.
213			*
214			* @return string
215			*/
216			public function jsonSerialize(): string
217			{
218			return $this->getScript();
219			}
			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...
220			}
221

jaxon-php / jaxon-core

Push — main ( 661f96...723415 )

DomSelector::cb() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like