Jaxon\Request\Factory\Parameter

Complexity

Total Complexity

27

Size/Duplication

Total Lines	273
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getType()	0	4	1
A	getValue()	0	4	1
A	setValue()	0	4	1
A	make()	0	23	5
A	getQuotedValue()	0	5	1
A	getJsCall()	0	4	1
A	getFormValuesScript()	0	4	1
A	getInputValueScript()	0	4	1
A	getCheckedValueScript()	0	4	1
A	getElementInnerHTMLScript()	0	4	1
A	getQuotedValueScript()	0	4	1
A	getBoolValueScript()	0	4	2
A	getNumericValueScript()	0	4	1
A	getUnquotedValueScript()	0	10	3
A	getPageNumberScript()	0	4	1
A	getScript()	0	9	2
A	__toString()	0	4	1
A	jsonSerialize()	0	4	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\Request\Factory;

class Parameter implements Contracts\Parameter

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

Expected 1 spaces after parameter type; 8 found

Expected 2 spaces after parameter name; 18 found

     * @param mixed         $xValue                 The parameter value

Expected 2 spaces after parameter type; 9 found

Expected 1 spaces after parameter name; 17 found

     */
    public function __construct($sType, $xValue)
    {
        $this->sType = $sType;

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

        $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

Expected 1 spaces after parameter type; 9 found

Expected 1 spaces after parameter name; 17 found

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

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

Expected 1 spaces after parameter type; 9 found

Expected 1 spaces after parameter name; 17 found

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

Expected 1 spaces after parameter type; 4 found

Expected 1 spaces after parameter name; 5 found

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

Expected 1 spaces after parameter type; 4 found

Expected 2 spaces after parameter name; 6 found

     * @param string    $sParameter     The function parameter

Expected 1 spaces after parameter type; 4 found

Expected 1 spaces after parameter name; 5 found

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