Jaxon\Request\Factory\Factory

Complexity

Total Complexity

6

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	rq()	0	7	2
A	pm()	0	3	1
A	__construct()	0	10	1
A	js()	0	7	2

<?php

Missing file doc comment

namespace Jaxon\Request\Factory;

/**

Block comments must be started with /*

 * Factory.php
 *
 * Gives access to the factories.
 *
 * @package jaxon-core
 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @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\DialogManager;
 use Jaxon\Exception\SetupException;
use Jaxon\Plugin\Request\CallableClass\CallableRegistry;

use function trim;

class Factory

Missing doc comment for class Factory

{
    /**
     * @var CallableRegistry
     */
    private $xCallableRegistry;

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

    /**
     * @var DialogManager
     */
    protected $xDialogManager;

    /**
     * @var ParameterFactory
     */
    protected $xParameterFactory;

    /**
     * @var JsCallFactory
     */
    protected $xRqFunctionFactory;

    /**
     * @var JsCallFactory
     */
    protected $xJsFunctionFactory;

    /**
     * The constructor.
     *
     * @param CallableRegistry $xCallableRegistry

Missing parameter comment

     * @param DialogManager $xDialogManager

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     * @param ParameterFactory $xParameterFactory

Missing parameter comment

     * @param string $sFunctionPrefix

Missing parameter comment

Expected 11 spaces after parameter type; 1 found

     */
    public function __construct(CallableRegistry $xCallableRegistry,

Expected 2 blank lines before function; 1 found

        DialogManager $xDialogManager, ParameterFactory $xParameterFactory, string $sFunctionPrefix)
    {
        $this->xCallableRegistry = $xCallableRegistry;
        $this->xDialogManager = $xDialogManager;

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

        $this->xParameterFactory = $xParameterFactory;
        // Factory for registered functions
        $this->xRqFunctionFactory = new JsCallFactory($sFunctionPrefix, $this->xDialogManager);
        // Factory for Js functions
        $this->xJsFunctionFactory = new JsCallFactory($sFunctionPrefix, $this->xDialogManager);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the js call factory.
     *
     * @param string $sClassName

Missing parameter comment

     *
     * @return JsCallFactory|null
     * @throws SetupException
     */
    public function rq(string $sClassName = ''): ?JsCallFactory
    {
        $sClassName = trim($sClassName);
        // There is a single request factory for all callable functions,
        // while each callable class has it own request factory.
        return !$sClassName ? $this->xRqFunctionFactory :

Expected 1 space after ":"; newline found

            $this->xCallableRegistry->getJsCallFactory($sClassName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the js call factory.
     *
     * @param string $sClassName

Missing parameter comment

     *
     * @return JsCallFactory|null
     */
    public function js(string $sClassName = ''): ?JsCallFactory
    {
        $sClassName = trim($sClassName);
        // There is a single request factory for all js functions,
        // while each js object has it own request factory.
        return !$sClassName ? $this->xJsFunctionFactory :

Expected 1 space after ":"; newline found

            new JsCallFactory($sClassName . '.', $this->xDialogManager);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the js call parameter factory.
     *
     * @return ParameterFactory
     */
    public function pm(): ParameterFactory
    {
        return $this->xParameterFactory;
    }

Expected 2 blank lines after function; 0 found

}