Ajax::respondJson() - Code Metrics - terrylinooo/shieldon - Measure and Improve Code Quality continuously with Scrutinizer

Ajax::respondJson() A
last analyzed 2023-06-17 08:58 UTC

↳ Parent: Ajax

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	8
c	2
b	0
f	0
dl	0
loc	13
ccs	6
cts	6
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1

<?php
/**
 * This file is part of the Shieldon package.
 *
 * (c) Terry L. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * php version 7.1.0
 *
 * @category  Web-security
 * @package   Shieldon
 * @author    Terry Lin <[email protected]>
 * @copyright 2019 terrylinooo
 * @license   https://github.com/terrylinooo/shieldon/blob/2.x/LICENSE MIT
 * @link      https://github.com/terrylinooo/shieldon
 * @see       https://shieldon.io
 */

declare(strict_types=1);

namespace Shieldon\Firewall\Panel;

use Psr\Http\Message\ResponseInterface;
use Shieldon\Firewall\Panel\BaseController;
use Shieldon\Firewall\HttpFactory;
use function Shieldon\Firewall\__;
use function Shieldon\Firewall\get_request;
use function Shieldon\Firewall\get_response;
use function Shieldon\Firewall\get_session_instance;
use function Shieldon\Firewall\set_request;
use function array_map;
use function explode;
use function file_exists;
use function gethostname;
use function implode;
use function json_encode;

/**
 * User
 */
class Ajax extends BaseController
{
    /**
     *   Public methods       | Desctiotion
     *  ----------------------|---------------------------------------------
     *   __call               | The magic method.
     *   changeLocale         | Change the user's language of the UI.
     *   tryMessenger         | Test messenger modules.
     *  ----------------------|---------------------------------------------
     */

    /**
     * Constructor.
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Fallback for undefined methods.
     *
     * @param string $function The method name.
     * @param array  $args     The arguments.
     *
     * @return bool
     */
    public function __call($function, $args): bool
    {
        $className = 'Shieldon\Firewall\Panel\Sandbox\\' . $function;

        if (file_exists(__DIR__ . '/Sandbox/' . $function . '.php')) {
            $sandbox = new $className();
            return $sandbox($args);
        }
        return false;
    }

    /**
     * Change the user's language of the UI.
     *
     * @return ResponseInterface
     */
    public function changeLocale(): ResponseInterface
    {
        $langCode = get_request()->getQueryParams()['langCode'] ?? 'en';
        get_session_instance()->set('shieldon_panel_lang', $langCode);
        get_session_instance()->save();
        $data = [];

        $data['status'] = 'success';
        $data['lang_code'] = $langCode;
        $data['session_lang_code'] = $langCode;
 
        $output = json_encode($data);

        return $this->respondJson($output);
    }

    /**
     * Test messenger modules.
     *
     * @return ResponseInterface
     */
    public function tryMessenger(): ResponseInterface
    {
        $request = get_request();
        $message = [];

        $getParams = $request->getQueryParams();
        $serverParams = $request->getServerParams();

        $serverName = $serverParams['SERVER_NAME'] ?? gethostname();
        $moduleName = $getParams['module'] ?? '';

        $data = [];
        $data['status'] = 'undefined';
        $data['result']['moduleName'] = $moduleName;

        $message['title'] = __('panel', 'test_msg_title', 'Testing Message from Host: ') . $serverName;
        $message['body'] = __(
            'panel',
            'test_msg_body',
            'Messenger module "{0}" has been tested and confirmed successfully.',
            [$moduleName]
        );
    
        // @codeCoverageIgnoreStart

        // Name the testing method.
        $method = explode('-', $moduleName);
        $method = implode(
            '',
            array_map(
                function ($word) {
                    return ucwords($word);
                },
                $method
            )
        );

        $postParams = $request->getParsedBody();
        $postKey = 'messengers__' . $moduleName . '__confirm_test';

        // Call testing method if exists.
        $status = $this->{$method}($getParams, $message);

        if ($status) {
            $data['status'] = 'success';
            $postParams[$postKey] = 'on';
        } else {
            $data['status'] = 'error';
            $postParams[$postKey] = 'off';
        }

        set_request($request->withParsedBody($postParams));

        $this->saveConfig();

        // @codeCoverageIgnoreEnd

        $data['result']['postKey'] = $postKey;

        $output = json_encode($data);

        return $this->respondJson($output);
    }

    /**
     * Respond the JSON format result.
     *
     * @param string $output The string you want to output to the browser.
     *
     * @return ResponseInterface
     */
    private function respondJson($output): ResponseInterface
    {
        $response = get_response();

        $stream = HttpFactory::createStream();
        $stream->write($output);
        $stream->rewind();

        $response = $response->withHeader('Content-Type', 'application/json');
        $response = $response->withAddedHeader('Content-Type', 'charset=utf-8');
        $response = $response->withBody($stream);

        return $response;

    }
}


1		<?php
2		/**
3		* This file is part of the Shieldon package.
4		*
5		* (c) Terry L. <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*
10		* php version 7.1.0
11		*
12		* @category Web-security
13		* @package Shieldon
14		* @author Terry Lin <[email protected]>
15		* @copyright 2019 terrylinooo
16		* @license https://github.com/terrylinooo/shieldon/blob/2.x/LICENSE MIT
17		* @link https://github.com/terrylinooo/shieldon
18		* @see https://shieldon.io
19		*/
20
21		declare(strict_types=1);
22
23		namespace Shieldon\Firewall\Panel;
24
25		use Psr\Http\Message\ResponseInterface;
26		use Shieldon\Firewall\Panel\BaseController;
27		use Shieldon\Firewall\HttpFactory;
28		use function Shieldon\Firewall\__;
29		use function Shieldon\Firewall\get_request;
30		use function Shieldon\Firewall\get_response;
31		use function Shieldon\Firewall\get_session_instance;
32		use function Shieldon\Firewall\set_request;
33		use function array_map;
34		use function explode;
35		use function file_exists;
36		use function gethostname;
37		use function implode;
38		use function json_encode;
39
40		/**
41		* User
42		*/
43		class Ajax extends BaseController
44		{
45		/**
46		* Public methods \| Desctiotion
47		* ----------------------\|---------------------------------------------
48		* __call \| The magic method.
49		* changeLocale \| Change the user's language of the UI.
50		* tryMessenger \| Test messenger modules.
51		* ----------------------\|---------------------------------------------
52		*/
53
54		/**
55		* Constructor.
56		*/
57	12	public function __construct()
58		{
59	12	parent::__construct();
60		}
61
62		/**
63		* Fallback for undefined methods.
64		*
65		* @param string $function The method name.
66		* @param array $args The arguments.
67		*
68		* @return bool
69		*/
70	11	public function __call($function, $args): bool
71		{
72	11	$className = 'Shieldon\Firewall\Panel\Sandbox\\' . $function;
73
74	11	if (file_exists(__DIR__ . '/Sandbox/' . $function . '.php')) {
75	10	$sandbox = new $className();
76	10	return $sandbox($args);
77		}
78	1	return false;
79		}
80
81		/**
82		* Change the user's language of the UI.
83		*
84		* @return ResponseInterface
85		*/
86	1	public function changeLocale(): ResponseInterface
87		{
88	1	$langCode = get_request()->getQueryParams()['langCode'] ?? 'en';
89	1	get_session_instance()->set('shieldon_panel_lang', $langCode);
90	1	get_session_instance()->save();
91	1	$data = [];
92
93	1	$data['status'] = 'success';
94	1	$data['lang_code'] = $langCode;
95	1	$data['session_lang_code'] = $langCode;
96
97	1	$output = json_encode($data);
98
99	1	return $this->respondJson($output);
100		}
101
102		/**
103		* Test messenger modules.
104		*
105		* @return ResponseInterface
106		*/
107	11	public function tryMessenger(): ResponseInterface
108		{
109	11	$request = get_request();
110	11	$message = [];
111
112	11	$getParams = $request->getQueryParams();
113	11	$serverParams = $request->getServerParams();
114
115	11	$serverName = $serverParams['SERVER_NAME'] ?? gethostname();
116	11	$moduleName = $getParams['module'] ?? '';
117
118	11	$data = [];
119	11	$data['status'] = 'undefined';
120	11	$data['result']['moduleName'] = $moduleName;
121
122	11	$message['title'] = __('panel', 'test_msg_title', 'Testing Message from Host: ') . $serverName;
123	11	$message['body'] = __(
124		'panel',
125		'test_msg_body',
126		'Messenger module "{0}" has been tested and confirmed successfully.',
127		[$moduleName]
128		);
129
130		// @codeCoverageIgnoreStart
131
132		// Name the testing method.
133		$method = explode('-', $moduleName);
134		$method = implode(
135		'',
136		array_map(
137		function ($word) {
138		return ucwords($word);
139		},
140		$method
141		)
142		);
143
144		$postParams = $request->getParsedBody();
145		$postKey = 'messengers__' . $moduleName . '__confirm_test';
146
147		// Call testing method if exists.
148		$status = $this->{$method}($getParams, $message);
149
150		if ($status) {
151		$data['status'] = 'success';
152		$postParams[$postKey] = 'on';
153		} else {
154		$data['status'] = 'error';
155		$postParams[$postKey] = 'off';
156		}
157
158		set_request($request->withParsedBody($postParams));
159	11
160		$this->saveConfig();
161	11
162		// @codeCoverageIgnoreEnd
163	11
164		$data['result']['postKey'] = $postKey;
165
166		$output = json_encode($data);
167
168		return $this->respondJson($output);
169		}
170
171		/**
172		* Respond the JSON format result.
173	12	*
174		* @param string $output The string you want to output to the browser.
175	12	*
176		* @return ResponseInterface
177	12	*/
178	12	private function respondJson($output): ResponseInterface
179	12	{
180		$response = get_response();
181	12
182	12	$stream = HttpFactory::createStream();
183	12	$stream->write($output);
184		$stream->rewind();
185	12
186		$response = $response->withHeader('Content-Type', 'application/json');
187		$response = $response->withAddedHeader('Content-Type', 'charset=utf-8');
188		$response = $response->withBody($stream);
189
190		return $response;
		0 ignored issues – show Bug Best Practice introduced 2023-06-09 05:10 UTC by Report Bug Copy Issue Report The expression `return $response` returns the type `Psr\Http\Message\MessageInterface` which includes types incompatible with the type-hinted return `Psr\Http\Message\ResponseInterface`. Loading history...
191		}
192		}
193

terrylinooo / shieldon

Ajax::respondJson() A last analyzed 2023-06-17 08:58 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Ajax::respondJson() A
last analyzed 2023-06-17 08:58 UTC