Files
sysPass/app/modules/web/Controllers/Helpers/JsonResponseHandler.php
2024-08-28 12:38:42 +02:00

121 lines
3.3 KiB
PHP

<?php
/**
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2024, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace SP\Modules\Web\Controllers\Helpers;
use Exception;
use SP\Domain\Core\Exceptions\SPException;
use SP\Domain\Http\Dtos\JsonMessage;
use SP\Domain\Http\Services\JsonResponse;
/**
* Class JsonResponseHandler
*/
final readonly class JsonResponseHandler
{
public function __construct(private JsonResponse $response)
{
}
/**
* Returns JSON response
*
* @param mixed $data
* @param int $status Status code
* @param string|null $description Untranslated description string
* @param array|null $messages
*
* @return bool
* @throws SPException
*/
public function sendData(
mixed $data,
int $status = JsonMessage::JSON_SUCCESS,
?string $description = null,
?array $messages = null
): bool {
$jsonResponse = new JsonMessage();
$jsonResponse->setStatus($status);
$jsonResponse->setData($data);
if (null !== $description) {
$jsonResponse->setDescription($description);
}
if (null !== $messages) {
$jsonResponse->setMessages($messages);
}
return $this->response->send($jsonResponse);
}
/**
* Returns JSON response
*
* @param int $status Status code
* @param string $description Untranslated description string
* @param array|string|null $messages Untranslated massages array of strings
*
* @return bool
* @throws SPException
*/
public function send(int $status, string $description, array|string|null $messages = null): bool
{
$jsonMessage = new JsonMessage();
$jsonMessage->setStatus($status);
$jsonMessage->setDescription($description);
if (null !== $messages) {
$jsonMessage->setMessages((array)$messages);
}
return $this->response->send($jsonMessage);
}
/**
* Returns JSON response
*
* @param Exception $exception
* @param int $status
*
* @return bool
* @throws SPException
*/
public function sendException(Exception $exception, int $status = JsonMessage::JSON_ERROR): bool
{
$jsonResponse = new JsonMessage();
$jsonResponse->setStatus($status);
$jsonResponse->setDescription($exception->getMessage());
if ($exception instanceof SPException && $exception->getHint() !== null) {
$jsonResponse->setMessages([$exception->getHint()]);
}
return $this->response->send($jsonResponse);
}
}