Jaxon\Request\Factory\RequestFactory

Complexity

Total Complexity

5

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	call()	0	7	1
A	noPrefix()	0	4	1
A	__call()	0	7	2
A	__construct()	0	5	1

<?php

Missing file doc comment

namespace Jaxon\Request\Factory;

/**

Block comments must be started with /*

 * RequestFactory.php
 *
 * Create Jaxon client side requests, which will generate the client script necessary
 * to invoke a jaxon request from the browser to registered objects.
 *
 * @package jaxon-core
 * @author Thierry Feuzeu
 * @copyright 2022 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
 */

use Jaxon\App\Dialog\Library\DialogLibraryManager;
use Jaxon\Request\Call\Call;
use Jaxon\Request\Call\Paginator;

use function array_shift;
use function func_get_args;

class RequestFactory

Missing doc comment for class RequestFactory

{
    /**
     * @var string
     */
    protected $sPrefix;

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

    /**
     * @var bool

Expected "boolean" but found "bool" for @var tag in member variable comment

     */
    protected $bNoPrefix = false;

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

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

    /**
     * The class constructor
     *
     * @param string $sPrefix

Missing parameter comment

Expected 15 spaces after parameter type; 1 found

     * @param DialogLibraryManager $xDialogLibraryManager

Missing parameter comment

     * @param Paginator $xPaginator

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

     */
    public function __construct(string $sPrefix, DialogLibraryManager $xDialogLibraryManager, Paginator $xPaginator)

Expected 2 blank lines before function; 1 found

    {
        $this->sPrefix = $sPrefix;

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

        $this->xDialogLibraryManager = $xDialogLibraryManager;
        $this->xPaginator = $xPaginator;

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

    }

Expected 2 blank lines after function; 1 found

    /**
     * @param bool $bNoPrefix

Missing parameter comment

     *
     * @return RequestFactory
     */
    public function noPrefix(bool $bNoPrefix): RequestFactory
    {
        $this->bNoPrefix = $bNoPrefix;
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Generate the javascript code for a call to a given method
     *
     * @param string $sFunction

Missing parameter comment

     * @param array $aArguments

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return Call
     */
    public function __call(string $sFunction, array $aArguments): Call
    {
        // Make the request
        $sPrefix = $this->bNoPrefix ? '' : $this->sPrefix;
        $xCall = new Call($sPrefix . $sFunction, $this->xDialogLibraryManager, $this->xPaginator);

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

        $xCall->addParameters($aArguments);
        return $xCall;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Return the javascript call to a Jaxon function or object method
     *
     * @param string $sFunction    The function or method (without class) name

Expected 1 spaces after parameter name; 4 found

     *
     * @return Call
     */
    public function call(string $sFunction): Call
    {
        $aArguments = func_get_args();
        // Remove the function name from the arguments array.
        array_shift($aArguments);
        // Make the request
        return $this->__call($sFunction, $aArguments);
    }

Expected 2 blank lines after function; 0 found

}