This repository has been archived on 2026-07-19. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
espocrm-base/application/Espo/Core/Utils/Api/Output.php
T
2015-01-12 15:15:11 +02:00

123 lines
3.5 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
* Website: http://www.espocrm.com
*
* EspoCRM 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.
*
* EspoCRM 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 EspoCRM. If not, see http://www.gnu.org/licenses/.
************************************************************************/
namespace Espo\Core\Utils\Api;
class Output
{
private $slim;
protected $errorDesc = array(
400 => 'Bad Request',
401 => 'Unauthorized',
403 => 'Forbidden',
404 => 'Page Not Found',
409 => 'Conflict',
500 => 'Internal Server Error',
);
public function __construct(\Espo\Core\Utils\Api\Slim $slim)
{
$this->slim = $slim;
}
protected function getSlim()
{
return $this->slim;
}
/**
* Output the result
*
* @param mixed $data - JSON
*/
public function render($data = null)
{
if (is_array($data)) {
$dataArr = array_values($data);
$data = empty($dataArr[0]) ? false : $dataArr[0];
}
ob_clean();
echo $data;
}
public function processError($message = 'Error', $code = 500, $isPrint = false)
{
$currentRoute = $this->getSlim()->router()->getCurrentRoute();
if (isset($currentRoute)) {
$GLOBALS['log']->error('API ['.$this->getSlim()->request()->getMethod().']:'.$currentRoute->getPattern().', Params:'.print_r($currentRoute->getParams(), true).', InputData: '.$this->getSlim()->request()->getBody().' - '.$message);
}
$this->displayError($message, $code, $isPrint);
}
/**
* Output the error and stop app execution
*
* @param string $text
* @param int $statusCode
*
* @return void
*/
public function displayError($text, $statusCode = 500, $isPrint = false)
{
$GLOBALS['log']->error('Display Error: '.$text.', Code: '.$statusCode.' URL: '.$_SERVER['REQUEST_URI']);
ob_clean();
if (!empty( $this->slim)) {
$this->getSlim()->response()->status($statusCode);
$this->getSlim()->response()->header('X-Status-Reason', $text);
if ($isPrint) {
$status = $this->getCodeDesc($statusCode);
$status = isset($status) ? $statusCode.' '.$status : 'HTTP '.$statusCode;
$this->getSlim()->printError($text, $status);
}
$this->getSlim()->stop();
} else {
$GLOBALS['log']->info('Could not get Slim instance. It looks like a direct call (bypass API). URL: '.$_SERVER['REQUEST_URI']);
die($text);
}
}
/**
* Get status code desription
*
* @param int $statusCode
* @return string | null
*/
protected function getCodeDesc($statusCode)
{
if (isset($this->errorDesc[$statusCode])) {
return $this->errorDesc[$statusCode];
}
return null;
}
}