mirror of
https://github.com/YunoHost-Apps/dolibarr_ynh.git
synced 2024-09-03 18:35:53 +02:00
71 lines
2 KiB
PHP
71 lines
2 KiB
PHP
|
<?php
|
||
|
|
namespace Luracast\Restler;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Default Composer to provide standard structure for all HTTP responses
|
||
|
|
*
|
||
|
|
* @category Framework
|
||
|
|
* @package Restler
|
||
|
|
* @subpackage result
|
||
|
|
* @author R.Arul Kumaran <arul@luracast.com>
|
||
|
|
* @copyright 2010 Luracast
|
||
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
||
|
|
* @link http://luracast.com/products/restler/
|
||
|
|
*/
|
||
|
|
class Compose implements iCompose
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* @var bool When restler is not running in production mode, this value will
|
||
|
|
* be checked to include the debug information on error response
|
||
|
|
*/
|
||
|
|
public static $includeDebugInfo = true;
|
||
|
|
/**
|
||
|
|
* Current Restler instance
|
||
|
|
* Injected at runtime
|
||
|
|
*
|
||
|
|
* @var Restler
|
||
|
|
*/
|
||
|
|
public $restler;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Result of an api call is passed to this method
|
||
|
|
* to create a standard structure for the data
|
||
|
|
*
|
||
|
|
* @param mixed $result can be a primitive or array or object
|
||
|
|
*
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function response($result)
|
||
|
|
{
|
||
|
|
//TODO: check Defaults::language and change result accordingly
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* When the api call results in RestException this method
|
||
|
|
* will be called to return the error message
|
||
|
|
*
|
||
|
|
* @param RestException $exception exception that has reasons for failure
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function message(RestException $exception)
|
||
|
|
{
|
||
|
|
//TODO: check Defaults::language and change result accordingly
|
||
|
|
$r = array(
|
||
|
|
'error' => array(
|
||
|
|
'code' => $exception->getCode(),
|
||
|
|
'message' => $exception->getErrorMessage(),
|
||
|
|
) + $exception->getDetails()
|
||
|
|
);
|
||
|
|
if (!Scope::get('Restler')->getProductionMode() && self::$includeDebugInfo) {
|
||
|
|
$r += array(
|
||
|
|
'debug' => array(
|
||
|
|
'source' => $exception->getSource(),
|
||
|
|
'stages' => $exception->getStages(),
|
||
|
|
)
|
||
|
|
);
|
||
|
|
}
|
||
|
|
return $r;
|
||
|
|
}
|
||
|
|
}
|