Jaxon\Response\Traits\CommandTrait

Complexity

Total Complexity

13

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getCommandCount()	0	3	1
A	_addCommand()	0	14	3
A	addRawCommand()	0	5	1
A	getCommands()	0	3	1
A	clearCommands()	0	3	1
A	addPluginCommand()	0	4	1
A	appendCommands()	0	5	2
A	addCommand()	0	6	2
A	appendResponse()	0	3	1

<?php

Missing file doc comment

namespace Jaxon\Response\Traits;

use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Response\ResponseInterface;

use function array_filter;
use function array_map;
use function array_merge;
use function count;
use function is_array;
use function is_integer;
use function trim;

trait CommandTrait

Missing doc comment for trait CommandTrait

{
    /**
     * The commands that will be sent to the browser in the response
     *
     * @var array
     */
    protected $aCommands = [];

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

    /**
     * Get the commands in the response
     *
     * @return array
     */
    public function getCommands(): array

Expected 2 blank lines before function; 1 found

    {
        return $this->aCommands;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the number of commands in the response
     *
     * @return int
     */
    public function getCommandCount(): int
    {
        return count($this->aCommands);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Clear all the commands already added to the response
     *
     * @return void
     */
    public function clearCommands()
    {
        $this->aCommands = [];
    }

Expected 2 blank lines after function; 1 found

    /**
     * Merge the commands with those in this <Response> object
     *
     * @param array $aCommands    The commands to merge

Expected 1 spaces after parameter name; 4 found

     * @param bool $bBefore    Add the new commands to the beginning of the list

Expected 2 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function appendCommands(array $aCommands, bool $bBefore = false)
    {
        $this->aCommands = ($bBefore) ?

Expected 1 space after "?"; newline found

            array_merge($aCommands, $this->aCommands) :

Expected 1 space after ":"; newline found

            array_merge($this->aCommands, $aCommands);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Merge the response commands with those in this <Response> object
     *
     * @param ResponseInterface $xResponse    The <Response> object

Expected 1 spaces after parameter name; 4 found

     * @param bool $bBefore    Add the new commands to the beginning of the list

Expected 14 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 4 found

     *
     * @return void
     */
    public function appendResponse(ResponseInterface $xResponse, bool $bBefore = false)
    {
        $this->appendCommands($xResponse->getCommands(), $bBefore);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a response command to the array of commands that will be sent to the browser
     *
     * @param array $aAttributes    Associative array of attributes that will describe the command

Expected 1 spaces after parameter name; 4 found

     * @param mixed $mData    The data to be associated with this command

Expected 7 spaces after parameter name; 4 found

     *
     * @return ResponseInterface
     */
    public function addRawCommand(array $aAttributes, $mData): ResponseInterface
    {
        $aAttributes['data'] = $mData;
        $this->aCommands[] = $aAttributes;

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

        return $this;

The expression return $this returns the type Jaxon\Response\Traits\CommandTrait which is incompatible with the type-hinted return Jaxon\Response\ResponseInterface.

    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a response command to the array of commands that will be sent to the browser
     * Convert all attributes, excepted integers, to string.
     *
     * @param array $aAttributes    Associative array of attributes that will describe the command

Expected 1 spaces after parameter name; 4 found

     * @param mixed $mData    The data to be associated with this command

Expected 7 spaces after parameter name; 4 found

     *
     * @return ResponseInterface
     */
    public function addCommand(array $aAttributes, $mData): ResponseInterface
    {
        $aAttributes = array_map(function($xAttribute) {
            return is_integer($xAttribute) ? $xAttribute : trim((string)$xAttribute, " \t");
        }, $aAttributes);
        return $this->addRawCommand($aAttributes, $mData);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a response command to the array of commands that will be sent to the browser
     *
     * @param string $sName    The command name

Expected 8 spaces after parameter name; 4 found

     * @param array $aAttributes    Associative array of attributes that will describe the command

Expected 2 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 4 found

     * @param mixed $mData    The data to be associated with this command

Expected 2 spaces after parameter type; 1 found

Expected 8 spaces after parameter name; 4 found

     * @param bool $bRemoveEmpty    If true, remove empty attributes

Expected 3 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return ResponseInterface
     */
    protected function _addCommand(string $sName, array $aAttributes,
        $mData, bool $bRemoveEmpty = false): ResponseInterface
    {
        $mData = is_array($mData) ? array_map(function($sData) {
            return trim((string)$sData, " \t\n");
        }, $mData) : trim((string)$mData, " \t\n");
        if($bRemoveEmpty)
        {
            $aAttributes = array_filter($aAttributes, function($xValue) {
                return $xValue === '';
            });
        }
        $aAttributes['cmd'] = $sName;
        return $this->addCommand($aAttributes, $mData);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a response command that is generated by a plugin
     *
     * @param ResponsePlugin $xPlugin    The plugin object

Expected 5 spaces after parameter name; 4 found

     * @param array $aAttributes    The attributes for this response command

Expected 10 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     * @param mixed $mData    The data to be sent with this command

Expected 10 spaces after parameter type; 1 found

Expected 7 spaces after parameter name; 4 found

     *
     * @return ResponseInterface
     */
    public function addPluginCommand(ResponsePlugin $xPlugin, array $aAttributes, $mData): ResponseInterface
    {
        $aAttributes['plg'] = $xPlugin->getName();
        return $this->addCommand($aAttributes, $mData);
    }

Expected 2 blank lines after function; 0 found

}