Jaxon\Plugin\Response\JQuery\JQueryPlugin

Complexity

Total Complexity

7

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	__construct()	0	3	1
A	getHash()	0	4	1
A	command()	0	4	1
A	selector()	0	10	3

<?php

Missing file doc comment

namespace Jaxon\Plugin\Response\JQuery;

use Jaxon\Plugin\ResponsePlugin;

class JQueryPlugin extends ResponsePlugin

Missing doc comment for class JQueryPlugin

{
    /**
     * @const The plugin name
     */
    const NAME = 'jquery';

    /**
     * @var string
     */
    protected $jQueryNs;

    /**
     * True if the next selector is a command
     *
     * @var bool

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

     */
    protected $bCommand = true;

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

Missing parameter comment

     */
    public function __construct(string $jQueryNs)

Expected 2 blank lines before function; 1 found

    {
        $this->jQueryNs = $jQueryNs;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @param bool $bCommand

Missing parameter comment

     *
     * @return JQueryPlugin
     */
    public function command(bool $bCommand): JQueryPlugin
    {
        $this->bCommand = $bCommand;
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return self::NAME;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getHash(): string
    {
        // Use the version number as hash
        return '4.0.0';
    }

Expected 2 blank lines after function; 1 found

    /**
     * Create a JQueryPlugin DomSelector, and link it to the current response.
     *
     * Since this element is linked to a response, its code will be automatically sent to the client.
     * The returned object can be used to call jQuery functions on the selected elements.
     *
     * @param string $sPath    The jQuery selector path
     * @param mixed $xContext    A context associated to the selector

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return DomSelector
     */
    public function selector(string $sPath = '', $xContext = null): DomSelector
    {
        $xSelector = new DomSelector($sPath, $xContext);
        if($this->bCommand && $this->response() !== null)
        {
            $this->addCommand('jquery', ['selector' => $xSelector]);
        }
        // Reset the command value.
        $this->bCommand = true;
        return $xSelector;
    }

Expected 2 blank lines after function; 0 found

}