diff options
Diffstat (limited to 'engine/classes/ErrorResult.php')
| -rw-r--r-- | engine/classes/ErrorResult.php | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/engine/classes/ErrorResult.php b/engine/classes/ErrorResult.php index 3692cc49b..afad4c740 100644 --- a/engine/classes/ErrorResult.php +++ b/engine/classes/ErrorResult.php @@ -3,9 +3,8 @@ * ErrorResult * The error result class. * - * @author Curverider Ltd <info@elgg.com> - * @package Elgg - * @subpackage Core + * @package Elgg.Core + * @subpackage WebServicesAPI */ class ErrorResult extends GenericResult { // Fail with no specific code @@ -18,12 +17,21 @@ class ErrorResult extends GenericResult { // Invalid, expired or missing auth token public static $RESULT_FAIL_AUTHTOKEN = -20; - public function ErrorResult($message, $code = "", Exception $exception = NULL) { + /** + * 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) { + if ($exception != NULL) { $this->setResult($exception->__toString()); } @@ -33,12 +41,14 @@ class ErrorResult extends GenericResult { /** * Get a new instance of the ErrorResult. * - * @param string $message - * @param int $code + * @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); } -}
\ No newline at end of file +} |