Jaxon\Response\Traits\DomTreeTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	domStartResponse()	0	3	1
A	domEndResponse()	0	3	1
A	domInsertAfter()	0	4	1
A	domRemoveChildren()	0	4	1
A	domAppendChild()	0	4	1
A	domCreateElement()	0	4	1
A	domAppendText()	0	4	1
A	domInsertBefore()	0	4	1
A	domSetAttribute()	0	4	1

<?php

/**
 * DomTreeTrait.php - Provides DOM (HTML) related commands for the Response
 *
 * @author 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-core
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

namespace Jaxon\Response\Traits;

use Jaxon\Response\Response;

trait DomTreeTrait

Missing doc comment for trait DomTreeTrait

{
    /**
     * 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 name; 4 found

Expected 2 spaces after parameter type; 1 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 Response
     */
    abstract protected function _addCommand(string $sName, array $aAttributes, $mData, bool $bRemoveEmpty = false): Response;

Expected 2 blank lines before function; 0 found

Expected 2 blank lines after function; 1 found

    /**
     * Add a command to start a DOM response
     *
     * @return Response
     */
    public function domStartResponse(): Response
    {
        return $this->_addCommand('DSR', [], '');
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a command to create a DOM element
     *
     * @param string $sVariable    The DOM element name (id or class)

Expected 1 spaces after parameter name; 4 found

     * @param string $sTag    The HTML tag of the new DOM element

Expected 6 spaces after parameter name; 4 found

     *
     * @return Response
     */
    public function domCreateElement(string $sVariable, string $sTag): Response
    {
        $aAttributes = ['tgt' => $sVariable];
        return $this->_addCommand('DCE', $aAttributes, $sTag);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a command to set an attribute on a DOM element
     *
     * @param string $sVariable    The DOM element name (id or class)

Expected 1 spaces after parameter name; 4 found

     * @param string $sKey    The name of the attribute

Expected 6 spaces after parameter name; 4 found

     * @param string $sValue    The value of the attribute
     *
     * @return Response
     */
    public function domSetAttribute(string $sVariable, string $sKey, string $sValue): Response
    {
        $aAttributes = ['tgt' => $sVariable, 'key' => $sKey];
        return $this->_addCommand('DSA', $aAttributes, $sValue);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a command to remove children from a DOM element
     *
     * @param string $sParent    The DOM parent element

Expected 1 spaces after parameter name; 4 found

     * @param int $nSkip    The number of children to skip

Expected 4 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 4 found

     * @param int $nRemove    The number of children to remove

Expected 1 spaces after parameter name; 4 found

Expected 4 spaces after parameter type; 1 found

     *
     * @return Response
     */
    public function domRemoveChildren(string $sParent, int $nSkip = 0, int $nRemove = 0): Response
    {
        $aAttributes = ['skip' => $nSkip, 'remove' => $nRemove];
        return $this->_addCommand('DRC', $aAttributes, $sParent, true);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a command to append a child to a DOM element
     *
     * @param string $sParent    The DOM parent element

Expected 3 spaces after parameter name; 4 found

     * @param string $sVariable    The DOM element name (id or class)

Expected 1 spaces after parameter name; 4 found

     *
     * @return Response
     */
    public function domAppendChild(string $sParent, string $sVariable): Response
    {
        $aAttributes = ['par' => $sParent];
        return $this->_addCommand('DAC', $aAttributes, $sVariable);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a command to insert a DOM element before another
     *
     * @param string $sTarget    The DOM target element

Expected 3 spaces after parameter name; 4 found

     * @param string $sVariable    The DOM element name (id or class)

Expected 1 spaces after parameter name; 4 found

     *
     * @return Response
     */
    public function domInsertBefore(string $sTarget, string $sVariable): Response
    {
        $aAttributes = ['tgt' => $sTarget];
        return $this->_addCommand('DIB', $aAttributes, $sVariable);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a command to insert a DOM element after another
     *
     * @param string $sTarget    The DOM target element

Expected 3 spaces after parameter name; 4 found

     * @param string $sVariable    The DOM element name (id or class)

Expected 1 spaces after parameter name; 4 found

     *
     * @return Response
     */
    public function domInsertAfter(string $sTarget, string $sVariable): Response
    {
        $aAttributes = ['tgt' => $sTarget];
        return $this->_addCommand('DIA', $aAttributes, $sVariable);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a command to append a text to a DOM element
     *
     * @param string $sParent    The DOM parent element

Expected 1 spaces after parameter name; 4 found

     * @param string $sText    The HTML text to append

Expected 3 spaces after parameter name; 4 found

     *
     * @return Response
     */
    public function domAppendText(string $sParent, string $sText): Response
    {
        $aAttributes = ['par' => $sParent];
        return $this->_addCommand('DAT', $aAttributes, $sText);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a command to end a DOM response
     *
     * @return Response
     */
    public function domEndResponse(): Response
    {
        return $this->_addCommand('DER', [], '');
    }

Expected 2 blank lines after function; 0 found

}