Jaxon\Request\Factory\Request

Complexity

Total Complexity

32

Size/Duplication

Total Lines	355
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	when()	0	5	1
A	unless()	0	5	1
A	ifeq()	0	5	1
A	ifne()	0	5	1
A	ifgt()	0	5	1
A	ifge()	0	5	1
A	iflt()	0	5	1
A	ifle()	0	5	1
A	setMessageArgs()	0	7	1
A	confirm()	0	6	1
A	elseShow()	0	5	1
A	_makeUniqueJsVar()	0	22	3
B	getScript()	0	54	8
A	printScript()	0	4	1
A	hasPageNumber()	0	11	3
A	setPageNumber()	0	13	3
A	pg()	0	5	1
A	paginate()	0	4	1

<?php

/**
 * Request.php - The Jaxon Request
 *
 * 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\Factory;

use Jaxon\Request\Factory\Parameter;
use Jaxon\Request\Factory\Contracts\Parameter as ParameterContract;
use Jaxon\Response\Plugin\JQuery\Dom\Element as DomElement;

class Request extends JsCall

Missing doc comment for class Request

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

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

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

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 12 found

     */
    public function __construct($sName)
    {
        parent::__construct($sName);
    }

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 15 found

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

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 15 found

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

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     * @param string        $sValue2                  The second value to compare

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     *
     * @return Request
     */
    public function ifeq($sValue1, $sValue2)
    {
        $this->sCondition = '(' . Parameter::make($sValue1) . '==' . Parameter::make($sValue2) . ')';
        return $this;
    }

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     * @param string        $sValue2                  The second value to compare

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     *
     * @return Request
     */
    public function ifne($sValue1, $sValue2)
    {
        $this->sCondition = '(' . Parameter::make($sValue1) . '!=' . Parameter::make($sValue2) . ')';
        return $this;
    }

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     * @param string        $sValue2                  The second value to compare

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     *
     * @return Request
     */
    public function ifgt($sValue1, $sValue2)
    {
        $this->sCondition = '(' . Parameter::make($sValue1) . '>' . Parameter::make($sValue2) . ')';
        return $this;
    }

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     * @param string        $sValue2                  The second value to compare

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     *
     * @return Request
     */
    public function ifge($sValue1, $sValue2)
    {
        $this->sCondition = '(' . Parameter::make($sValue1) . '>=' . Parameter::make($sValue2) . ')';
        return $this;
    }

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     * @param string        $sValue2                  The second value to compare

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     *
     * @return Request
     */
    public function iflt($sValue1, $sValue2)
    {
        $this->sCondition = '(' . Parameter::make($sValue1) . '<' . Parameter::make($sValue2) . ')';
        return $this;
    }

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     * @param string        $sValue2                  The second value to compare

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 18 found

     *
     * @return Request
     */
    public function ifle($sValue1, $sValue2)
    {
        $this->sCondition = '(' . Parameter::make($sValue1) . '<=' . Parameter::make($sValue2) . ')';
        return $this;
    }

    /**
     * Create parameters for message arguments
     *
     * @param array     $aArgs          The arguments

Expected 1 spaces after parameter type; 5 found

Expected 1 spaces after parameter name; 10 found

     *
     * @return void
     */
    private function setMessageArgs(array $aArgs)
    {
        array_walk($aArgs, function(&$xParameter) {
            $xParameter = Parameter::make($xParameter);
        });
        $this->aMessageArgs = $aArgs;
    }

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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 16 found

     *
     * @return Request
     */
    public function confirm($sQuestion)
    {
        $this->sCondition = '__confirm__';
        $this->setMessageArgs(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 followin allow to insert 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 type; 8 found

Expected 1 spaces after parameter name; 17 found

     *
     * @return Request
     */
    public function elseShow($sMessage)
    {
        $this->setMessageArgs(func_get_args());
        return $this;
    }

    /**

Parameter $xParameter should have a doc-comment as per coding-style.

Parameter $aVariables should have a doc-comment as per coding-style.

Parameter $sVars should have a doc-comment as per coding-style.

Parameter $nVarId should have a doc-comment as per coding-style.

     * Make unique js vars for parameters of type DomElement
     *
     * @var ParameterContract   $xParameter
     * @var array               &$aVariables
     * @var string              &$sVars
     * @var integer             &$nVarId
     *
     * @return ParameterContract
     */
    private function _makeUniqueJsVar(ParameterContract $xParameter, array &$aVariables, &$sVars, &$nVarId)
    {
        if($xParameter instanceof DomElement)
        {
            $sParameterStr = $xParameter->getScript();
            if(!array_key_exists($sParameterStr, $aVariables))
            {
                // The value is not yet defined. A new variable is created.
                $sVarName = "jxnVar$nVarId";

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

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

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

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

Consider using a different name than the parameter $xParameter. This often makes code more readable.

        }
        return $xParameter;
    }

    /**
     * Returns a string representation of the script output (javascript) from this request object
     *
     * @return string
     */
    public function getScript()
    {
        /*
         * 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

        $sVars = ''; // Javascript code defining all the variables values.

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

        $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.
        $aVariables = []; // Array of local variables.
        foreach($this->aParameters as &$xParameter)
        {
            $xParameter = $this->_makeUniqueJsVar($xParameter, $aVariables, $sVars, $nVarId);
        }

        $sPhrase = '';
        if(count($this->aMessageArgs) > 0)
        {
            $sPhrase = array_shift($this->aMessageArgs); // The first array entry is the question.
            // $sPhrase = "'" . addslashes($sPhrase) . "'"; // Wrap the phrase with single quotes
            if(count($this->aMessageArgs) > 0)
            {
                $nParamId = 1;
                foreach($this->aMessageArgs as &$xParameter)
                {
                    $xParameter = $this->_makeUniqueJsVar($xParameter, $aVariables, $sVars, $nVarId);
                    $xParameter = "'$nParamId':" . $xParameter->getScript();
                    $nParamId++;
                }
                $sPhrase .= '.supplant({' . implode(',', $this->aMessageArgs) . '})';
            }
        }

        $sScript = parent::getScript();
        $xDialog = jaxon()->dialog();
        if($this->sCondition == '__confirm__')
        {
            $sScript = $xDialog->confirm($sPhrase, $sScript, '');
        }
        elseif($this->sCondition !== null)
        {
            $sScript = 'if(' . $this->sCondition . '){' . $sScript . ';}';
            if(($sPhrase))
            {
                $xDialog->getAlert()->setReturn(true);
                $sScript .= 'else{' . $xDialog->warning($sPhrase) . ';}';
            }
        }
        return $sVars . $sScript;
    }

    /**
     * Prints a string representation of the script output (javascript) from this request object
     *
     * @return void
     */
    public function printScript()
    {
        print $this->getScript();
    }

    /**
     * Check if the request has a parameter of type Parameter::PAGE_NUMBER
     *
     * @return boolean
     */
    public function hasPageNumber()
    {
        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

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 8 found

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

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

Expected 1 spaces after parameter type; 7 found

Expected 2 spaces after parameter name; 11 found

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

Expected 1 spaces after parameter type; 7 found

Expected 1 spaces after parameter name; 10 found

     * @param integer       $nItemsTotal            The total number of items

Expected 1 spaces after parameter type; 7 found

Expected 3 spaces after parameter name; 12 found

     *
     * @return \Jaxon\Utils\Pagination\Paginator
     */
    public function pg($nCurrentPage, $nItemsPerPage, $nItemsTotal)
    {
        return jaxon()->di()->getPaginator()
            ->setup($nItemsTotal, $nItemsPerPage, $nCurrentPage, $this);

Space found before object operator

    }

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

Expected 1 spaces after parameter type; 7 found

Expected 2 spaces after parameter name; 11 found

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

Expected 1 spaces after parameter type; 7 found

Expected 1 spaces after parameter name; 10 found

     * @param integer       $nItemsTotal            The total number of items

Expected 1 spaces after parameter type; 7 found

Expected 3 spaces after parameter name; 12 found

     *
     * @return \Jaxon\Utils\Pagination\Paginator
     */
    public function paginate($nCurrentPage, $nItemsPerPage, $nItemsTotal)
    {
        return $this->pg($nCurrentPage, $nItemsPerPage, $nItemsTotal);
    }
}