Jaxon\Request\Call\JsCall

Complexity

Total Complexity

12

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getScript()	0	4	2
A	addParameter()	0	4	1
A	addParameters()	0	14	3
A	__construct()	0	3	1
A	jsonSerialize()	0	3	1
A	clearParameters()	0	4	1
A	toInt()	0	4	1
A	__toString()	0	3	1
A	pushParameter()	0	4	1

<?php

/**
 * JsCall.php - A javascript function call, with its parameters.
 *
 * @package jaxon-core

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

 * @author Jared White

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author J. Max Wilson

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Joseph Woolley

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Steffen Konerow

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Thierry Feuzeu

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson

@copyright tag must contain a year and the name of the copyright holder

 * @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White  & J. Max Wilson

@copyright tag must contain a year and the name of the copyright holder

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

namespace Jaxon\Request\Call;

use JsonSerializable;

class JsCall implements JsonSerializable

Missing doc comment for class JsCall

{
    /**
     * The name of the javascript function
     *
     * @var string
     */
    private $sFunction;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * @var string
     */
    private $sQuoteCharacter = "'";

The private property $sQuoteCharacter is not used, and could be removed.

    /**
     * @var array
     */
    protected $aParameters = [];

    /**
     * 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 $sFunction    The javascript function

Expected 1 spaces after parameter name; 4 found

     */
    public function __construct(string $sFunction)

Expected 2 blank lines before function; 1 found

    {
        $this->sFunction = $sFunction;
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Clear the parameter list associated with this request
     *
     * @return JsCall
     */
    public function clearParameters(): JsCall
    {
        $this->aParameters = [];
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the value of the parameter at the given position
     *
     * @param ParameterInterface $xParameter    The value to be used

Expected 1 spaces after parameter name; 4 found

     *
     * @return JsCall
     */
    public function pushParameter(ParameterInterface $xParameter): JsCall
    {
        $this->aParameters[] = $xParameter;
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a parameter value to the parameter list for this request
     *
     * @param string $sType    The type of the value to be used

Expected 2 spaces after parameter name; 4 found

     * @param string $sValue    The value to be used

Expected 1 spaces after parameter name; 4 found

     *
     * Types should be one of the following <Parameter::FORM_VALUES>, <Parameter::QUOTED_VALUE>, <Parameter::NUMERIC_VALUE>,

Parameter comment not aligned correctly; expected 26 spaces but found 1

     * <Parameter::JS_VALUE>, <Parameter::INPUT_VALUE>, <Parameter::CHECKED_VALUE>, <Parameter::PAGE_NUMBER>.

Parameter comment not aligned correctly; expected 26 spaces but found 1

     * The value should be as follows:

Parameter comment not aligned correctly; expected 26 spaces but found 1

     * - <Parameter::FORM_VALUES> - Use the ID of the form you want to process.

Parameter comment not aligned correctly; expected 26 spaces but found 1

     * - <Parameter::QUOTED_VALUE> - The string data to be passed.

Parameter comment not aligned correctly; expected 26 spaces but found 1

     * - <Parameter::JS_VALUE> - A string containing valid javascript

Parameter comment not aligned correctly; expected 26 spaces but found 1

     *   (either a javascript variable name that will be in scope at the time of the call or

Parameter comment not aligned correctly; expected 26 spaces but found 3

     *   a javascript function call whose return value will become the parameter).

Parameter comment not aligned correctly; expected 26 spaces but found 3

     *
     * @return JsCall
     */
    public function addParameter(string $sType, string $sValue): JsCall
    {
        $this->pushParameter(new Parameter($sType, $sValue));
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a set of parameters to this request
     *
     * @param array $aParameters    The parameters

Expected 1 spaces after parameter name; 4 found

     *
     * @return JsCall
     */
    public function addParameters(array $aParameters): JsCall
    {
        foreach($aParameters as $xParameter)
        {
            if($xParameter instanceof JsCall)
            {
                $this->addParameter(Parameter::JS_VALUE, 'function(){' . $xParameter->getScript() . ';}');
            }
            else
            {
                $this->pushParameter(Parameter::make($xParameter));
            }
        }
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Returns a string representation of the script output (javascript) from this request object
     *
     * @return string
     */
    public function getScript(): string
    {
        $sScript = $this->sFunction . '(' . implode(', ', $this->aParameters) . ')';
        return $this->bToInt ? "parseInt($sScript)" : $sScript;
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Convert this request object to string, when converting the response into json.
     *
     * This is a method of the JsonSerializable interface.
     *
     * @return string
     */
    public function jsonSerialize(): string
    {
        return $this->getScript();
    }

Expected 2 blank lines after function; 0 found

}