Jaxon\Response\Response

Complexity

Total Complexity

12

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Importance

Changes	22
Bugs	1	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	__get()	0	3	1
A	bag()	0	5	1
A	str()	0	3	1
A	jq()	0	5	1
A	getContentType()	0	3	1
A	dialog()	0	3	1
A	getOutput()	0	3	1
A	plugin()	0	3	1
A	paginator()	0	5	1
A	toPsr()	0	14	2

<?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.
 *
 * @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;

use Jaxon\App\Dialog\DialogManager;
use Jaxon\Plugin\Manager\PluginManager;
use Jaxon\Plugin\Response\DataBag\DataBagContext;
use Jaxon\Plugin\Response\DataBag\DataBagPlugin;
use Jaxon\Plugin\Response\JQuery\DomSelector;
use Jaxon\Plugin\Response\JQuery\JQueryPlugin;
use Jaxon\Plugin\Response\Pagination\Paginator;
use Jaxon\Plugin\Response\Pagination\PaginatorPlugin;
use Jaxon\Plugin\ResponsePlugin;
use Nyholm\Psr7\Factory\Psr17Factory;
use Nyholm\Psr7\Stream;
use Psr\Http\Message\ResponseInterface as PsrResponseInterface;
use Psr\Http\Message\ServerRequestInterface as PsrRequestInterface;

use function gmdate;
use function json_encode;
use function trim;

class Response implements ResponseInterface

Missing doc comment for class Response

{
    use Traits\CommandTrait;
    use Traits\HtmlDomTrait;
    use Traits\ScriptTrait;

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

    /**
     * @var DialogManager
     */
    protected $xDialogManager;

    /**
     * @var Psr17Factory
     */
    protected $xPsr17Factory;

    /**
     * @var PsrRequestInterface
     */
    protected $xRequest;

    /**
     * The constructor
     *
     * @param Psr17Factory $xPsr17Factory

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

     * @param PsrRequestInterface $xRequest

Missing parameter comment

     * @param PluginManager $xPluginManager

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param DialogManager $xDialogManager

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     */
    public function __construct(Psr17Factory $xPsr17Factory, PsrRequestInterface $xRequest,

Expected 2 blank lines before function; 1 found

        PluginManager $xPluginManager, DialogManager $xDialogManager)
    {
        $this->xPsr17Factory = $xPsr17Factory;
        $this->xRequest = $xRequest;

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

        $this->xPluginManager = $xPluginManager;
        $this->xDialogManager = $xDialogManager;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @return DialogManager
     */
    protected function dialog(): DialogManager
    {
        return $this->xDialogManager;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getContentType(): string
    {
        return 'application/json';
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getOutput(): string
    {
        return json_encode(['jxn' => ['commands' => $this->aCommands]]);
    }

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

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

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter name; 4 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Convert to string
     *
     * @param mixed $xData

Missing parameter comment

     *
     * @return string
     */
    protected function str($xData): string
    {
        return trim((string)$xData, " \t\n");
    }

Expected 2 blank lines after function; 1 found

    /**
     * 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 mixed $xContext    A context associated to the selector

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 found

     *
     * @return DomSelector
     */
    public function jq(string $sPath = '', $xContext = null): DomSelector
    {
        /** @var JQueryPlugin */

Block comments must be started with /*

        $xPlugin = $this->plugin('pg');
        return $xPlugin->selector($sPath, $xContext);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the databag with a given name
     *
     * @param string $sName

Missing parameter comment

     *
     * @return DataBagContext
     */
    public function bag(string $sName): DataBagContext
    {
        /** @var DataBagPlugin */

Block comments must be started with /*

        $xPlugin = $this->plugin('pg');
        return $xPlugin->bag($sName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Render an HTML pagination control.
     *
     * @param int $nCurrentPage     The current page number

Expected 2 spaces after parameter name; 5 found

     * @param int $nItemsPerPage    The number of items per page

Expected 1 spaces after parameter name; 4 found

     * @param int $nTotalItems      The total number of items

Expected 3 spaces after parameter name; 6 found

     *
     * @return Paginator
     */
    public function paginator(int $nCurrentPage, int $nItemsPerPage, int $nTotalItems): Paginator
    {
        /** @var PaginatorPlugin */

Block comments must be started with /*

        $xPlugin = $this->plugin('pg');
        return $xPlugin->paginator($nCurrentPage, $nItemsPerPage, $nTotalItems);

The method paginator() does not exist on Jaxon\Plugin\ResponsePlugin. It seems like you code against a sub-type of Jaxon\Plugin\ResponsePlugin such as Jaxon\Plugin\Response\Pagination\PaginatorPlugin.

    }

Expected 2 blank lines after function; 1 found

    /**
     * Convert this response to a PSR7 response object
     *
     * @return PsrResponseInterface
     */
    public function toPsr(): PsrResponseInterface
    {
        $xPsrResponse = $this->xPsr17Factory->createResponse(200);
        if($this->xRequest->getMethod() === 'GET')
        {
            $xPsrResponse = $xPsrResponse
                ->withHeader('Expires', 'Mon, 26 Jul 1997 05:00:00 GMT')

Space found before object operator

                ->withHeader('Last-Modified', gmdate("D, d M Y H:i:s") . ' GMT')

Space found before object operator

                ->withHeader('Cache-Control', 'no-cache, must-revalidate')

Space found before object operator

                ->withHeader('Pragma', 'no-cache');

Space found before object operator

        }
        return $xPsrResponse
            ->withHeader('content-type', $this->getContentType())

Space found before object operator

            ->withBody(Stream::create($this->getOutput()));

Space found before object operator

    }

Expected 2 blank lines after function; 0 found

}