Parameter::getJsCall() - Code Metrics - Inspection of "Separated long functions into shorter ones." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/code_improvement ( 374d0e...1b7fb9 )

by Thierry

created 2019-12-03 07:07 UTC

Parameter::getJsCall() A

↳ Parent: Parameter

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	2
dl	0
loc	4
rs	10
c	0
b	0
f	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\Factory;

class Parameter implements Contracts\Parameter

{
    /*
     * 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 boolean 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 boolean 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 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;

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

     * @param mixed         $xValue                 The parameter value

     */
    public function __construct($sType, $xValue)
    {
        $this->sType = $sType;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xValue = $xValue;
    }

    /**
     * Get the parameter type
     *
     * @return string
     */
    public function getType()
    {
        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;
    }

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

     *
     * @return Parameter
     */
    public static function make($xValue)
    {
        if($xValue instanceof Contracts\Parameter)
        {
            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(is_array($xValue) || is_object($xValue))
        {
            return new Parameter(self::JS_VALUE, $xValue);
        }
    }

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

     *
     * @return string
     */
    private function getQuotedValue($xValue)
    {
        $sQuoteCharacter = "'";
        return $sQuoteCharacter . $xValue . $sQuoteCharacter;
    }

    /**
     * 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 getJsCall($sFunction, $sParameter)
    {
        return 'jaxon.' . $sFunction . '(' . $this->getQuotedValue($sParameter) . ')';
    }

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

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

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

    /**
     * Get the script for the innerHTML value of the element.
     *
     * @return string
     */
    protected function getElementInnerHTMLScript()
    {
        return $this->getJsCall('$', $this->xValue) . '.innerHTML';
    }

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

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

    /**
     * Get the script for a numeric, non-quoted value.
     *
     * @return string
     */
    protected function getNumericValueScript()
    {
        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()
    {
        if(is_array($this->xValue) || is_object($this->xValue))
        {
            // 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));
        }
        return (string)$this->xValue;
    }

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

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

    /**
     * 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()
    {
        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\Factory;
15
16			class Parameter implements Contracts\Parameter
			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...
17			{
18			/*
19			* Request parameters
20			*/
			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...
21			// Specifies that the parameter will consist of an array of form values.
22			const FORM_VALUES = 'FormValues';
23			// Specifies that the parameter will contain the value of an input control.
24			const INPUT_VALUE = 'InputValue';
25			// Specifies that the parameter will consist of a boolean value of a checkbox.
26			const CHECKED_VALUE = 'CheckedValue';
27			// Specifies that the parameter value will be the innerHTML value of the element.
28			const ELEMENT_INNERHTML = 'ElementInnerHTML';
29			// Specifies that the parameter will be a quoted value (string).
30			const QUOTED_VALUE = 'QuotedValue';
31			// Specifies that the parameter will be a boolean value (true or false).
32			const BOOL_VALUE = 'BoolValue';
33			// Specifies that the parameter will be a numeric, non-quoted value.
34			const NUMERIC_VALUE = 'NumericValue';
35			// Specifies that the parameter will be a non-quoted value
36			// (evaluated by the browsers javascript engine at run time).
37			const JS_VALUE = 'UnquotedValue';
38			// Specifies that the parameter will be an integer used to generate pagination links.
39			const PAGE_NUMBER = 'PageNumber';
40
41			/**
42			* The parameter type
43			*
44			* @var string
45			*/
46			protected $sType;
47
48			/**
49			* The parameter value
50			*
51			* @var mixed
52			*/
53			protected $xValue;
54
55			/**
56			* The constructor.
57			*
58			* @param string $sType The parameter type
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 8 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter name; 18 found Loading history...
59			* @param mixed $xValue The parameter value
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 9 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 17 found Loading history...
60			*/
61			public function __construct($sType, $xValue)
62			{
63			$this->sType = $sType;
			1 ignored issue – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 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...
64			$this->xValue = $xValue;
65			}
66
67			/**
68			* Get the parameter type
69			*
70			* @return string
71			*/
72			public function getType()
73			{
74			return $this->sType;
75			}
76
77			/**
78			* Get the parameter value
79			*
80			* @return mixed
81			*/
82			public function getValue()
83			{
84			return $this->xValue;
85			}
86
87			/**
88			* Set the parameter value
89			*
90			* @param mixed $xValue The parameter value
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 9 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 17 found Loading history...
91			*
92			* @return void
93			*/
94			public function setValue($xValue)
95			{
96			$this->xValue = $xValue;
97			}
98
99			/**
100			* Create a Parameter instance using the given value
101			*
102			* @param mixed $xValue The parameter value
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 9 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 17 found Loading history...
103			*
104			* @return Parameter
105			*/
106			public static function make($xValue)
107			{
108			if($xValue instanceof Contracts\Parameter)
109			{
110			return $xValue;
111			}
112			if(is_numeric($xValue))
113			{
114			return new Parameter(self::NUMERIC_VALUE, $xValue);
115			}
116			if(is_string($xValue))
117			{
118			return new Parameter(self::QUOTED_VALUE, $xValue);
119			}
120			if(is_bool($xValue))
121			{
122			return new Parameter(self::BOOL_VALUE, $xValue);
123			}
124			// if(is_array($xValue) \|\| is_object($xValue))
125			{
126			return new Parameter(self::JS_VALUE, $xValue);
127			}
128			}
129
130			/**
131			* Add quotes to a given value
132			*
133			* @param string $xValue The value to be quoted
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 4 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 5 found Loading history...
134			*
135			* @return string
136			*/
137			private function getQuotedValue($xValue)
138			{
139			$sQuoteCharacter = "'";
140			return $sQuoteCharacter . $xValue . $sQuoteCharacter;
141			}
142
143			/**
144			* Get a js call to Jaxon with a single parameter
145			*
146			* @param string $sFunction The function name
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 4 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter name; 6 found Loading history...
147			* @param string $sParameter The function parameter
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 4 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 5 found Loading history...
148			*
149			* @return string
150			*/
151			private function getJsCall($sFunction, $sParameter)
152			{
153			return 'jaxon.' . $sFunction . '(' . $this->getQuotedValue($sParameter) . ')';
154			}
155
156			/**
157			* Get the script for an array of form values.
158			*
159			* @return string
160			*/
161			protected function getFormValuesScript()
162			{
163			return $this->getJsCall('getFormValues', $this->xValue);
164			}
165
166			/**
167			* Get the script for an input control.
168			*
169			* @return string
170			*/
171			protected function getInputValueScript()
172			{
173			return $this->getJsCall('$', $this->xValue) . '.value';
174			}
175
176			/**
177			* Get the script for a boolean value of a checkbox.
178			*
179			* @return string
180			*/
181			protected function getCheckedValueScript()
182			{
183			return $this->getJsCall('$', $this->xValue) . '.checked';
184			}
185
186			/**
187			* Get the script for the innerHTML value of the element.
188			*
189			* @return string
190			*/
191			protected function getElementInnerHTMLScript()
192			{
193			return $this->getJsCall('$', $this->xValue) . '.innerHTML';
194			}
195
196			/**
197			* Get the script for a quoted value (string).
198			*
199			* @return string
200			*/
201			protected function getQuotedValueScript()
202			{
203			return $this->getQuotedValue(addslashes($this->xValue));
204			}
205
206			/**
207			* Get the script for a boolean value (true or false).
208			*
209			* @return string
210			*/
211			protected function getBoolValueScript()
212			{
213			return ($this->xValue) ? 'true' : 'false';
214			}
215
216			/**
217			* Get the script for a numeric, non-quoted value.
218			*
219			* @return string
220			*/
221			protected function getNumericValueScript()
222			{
223			return (string)$this->xValue;
224			}
225
226			/**
227			* Get the script for a non-quoted value (evaluated by the browsers javascript engine at run time).
228			*
229			* @return string
230			*/
231			protected function getUnquotedValueScript()
232			{
233			if(is_array($this->xValue) \|\| is_object($this->xValue))
234			{
235			// Unable to use double quotes here because they cannot be handled on client side.
236			// So we are using simple quotes even if the Json standard recommends double quotes.
237			return str_replace('"', "'", json_encode($this->xValue, JSON_HEX_APOS \| JSON_HEX_QUOT));
238			}
239			return (string)$this->xValue;
240			}
241
242			/**
243			* Get the script for an integer used to generate pagination links.
244			*
245			* @return string
246			*/
247			protected function getPageNumberScript()
248			{
249			return (string)$this->xValue;
250			}
251
252			/**
253			* Generate the javascript code.
254			*
255			* @return string
256			*/
257			public function getScript()
258			{
259			$sMethodName = 'get' . $this->sType . 'Script';
260			if(!\method_exists($this, $sMethodName))
261			{
262			return '';
263			}
264			return $this->$sMethodName();
265			}
266
267			/**
268			* Magic function to generate the jQuery call.
269			*
270			* @return string
271			*/
272			public function __toString()
273			{
274			return $this->getScript();
275			}
276
277			/**
278			* Generate the jQuery call, when converting the response into json.
279			*
280			* This is a method of the JsonSerializable interface.
281			*
282			* @return string
283			*/
284			public function jsonSerialize()
285			{
286			return $this->getScript();
287			}
288			}
289

jaxon-php / jaxon-core

Push — feature/code_improvement ( 374d0e...1b7fb9 )

Parameter::getJsCall() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like