Response::jq() - Code Metrics - Inspection of "Improved the dialog plugin system." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — v5.x ( 57c2ac...73bdb8 )

by Thierry
created 2024-05-10 11:04 UTC
Response::jq() A

↳ Parent: Response
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

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

 * @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\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\PaginatorPlugin;
use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Request\Call\Call;
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

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

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

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

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

    /**
     * The constructor
     *
     * @param PluginManager $xPluginManager

     * @param Psr17Factory $xPsr17Factory

     * @param PsrRequestInterface $xRequest

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

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


    /**
     * @inheritDoc
     */

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


    /**
     * @inheritDoc
     */

    public function getOutput(): string
    {
        return $this->getCommandCount() === 0 ? '{}' :

            json_encode(['jxnobj' => $this->aCommands]);
    }


    /**
     * 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);
    }


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

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


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

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

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


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

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

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


    /**
     * Render an HTML pagination control.
     *
     * @param Call $xCall

     * @param int $nCurrentPage     The current page number

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

     * @param int $nTotalItems      The total number of items

     *
     * @return void
     */
    public function paginate(Call $xCall, int $nCurrentPage, int $nItemsPerPage, int $nTotalItems)
    {
        /** @var PaginatorPlugin */

        $xPlugin = $this->plugin('pg');
        $xPlugin->render($xCall, $nCurrentPage, $nItemsPerPage, $nTotalItems);
                  render($xCall, $nCurrentPage, $nItemsPerPage, $nTotalItems);
    }


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

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

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

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

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

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

    }

}

jaxon-php / jaxon-core

Push — v5.x ( 57c2ac...73bdb8 )

Response::jq() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
