Call::setPageNumber() - Code Metrics - Inspection of "More tests on dialogs." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 6eb156...b34d93 )

by Thierry
created 2022-04-05 13:39 UTC
Call::setPageNumber() A

↳ Parent: Call
Complexity

Conditions	3
Paths	3
Size

Total Lines	12
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	5
c	0
b	0
f	0
nc	3
nop	1
dl	0
loc	12
rs	10
<?php

/**
 * Call.php - The Jaxon Call
 *
 * This class is used to create client side requests to callable classes and functions.
 *
 * @package jaxon-core

 * @author Jared White

 * @author J. Max Wilson

 * @author Joseph Woolley

 * @author Steffen Konerow

 * @author Thierry Feuzeu <[email protected]>
 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson

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

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

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


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

     */
    private $nVarId;

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

     * @param DialogFacade $xDialogFacade

     * @param Paginator $xPaginator

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

    {
        parent::__construct($sName);
        $this->xDialogFacade = $xDialogFacade;
        $this->xPaginator = $xPaginator;
$a = "a";
$ab = "ab";
$abc = "abc";
    }


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

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


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

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


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

     * @param mixed $xValue2    The second value to compare

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


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

     * @param mixed $xValue2    The second value to compare

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


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

     * @param mixed $xValue2    The second value to compare

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


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

     * @param mixed $xValue2    The second value to compare

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


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

     * @param mixed $xValue2    The second value to compare

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


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

     * @param mixed $xValue2    The second value to compare

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


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

     *
     * @return Call
     */
    public function confirm(string $sQuestion): Call
    {
        $this->sCondition = '__confirm__';
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->aConfirmArgs = array_map(function($xParameter) {
            return Parameter::make($xParameter);
        }, func_get_args());
        return $this;
    }


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

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


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

     *
     * @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;
$a = "a";
$ab = "ab";
$abc = "abc";
                $this->aVariables[$sParameterStr] = $sVarName;
                $this->sVars .= "$sVarName=$xParameter;";
$a = "a";
$ab = "ab";
$abc = "abc";
                $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;
    }


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

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


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

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

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


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

        $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();
$a = "a";
$ab = "ab";
$abc = "abc";
        if($this->sCondition === '__confirm__')
        {
            $sConfirmPhrase = $this->makePhrase($this->aConfirmArgs);
            $sScript = $this->xDialogFacade->getQuestionLibrary()
$a = "a";
$ab = "ab";
$abc = "abc";
                ->confirm($sConfirmPhrase, $sScript, $sMessageScript);

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

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


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


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

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


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

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

     * @param integer $nItemsTotal    The total number of items

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


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

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

     * @param integer $nItemsTotal    The total number of items

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


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

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

     * @param integer $nItemsTotal    The total number of items

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

}

jaxon-php / jaxon-core

Push — master ( 6eb156...b34d93 )

Call::setPageNumber() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
