mirror of
https://github.com/nuxsmin/sysPass.git
synced 2026-03-03 07:04:07 +01:00
120 lines
3.4 KiB
PHP
120 lines
3.4 KiB
PHP
<?php
|
|
/*
|
|
* sysPass
|
|
*
|
|
* @author nuxsmin
|
|
* @link https://syspass.org
|
|
* @copyright 2012-2023, 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/>.
|
|
*/
|
|
|
|
namespace SP\Modules\Web\Controllers\Traits;
|
|
|
|
use Exception;
|
|
use Klein\Klein;
|
|
use SP\Core\Context\Session;
|
|
use SP\Domain\Core\Exceptions\SPException;
|
|
use SP\Domain\Http\Dtos\JsonMessage;
|
|
use SP\Domain\Http\Services\JsonResponse;
|
|
|
|
/**
|
|
* Trait JsonTrait
|
|
*
|
|
* @property Session $session
|
|
* @property Klein $router
|
|
*/
|
|
trait JsonTrait
|
|
{
|
|
/**
|
|
* Returns JSON response
|
|
*
|
|
* @param int $status Status code
|
|
* @param string $description Untranslated description string
|
|
* @param array|null $messages Untranslated massages array of strings
|
|
*
|
|
* @return bool
|
|
* @throws SPException
|
|
*/
|
|
protected function returnJsonResponse(int $status, string $description, ?array $messages = null): bool
|
|
{
|
|
$jsonResponse = new JsonMessage();
|
|
$jsonResponse->setStatus($status);
|
|
$jsonResponse->setDescription($description);
|
|
|
|
if (null !== $messages) {
|
|
$jsonResponse->setMessages($messages);
|
|
}
|
|
|
|
return JsonResponse::factory($this->router->response())->send($jsonResponse);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
protected function returnJsonResponseData(
|
|
$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 JsonResponse::factory($this->router->response())->send($jsonResponse);
|
|
}
|
|
|
|
/**
|
|
* Returns JSON response
|
|
*
|
|
* @param Exception $exception
|
|
* @param int $status
|
|
*
|
|
* @return bool
|
|
* @throws SPException
|
|
*/
|
|
protected function returnJsonResponseException(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 JsonResponse::factory($this->router->response())->send($jsonResponse);
|
|
}
|
|
}
|