Jaxon\Js\Parameter

Complexity

Total Complexity

40

Size/Duplication

Total Lines	325
Duplicated Lines	0 %

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getQuotedValue()	0	3	1
A	__toString()	0	3	1
A	getBoolValueScript()	0	3	2
A	toInt()	0	4	1
A	getInputValueScript()	0	3	1
A	getCheckedValueScript()	0	3	1
A	getUnquotedValueScript()	0	3	1
A	getPageNumberScript()	0	3	1
A	getJsonValueScript()	0	5	1
A	getElementInnerHTMLScript()	0	3	1
A	getType()	0	3	1
A	make()	0	25	6
A	getNumericValueScript()	0	3	1
A	getQuotedValueScript()	0	3	1
C	jsonSerialize()	0	28	12
A	getFormValuesScript()	0	3	1
A	getValue()	0	3	1
A	setValue()	0	3	1
A	getScript()	0	9	3
A	getJaxonCall()	0	3	1

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

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

 * @copyright 2016 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

PHP version not specified

Missing @category tag in file comment

Missing @author tag in file comment

namespace Jaxon\Js;

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

class Parameter implements ParameterInterface

Missing doc comment for class Parameter

{
    /*
     * Request parameters
     */

Empty line required after block comment

    // 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

Expected "boolean" but found "bool" for @var tag in member variable comment

     */
    protected $bToInt = false;

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

Expected 2 spaces after parameter name; 4 found

     * @param mixed $xValue    The parameter value

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

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

Expected 2 blank lines before function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter name; 4 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter name; 4 found

     *
     * @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 Call)
        {
            return new Parameter(self::JS_CALL, $xValue);
        }
        // if(is_array($xValue) || is_object($xValue))
        {
            return new Parameter(self::JSON_VALUE, $xValue);
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Convert to a value to be inserted in an array for json conversion
     *
     * @return mixed
     */
    public function jsonSerialize()
    {
        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::PAGE_NUMBER:
            return ['_type' => 'page', '_name' => ''];
        case self::QUOTED_VALUE:
        case self::BOOL_VALUE:
        case self::NUMERIC_VALUE:
        case self::JSON_VALUE:
        default:
            // Return the value as is.
            return $this->getValue();
        }
    }

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter name; 4 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 spaces after parameter name; 4 found

     * @param string $sParameter    The function parameter

Expected 1 spaces after parameter name; 4 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

This method is not in camel caps format.

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * 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;
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * 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;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Convert this call to string
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getScript();
    }

Expected 2 blank lines after function; 0 found

}