Response::clearCommands() - Code Metrics - Inspection of "Added a method for the databag in the response." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 888408...eb1365 )

by Thierry
created 2022-03-20 05:59 UTC
Response::clearCommands() A

↳ Parent: Response
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	4
rs	10
<?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

 * @author Jared White

 * @author J. Max Wilson

 * @author Joseph Woolley

 * @author Steffen Konerow

 * @author Thierry Feuzeu <[email protected]>
 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson

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

 * @copyright 2016 Thierry Feuzeu <[email protected]>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */


namespace Jaxon\Response;

use Jaxon\Plugin\PluginManager;
use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Response\Plugin\DataBag\DataBagContext;
use Jaxon\Response\Plugin\JQuery\DomSelector;
use Jaxon\Utils\Translation\Translator;
use Jaxon\Exception\RequestException;

use function array_keys;
use function array_map;
use function array_merge;
use function count;
use function is_array;
use function is_integer;
use function json_encode;
use function trim;

class Response extends AbstractResponse

{
    use Traits\DomTrait;
    use Traits\JsTrait;
    use Traits\DomTreeTrait;

    /**
     * @var Translator
     */
    protected $xTranslator;

    /**
     * @var PluginManager
     */
    protected $xPluginManager;

    /**
     * The commands that will be sent to the browser in the response
     *
     * @var array
     */
    protected $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
     */
    protected $xReturnValue;

    /**
     * The constructor
     *
     * @param Translator $xTranslator

     * @param PluginManager $xPluginManager

     */
    public function __construct(Translator $xTranslator, PluginManager $xPluginManager)

    {
        $this->xTranslator = $xTranslator;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xPluginManager = $xPluginManager;
    }


    /**
     * Create a new Jaxon response object
     *
     * @return Response
     */
    public function newResponse(): Response
    {
        return new Response($this->xTranslator, $this->xPluginManager);
    }


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


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

     *
     * @return null|ResponsePlugin
     */
    public function plugin(string $sName): ?ResponsePlugin
    {
        return $this->xPluginManager->getResponsePlugin($sName, $this);
    }


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

     *
     * @return null|ResponsePlugin
     */
    public function __get(string $sPluginName)
    {
        return $this->plugin($sPluginName);
    }


    /**
     * Create a JQuery DomSelector, and link it to the current response.
     *
     * This is a shortcut to the JQuery plugin.
     *
     * @param string $sPath    The jQuery selector path
     * @param string $sContext    A context associated to the selector

     *
     * @return DomSelector
     */
    public function jq(string $sPath = '', string $sContext = ''): DomSelector
    {
        return $this->plugin('jquery')->selector($sPath, $sContext);
        return $this->plugin('jquery')->/** @scrutinizer ignore-call */ selector($sPath, $sContext);
    }


    /**
     * @param string $sName

     *
     * @return DataBagContext
     */
    public function bag(string $sName): DataBagContext
    {
        return $this->plugin('bags')->bag($sName);;
        return $this->plugin('bags')->/** @scrutinizer ignore-call */ bag($sName);;
    }


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

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

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

        $aAttributes['data'] = $mData;
        $this->aCommands[] = $aAttributes;
$a = "a";
$ab = "ab";
$abc = "abc";

        return $this;
    }


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

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

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

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

     *
     * @return Response
     */
    protected function _addCommand(string $sName, array $aAttributes, $mData, bool $bRemoveEmpty = false): Response
    {
        $mData = is_array($mData) ? array_map(function($sData) {
            return trim((string)$sData, " \t\n");
        }, $mData) : trim((string)$mData, " \t\n");

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

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


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


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

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

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

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


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

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

     *
     * @return void
     * @throws RequestException
     */
    public function appendResponse($mCommands, bool $bBefore = false)
    {
        if($mCommands instanceof Response)
        {
            $this->xReturnValue = $mCommands->xReturnValue;
            $aCommands = $mCommands->aCommands;
$a = "a";
$ab = "ab";
$abc = "abc";
        }
        elseif(is_array($mCommands))

        {
            $aCommands = $mCommands;
        }
        else
        {
            throw new RequestException($this->xTranslator->trans('errors.response.data.invalid'));
        }

        $this->aCommands = ($bBefore) ?

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

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


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


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


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

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


    /**
     * Return the output, generated from the commands added to the response, that will be sent to the browser
     *
     * @return string
     */
    public function getOutput(): string
    {
        $aResponse = ['jxnobj' => []];
        if(($this->xReturnValue))
        {
            $aResponse['jxnrv'] = $this->xReturnValue;
        }
        foreach($this->aCommands as $xCommand)
        {
            $aResponse['jxnobj'][] = $xCommand;
        }

        return json_encode($aResponse);
    }

}

jaxon-php / jaxon-core

Push — master ( 888408...eb1365 )

Response::clearCommands() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
