diff options
Diffstat (limited to 'engine/classes/SuccessResult.php')
| -rw-r--r-- | engine/classes/SuccessResult.php | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/engine/classes/SuccessResult.php b/engine/classes/SuccessResult.php index e769fbada..ab5468ad8 100644 --- a/engine/classes/SuccessResult.php +++ b/engine/classes/SuccessResult.php @@ -3,20 +3,32 @@ * SuccessResult * Generic success result class, extend if you want to do something special. * - * @author Curverider Ltd <info@elgg.com> - * @package Elgg - * @subpackage Core + * @package Elgg.Core + * @subpackage WebServicesAPI */ class SuccessResult extends GenericResult { - public static $RESULT_SUCCESS = 0; // Do not change this from 0 + // Do not change this from 0 + public static $RESULT_SUCCESS = 0; - public function SuccessResult($result) { + /** + * 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); } -}
\ No newline at end of file +} |
