Parameter::__toString() - Code Metrics - Inspection of "New response plugin for pagination." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v5.x ( 26d105...7911f3 )

by Thierry

created 2024-02-24 16:46 UTC

Parameter::__toString() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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;

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


    /**
     * Convert to a value to be inserted in an array for json conversion
     *
     * @return mixed
     */
    public function forArray()
    {
        switch($this->getType())
        {
        case self::JS_CALL:
            return $this->getValue()->toArray();
        case self::JS_VALUE:
            return [
                '_type' => 'expr',
                'calls' => [['_type' => 'attr', '_name' => $this->getValue()]],
            ];
        case self::FORM_VALUES:
            return ['_type' => 'form', '_name' => $this->getValue()];
        case self::INPUT_VALUE:
            return ['_type' => 'input', '_name' => $this->getValue()];
        case self::CHECKED_VALUE:
            return ['_type' => 'checked', '_name' => $this->getValue()];
        case self::ELEMENT_INNERHTML:
            return ['_type' => 'html', '_name' => $this->getValue()];
        case self::QUOTED_VALUE:
        case self::BOOL_VALUE:
        case self::NUMERIC_VALUE:
        case self::JSON_VALUE:
        case self::PAGE_NUMBER:
        default:
            // Return the value as is.
            return $this->getValue();
        }
    }

}


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
22			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...
23			{
24			/*
25			* Request parameters
26			*/
			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...
27			// Specifies that the parameter will consist of an array of form values.
28			const FORM_VALUES = 'FormValues';
29			// Specifies that the parameter will contain the value of an input control.
30			const INPUT_VALUE = 'InputValue';
31			// Specifies that the parameter will consist of a bool value of a checkbox.
32			const CHECKED_VALUE = 'CheckedValue';
33			// Specifies that the parameter value will be the innerHTML value of the element.
34			const ELEMENT_INNERHTML = 'ElementInnerHTML';
35			// Specifies that the parameter will be a quoted value (string).
36			const QUOTED_VALUE = 'QuotedValue';
37			// Specifies that the parameter will be a bool value (true or false).
38			const BOOL_VALUE = 'BoolValue';
39			// Specifies that the parameter will be a numeric, non-quoted value.
40			const NUMERIC_VALUE = 'NumericValue';
41			// Specifies that the parameter will be a non-quoted value
42			// (evaluated by the browsers javascript engine at run time).
43			const JS_VALUE = 'UnquotedValue';
44			// Specifies that the parameter is a call to a javascript function
45			const JS_CALL = 'JsCall';
46			// Specifies that the parameter must be json encoded
47			const JSON_VALUE = 'JsonValue';
48			// Specifies that the parameter will be an integer used to generate pagination links.
49			const PAGE_NUMBER = 'PageNumber';
50
51			/**
52			* The parameter type
53			*
54			* @var string
55			*/
56			protected $sType;
57
58			/**
59			* The parameter value
60			*
61			* @var mixed
62			*/
63			protected $xValue;
64
65			/**
66			* Convert the parameter value to integer
67			*
68			* @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...
69			*/
70			protected $bToInt = false;
71
72			/**
73			* The constructor.
74			*
75			* @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...
76			* @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...
77			*/
78			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...
79			{
80			$this->sType = $sType;
81			$this->xValue = $xValue;
82			}
			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...
83
84			/**
85			* Get the parameter type
86			*
87			* @return string
88			*/
89			public function getType(): string
90			{
91			return $this->sType;
92			}
			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...
93
94			/**
95			* Get the parameter value
96			*
97			* @return mixed
98			*/
99			public function getValue()
100			{
101			return $this->xValue;
102			}
			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...
103
104			/**
105			* Set the parameter value
106			*
107			* @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...
108			*
109			* @return void
110			*/
111			public function setValue($xValue)
112			{
113			$this->xValue = $xValue;
114			}
			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...
115
116			/**
117			* @return ParameterInterface
118			*/
119			public function toInt(): ParameterInterface
120			{
121			$this->bToInt = true;
122			return $this;
123			}
			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...
124
125			/**
126			* Create a Parameter instance using the given value
127			*
128			* @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...
129			*
130			* @return ParameterInterface
131			*/
132			public static function make($xValue): ParameterInterface
133			{
134			if($xValue instanceof ParameterInterface)
135			{
136			return $xValue;
137			}
138			if(is_numeric($xValue))
139			{
140			return new Parameter(self::NUMERIC_VALUE, $xValue);
141			}
142			if(is_string($xValue))
143			{
144			return new Parameter(self::QUOTED_VALUE, $xValue);
145			}
146			if(is_bool($xValue))
147			{
148			return new Parameter(self::BOOL_VALUE, $xValue);
149			}
150			if($xValue instanceof JsCall)
151			{
152			return new Parameter(self::JS_CALL, $xValue);
153			}
154			// if(is_array($xValue) \|\| is_object($xValue))
155			{
156			return new Parameter(self::JSON_VALUE, $xValue);
157			}
158			}
			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...
159
160			/**
161			* Convert to a value to be inserted in an array for json conversion
162			*
163			* @return mixed
164			*/
165			public function forArray()
166			{
167			switch($this->getType())
168			{
169			case self::JS_CALL:
170			return $this->getValue()->toArray();
171			case self::JS_VALUE:
172			return [
173			'_type' => 'expr',
174			'calls' => [['_type' => 'attr', '_name' => $this->getValue()]],
175			];
176			case self::FORM_VALUES:
177			return ['_type' => 'form', '_name' => $this->getValue()];
178			case self::INPUT_VALUE:
179			return ['_type' => 'input', '_name' => $this->getValue()];
180			case self::CHECKED_VALUE:
181			return ['_type' => 'checked', '_name' => $this->getValue()];
182			case self::ELEMENT_INNERHTML:
183			return ['_type' => 'html', '_name' => $this->getValue()];
184			case self::QUOTED_VALUE:
185			case self::BOOL_VALUE:
186			case self::NUMERIC_VALUE:
187			case self::JSON_VALUE:
188			case self::PAGE_NUMBER:
189			default:
190			// Return the value as is.
191			return $this->getValue();
192			}
193			}
			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...
194			}
195

jaxon-php / jaxon-core

Push — v5.x ( 26d105...7911f3 )

Parameter::__toString() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like