Jaxon\Response\Plugin\JQuery\JQueryPlugin

Complexity

Total Complexity

6

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	element()	0	6	2
A	getHash()	0	4	1
A	getName()	0	3	1
A	getReadyScript()	0	3	1
A	__construct()	0	3	1

<?php

Missing file doc comment

namespace Jaxon\Response\Plugin\JQuery;

use Jaxon\Response\Plugin\JQuery\Dom\Element;
use Jaxon\Utils\Config\Config;

class JQueryPlugin extends \Jaxon\Plugin\Response

Missing doc comment for class JQueryPlugin

{
    /**
     * @var Config
     */
    protected $xConfig;

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

    /**
     * The class constructor
     *
     * @param Config $xConfig

Missing parameter comment

     */
    public function __construct(Config $xConfig)

Expected 2 blank lines before function; 1 found

    {
        $this->xConfig = $xConfig;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return 'jquery';
    }

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 '3.3.0';
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getReadyScript(): string
    {
        return '
    jaxon.command.handler.register("jquery", function(args) {
        jaxon.cmd.script.execute(args);
    });
';
    }

Expected 2 blank lines after function; 1 found

    /**
     * Create a JQueryPlugin Element with a given selector, 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 $sSelector    The jQuery selector

Expected 1 spaces after parameter name; 4 found

     * @param string $sContext    A context associated to the selector

Expected 2 spaces after parameter name; 4 found

     *
     * @return Element
     */
    public function element(string $sSelector = '', string $sContext = ''): Element
    {
        $jQueryNs = $this->xConfig->getOption('core.jquery.no_conflict', false) ? 'jQuery' : '$';
        $xElement = new Element($jQueryNs, $sSelector, $sContext);
        $this->addCommand(['cmd' => 'jquery'], $xElement);
        return $xElement;
    }

Expected 2 blank lines after function; 0 found

}