Jaxon\Response\Response

Complexity

Total Complexity

35

Size/Duplication

Total Lines	311
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getContentType()	0	4	1
A	plugin()	0	10	2
A	__get()	0	4	1
A	jq()	0	4	1
A	jQuery()	0	4	1
B	addCommand()	0	43	11
A	_addCommand()	0	27	5
A	clearCommands()	0	6	1
A	addPluginCommand()	0	5	1
A	appendResponse()	0	29	5
A	getCommands()	0	4	1
A	getCommandCount()	0	4	1
A	setReturnValue()	0	5	1
A	getOutput()	0	18	3

<?php

/**
 * Response.php - The Jaxon Response
 *
 * This class collects commands to be sent back to the browser in response to a jaxon request.
 * Commands are encoded and packaged in json format.
 *
 * Common commands include:
 * - <Response->assign>: Assign a value to an element's attribute.
 * - <Response->append>: Append a value on to an element's attribute.
 * - <Response->script>: Execute a portion of javascript code.
 * - <Response->call>: Execute an existing javascript function.
 * - <Response->alert>: Display an alert dialog to the user.
 *
 * Elements are identified by the value of the HTML id attribute.
 *
 * @package jaxon-core

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

 * @author Jared White

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author J. Max Wilson

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Joseph Woolley

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Steffen Konerow

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson

@copyright tag must contain a year and the name of the copyright holder

 * @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White  & J. Max Wilson

@copyright tag must contain a year and the name of the copyright holder

 * @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-core
 */

PHP version not specified

Missing @category tag in file comment

namespace Jaxon\Response;

class Response extends AbstractResponse

Missing doc comment for class Response

{
    use Features\DomCommands;
    use Features\JsCommands;
    use Features\DomTreeCommands;

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

    /**
     * A string, array or integer value to be returned to the caller when using 'synchronous' mode requests.
     * See <jaxon->setMode> for details.
     *
     * @var mixed
     */
    private $returnValue;

    /**
     * Get the content type, which is always set to 'application/json'
     *
     * @return string
     */
    public function getContentType()

Expected 2 blank lines before function; 1 found

    {
        return 'application/json';
    }

Expected 2 blank lines after function; 1 found

    /**
     * Provides access to registered response plugins
     *
     * Pass the plugin name as the first argument and the plugin object will be returned.
     *
     * @param string        $sName                The name of the plugin

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 16 found

     *
     * @return null|\Jaxon\Plugin\Response
     */
    public function plugin($sName)
    {
        $xPlugin = jaxon()->di()->getPluginManager()->getResponsePlugin($sName);
        if(!$xPlugin)
        {
            return null;
        }
        $xPlugin->setResponse($this);
        return $xPlugin;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Magic PHP function
     *
     * Used to permit plugins to be called as if they where native members of the Response instance.
     *
     * @param string        $sPluginName        The name of the plugin

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 8 found

     *
     * @return null|\Jaxon\Plugin\Response
     */
    public function __get($sPluginName)
    {
        return $this->plugin($sPluginName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Create a JQuery Element with a given selector, and link it to the current response.
     *
     * This is a shortcut to the JQuery plugin.
     *
     * @param string        $sSelector            The jQuery selector

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 12 found

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

Expected 1 spaces after parameter type; 8 found

Expected 2 spaces after parameter name; 13 found

     *
     * @return \Jaxon\Response\Plugin\JQuery\Dom\Element
     */
    public function jq($sSelector = '', $sContext = '')
    {
        return $this->plugin('jquery')->element($sSelector, $sContext);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Create a JQuery Element with a given selector, and link it to the current response.
     *
     * This is a shortcut to the JQuery plugin.
     *
     * @param string        $sSelector            The jQuery selector

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 12 found

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

Expected 1 spaces after parameter type; 8 found

Expected 2 spaces after parameter name; 13 found

     *
     * @return \Jaxon\Response\Plugin\JQuery\Dom\Element
     */
    public function jQuery($sSelector = '', $sContext = '')
    {
        return $this->jq($sSelector, $sContext);
    }

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 type; 13 found

Expected 1 spaces after parameter name; 8 found

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

Expected 1 spaces after parameter type; 13 found

Expected 7 spaces after parameter name; 14 found

     *
     * @return Response
     */
    public function addCommand(array $aAttributes, $mData)
    {
        array_walk($aAttributes, function(&$sAttribute) {
            if(!is_integer($sAttribute))
            {
                $sAttribute = trim((string)$sAttribute, " \t");
            }
        });

        /* merge commands if possible */

Single line block comment not allowed; use inline ("// text") comment instead

        if(in_array($aAttributes['cmd'], ['js', 'ap']))
        {
            if(($aLastCommand = array_pop($this->aCommands)))

Variable assignment found within a condition. Did you mean to do a comparison ?

            {
                if($aLastCommand['cmd'] == $aAttributes['cmd'])
                {
                    if($this->getOption('core.response.merge.js') && $aLastCommand['cmd'] == 'js')
                    {
                        $mData = $aLastCommand['data'] . '; ' . $mData;

Consider using a different name than the parameter $mData. This often makes code more readable.

                    }
                    elseif($this->getOption('core.response.merge.ap') &&
                        $aLastCommand['cmd'] == 'ap' &&
                        $aLastCommand['id'] == $aAttributes['id'] &&
                        $aLastCommand['prop'] == $aAttributes['prop'])
                    {
                        $mData = $aLastCommand['data'] . ' ' . $mData;

Consider using a different name than the parameter $mData. This often makes code more readable.

                    }
                    else
                    {
                        $this->aCommands[] = $aLastCommand;
                    }
                }
                else
                {
                    $this->aCommands[] = $aLastCommand;
                }
            }
        }
        $aAttributes['data'] = $mData;
        $this->aCommands[] = $aAttributes;

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

        return $this;
    }

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 2 spaces after parameter type; 8 found

Expected 8 spaces after parameter name; 14 found

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

Expected 3 spaces after parameter type; 9 found

Expected 2 spaces after parameter name; 8 found

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

Expected 3 spaces after parameter type; 9 found

Expected 8 spaces after parameter name; 14 found

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

Expected 1 spaces after parameter type; 7 found

Expected 1 spaces after parameter name; 7 found

     *
     * @return Response
     */
    protected function _addCommand($sName, array $aAttributes, $mData, $bRemoveEmpty = false)
    {
        if(is_array($mData))
        {
            array_walk($mData, function(&$sData) {
                $sData = trim((string)$sData, " \t\n");
            });
        }
        else
        {
            $mData = trim((string)$mData, " \t\n");

Consider using a different name than the parameter $mData. This often makes code more readable.

        }

        if($bRemoveEmpty)
        {
            foreach(array_keys($aAttributes) as $sAttr)
            {
                if($aAttributes[$sAttr] === '')
                {
                    unset($aAttributes[$sAttr]);
                }
            }
        }

        $aAttributes['cmd'] = $sName;
        return $this->addCommand($aAttributes, $mData);
    }

Expected 2 blank lines after function; 1 found

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

        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a response command that is generated by a plugin
     *
     * @param \Jaxon\Plugin\Response    $xPlugin            The plugin object

Expected 1 spaces after parameter type; 4 found

Expected 5 spaces after parameter name; 12 found

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

Expected 18 spaces after parameter type; 21 found

Expected 1 spaces after parameter name; 8 found

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

Expected 17 spaces after parameter type; 20 found

Expected 7 spaces after parameter name; 14 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Merge the response commands from the specified <Response> object with
     * the response commands in this <Response> object
     *
     * @param AbstractResponse|array    $mCommands          The <Response> object

Expected 1 spaces after parameter name; 10 found

Expected 1 spaces after parameter type; 4 found

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

Expected 3 spaces after parameter name; 12 found

Expected 16 spaces after parameter type; 19 found

     *
     * @return void
     */
    public function appendResponse($mCommands, $bBefore = false)
    {
        $aCommands = [];

$aCommands is not used, you could remove the assignment.

        if($mCommands instanceof AbstractResponse)
        {
            $this->returnValue = $mCommands->returnValue;

The property returnValue does not seem to exist in Jaxon\Response\AbstractResponse.

            $aCommands = $mCommands->aCommands;

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

The property aCommands does not seem to exist in Jaxon\Response\AbstractResponse.

        }
        elseif(is_array($mCommands))
        {
            $aCommands = $mCommands;
        }
        else
        {
            throw new \Jaxon\Exception\Error(jaxon_trans('errors.response.data.invalid'));
        }

        if(count($aCommands) > 0)
        {
            if($bBefore)
            {
                $this->aCommands = array_merge($aCommands, $this->aCommands);
            }
            else
            {
                $this->aCommands = array_merge($this->aCommands, $aCommands);
            }
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the commands in the response
     *
     * @return array
     */
    public function getCommands()
    {
        return $this->aCommands;
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Stores a value that will be passed back as part of the response
     *
     * When making synchronous requests, the calling javascript can obtain this value
     * immediately as the return value of the <jaxon.call> javascript function
     *
     * @param mixed        $value                Any value

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 16 found

     *
     * @return Response
     */
    public function setReturnValue($value)
    {
        $this->returnValue = $value;
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Return the output, generated from the commands added to the response, that will be sent to the browser
     *
     * @return string
     */
    public function getOutput()
    {
        $response = [
            'jxnobj' => [],
        ];

        if(($this->returnValue))
        {
            $response['jxnrv'] = $this->returnValue;
        }

        foreach($this->aCommands as $xCommand)
        {
            $response['jxnobj'][] = $xCommand;
        }

        return json_encode($response);
    }

Expected 2 blank lines after function; 0 found

}