/**
* Factory function for fatal errors
+ *
+ * @param $message String: message name
*/
static function newFatal( $message /*, parameters...*/ ) {
$params = func_get_args();
return $result;
}
+ /**
+ * Factory function for good results
+ *
+ * @param $value Mixed
+ */
static function newGood( $value = null ) {
$result = new self;
$result->value = $value;
return $result;
}
+ /**
+ * Change operation result
+ *
+ * @param $ok Boolean: whether to operation completed
+ * @param $value Mixed
+ */
function setResult( $ok, $value = null ) {
$this->ok = $ok;
$this->value = $value;
}
+ /**
+ * Returns whether the operation completed and didn't have any error or
+ * warnings
+ *
+ * @return Boolean
+ */
function isGood() {
return $this->ok && !$this->errors;
}
+ /**
+ * Returns whether the operation completed
+ *
+ * @return Boolean
+ */
function isOK() {
return $this->ok;
}
+ /**
+ * Add a new warning
+ *
+ * @param $message String: message name
+ */
function warning( $message /*, parameters... */ ) {
$params = array_slice( func_get_args(), 1 );
$this->errors[] = array(
/**
* Add an error, do not set fatal flag
* This can be used for non-fatal errors
+ *
+ * @param $message String: message name
*/
function error( $message /*, parameters... */ ) {
$params = array_slice( func_get_args(), 1 );
}
/**
- * Add an error and set OK to false, indicating that the operation as a whole was fatal
+ * Add an error and set OK to false, indicating that the operation
+ * as a whole was fatal
+ *
+ * @param $message String: message name
*/
function fatal( $message /*, parameters... */ ) {
$params = array_slice( func_get_args(), 1 );
/**
* Get the error list as a wikitext formatted list
- * @param string $shortContext A short enclosing context message name, to be used
- * when there is a single error
- * @param string $longContext A long enclosing context message name, for a list
+ *
+ * @param $shortContext String: a short enclosing context message name, to
+ * be used when there is a single error
+ * @param $longContext String: a long enclosing context message name, for a list
+ * @return String
*/
function getWikiText( $shortContext = false, $longContext = false ) {
if ( count( $this->errors ) == 0 ) {
/**
* Merge another status object into this one
+ *
+ * @param $other Other Status object
+ * @param $overwriteValue Boolean: whether to override the "value" member
*/
function merge( $other, $overwriteValue = false ) {
$this->errors = array_merge( $this->errors, $other->errors );
$this->failCount += $other->failCount;
}
+ /**
+ * Get the list of errors (but not warnings)
+ *
+ * @return Array
+ */
function getErrorsArray() {
$result = array();
foreach ( $this->errors as $error ) {
/**
* Returns true if the specified message is present as a warning or error
+ *
+ * @param $msg String: message name
+ * @return Boolean
*/
function hasMessage( $msg ) {
foreach ( $this->errors as $error ) {