Jaxon\Response\Plugin\JQuery\DomSelector

Complexity

Total Complexity

10

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getScript()	0	7	2
A	jsonSerialize()	0	3	1
A	__toString()	0	3	1
A	__construct()	0	17	3
A	__get()	0	6	1
A	__set()	0	4	1
A	__call()	0	6	1

<?php

/**
 * DomSelector.php - A jQuery selector
 *
 * This class is used to create client side requests to the Jaxon functions and callable objects.
 *
 * When inserted into a Jaxon response, a DomSelector object must be converted to the corresponding jQuery code.
 * Therefore, the DomSelector class implements the JsonSerializable interface.
 *
 * When used as a parameter of a Jaxon call, the DomSelector must be converted to Jaxon request parameter.
 * Therefore, the DomSelector class also implements the Jaxon\Request\Contracts\Parameter interface.
 *
 * @package jaxon-jquery

Package name "jaxon-jquery" is not valid; consider "Jaxonjquery" instead

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @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-jquery
 */

Missing @category tag in file comment

PHP version not specified

namespace Jaxon\Response\Plugin\JQuery;

use Jaxon\Request\Call\Contracts\Parameter;
use Jaxon\Response\Plugin\JQuery\Call\AttrGet;
use Jaxon\Response\Plugin\JQuery\Call\AttrSet;
use Jaxon\Response\Plugin\JQuery\Call\Method;

use JsonSerializable;

use function count;
use function implode;
use function trim;

class DomSelector implements JsonSerializable, Parameter

Missing doc comment for class DomSelector

{
    /**
     * The jQuery selector path
     *
     * @var string
     */
    protected $sPath;

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

    /**
     * The actions to be applied on the selected element
     *
     * @var array
     */
    protected $aCalls;

    /**
     * The constructor.
     *
     * @param string $jQueryNs    The jQuery symbol

Expected 1 spaces after parameter name; 4 found

     * @param string $sPath    The jQuery selector path
     * @param string $sContext    A context associated to the selector

Expected 1 spaces after parameter name; 4 found

     */
    public function __construct(string $jQueryNs, string $sPath, string $sContext)

Expected 2 blank lines before function; 1 found

    {
        $sPath = trim($sPath, " \t");

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

        $sContext = trim($sContext, " \t");

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

        $this->aCalls = [];

        if(!$sPath)
        {
            $this->sPath = "$jQueryNs(this)"; // If an empty selector is given, use javascript "this" instead
        }
        elseif(($sContext))
        {
            $this->sPath = "$jQueryNs('" . $sPath . "', $jQueryNs('" . $sContext . "'))";
        }
        else
        {
            $this->sPath = "$jQueryNs('" . $sPath . "')";
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a call to a jQuery method on the selected elements
     *
     * @param string  $sMethod

Expected 1 spaces after parameter type; 2 found

Missing parameter comment

     * @param array  $aArguments

Missing parameter comment

     *
     * @return DomSelector
     */
    public function __call(string $sMethod, array $aArguments)
    {
        // Push the action into the array
        $this->aCalls[] = new Method($sMethod, $aArguments);
        // Return $this so the calls can be chained
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the value of an attribute on the first selected element
     *
     * @param string  $sAttribute

Expected 1 spaces after parameter type; 2 found

Missing parameter comment

     *
     * @return DomSelector
     */
    public function __get(string $sAttribute)
    {
        // Push the action into the array
        $this->aCalls[] = new AttrGet($sAttribute);
        // Return $this so the calls can be chained
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the value of an attribute on the first selected element
     *
     * @param string $sAttribute

Missing parameter comment

     * @param $xValue

Missing parameter comment

     *
     * @return void
     */
    public function __set(string $sAttribute, $xValue)
    {
        // Push the action into the array
        $this->aCalls[] = new AttrSet($sAttribute, $xValue);
        // No other call is allowed after a set
        // return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Generate the jQuery call.
     *
     * @return string
     */
    public function getScript(): string
    {
        if(count($this->aCalls) === 0)
        {
            return $this->sPath;
        }
        return $this->sPath . '.' . implode('.', $this->aCalls);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Magic function to generate the jQuery call.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getScript();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Generate the jQuery call, when converting the response into json.
     *
     * This is a method of the JsonSerializable interface.
     *
     * @return string
     */
    public function jsonSerialize(): string
    {
        return $this->getScript();
    }

Expected 2 blank lines after function; 0 found

}