This interface represents the authority associated with the current execution context, such as a web request. More...

Inherited by MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Public Member Functions
	authorizeAction (string $action, ?PermissionStatus $status=null)
	Authorize an action.

	authorizeRead (string $action, PageIdentity $target, ?PermissionStatus $status=null)
	Authorize read access.

	authorizeWrite (string $action, PageIdentity $target, ?PermissionStatus $status=null)
	Authorize write access.

	definitelyCan (string $action, PageIdentity $target, ?PermissionStatus $status=null)
	Checks whether this authority can perform the given action on the given target page.

	getBlock (int $freshness=IDBAccessObject::READ_NORMAL)
	Returns any user block affecting the Authority.

	getUser ()
	Returns the performer of the actions associated with this authority.

	isAllowed (string $permission, ?PermissionStatus $status=null)
	Checks whether this authority has the given permission in general.

	isAllowedAll (... $permissions)
	Checks whether this authority has any of the given permissions in general.

	isAllowedAny (... $permissions)
	Checks whether this authority has any of the given permissions in general.

	isDefinitelyAllowed (string $action, ?PermissionStatus $status=null)
	Checks whether this authority is allowed to perform the given action.

	isNamed ()
	Is the user a normal non-temporary registered user?

	isRegistered ()
	Get whether the user is registered.

	isTemp ()
	Is the user an autocreated temporary user?

	probablyCan (string $action, PageIdentity $target, ?PermissionStatus $status=null)
	Checks whether this authority can probably perform the given action on the given target page.

Detailed Description

This interface represents the authority associated with the current execution context, such as a web request.

The authority determines which actions can or cannot be performed within that execution context.

See the individual implementations for information on how that authority is determined.

Since: 1.36

Definition at line 37 of file Authority.php.

Member Function Documentation

◆ authorizeAction()

MediaWiki\Permissions\Authority::authorizeAction	(	string	$action,
		?PermissionStatus	$status = null )

Authorize an action.

This should be used immediately before performing the action.

Calling this method may have non-trivial side-effects, such as incrementing a rate limit counter.

Since: 1.41

See also: isDefinitelyAllowed; authorizeRead; authorizeWrite

Parameters

string	$action
PermissionStatus \| null	$status	aggregator for failures

Returns: bool

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Referenced by ChangeTags\updateTagsWithChecks().

◆ authorizeRead()

MediaWiki\Permissions\Authority::authorizeRead	(	string	$action,
		PageIdentity	$target,
		?PermissionStatus	$status = null )

Authorize read access.

This should be used immediately before performing read access on restricted information.

Calling this method may have non-trivial side-effects, such as incrementing a rate limit counter.

Parameters

string	$action
PageIdentity	$target
PermissionStatus \| null	$status	aggregator for failures

Returns: bool If the user can perform the action

See also: authorizeAction; authorizeWrite; definitelyCan

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Referenced by DifferenceEngine\getPermissionErrors(), MediaWiki\Revision\RevisionArchiveRecord\userCan(), and MediaWiki\Revision\RevisionRecord\userCanBitfield().

◆ authorizeWrite()

MediaWiki\Permissions\Authority::authorizeWrite	(	string	$action,
		PageIdentity	$target,
		?PermissionStatus	$status = null )

Authorize write access.

This should be used immediately before updating persisted information.

Calling this method may have non-trivial side-effects, such as incrementing a rate limit counter.

Parameters

string	$action
PageIdentity	$target
PermissionStatus \| null	$status	aggregator for failures

Returns: bool If the user can perform the action

See also: authorizeAction; authorizeRead; definitelyCan

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Referenced by MediaWiki\Auth\AuthManager\authorizeCreateAccount(), MediaWiki\Page\MergeHistory\authorizeMerge(), MediaWiki\Page\MovePage\authorizeMove(), MediaWiki\Page\MovePage\moveSubpagesIfAllowed(), and UploadBase\verifyTitlePermissions().

◆ definitelyCan()

MediaWiki\Permissions\Authority::definitelyCan	(	string	$action,
		PageIdentity	$target,
		?PermissionStatus	$status = null )

Checks whether this authority can perform the given action on the given target page.

This method performs a thorough check, but does not protect against race conditions. It is intended to be used when a user is intending to perform an action, but has not yet committed to it. For example, when a user goes to the edit page of an article, this method may be used to determine whether the user should be presented with a warning and a read-only view instead.

This method may apply rate limit checks and evaluate user blocks.

See also: probablyCan; isDefinitelyAllowed

Parameters

string	$action
PageIdentity	$target
PermissionStatus \| null	$status	aggregator for failures

Returns: bool

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Referenced by MediaWiki\Page\MovePage\checkPermissions().

◆ getBlock()

MediaWiki\Permissions\Authority::getBlock ( int $freshness = IDBAccessObject::READ_NORMAL )

Returns any user block affecting the Authority.

Parameters

int $freshness Indicates whether slightly stale data is acceptable in, exchange for a fast response.

Returns: ?Block

Since: 1.37

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, and MediaWiki\Permissions\UserAuthority.

◆ getUser()

MediaWiki\Permissions\Authority::getUser ( )

Returns the performer of the actions associated with this authority.

Actions performed under this authority should generally be attributed to the user identity returned by this method.

Returns: UserIdentity

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Referenced by ChangeTags\activateTagWithChecks(), EmailNotification\actuallyNotifyOnPageChange(), MediaWiki\Auth\AuthManager\beginAccountCreation(), ChangeTags\createTagWithChecks(), ChangeTags\deactivateTagWithChecks(), ChangeTags\deleteTagWithChecks(), MediaWiki\Watchlist\WatchlistManager\isTempWatched(), MediaWiki\Watchlist\WatchlistManager\isWatched(), MediaWiki\Page\MergeHistory\merge(), MediaWiki\Page\MovePage\moveIfAllowed(), ChangesList\revDateLink(), and ChangeTags\updateTagsWithChecks().

◆ isAllowed()

MediaWiki\Permissions\Authority::isAllowed	(	string	$permission,
		?PermissionStatus	$status = null )

Checks whether this authority has the given permission in general.

For some permissions, exceptions may exist, both positive and negative, on a per-target basis. This method offers a fast, lightweight check, but may produce false positives. It is intended for determining which UI elements should be offered to the user.

This method will not apply rate limit checks or evaluate user blocks.

Parameters

string	$permission
PermissionStatus \| null	$status

Returns: bool

See also: isDefinitelyAllowed; probablyCan

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Referenced by EmailNotification\actuallyNotifyOnPageChange(), MediaWiki\Linker\Linker\getRevDeleteLink(), UploadBase\isAllowed(), UploadFromUrl\isAllowed(), MediaWiki\Page\MovePage\moveIfAllowed(), MediaWiki\User\TempUser\RealTempUserConfig\shouldAutoCreate(), ChangeTags\showTagEditingUI(), LogEventsList\userCanBitfield(), and LogEventsList\userCanViewLogType().

◆ isAllowedAll()

MediaWiki\Permissions\Authority::isAllowedAll ( $permissions )

Checks whether this authority has any of the given permissions in general.

Implementations must ensure that this method returns false if isAllowed would return false for any of the given permissions. Calling isAllowedAll() with one parameter must be equivalent to calling isAllowed(). Calling isAllowedAny() with no parameter is not allowed.

See also: isAllowed

Parameters

string ...$permissions Permissions to test. At least one must be given.

Returns: bool True if the user is allowed to perform all of the given actions

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

◆ isAllowedAny()

MediaWiki\Permissions\Authority::isAllowedAny ( $permissions )

Checks whether this authority has any of the given permissions in general.

Implementations must ensure that this method returns true if isAllowed would return true for any of the given permissions. Calling isAllowedAny() with one parameter must be equivalent to calling isAllowed(). Calling isAllowedAny() with no parameter is not allowed.

See also: isAllowed

Parameters

string ...$permissions Permissions to test. At least one must be given.

Returns: bool True if user is allowed to perform any of the given actions

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Referenced by LogEventsList\userCanBitfield(), and MediaWiki\Revision\RevisionRecord\userCanBitfield().

◆ isDefinitelyAllowed()

MediaWiki\Permissions\Authority::isDefinitelyAllowed	(	string	$action,
		?PermissionStatus	$status = null )

Checks whether this authority is allowed to perform the given action.

This method performs a thorough check, but does not protect against race conditions. It is intended to be used when a user is intending to perform an action, but has not yet committed to it. For example, when a user visits their preferences page, this method may be used to determine whether the user should have the option to change their email address.

This method may apply rate limit checks and evaluate user blocks.

Since: 1.41

See also: isAllowed; definitelyCan

Parameters

string	$action
PermissionStatus \| null	$status	aggregator for failures

Returns: bool

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

◆ isNamed()

MediaWiki\Permissions\Authority::isNamed ( )

Is the user a normal non-temporary registered user?

Since: 1.39

Returns: bool

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

◆ isRegistered()

MediaWiki\Permissions\Authority::isRegistered ( )

Get whether the user is registered.

Returns: bool

Since: 1.39

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Referenced by MediaWiki\User\TempUser\RealTempUserConfig\shouldAutoCreate().

◆ isTemp()

MediaWiki\Permissions\Authority::isTemp ( )

Is the user an autocreated temporary user?

Since: 1.39

Returns: bool

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

◆ probablyCan()

MediaWiki\Permissions\Authority::probablyCan	(	string	$action,
		PageIdentity	$target,
		?PermissionStatus	$status = null )

Checks whether this authority can probably perform the given action on the given target page.

This method offers a fast, lightweight check, but may produce false positives. It is intended for determining which UI elements should be offered to the user. This method will not apply rate limit checks or evaluate user blocks.

See also: definitelyCan; isAllowed

Parameters

string	$action
PageIdentity	$target
PermissionStatus \| null	$status	aggregator for failures

Returns: bool

Implemented in MediaWiki\Permissions\SimpleAuthority, MediaWiki\Permissions\UltimateAuthority, MediaWiki\Permissions\UserAuthority, and MediaWiki\User\User.

Referenced by MediaWiki\Auth\AuthManager\probablyCanCreateAccount(), MediaWiki\Page\MergeHistory\probablyCanMerge(), and MediaWiki\Page\MovePage\probablyCanMove().

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

includes/Permissions/Authority.php

Public Member Functions

Detailed Description

Member Function Documentation

◆ authorizeAction()

◆ authorizeRead()

◆ authorizeWrite()

◆ definitelyCan()

◆ getBlock()

◆ getUser()

◆ isAllowed()

◆ isAllowedAll()

◆ isAllowedAny()

◆ isDefinitelyAllowed()

◆ isNamed()

◆ isRegistered()

◆ isTemp()

◆ probablyCan()