diff options
Diffstat (limited to 'engine/classes/SuccessResult.php')
| -rw-r--r-- | engine/classes/SuccessResult.php | 56 |
1 files changed, 34 insertions, 22 deletions
diff --git a/engine/classes/SuccessResult.php b/engine/classes/SuccessResult.php index db5769d58..ab5468ad8 100644 --- a/engine/classes/SuccessResult.php +++ b/engine/classes/SuccessResult.php @@ -1,22 +1,34 @@ -<?php
-/**
- * SuccessResult
- * Generic success result class, extend if you want to do something special.
- *
- * @author Curverider Ltd <info@elgg.com>
- * @package Elgg
- * @subpackage Core
- */
-class SuccessResult extends GenericResult {
- public static $RESULT_SUCCESS = 0; // Do not change this from 0
-
- public function SuccessResult($result) {
- $this->setResult($result);
- $this->setStatusCode(SuccessResult::$RESULT_SUCCESS);
- }
-
- public static function getInstance($result) {
- // Return a new error object.
- return new SuccessResult($result);
- }
-}
\ No newline at end of file +<?php +/** + * SuccessResult + * Generic success result class, extend if you want to do something special. + * + * @package Elgg.Core + * @subpackage WebServicesAPI + */ +class SuccessResult extends GenericResult { + // Do not change this from 0 + public static $RESULT_SUCCESS = 0; + + /** + * A new success result + * + * @param string $result The result + */ + public function __construct($result) { + $this->setResult($result); + $this->setStatusCode(SuccessResult::$RESULT_SUCCESS); + } + + /** + * Returns a new instance of this class + * + * @param unknown $result A result of some kind? + * + * @return SuccessResult + */ + public static function getInstance($result) { + // Return a new error object. + return new SuccessResult($result); + } +} |
