FileRepoStatus Class Reference

Generic operation result class for FileRepo-related operations. More...

Inheritance diagram for FileRepoStatus:

Collaboration diagram for FileRepoStatus:

Additional Inherited Members
Public Member Functions inherited from Status
	__get ( $name)
	Backwards compatibility logic.
	__set ( $name, $value)
	Change operation result Backwards compatibility logic.
	__sleep ()
	Don't save the callback when serializing, because Closures can't be serialized and we're going to clear it in __wakeup anyway.
	__wakeup ()
	Sanitize the callback parameter on wakeup, to avoid arbitrary execution.
	getErrorsArray ()
	Get the list of errors (but not warnings)
	getHTML ( $shortContext=false, $longContext=false, $lang=null)
	Get the error message as HTML.
	getMessage ( $shortContext=false, $longContext=false, $lang=null)
	Get a bullet list of the errors as a Message object.
	getStatusValue ()
	Returns the wrapped StatusValue object.
	getWarningsArray ()
	Get the list of warnings (but not errors)
	getWikiText ( $shortContext=false, $longContext=false, $lang=null)
	Get the error list as a wikitext formatted list.
	splitByErrorType ()
	Splits this Status object into two new Status objects, one which contains only the error messages, and one that contains the warnings, only.
Public Member Functions inherited from StatusValue
	__toString ()
	error ( $message)
	Add an error, do not set fatal flag This can be used for non-fatal errors.
	fatal ( $message)
	Add an error and set OK to false, indicating that the operation as a whole was fatal.
	getErrors ()
	Get the list of errors.
	getErrorsByType ( $type)
	Returns a list of status messages of the given type.
	getValue ()
	hasMessage ( $message)
	Returns true if the specified message is present as a warning or error.
	isGood ()
	Returns whether the operation completed and didn't have any error or warnings.
	isOK ()
	Returns whether the operation completed.
	merge ( $other, $overwriteValue=false)
	Merge another status object into this one.
	replaceMessage ( $source, $dest)
	If the specified source message exists, replace it with the specified destination message, but keep the same parameters as in the original error.
	setOK ( $ok)
	Change operation status.
	setResult ( $ok, $value=null)
	Change operation result.
	warning ( $message)
	Add a new warning.
Static Public Member Functions inherited from Status
static	wrap ( $sv)
	Succinct helper method to wrap a StatusValue.
Static Public Member Functions inherited from StatusValue
static	newFatal ( $message)
	Factory function for fatal errors.
static	newGood ( $value=null)
	Factory function for good results.
Public Attributes inherited from Status
callable	$cleanCallback = false
Public Attributes inherited from StatusValue
int	$failCount = 0
	Counter for batch operations.
bool[]	$success = []
	Map of (key => bool) to indicate success of each part of batch operations.
int	$successCount = 0
	Counter for batch operations.
mixed	$value
Protected Member Functions inherited from Status
	cleanParams (array $params)
	getErrorMessage ( $error, $lang=null)
	Return the message for a single error.
	getErrorMessageArray ( $errors, $lang=null)
	Return an array with a Message object for each error.
	getStatusArray ( $type=false)
	Returns a list of status messages of the given type (or all if false)
	languageFromParam ( $lang)
Protected Attributes inherited from StatusValue
array[]	$errors = []
bool	$ok = true

Detailed Description

Generic operation result class for FileRepo-related operations.

Deprecated

since 1.25

Definition at line 29 of file FileRepoStatus.php.

---

The documentation for this class was generated from the following file:

• includes/filerepo/FileRepoStatus.php