aboutsummaryrefslogtreecommitdiff
path: root/engine/classes/SuccessResult.php
blob: f68ddd39e1166ea9f22e0c3afe15ee46d3612007 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<?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 SuccessResult($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);
	}
}