MediaWiki\User\TempUser\CreateStatus Class Reference
Status object with strongly typed value, for TempUserManager::createUser() More...
Inheritance diagram for MediaWiki\User\TempUser\CreateStatus:
Collaboration diagram for MediaWiki\User\TempUser\CreateStatus:
Public Member Functions | |
| getUser () | |
 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. | |
| setMessageLocalizer (MessageLocalizer $messageLocalizer) | |
| Makes this Status object use the given localizer instead of the global one. | |
| 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 () | |
| Returns a string representation of the status for debugging. | |
| error ( $message,... $parameters) | |
| Add an error, do not set fatal flag This can be used for non-fatal errors. | |
| fatal ( $message,... $parameters) | |
| 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,... $parameters) | |
| Add a new warning. | |
Additional Inherited Members | |
| 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,... $parameters) |
| Factory function for fatal errors. | |
| static | newGood ( $value=null) |
| Factory function for good results. | |
| Public Attributes inherited from Status | |
| callable false | $cleanCallback = false |
| Public Attributes inherited from StatusValue | |
| int | $failCount = 0 |
| Counter for batch operations. | |
| mixed | $statusData |
| arbitrary extra data about the operation | |
| 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. | |
| Protected Member Functions inherited from StatusValue | |
| getStatusArray ( $type=false) | |
| Returns a list of status messages of the given type (or all if false) | |
| Protected Attributes inherited from Status | |
| MessageLocalizer null | $messageLocalizer |
| Protected Attributes inherited from StatusValue | |
| array[] | $errors = [] |
| bool | $ok = true |
Detailed Description
Status object with strongly typed value, for TempUserManager::createUser()
- Since
- 1.39
- Access: internal
Definition at line 14 of file CreateStatus.php.
Member Function Documentation
◆ getUser()
| MediaWiki\User\TempUser\CreateStatus::getUser | ( | ) |
- Returns
- User
Definition at line 18 of file CreateStatus.php.
The documentation for this class was generated from the following file:
- includes/user/TempUser/CreateStatus.php
