Call::unless() - Code Metrics - Inspection of "New interfaces and traits for Dialog libraries." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — v5.x ( 00e299...57c2ac )

by Thierry
created 2024-03-14 00:26 UTC
Call::unless() A

↳ Parent: Call
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	4
rs	10
<?php

/**
 * Call.php - The Jaxon Call
 *
 * This class is used to create js ajax 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\App\Dialog\Library\DialogLibraryManager;

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

class Call extends JsCall

{
    /**
     * @var DialogLibraryManager
     */
    protected $xDialogLibraryManager;


    /**
     * The arguments of the else() calls
     *
     * @var array
     */
    protected $aMessage = [];

    /**
     * A condition to check before making the call
     *
     * @var array
     */
    protected $aCondition = [];

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

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

     * @param DialogLibraryManager $xDialogLibraryManager

     */
    public function __construct(string $sName, DialogLibraryManager $xDialogLibraryManager)

    {
        parent::__construct($sName);
        $this->xDialogLibraryManager = $xDialogLibraryManager;
    }


    /**
     * Make a phrase to be displayed in js code
     *
     * @param string $sPhrase

     * @param array $aArgs

     *
     * @return array
     */
    private function makePhrase(string $sPhrase, array $aArgs = []): array
    {
        array_shift($aArgs);
        return [
            'str' => $sPhrase,
            'args' => array_map(fn($xArg) => Parameter::make($xArg), $aArgs),
        ];
    }


    /**
     * Set the message if the condition to the call is not met
     *
     * The first parameter is the message to show. The second allows inserting data from
     * the webpage in the message using positional placeholders.
     *
     * @param string $sType

     * @param string $sMessage

     * @param array $aArgs

     *
     * @return Call
     */
    private function setMessage(string $sType, string $sMessage, array $aArgs): Call
    {
        $this->aMessage = [
            'lib' => $this->xDialogLibraryManager->getMessageLibrary()->getName(),
            'type' => $sType,
            'phrase' => $this->makePhrase($sMessage, $aArgs),
        ];
        return $this;
    }


    /**
     * Show a message if the condition to the call is not met
     *
     * @param string $sMessage  The message to show

     *
     * @return Call
     */
    public function elseShow(string $sMessage): Call
    {
        return $this->setMessage('warning', $sMessage, func_get_args());
    }


    /**
     * Show an information message if the condition to the call is not met
     *
     * @param string $sMessage  The message to show

     *
     * @return Call
     */
    public function elseInfo(string $sMessage): Call
    {
        return $this->setMessage('info', $sMessage, func_get_args());
    }


    /**
     * Show a success message if the condition to the call is not met
     *
     * @param string $sMessage  The message to show

     *
     * @return Call
     */
    public function elseSuccess(string $sMessage): Call
    {
        return $this->setMessage('success', $sMessage, func_get_args());
    }


    /**
     * Show a warning message if the condition to the call is not met
     *
     * @param string $sMessage  The message to show

     *
     * @return Call
     */
    public function elseWarning(string $sMessage): Call
    {
        return $this->setMessage('warning', $sMessage, func_get_args());
    }


    /**
     * Show an error message if the condition to the call is not met
     *
     * @param string $sMessage  The message to show

     *
     * @return Call
     */
    public function elseError(string $sMessage): Call
    {
        return $this->setMessage('error', $sMessage, func_get_args());
    }


    /**
     * 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->aCondition = [true, Parameter::make($xCondition)];
        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->aCondition = [false, Parameter::make($xCondition)];
        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->aCondition = ['==', Parameter::make($xValue1), Parameter::make($xValue2)];
        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 ifteq($xValue1, $xValue2): Call
    {
        $this->aCondition = ['===', 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->aCondition = ['!=', 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 ifnte($xValue1, $xValue2): Call
    {
        $this->aCondition = ['!==', Parameter::make($xValue1), 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->aCondition = ['>', 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->aCondition = ['>=', Parameter::make($xValue1), 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->aCondition = ['<', 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->aCondition = ['<=', Parameter::make($xValue1), 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->aConfirm = [
            'lib' => $this->xDialogLibraryManager->getQuestionLibrary()->getName(),
            'phrase' => $this->makePhrase($sQuestion, func_get_args()),
        ];
        return $this;
    }


    /**
     * Convert this call to array
     *
     * @return array
     */
    public function toArray(): array
    {
        $aCall = parent::toArray();
        if(($this->aConfirm))

        {
            $aCall['confirm'] = $this->aConfirm;
        }
        if(($this->aCondition))

        {
            $aCall['condition'] = $this->aCondition;
        }
        if(($this->aMessage))

        {
            $aCall['else'] = $this->aMessage;
        }
        return $aCall;
    }


    /**
     * Check if the request has a parameter of type Parameter::PAGE_NUMBER
     *
     * @return ParameterInterface|null
     */
    private function findPageNumber(): ?ParameterInterface
    {
        foreach($this->aParameters as $xParameter)
        {
            if($xParameter->getType() === Parameter::PAGE_NUMBER)
            {
                return $xParameter;
            }
        }
        return null;
    }


    /**
     * Check if the request has a parameter of type Parameter::PAGE_NUMBER
     *
     * @return bool
     */
    public function hasPageNumber(): bool
    {
        return $this->findPageNumber() !== null;
    }


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

     *
     * @return Call
     */
    public function setPageNumber(int $nPageNumber): Call
    {
        /** @var Parameter */

        $xParameter = $this->findPageNumber();
        if($xParameter !== null)
        {
            $xParameter->setValue($nPageNumber);
                         setValue($nPageNumber);
        }
        return $this;
    }

}

jaxon-php / jaxon-core

Push — v5.x ( 00e299...57c2ac )

Call::unless() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
