Parameter::getCheckedValueScript() - Code Metrics - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Parameter::getCheckedValueScript() A
last analyzed 2024-06-20 23:09 UTC

↳ Parent: Parameter

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/**
 * Parameter.php - A parameter of a Jaxon request
 *
 * This class is used to create client side requests to the Jaxon functions and callable objects.
 *
 * @package jaxon-core

 * @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-core
 */


namespace Jaxon\Request\Call;

use function is_array;
use function is_bool;
use function is_numeric;
use function is_object;
use function is_string;
use function json_encode;
use function method_exists;
use function str_replace;

class Parameter implements ParameterInterface

{
    /*
     * Request parameters
     */

    // Specifies that the parameter will consist of an array of form values.
    const FORM_VALUES = 'FormValues';
    // Specifies that the parameter will contain the value of an input control.
    const INPUT_VALUE = 'InputValue';
    // Specifies that the parameter will consist of a bool value of a checkbox.
    const CHECKED_VALUE = 'CheckedValue';
    // Specifies that the parameter value will be the innerHTML value of the element.
    const ELEMENT_INNERHTML = 'ElementInnerHTML';
    // Specifies that the parameter will be a quoted value (string).
    const QUOTED_VALUE = 'QuotedValue';
    // Specifies that the parameter will be a bool value (true or false).
    const BOOL_VALUE = 'BoolValue';
    // Specifies that the parameter will be a numeric, non-quoted value.
    const NUMERIC_VALUE = 'NumericValue';
    // Specifies that the parameter will be a non-quoted value
    // (evaluated by the browsers javascript engine at run time).
    const JS_VALUE = 'UnquotedValue';
    // Specifies that the parameter is a call to a javascript function
    const JS_CALL = 'JsCall';
    // Specifies that the parameter must be json encoded
    const JSON_VALUE = 'JsonValue';
    // Specifies that the parameter will be an integer used to generate pagination links.
    const PAGE_NUMBER = 'PageNumber';

    /**
     * The parameter type
     *
     * @var string
     */
    protected $sType;

    /**
     * The parameter value
     *
     * @var mixed
     */
    protected $xValue;

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

     */
    protected $bToInt = false;

    /**
     * The constructor.
     *
     * @param string $sType    The parameter type

     * @param mixed $xValue    The parameter value

     */
    public function __construct(string $sType, $xValue)

    {
        $this->sType = $sType;
        $this->xValue = $xValue;
    }


    /**
     * Get the parameter type
     *
     * @return string
     */
    public function getType(): string
    {
        return $this->sType;
    }


    /**
     * Get the parameter value
     *
     * @return mixed
     */
    public function getValue()
    {
        return $this->xValue;
    }


    /**
     * Set the parameter value
     *
     * @param mixed $xValue    The parameter value

     *
     * @return void
     */
    public function setValue($xValue)
    {
        $this->xValue = $xValue;
    }


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


    /**
     * Create a Parameter instance using the given value
     *
     * @param mixed $xValue    The parameter value

     *
     * @return ParameterInterface
     */
    public static function make($xValue): ParameterInterface
    {
        if($xValue instanceof ParameterInterface)
        {
            return $xValue;
        }
        if(is_numeric($xValue))
        {
            return new Parameter(self::NUMERIC_VALUE, $xValue);
        }
        if(is_string($xValue))
        {
            return new Parameter(self::QUOTED_VALUE, $xValue);
        }
        if(is_bool($xValue))
        {
            return new Parameter(self::BOOL_VALUE, $xValue);
        }
        if($xValue instanceof JsCall)
        {
            return new Parameter(self::JS_CALL, $xValue);
        }
        // if(is_array($xValue) || is_object($xValue))
        {
            return new Parameter(self::JSON_VALUE, $xValue);
        }
    }


    /**
     * Add quotes to a given value
     *
     * @param string $sValue    The value to be quoted

     *
     * @return string
     */
    private function getQuotedValue(string $sValue): string
    {
        return "'" . $sValue . "'";
    }


    /**
     * Get a js call to Jaxon with a single parameter
     *
     * @param string $sFunction    The function name

     * @param string $sParameter    The function parameter

     *
     * @return string
     */
    private function getJaxonCall(string $sFunction, string $sParameter): string
    {
        return 'jaxon.' . $sFunction . '(' . $this->getQuotedValue($sParameter) . ')';
    }


    /**
     * Get the script for an array of form values.
     *
     * @return string
     */
    protected function getFormValuesScript(): string
    {
        return $this->getJaxonCall('getFormValues', $this->xValue);
    }


    /**
     * Get the script for an input control.
     *
     * @return string
     */
    protected function getInputValueScript(): string
    {
        return $this->getJaxonCall('$', $this->xValue) . '.value';
    }


    /**
     * Get the script for a bool value of a checkbox.
     *
     * @return string
     */
    protected function getCheckedValueScript(): string
    {
        return $this->getJaxonCall('$', $this->xValue) . '.checked';
    }


    /**
     * Get the script for the innerHTML value of the element.
     *
     * @return string
     */
    protected function getElementInnerHTMLScript(): string

    {
        return $this->getJaxonCall('$', $this->xValue) . '.innerHTML';
    }


    /**
     * Get the script for a quoted value (string).
     *
     * @return string
     */
    protected function getQuotedValueScript(): string
    {
        return $this->getQuotedValue(addslashes($this->xValue));
    }


    /**
     * Get the script for a bool value (true or false).
     *
     * @return string
     */
    protected function getBoolValueScript(): string
    {
        return ($this->xValue) ? 'true' : 'false';
    }


    /**
     * Get the script for a numeric, non-quoted value.
     *
     * @return string
     */
    protected function getNumericValueScript(): string
    {
        return (string)$this->xValue;
    }


    /**
     * Get the script for a non-quoted value (evaluated by the browsers javascript engine at run time).
     *
     * @return string
     */
    protected function getUnquotedValueScript(): string
    {
        return (string)$this->xValue;
    }


    /**
     * Get the script for a non-quoted value (evaluated by the browsers javascript engine at run time).
     *
     * @return string
     */
    protected function getJsonValueScript(): string
    {
        // Unable to use double quotes here because they cannot be handled on client side.
        // So we are using simple quotes even if the Json standard recommends double quotes.
        return str_replace('"', "'", json_encode($this->xValue, JSON_HEX_APOS | JSON_HEX_QUOT));
    }


    /**
     * Get the script for an integer used to generate pagination links.
     *
     * @return string
     */
    protected function getPageNumberScript(): string
    {
        return (string)$this->xValue;
    }


    /**
     * Get the script for a call to a javascript function.
     *
     * @return string
     */
    protected function getJsCallScript(): string
    {
        return '(e) => {' . $this->xValue->getScript() . ';}';
    }


    /**
     * Generate the javascript code.
     *
     * @return string
     */
    public function getScript(): string
    {
        $sMethodName = 'get' . $this->sType . 'Script';
        if(!method_exists($this, $sMethodName))
        {
            return '';
        }
        $sScript = $this->$sMethodName();
        return $this->bToInt ? "parseInt($sScript)" : $sScript;
    }


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

}


1			<?php
2
3			/**
4			* Parameter.php - A parameter of a Jaxon request
5			*
6			* This class is used to create client side requests to the Jaxon functions and callable objects.
7			*
8			* @package jaxon-core
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Package name "jaxon-core" is not valid; consider "Jaxoncore" instead Loading history...
9			* @copyright 2016 Thierry Feuzeu <[email protected]>
10			* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
11			* @link https://github.com/jaxon-php/jaxon-core
12			*/
			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... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history...
13
14			namespace Jaxon\Request\Call;
15
16			use function is_array;
17			use function is_bool;
18			use function is_numeric;
19			use function is_object;
20			use function is_string;
21			use function json_encode;
22			use function method_exists;
23			use function str_replace;
24
25			class Parameter implements ParameterInterface
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Missing doc comment for class Parameter Loading history...
26			{
27			/*
28			* Request parameters
29			*/
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Empty line required after block comment Loading history...
30			// Specifies that the parameter will consist of an array of form values.
31			const FORM_VALUES = 'FormValues';
32			// Specifies that the parameter will contain the value of an input control.
33			const INPUT_VALUE = 'InputValue';
34			// Specifies that the parameter will consist of a bool value of a checkbox.
35			const CHECKED_VALUE = 'CheckedValue';
36			// Specifies that the parameter value will be the innerHTML value of the element.
37			const ELEMENT_INNERHTML = 'ElementInnerHTML';
38			// Specifies that the parameter will be a quoted value (string).
39			const QUOTED_VALUE = 'QuotedValue';
40			// Specifies that the parameter will be a bool value (true or false).
41			const BOOL_VALUE = 'BoolValue';
42			// Specifies that the parameter will be a numeric, non-quoted value.
43			const NUMERIC_VALUE = 'NumericValue';
44			// Specifies that the parameter will be a non-quoted value
45			// (evaluated by the browsers javascript engine at run time).
46			const JS_VALUE = 'UnquotedValue';
47			// Specifies that the parameter is a call to a javascript function
48			const JS_CALL = 'JsCall';
49			// Specifies that the parameter must be json encoded
50			const JSON_VALUE = 'JsonValue';
51			// Specifies that the parameter will be an integer used to generate pagination links.
52			const PAGE_NUMBER = 'PageNumber';
53
54			/**
55			* The parameter type
56			*
57			* @var string
58			*/
59			protected $sType;
60
61			/**
62			* The parameter value
63			*
64			* @var mixed
65			*/
66			protected $xValue;
67
68			/**
69			* Convert the parameter value to integer
70			*
71			* @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...
72			*/
73			protected $bToInt = false;
74
75			/**
76			* The constructor.
77			*
78			* @param string $sType The parameter type
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter name; 4 found Loading history...
79			* @param mixed $xValue The parameter value
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 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...
80			*/
81			public function __construct(string $sType, $xValue)
			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...
82			{
83			$this->sType = $sType;
84			$this->xValue = $xValue;
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; 1 found Loading history...
86
87			/**
88			* Get the parameter type
89			*
90			* @return string
91			*/
92			public function getType(): string
93			{
94			return $this->sType;
95			}
			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...
96
97			/**
98			* Get the parameter value
99			*
100			* @return mixed
101			*/
102			public function getValue()
103			{
104			return $this->xValue;
105			}
			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...
106
107			/**
108			* Set the parameter value
109			*
110			* @param mixed $xValue The parameter value
			0 ignored issues – show 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...
111			*
112			* @return void
113			*/
114			public function setValue($xValue)
115			{
116			$this->xValue = $xValue;
117			}
			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...
118
119			/**
120			* @return ParameterInterface
121			*/
122			public function toInt(): ParameterInterface
123			{
124			$this->bToInt = true;
125			return $this;
126			}
			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...
127
128			/**
129			* Create a Parameter instance using the given value
130			*
131			* @param mixed $xValue The parameter value
			0 ignored issues – show 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...
132			*
133			* @return ParameterInterface
134			*/
135			public static function make($xValue): ParameterInterface
136			{
137			if($xValue instanceof ParameterInterface)
138			{
139			return $xValue;
140			}
141			if(is_numeric($xValue))
142			{
143			return new Parameter(self::NUMERIC_VALUE, $xValue);
144			}
145			if(is_string($xValue))
146			{
147			return new Parameter(self::QUOTED_VALUE, $xValue);
148			}
149			if(is_bool($xValue))
150			{
151			return new Parameter(self::BOOL_VALUE, $xValue);
152			}
153			if($xValue instanceof JsCall)
154			{
155			return new Parameter(self::JS_CALL, $xValue);
156			}
157			// if(is_array($xValue) \|\| is_object($xValue))
158			{
159			return new Parameter(self::JSON_VALUE, $xValue);
160			}
161			}
			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...
162
163			/**
164			* Add quotes to a given value
165			*
166			* @param string $sValue The value to be quoted
			0 ignored issues – show 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...
167			*
168			* @return string
169			*/
170			private function getQuotedValue(string $sValue): string
171			{
172			return "'" . $sValue . "'";
173			}
			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...
174
175			/**
176			* Get a js call to Jaxon with a single parameter
177			*
178			* @param string $sFunction The function name
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter name; 4 found Loading history...
179			* @param string $sParameter The function parameter
			0 ignored issues – show 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...
180			*
181			* @return string
182			*/
183			private function getJaxonCall(string $sFunction, string $sParameter): string
184			{
185			return 'jaxon.' . $sFunction . '(' . $this->getQuotedValue($sParameter) . ')';
186			}
			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...
187
188			/**
189			* Get the script for an array of form values.
190			*
191			* @return string
192			*/
193			protected function getFormValuesScript(): string
194			{
195			return $this->getJaxonCall('getFormValues', $this->xValue);
196			}
			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...
197
198			/**
199			* Get the script for an input control.
200			*
201			* @return string
202			*/
203			protected function getInputValueScript(): string
204			{
205			return $this->getJaxonCall('$', $this->xValue) . '.value';
206			}
			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...
207
208			/**
209			* Get the script for a bool value of a checkbox.
210			*
211			* @return string
212			*/
213			protected function getCheckedValueScript(): string
214			{
215			return $this->getJaxonCall('$', $this->xValue) . '.checked';
216			}
			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...
217
218			/**
219			* Get the script for the innerHTML value of the element.
220			*
221			* @return string
222			*/
223			protected function getElementInnerHTMLScript(): string
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report This method is not in camel caps format. This check looks for method names that are not written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection seeker becomes `databaseConnectionSeeker`. Loading history...
224			{
225			return $this->getJaxonCall('$', $this->xValue) . '.innerHTML';
226			}
			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...
227
228			/**
229			* Get the script for a quoted value (string).
230			*
231			* @return string
232			*/
233			protected function getQuotedValueScript(): string
234			{
235			return $this->getQuotedValue(addslashes($this->xValue));
236			}
			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...
237
238			/**
239			* Get the script for a bool value (true or false).
240			*
241			* @return string
242			*/
243			protected function getBoolValueScript(): string
244			{
245			return ($this->xValue) ? 'true' : 'false';
246			}
			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...
247
248			/**
249			* Get the script for a numeric, non-quoted value.
250			*
251			* @return string
252			*/
253			protected function getNumericValueScript(): string
254			{
255			return (string)$this->xValue;
256			}
			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...
257
258			/**
259			* Get the script for a non-quoted value (evaluated by the browsers javascript engine at run time).
260			*
261			* @return string
262			*/
263			protected function getUnquotedValueScript(): string
264			{
265			return (string)$this->xValue;
266			}
			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...
267
268			/**
269			* Get the script for a non-quoted value (evaluated by the browsers javascript engine at run time).
270			*
271			* @return string
272			*/
273			protected function getJsonValueScript(): string
274			{
275			// Unable to use double quotes here because they cannot be handled on client side.
276			// So we are using simple quotes even if the Json standard recommends double quotes.
277			return str_replace('"', "'", json_encode($this->xValue, JSON_HEX_APOS \| JSON_HEX_QUOT));
278			}
			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...
279
280			/**
281			* Get the script for an integer used to generate pagination links.
282			*
283			* @return string
284			*/
285			protected function getPageNumberScript(): string
286			{
287			return (string)$this->xValue;
288			}
			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...
289
290			/**
291			* Get the script for a call to a javascript function.
292			*
293			* @return string
294			*/
295			protected function getJsCallScript(): string
296			{
297			return '(e) => {' . $this->xValue->getScript() . ';}';
298			}
			0 ignored issues – show Coding Style introduced 2022-07-12 22:53 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
299
300			/**
301			* Generate the javascript code.
302			*
303			* @return string
304			*/
305			public function getScript(): string
306			{
307			$sMethodName = 'get' . $this->sType . 'Script';
308			if(!method_exists($this, $sMethodName))
309			{
310			return '';
311			}
312			$sScript = $this->$sMethodName();
313			return $this->bToInt ? "parseInt($sScript)" : $sScript;
314			}
			0 ignored issues – show Coding Style introduced 2023-11-20 05:45 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
315
316			/**
317			* Magic function to generate the jQuery call.
318			*
319			* @return string
320			*/
321			public function __toString()
322			{
323			return $this->getScript();
324			}
			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...
325			}
326

jaxon-php / jaxon-core

Parameter::getCheckedValueScript() A last analyzed 2024-06-20 23:09 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Parameter::getCheckedValueScript() A
last analyzed 2024-06-20 23:09 UTC