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