Class RestrictionStore. More...

Collaboration diagram for MediaWiki\Permissions\RestrictionStore:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, WANObjectCache $wanCache, ILoadBalancer $loadBalancer, LinkCache $linkCache, CommentStore $commentStore, HookContainer $hookContainer, PageStore $pageStore)

	areCascadeProtectionSourcesLoaded (PageIdentity $page)
	Determines whether cascading protection sources have already been loaded from the database.

	areRestrictionsCascading (PageIdentity $page)
	Checks if restrictions are cascading for the current page.

	areRestrictionsLoaded (PageIdentity $page)

	deleteCreateProtection (PageIdentity $page)
	Remove any title creation protection due to page existing.

	flushRestrictions (PageIdentity $page)
	Flush the protection cache in this object and force reload from the database.

	getAllRestrictions (PageIdentity $page)
	Returns the restricted actions and their restrictions for the specified page.

	getCascadeProtectionSources (PageIdentity $page)
	Cascading protection: Get the source of any cascading restrictions on this page.

	getCreateProtection (PageIdentity $page)
	Is this title subject to protection against creation?

	getRestrictionExpiry (PageIdentity $page, string $action)
	Get the expiry time for the restriction against a given action.

	getRestrictions (PageIdentity $page, string $action)
	Returns list of restrictions for specified page.

	isCascadeProtected (PageIdentity $page)
	Cascading protection: Return true if cascading restrictions apply to this page, false if not.

	isProtected (PageIdentity $page, string $action='')
	Does the title correspond to a protected article?

	isSemiProtected (PageIdentity $page, string $action='edit')
	Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels?

	listAllRestrictionTypes (bool $exists=true)
	Get a filtered list of all restriction types supported by this wiki.

	listApplicableRestrictionTypes (PageIdentity $page)
	Returns restriction types for the current page.

	loadRestrictions (PageIdentity $page, int $flags=IDBAccessObject::READ_NORMAL, ?string $oldRestrictions=null)
	Load restrictions from page.page_restrictions and the page_restrictions table.

	loadRestrictionsFromRows (PageIdentity $page, array $rows, ?string $oldRestrictions=null)
	Compiles list of active page restrictions for this existing page.

	registerOldRestrictions (PageIdentity $page, string $oldRestrictions)
	Register legacy restrictions from page.page_restrictions.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Private Member Functions
	convertOldRestrictions (string $oldRestrictions)
	Given a string formatted like the legacy page.page_restrictions field, return an array of restrictions in the format returned by getAllRestrictions().

	getCascadeProtectionSourcesInternal (PageIdentity $page, bool $shortCircuit=false)
	Cascading protection: Get the source of any cascading restrictions on this page.

	getCreateProtectionInternal (PageIdentity $page)
	Fetch title protection settings.

Private Attributes
array[]	$cache = []
	Caching various restrictions data in the following format: cache key => [ string[] `restrictions` => restrictions loaded for pages string `oldRestrictions` => legacy-formatted restrictions from page.page_restrictions ?string `expiry` => restrictions expiry data for pages ?array `create_protection` => value for getCreateProtection bool `cascade` => cascade restrictions on this page to included templates and images? array[] `cascade_sources` => the results of getCascadeProtectionSources bool `has_cascading` => Are cascading restrictions in effect on this page? ].

CommentStore	$commentStore

HookContainer	$hookContainer

HookRunner	$hookRunner

LinkCache	$linkCache

ILoadBalancer	$loadBalancer

ServiceOptions	$options

PageStore	$pageStore

WANObjectCache	$wanCache

Detailed Description

Class RestrictionStore.

Since: 1.37

Definition at line 28 of file RestrictionStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Permissions\RestrictionStore::__construct	(	ServiceOptions	$options,
		WANObjectCache	$wanCache,
		ILoadBalancer	$loadBalancer,
		LinkCache	$linkCache,
		CommentStore	$commentStore,
		HookContainer	$hookContainer,
		PageStore	$pageStore
	)

Parameters

ServiceOptions	$options
WANObjectCache	$wanCache
ILoadBalancer	$loadBalancer
LinkCache	$linkCache
CommentStore	$commentStore
HookContainer	$hookContainer
PageStore	$pageStore

Definition at line 85 of file RestrictionStore.php.

References MediaWiki\Permissions\RestrictionStore\$commentStore, MediaWiki\Permissions\RestrictionStore\$hookContainer, MediaWiki\Permissions\RestrictionStore\$linkCache, MediaWiki\Permissions\RestrictionStore\$loadBalancer, MediaWiki\Permissions\RestrictionStore\$options, MediaWiki\Permissions\RestrictionStore\$pageStore, MediaWiki\Permissions\RestrictionStore\$wanCache, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ areCascadeProtectionSourcesLoaded()

MediaWiki\Permissions\RestrictionStore::areCascadeProtectionSourcesLoaded ( PageIdentity $page )

Determines whether cascading protection sources have already been loaded from the database.

Parameters

PageIdentity $page Must be local

Returns: bool

Definition at line 700 of file RestrictionStore.php.

◆ areRestrictionsCascading()

MediaWiki\Permissions\RestrictionStore::areRestrictionsCascading ( PageIdentity $page )

Checks if restrictions are cascading for the current page.

Parameters

PageIdentity $page Must be local

Returns: bool

Definition at line 712 of file RestrictionStore.php.

◆ areRestrictionsLoaded()

MediaWiki\Permissions\RestrictionStore::areRestrictionsLoaded ( PageIdentity $page )

Parameters

PageIdentity $page Must be local

Returns: bool Whether or not the page's restrictions have already been loaded from the database

Definition at line 688 of file RestrictionStore.php.

◆ convertOldRestrictions()

MediaWiki\Permissions\RestrictionStore::convertOldRestrictions ( string $oldRestrictions )

private

Given a string formatted like the legacy page.page_restrictions field, return an array of restrictions in the format returned by getAllRestrictions().

Parameters

string $oldRestrictions Restrictions in legacy format (page.page_restrictions). Example: "edit=autoconfirmed,sysop:move=sysop"

Returns: array As returned by getAllRestrictions()

Definition at line 511 of file RestrictionStore.php.

◆ deleteCreateProtection()

MediaWiki\Permissions\RestrictionStore::deleteCreateProtection ( PageIdentity $page )

Remove any title creation protection due to page existing.

Parameters

PageIdentity $page Must be local

Access: internal: Only to be called by WikiPage::onArticleCreate.

Definition at line 193 of file RestrictionStore.php.

◆ flushRestrictions()

MediaWiki\Permissions\RestrictionStore::flushRestrictions ( PageIdentity $page )

Flush the protection cache in this object and force reload from the database.

This is used when updating protection from WikiPage::doUpdateRestrictions().

Parameters

PageIdentity $page Must be local

Access: internal

Definition at line 728 of file RestrictionStore.php.

◆ getAllRestrictions()

MediaWiki\Permissions\RestrictionStore::getAllRestrictions ( PageIdentity $page )

Returns the restricted actions and their restrictions for the specified page.

Parameters

PageIdentity $page Must be local

Returns: string[][] Keys are actions, values are arrays as returned by RestrictionStore::getRestrictions(). Empty if no restrictions are in place.

Definition at line 130 of file RestrictionStore.php.

◆ getCascadeProtectionSources()

MediaWiki\Permissions\RestrictionStore::getCascadeProtectionSources ( PageIdentity $page )

Cascading protection: Get the source of any cascading restrictions on this page.

Parameters

PageIdentity $page Must be local

Returns: array[] Two elements: First is an array of PageIdentity objects of the pages from which cascading restrictions have come, which may be empty. Second is an array like that returned by getAllRestrictions(). NOTE: The first element of the return is always an array, unlike Title::getCascadeProtectionSources where the first element is false if there are no sources.

Definition at line 590 of file RestrictionStore.php.

◆ getCascadeProtectionSourcesInternal()

MediaWiki\Permissions\RestrictionStore::getCascadeProtectionSourcesInternal	(	PageIdentity	$page,
		bool	$shortCircuit = `false`
	)

private

Cascading protection: Get the source of any cascading restrictions on this page.

Parameters

PageIdentity	$page	Must be local
bool	$shortCircuit	If true, just return true or false instead of the actual lists.

Returns: array|bool If $shortCircuit is true, return true if there is some cascading protection and false otherwise. Otherwise, same as getCascadeProtectionSources().

Definition at line 604 of file RestrictionStore.php.

References $dbr, $res, DB_REPLICA, MediaWiki\Page\PageReference\getDBkey(), MediaWiki\Page\PageReference\getNamespace(), NS_FILE, and wfTimestampNow().

◆ getCreateProtection()

MediaWiki\Permissions\RestrictionStore::getCreateProtection ( PageIdentity $page )

Is this title subject to protection against creation?

Parameters

PageIdentity $page Must be local

Returns

?array Null if no restrictions. Otherwise an array with the following keys:

user: user id
expiry: 14-digit timestamp or 'infinity'
permission: string (pt_create_perm)
reason: string

Access: internal: Only to be called by Title::getTitleProtection. When that is discontinued, this will be too, in favor of getRestrictions( $page, 'create' ). If someone wants to know who protected it or the reason, there should be a method that exposes that for all restriction types.

Definition at line 171 of file RestrictionStore.php.

◆ getCreateProtectionInternal()

MediaWiki\Permissions\RestrictionStore::getCreateProtectionInternal ( PageIdentity $page )

private

Fetch title protection settings.

To work correctly, $this->loadRestrictions() needs to have access to the actual protections in the database without munging 'sysop' => 'editprotected' and 'autoconfirmed' => 'editsemiprotected'.

Parameters

PageIdentity $page Must be local

Returns: ?array Same format as getCreateProtection().

Definition at line 539 of file RestrictionStore.php.

◆ getRestrictionExpiry()

MediaWiki\Permissions\RestrictionStore::getRestrictionExpiry	(	PageIdentity	$page,
		string	$action
	)

Get the expiry time for the restriction against a given action.

Parameters

PageIdentity	$page	Must be local
string	$action

Returns: ?string 14-char timestamp, or 'infinity' if the page is protected forever or not protected at all, or null if the action is not recognized. NOTE: This returns null for unrecognized actions, unlike Title::getRestrictionExpiry which returns false.

Definition at line 148 of file RestrictionStore.php.

◆ getRestrictions()

MediaWiki\Permissions\RestrictionStore::getRestrictions	(	PageIdentity	$page,
		string	$action
	)

Returns list of restrictions for specified page.

Parameters

PageIdentity	$page	Must be local
string	$action	Action that restrictions need to be checked for

Returns: string[] Restriction levels needed to take the action. All levels are required. Note that restriction levels are normally user rights, but 'sysop' and 'autoconfirmed' are also allowed for backwards compatibility. These should be mapped to 'editprotected' and 'editsemiprotected' respectively. Returns an empty array if there are no restrictions set for this action (including for unrecognized actions).

Definition at line 116 of file RestrictionStore.php.

◆ isCascadeProtected()

MediaWiki\Permissions\RestrictionStore::isCascadeProtected ( PageIdentity $page )

Cascading protection: Return true if cascading restrictions apply to this page, false if not.

Parameters

PageIdentity $page Must be local

Returns: bool If the page is subject to cascading restrictions.

Definition at line 280 of file RestrictionStore.php.

◆ isProtected()

MediaWiki\Permissions\RestrictionStore::isProtected	(	PageIdentity	$page,
		string	$action = `''`
	)

Does the title correspond to a protected article?

Parameters

PageIdentity	$page	Must be local
string	$action	The action the page is protected from, by default checks all actions.

Returns: bool

Definition at line 241 of file RestrictionStore.php.

◆ isSemiProtected()

MediaWiki\Permissions\RestrictionStore::isSemiProtected	(	PageIdentity	$page,
		string	$action = `'edit'`
	)

Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels?

Parameters

PageIdentity	$page	Must be local
string	$action	Action to check (default: edit)

Returns: bool

Definition at line 213 of file RestrictionStore.php.

◆ listAllRestrictionTypes()

MediaWiki\Permissions\RestrictionStore::listAllRestrictionTypes ( bool $exists = true )

Get a filtered list of all restriction types supported by this wiki.

Parameters

bool $exists True to get all restriction types that apply to titles that do exist, false for all restriction types that apply to titles that do not exist

Returns: string[]

Definition at line 321 of file RestrictionStore.php.

◆ listApplicableRestrictionTypes()

MediaWiki\Permissions\RestrictionStore::listApplicableRestrictionTypes ( PageIdentity $page )

Returns restriction types for the current page.

Parameters

PageIdentity $page Must be local

Returns: string[] Applicable restriction types

Definition at line 292 of file RestrictionStore.php.

◆ loadRestrictions()

MediaWiki\Permissions\RestrictionStore::loadRestrictions	(	PageIdentity	$page,
		int	$flags = `IDBAccessObject::READ_NORMAL`,
		?string	$oldRestrictions = `null`
	)

Load restrictions from page.page_restrictions and the page_restrictions table.

Parameters

PageIdentity	$page	Must be local
int	$flags	IDBAccessObject::READ_XXX constants (e.g., READ_LATEST to read from primary DB)
string \| null	$oldRestrictions	Restrictions in legacy format (page.page_restrictions). null means we don't know about any legacy restrictions and they need to be looked up. Example: "edit=autoconfirmed,sysop:move=sysop"

Access: internal

Definition at line 343 of file RestrictionStore.php.

◆ loadRestrictionsFromRows()

MediaWiki\Permissions\RestrictionStore::loadRestrictionsFromRows	(	PageIdentity	$page,
		array	$rows,
		?string	$oldRestrictions = `null`
	)

Compiles list of active page restrictions for this existing page.

Public for usage by LiquidThreads.

Parameters

PageIdentity	$page	Must be local
stdClass[]	$rows	Array of db result objects
string \| null	$oldRestrictions	Restrictions in legacy format (page.page_restrictions). null means we don't know about any legacy restrictions and they need to be looked up. Example: "edit=autoconfirmed,sysop:move=sysop"

Definition at line 436 of file RestrictionStore.php.

◆ registerOldRestrictions()

MediaWiki\Permissions\RestrictionStore::registerOldRestrictions	(	PageIdentity	$page,
		string	$oldRestrictions
	)

Register legacy restrictions from page.page_restrictions.

This is nice to do if you have a page row handy anyway, so we don't have to look them up separately later.

Parameters

PageIdentity	$page	Must be local
string	$oldRestrictions	Restrictions in legacy format (page.page_restrictions). Example: "edit=autoconfirmed,sysop:move=sysop"

Access: internal

Definition at line 744 of file RestrictionStore.php.

Member Data Documentation

◆ $cache

array [] MediaWiki\Permissions\RestrictionStore::$cache = []

private

Caching various restrictions data in the following format: cache key => [ string[] restrictions => restrictions loaded for pages string oldRestrictions => legacy-formatted restrictions from page.page_restrictions ?string expiry => restrictions expiry data for pages ?array create_protection => value for getCreateProtection bool cascade => cascade restrictions on this page to included templates and images? array[] cascade_sources => the results of getCascadeProtectionSources bool has_cascading => Are cascading restrictions in effect on this page? ].

Definition at line 74 of file RestrictionStore.php.

◆ $commentStore

CommentStore MediaWiki\Permissions\RestrictionStore::$commentStore

private

Definition at line 51 of file RestrictionStore.php.

Referenced by MediaWiki\Permissions\RestrictionStore\__construct().

◆ $hookContainer

HookContainer MediaWiki\Permissions\RestrictionStore::$hookContainer

private

Definition at line 54 of file RestrictionStore.php.

Referenced by MediaWiki\Permissions\RestrictionStore\__construct().

◆ $hookRunner

HookRunner MediaWiki\Permissions\RestrictionStore::$hookRunner

private

Definition at line 57 of file RestrictionStore.php.

◆ $linkCache

LinkCache MediaWiki\Permissions\RestrictionStore::$linkCache

private

Definition at line 48 of file RestrictionStore.php.

Referenced by MediaWiki\Permissions\RestrictionStore\__construct().

◆ $loadBalancer

ILoadBalancer MediaWiki\Permissions\RestrictionStore::$loadBalancer

private

Definition at line 45 of file RestrictionStore.php.

Referenced by MediaWiki\Permissions\RestrictionStore\__construct().

◆ $options

ServiceOptions MediaWiki\Permissions\RestrictionStore::$options

private

Definition at line 39 of file RestrictionStore.php.

Referenced by MediaWiki\Permissions\RestrictionStore\__construct().

◆ $pageStore

PageStore MediaWiki\Permissions\RestrictionStore::$pageStore

private

Definition at line 60 of file RestrictionStore.php.

Referenced by MediaWiki\Permissions\RestrictionStore\__construct().

◆ $wanCache

WANObjectCache MediaWiki\Permissions\RestrictionStore::$wanCache

private

Definition at line 42 of file RestrictionStore.php.

Referenced by MediaWiki\Permissions\RestrictionStore\__construct().

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Permissions\RestrictionStore::CONSTRUCTOR_OPTIONS

Initial value:

= [
        'NamespaceProtection',
        'RestrictionLevels',
        'RestrictionTypes',
        'SemiprotectedRestrictionLevels',
    ]

Access: internal

Definition at line 31 of file RestrictionStore.php.

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

includes/Permissions/RestrictionStore.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ areCascadeProtectionSourcesLoaded()

◆ areRestrictionsCascading()

◆ areRestrictionsLoaded()

◆ convertOldRestrictions()

◆ deleteCreateProtection()

◆ flushRestrictions()

◆ getAllRestrictions()

◆ getCascadeProtectionSources()

◆ getCascadeProtectionSourcesInternal()

◆ getCreateProtection()

◆ getCreateProtectionInternal()

◆ getRestrictionExpiry()

◆ getRestrictions()

◆ isCascadeProtected()

◆ isProtected()

◆ isSemiProtected()

◆ listAllRestrictionTypes()

◆ listApplicableRestrictionTypes()

◆ loadRestrictions()

◆ loadRestrictionsFromRows()

◆ registerOldRestrictions()

Member Data Documentation

◆ $cache

◆ $commentStore

◆ $hookContainer

◆ $hookRunner

◆ $linkCache

◆ $loadBalancer

◆ $options

◆ $pageStore

◆ $wanCache

◆ CONSTRUCTOR_OPTIONS