Jaxon\Request\Call\Call

Complexity

Total Complexity

34

Size/Duplication

Total Lines	404
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	pg()	0	3	1
A	makePhrase()	0	21	4
A	ifge()	0	4	1
A	iflt()	0	4	1
A	setPageNumber()	0	12	3
A	getScript()	0	33	5
A	elseShow()	0	6	1
A	_makeUniqueJsVar()	0	21	3
A	ifne()	0	4	1
A	makeMessage()	0	7	2
A	paginate()	0	3	1
A	ifeq()	0	4	1
A	when()	0	4	1
A	hasPageNumber()	0	10	3
A	unless()	0	4	1
A	__construct()	0	5	1
A	ifgt()	0	4	1
A	confirm()	0	7	1
A	ifle()	0	4	1
A	pages()	0	3	1

<?php

/**
 * Call.php - The Jaxon Call
 *
 * This class is used to create client side requests to callable classes and functions.
 *
 * @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 <thierry.feuzeu@gmail.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 Jaxon\Response\Plugin\JQuery\DomSelector;
use Jaxon\Ui\Dialogs\DialogFacade;
use Jaxon\Ui\Pagination\Paginator;

use function array_map;
use function array_shift;
use function func_get_args;
use function implode;

class Call extends JsCall

Missing doc comment for class Call

{
    /**
     * @var DialogFacade
     */
    protected $xDialogFacade;

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

    /**
     * @var Paginator
     */
    protected $xPaginator;

    /**
     * A condition to check before sending this request
     *
     * @var string
     */
    protected $sCondition = null;

    /**
     * The arguments of the confirm() call
     *
     * @var array
     */
    protected $aConfirmArgs = [];

    /**
     * The arguments of the elseShow() call
     *
     * @var array
     */
    protected $aMessageArgs = [];

    /**
     * @var array
     */
    private $aVariables;

    /**
     * @var string
     */
    private $sVars;

    /**
     * @var int

Expected "integer" but found "int" for @var tag in member variable comment

     */
    private $nVarId;

    /**
     * The constructor.
     *
     * @param string $sName    The javascript function or method name

Expected 7 spaces after parameter type; 1 found

Expected 9 spaces after parameter name; 4 found

     * @param DialogFacade $xDialogFacade

Missing parameter comment

     * @param Paginator $xPaginator

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     */
    public function __construct(string $sName, DialogFacade $xDialogFacade, Paginator $xPaginator)

Expected 2 blank lines before function; 1 found

    {
        parent::__construct($sName);
        $this->xDialogFacade = $xDialogFacade;
        $this->xPaginator = $xPaginator;

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

    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a condition to the request
     *
     * The request is sent only if the condition is true.
     *
     * @param mixed $xCondition    The condition to check

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function when($xCondition): Call
    {
        $this->sCondition = Parameter::make($xCondition)->getScript();
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a condition to the request
     *
     * The request is sent only if the condition is false.
     *
     * @param mixed $xCondition    The condition to check

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function unless($xCondition): Call
    {
        $this->sCondition = '!(' . Parameter::make($xCondition)->getScript() . ')';
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if a value is equal to another before sending the request
     *
     * @param mixed $xValue1    The first value to compare

Expected 1 spaces after parameter name; 4 found

     * @param mixed $xValue2    The second value to compare

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function ifeq($xValue1, $xValue2): Call
    {
        $this->sCondition = Parameter::make($xValue1) . '==' . Parameter::make($xValue2);

Are you sure Jaxon\Request\Call\Parameter::make($xValue2) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

Are you sure Jaxon\Request\Call\Parameter::make($xValue1) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if a value is not equal to another before sending the request
     *
     * @param mixed $xValue1    The first value to compare

Expected 1 spaces after parameter name; 4 found

     * @param mixed $xValue2    The second value to compare

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function ifne($xValue1, $xValue2): Call
    {
        $this->sCondition = Parameter::make($xValue1) . '!=' . Parameter::make($xValue2);

Are you sure Jaxon\Request\Call\Parameter::make($xValue1) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

Are you sure Jaxon\Request\Call\Parameter::make($xValue2) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if a value is greater than another before sending the request
     *
     * @param mixed $xValue1    The first value to compare

Expected 1 spaces after parameter name; 4 found

     * @param mixed $xValue2    The second value to compare

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function ifgt($xValue1, $xValue2): Call
    {
        $this->sCondition = Parameter::make($xValue1) . '>' . Parameter::make($xValue2);

Are you sure Jaxon\Request\Call\Parameter::make($xValue2) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

Are you sure Jaxon\Request\Call\Parameter::make($xValue1) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if a value is greater or equal to another before sending the request
     *
     * @param mixed $xValue1    The first value to compare

Expected 1 spaces after parameter name; 4 found

     * @param mixed $xValue2    The second value to compare

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function ifge($xValue1, $xValue2): Call
    {
        $this->sCondition = Parameter::make($xValue1) . '>=' . Parameter::make($xValue2);

Are you sure Jaxon\Request\Call\Parameter::make($xValue1) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

Are you sure Jaxon\Request\Call\Parameter::make($xValue2) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if a value is lower than another before sending the request
     *
     * @param mixed $xValue1    The first value to compare

Expected 1 spaces after parameter name; 4 found

     * @param mixed $xValue2    The second value to compare

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function iflt($xValue1, $xValue2): Call
    {
        $this->sCondition = Parameter::make($xValue1) . '<' . Parameter::make($xValue2);

Are you sure Jaxon\Request\Call\Parameter::make($xValue2) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

Are you sure Jaxon\Request\Call\Parameter::make($xValue1) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if a value is lower or equal to another before sending the request
     *
     * @param mixed $xValue1    The first value to compare

Expected 1 spaces after parameter name; 4 found

     * @param mixed $xValue2    The second value to compare

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function ifle($xValue1, $xValue2): Call
    {
        $this->sCondition = Parameter::make($xValue1) . '<=' . Parameter::make($xValue2);

Are you sure Jaxon\Request\Call\Parameter::make($xValue1) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

Are you sure Jaxon\Request\Call\Parameter::make($xValue2) of type Jaxon\Request\Call\ParameterInterface can be used in concatenation? Consider adding a __toString()-method.

        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a confirmation question to the request
     *
     * @param string $sQuestion    The question to ask

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function confirm(string $sQuestion): Call
    {
        $this->sCondition = '__confirm__';

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

        $this->aConfirmArgs = array_map(function($xParameter) {
            return Parameter::make($xParameter);
        }, func_get_args());
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the message to show if the condition to send the request is not met
     *
     * The first parameter is the message to show. The followings allow inserting data from
     * the webpage in the message using positional placeholders.
     *
     * @param string $sMessage    The message to show if the request is not sent

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function elseShow(string $sMessage): Call
    {
        $this->aMessageArgs = array_map(function($xParameter) {
            return Parameter::make($xParameter);
        }, func_get_args());
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Make unique js vars for parameters of type DomSelector
     *
     * @param ParameterInterface $xParameter

Missing parameter comment

     *
     * @return ParameterInterface
     */
    private function _makeUniqueJsVar(ParameterInterface $xParameter): ParameterInterface
    {
        if($xParameter instanceof DomSelector)
        {
            $sParameterStr = $xParameter->getScript();
            if(!isset($this->aVariables[$sParameterStr]))
            {
                // The value is not yet defined. A new variable is created.
                $sVarName = 'jxnVar' . $this->nVarId;

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

                $this->aVariables[$sParameterStr] = $sVarName;
                $this->sVars .= "$sVarName=$xParameter;";

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

                $this->nVarId++;
            }
            else
            {
                // The value is already defined. The corresponding variable is assigned.
                $sVarName = $this->aVariables[$sParameterStr];
            }
            $xParameter = new Parameter(Parameter::JS_VALUE, $sVarName);
        }
        return $xParameter;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Make a phrase to be displayed in js code
     *
     * @param array $aArgs

Missing parameter comment

     *
     * @return string
     */
    private function makePhrase(array $aArgs): string
    {
        if(empty($aArgs))
        {
            return '';
        }
        // The first array entry is the message.
        $sPhrase = array_shift($aArgs);
        if(empty($aArgs))
        {
            return $sPhrase;
        }
        $nParamId = 1;
        foreach($aArgs as &$xParameter)
        {
            $xParameter = $this->_makeUniqueJsVar($xParameter);
            $xParameter = "'$nParamId':" . $xParameter->getScript();
            $nParamId++;
        }
        $sPhrase .= '.supplant({' . implode(',', $aArgs) . '})';
        return $sPhrase;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Make a phrase to be displayed in js code
     *
     * @param array $aArgs

Missing parameter comment

     *
     * @return string
     */
    private function makeMessage(array $aArgs): string
    {
        if(!($sPhrase = $this->makePhrase($aArgs)))

Variable assignment found within a condition. Did you mean to do a comparison ?

        {
            return '';
        }
        return $this->xDialogFacade->getMessageLibrary(true)->warning($sPhrase);
    }

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
    {
        /*
         * JQuery variables sometimes depend on the context where they are used, eg. when their value depends on $(this).
         * When a confirmation question is added, the Jaxon calls are made in a different context,
         * making those variables invalid.
         * To avoid issues related to these context changes, the JQuery selectors values are first saved into
         * local variables, which are then used in Jaxon function calls.
         */

Empty line required after block comment

        $this->sVars = ''; // Javascript code defining all the variables values.
        $this->nVarId = 1; // Position of the variables, starting from 1.
        // This array will avoid declaring multiple variables with the same value.
        // The array key is the variable value, while the array value is the variable name.
        $this->aVariables = []; // Array of local variables.
        foreach($this->aParameters as &$xParameter)
        {
            $xParameter = $this->_makeUniqueJsVar($xParameter);
        }

        $sMessageScript = $this->makeMessage($this->aMessageArgs);
        $sScript = parent::getScript();

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

        if($this->sCondition === '__confirm__')
        {
            $sConfirmPhrase = $this->makePhrase($this->aConfirmArgs);
            $sScript = $this->xDialogFacade->getQuestionLibrary()

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

                ->confirm($sConfirmPhrase, $sScript, $sMessageScript);

Space found before object operator

        }
        elseif($this->sCondition !== null)
        {
            $sScript = empty($sMessageScript) ? 'if(' . $this->sCondition . '){' . $sScript . ';}' :

Expected 1 space after ":"; newline found

                'if(' . $this->sCondition . '){' . $sScript . ';}else{' . $sMessageScript . ';}';
        }
        return $this->sVars . $sScript;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if the request has a parameter of type Parameter::PAGE_NUMBER
     *
     * @return bool
     */
    public function hasPageNumber(): bool
    {
        foreach($this->aParameters as $xParameter)
        {
            if($xParameter->getType() === Parameter::PAGE_NUMBER)
            {
                return true;
            }
        }
        return false;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set a value to the Parameter::PAGE_NUMBER parameter
     *
     * @param integer $nPageNumber    The current page number

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function setPageNumber(int $nPageNumber): Call
    {
        // Set the value of the Parameter::PAGE_NUMBER parameter
        foreach($this->aParameters as $xParameter)
        {
            if($xParameter->getType() === Parameter::PAGE_NUMBER)
            {
                $xParameter->setValue($nPageNumber);
                break;
            }
        }
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Make the pagination links for this request
     *
     * @param integer $nCurrentPage    The current page

Expected 2 spaces after parameter name; 4 found

     * @param integer $nItemsPerPage    The number of items per page

Expected 1 spaces after parameter name; 4 found

     * @param integer $nItemsTotal    The total number of items

Expected 3 spaces after parameter name; 4 found

     *
     * @return Paginator
     */
    public function paginate(int $nCurrentPage, int $nItemsPerPage, int $nItemsTotal): Paginator
    {
        return $this->xPaginator->setup($this, $nCurrentPage, $nItemsPerPage, $nItemsTotal);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Make the pagination links for this request
     *
     * @param integer $nCurrentPage    The current page

Expected 2 spaces after parameter name; 4 found

     * @param integer $nItemsPerPage    The number of items per page

Expected 1 spaces after parameter name; 4 found

     * @param integer $nItemsTotal    The total number of items

Expected 3 spaces after parameter name; 4 found

     *
     * @return Paginator
     */
    public function pg(int $nCurrentPage, int $nItemsPerPage, int $nItemsTotal): Paginator
    {
        return $this->paginate($nCurrentPage, $nItemsPerPage, $nItemsTotal);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Make the pagination links for this request
     *
     * @param integer $nCurrentPage    The current page

Expected 2 spaces after parameter name; 4 found

     * @param integer $nItemsPerPage    The number of items per page

Expected 1 spaces after parameter name; 4 found

     * @param integer $nItemsTotal    The total number of items

Expected 3 spaces after parameter name; 4 found

     *
     * @return array
     */
    public function pages(int $nCurrentPage, int $nItemsPerPage, int $nItemsTotal): array
    {
        return $this->xPaginator->setup($this, $nCurrentPage, $nItemsPerPage, $nItemsTotal)->getPages();
    }

Expected 2 blank lines after function; 0 found

}