36 lines
921 B
PHP
36 lines
921 B
PHP
|
<?php
|
||
|
|
namespace Luracast\Restler;
|
||
|
|
|
||
|
|
use Exception;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface for composing response
|
||
|
|
*
|
||
|
|
* @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/
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
interface iCompose {
|
||
|
|
/**
|
||
|
|
* 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
|
||
|
|
*/
|
||
|
|
public function response($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
|
||
|
|
*/
|
||
|
|
public function message(RestException $exception);
|
||
|
|
}
|