A StatusValue for permission errors. More...
Inherits StatusValue.
Public Member Functions | |
| getBlock () | |
| Returns the user block that contributed to permissions being denied, if such a block was provided via setBlock(). | |
| getPermission () | |
| Returns the name of the permission that was being checked. | |
| isBlocked () | |
| Returns true when permissions were denied because the user is blocked. | |
| isRateLimitExceeded () | |
| Whether the user is over the rate limit for some action. | |
| setBlock (Block $block) | |
| setPermission (string $permission) | |
| Sets the name of the permission that is being checked. | |
| setRateLimitExceeded () | |
| Call this to indicate that the user is over the rate limit for some action. | |
| throwErrorPageError () | |
| Will throw an appropriate ErrorPageError if isOK() returns false. | |
| toLegacyErrorArray () | |
| Returns this permission status in legacy error array format. | |
 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. | |
| getMessages (?string $type=null) | |
| Returns a list of error messages, optionally only those of the given type. | |
| getValue () | |
| hasMessage ( $message) | |
| Returns true if the specified message is present as a warning or error. | |
| hasMessagesExcept (... $messages) | |
| Returns true if any other message than the specified ones 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. | |
| splitByErrorType () | |
| Splits this StatusValue object into two new StatusValue objects, one which contains only the error messages, and one that contains the warnings, only. | |
| warning ( $message,... $parameters) | |
| Add a new warning. | |
Static Public Member Functions | |
| static | newEmpty () |
| 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. | |
Additional Inherited Members | |
| 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 StatusValue | |
| getStatusArray ( $type=false) | |
| Returns a list of status messages of the given type (or all if false) | |
| Protected Attributes inherited from StatusValue | |
| array[] | $errors = [] |
| bool | $ok = true |
Detailed Description
A StatusValue for permission errors.
- Todo
- Add compat code for PermissionManager::getPermissionErrors and additional info about user blocks.
- Stability: unstable
- Since
- 1.36
Definition at line 39 of file PermissionStatus.php.
Member Function Documentation
◆ getBlock()
| MediaWiki\Permissions\PermissionStatus::getBlock | ( | ) |
Returns the user block that contributed to permissions being denied, if such a block was provided via setBlock().
This is intended to be used to provide additional information to the user that allows them to determine the reason for them being denied an action.
- Since
- 1.37
- Returns
- ?Block
Definition at line 61 of file PermissionStatus.php.
◆ getPermission()
| MediaWiki\Permissions\PermissionStatus::getPermission | ( | ) |
Returns the name of the permission that was being checked.
- Returns
- string|null The permission, of known
- Since
- 1.41
Definition at line 141 of file PermissionStatus.php.
◆ isBlocked()
| MediaWiki\Permissions\PermissionStatus::isBlocked | ( | ) |
Returns true when permissions were denied because the user is blocked.
- Since
- 1.41
- Returns
- bool
Definition at line 72 of file PermissionStatus.php.
◆ isRateLimitExceeded()
| MediaWiki\Permissions\PermissionStatus::isRateLimitExceeded | ( | ) |
Whether the user is over the rate limit for some action.
- Since
- 1.41
- Returns
- bool True if setRateLimitExceeded() was called.
Definition at line 120 of file PermissionStatus.php.
◆ newEmpty()
|
static |
- Returns
- static
Definition at line 89 of file PermissionStatus.php.
◆ setBlock()
| MediaWiki\Permissions\PermissionStatus::setBlock | ( | Block | $block | ) |
- Since
- 1.37
- Access: internal
- Parameters
-
Block $block
Definition at line 81 of file PermissionStatus.php.
◆ setPermission()
| MediaWiki\Permissions\PermissionStatus::setPermission | ( | string | $permission | ) |
Sets the name of the permission that is being checked.
- Since
- 1.41
- Access: internal
- Will cause isRateLimited() to return true.
Definition at line 131 of file PermissionStatus.php.
◆ setRateLimitExceeded()
| MediaWiki\Permissions\PermissionStatus::setRateLimitExceeded | ( | ) |
Call this to indicate that the user is over the rate limit for some action.
- Since
- 1.41
- Access: internal
- Will cause isRateLimited() to return true.
Definition at line 110 of file PermissionStatus.php.
◆ throwErrorPageError()
| MediaWiki\Permissions\PermissionStatus::throwErrorPageError | ( | ) |
Will throw an appropriate ErrorPageError if isOK() returns false.
If isOK() returns true, this method does nothing.
This is a convenience method for use in user interaction code, such as subclasses of SpecialPage.
- Stability: unstable
- Introduced in 1.41, but unstable since the future of ErrorPageError is unclear (T281935).
- Exceptions
-
ErrorPageError
- Returns
- void
Definition at line 157 of file PermissionStatus.php.
◆ toLegacyErrorArray()
| MediaWiki\Permissions\PermissionStatus::toLegacyErrorArray | ( | ) |
Returns this permission status in legacy error array format.
- See also
- PermissionManager::getPermissionErrors()
- Returns
- array[]
Definition at line 100 of file PermissionStatus.php.
Referenced by ContentModelChange\checkPermissions().
The documentation for this class was generated from the following file:
- includes/Permissions/PermissionStatus.php
