diff options
Diffstat (limited to 'engine/classes/ErrorResult.php')
| -rw-r--r-- | engine/classes/ErrorResult.php | 54 | 
1 files changed, 54 insertions, 0 deletions
| diff --git a/engine/classes/ErrorResult.php b/engine/classes/ErrorResult.php new file mode 100644 index 000000000..afad4c740 --- /dev/null +++ b/engine/classes/ErrorResult.php @@ -0,0 +1,54 @@ +<?php +/** + * ErrorResult + * The error result class. + * + * @package    Elgg.Core + * @subpackage WebServicesAPI + */ +class ErrorResult extends GenericResult { +	// Fail with no specific code +	public static $RESULT_FAIL = -1 ; + +	public static $RESULT_FAIL_APIKEY_DISABLED = -30; +	public static $RESULT_FAIL_APIKEY_INACTIVE = -31; +	public static $RESULT_FAIL_APIKEY_INVALID = -32; + +	// Invalid, expired or missing auth token +	public static $RESULT_FAIL_AUTHTOKEN = -20; + +	/** +	 * A new error result +	 * +	 * @param string    $message   Message +	 * @param int       $code      Error Code +	 * @param Exception $exception Exception object +	 * +	 * @return void +	 */ +	public function __construct($message, $code = "", Exception $exception = NULL) { +		if ($code == "") { +			$code = ErrorResult::$RESULT_FAIL; +		} + +		if ($exception != NULL) { +			$this->setResult($exception->__toString()); +		} + +		$this->setStatusCode($code, $message); +	} + +	/** +	 * Get a new instance of the ErrorResult. +	 * +	 * @param string    $message   Message +	 * @param int       $code      Code +	 * @param Exception $exception Optional exception for generating a stack trace. +	 * +	 * @return ErrorResult +	 */ +	public static function getInstance($message, $code = "", Exception $exception = NULL) { +		// Return a new error object. +		return new ErrorResult($message, $code, $exception); +	} +} | 
