Files
sysPass/app/modules/web/Controllers/Traits/JsonTrait.php
nuxsmin 950ad4fff5 * [ADD] Unit testing. Work in progress
* [MOD] Code refactoring
2018-08-08 15:26:14 +02:00

107 lines
3.1 KiB
PHP

<?php
/**
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2018, 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 SP\Core\Exceptions\SPException;
use SP\Http\Json;
use SP\Http\JsonResponse;
/**
* Trait JsonTrait
*
* @package SP\Modules\Web\Controllers\Traits
*/
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
*/
protected function returnJsonResponse($status, $description, array $messages = null)
{
$jsonResponse = new JsonResponse();
$jsonResponse->setStatus($status);
$jsonResponse->setDescription($description);
if (null !== $messages) {
$jsonResponse->setMessages($messages);
}
return Json::fromDic()->returnJson($jsonResponse);
}
/**
* Returns JSON response
*
* @param mixed $data
* @param int $status Status code
* @param string $description Untranslated description string
* @param array $messages
*
* @return bool
*/
protected function returnJsonResponseData($data, $status = JsonResponse::JSON_SUCCESS, $description = null, array $messages = null)
{
$jsonResponse = new JsonResponse();
$jsonResponse->setStatus($status);
$jsonResponse->setData($data);
if (null !== $description) {
$jsonResponse->setDescription($description);
}
if (null !== $messages) {
$jsonResponse->setMessages($messages);
}
return Json::fromDic()->returnJson($jsonResponse);
}
/**
* Returns JSON response
*
* @param \Exception $exception
* @param int $status Status code
*
* @return bool
*/
protected function returnJsonResponseException(\Exception $exception, $status = JsonResponse::JSON_ERROR)
{
$jsonResponse = new JsonResponse();
$jsonResponse->setStatus($status);
$jsonResponse->setDescription($exception->getMessage());
if ($exception instanceof SPException && $exception->getHint() !== null) {
$jsonResponse->setMessages([$exception->getHint()]);
}
return Json::fromDic()->returnJson($jsonResponse);
}
}