Jaxon\Request\Js\Selector

Complexity

Total Complexity

20

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	jsonSerialize()	0	3	1
A	__set()	0	4	1
A	on()	0	3	1
A	__get()	0	6	1
A	getType()	0	3	1
A	toArray()	0	16	3
A	__call()	0	6	1
A	click()	0	3	1
A	toInt()	0	4	1
A	getPathAsArray()	0	9	2
A	__toString()	0	4	2
A	getPathAsStr()	0	17	4

<?php

/**
 * Selector.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 Selector object must be converted to the corresponding jQuery code.
 * Therefore, the Selector class implements the JsonSerializable interface.
 *
 * When used as a parameter of a Jaxon call, the Selector must be converted to Jaxon request parameter.
 * Therefore, the Selector class also implements the Jaxon\Request\Js\ParameterInterface 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
 */

PHP version not specified

Missing @category tag in file comment

namespace Jaxon\Request\Js;

use function implode;
use function trim;

class Selector implements ParameterInterface

Missing doc comment for class Selector

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

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

    /**
     * The jQuery selector context
     *
     * @var mixed
     */
    protected $xContext;

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

    /**
     * Convert the selector value to integer
     *
     * @var bool

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

     */
    protected $bToInt = false;

    /**
     * The constructor.
     *
     * @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

     */
    public function __construct(string $sPath, $xContext)

Expected 2 blank lines before function; 1 found

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

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

        $this->xContext = $xContext;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getType(): string
    {
        return 'selector';
    }

Expected 2 blank lines after function; 1 found

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

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param array  $aArguments

Missing parameter comment

     *
     * @return Selector
     */
    public function __call(string $sMethod, array $aArguments)
    {
        // Append the action into the array
        $this->aCalls[] = new Selector\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

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     *
     * @return Selector
     */
    public function __get(string $sAttribute)
    {
        // Append the action into the array
        $this->aCalls[] = new Selector\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 mixed $xValue

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Set an event handler on the first selected element
     *
     * @param string $sName

Missing parameter comment

     * @param Call $xHandler

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return void
     */
    public function on(string $sName, Call $xHandler)
    {
        $this->aCalls[] = new Selector\Event($sName, $xHandler);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set an "click" event handler on the first selected element
     *
     * @param Call $xHandler

Missing parameter comment

     *
     * @return void
     */
    public function click(Call $xHandler)
    {
        $this->on('click', $xHandler);
    }

Expected 2 blank lines after function; 1 found

    /**
     * @return Selector
     */
    public function toInt(): Selector
    {
        $this->bToInt = true;
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the selector js.
     *
     * @return string
     */
    private function getPathAsStr()
    {
        $jQuery = 'jaxon.jq'; // The JQuery selector
        if(!$this->sPath)
        {
            // If an empty selector is given, use the event target instead
            return "$jQuery(e.currentTarget)";
        }
        if(!$this->xContext)
        {
            return "$jQuery('" . $this->sPath . "')";
        }

        $sContext = is_a($this->xContext, self::class) ?

Expected 1 space after "?"; newline found

            $this->xContext->getScript() :

The method getScript() does not exist on Jaxon\Request\Js\Selector. Since you implemented __call, consider adding a @method annotation.

Expected 1 space after ":"; newline found

            "$jQuery('" . trim("{$this->xContext}") . "')";
        return "$jQuery('{$this->sPath}', $sContext)";
    }

Expected 2 blank lines after function; 1 found

    /**
     * Generate the jQuery call.
     *
     * @return string
     */
    public function __toString(): string
    {
        $sScript = $this->getPathAsStr() . implode('', $this->aCalls);
        return $this->bToInt ? "parseInt($sScript)" : $sScript;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @return array
     */
    private function getPathAsArray()
    {
        $sName = $this->sPath ?? 'this';
        $aCall = ['_type' => 'select', '_name' => $sName];
        if(($this->xContext))
        {
            $aCall['context'] = $this->xContext;
        }
        return $aCall;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @return array
     */
    public function toArray(): array
    {
        $aCalls = [$this->getPathAsArray()];
        foreach($this->aCalls as $xCall)
        {
            $aCalls[] = $xCall->jsonSerialize();
        }
        if($this->bToInt)
        {
            $aCalls[] = [
                '_type' => 'func',
                '_name' => 'toInt',
                'args' => [[ '_type' => '_', '_name' => 'this' ]],
            ];
        }
        return ['_type' => 'expr', 'calls' => $aCalls];
    }

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 array
     */
    public function jsonSerialize(): array
    {
        return $this->toArray();
    }

Expected 2 blank lines after function; 0 found

}