Add or remove change tags to individual revisions. More...

Inherits MediaWiki\SpecialPage\UnlistedSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialEditTags:

[legend]

Public Member Functions
	__construct (PermissionManager $permissionManager, ChangeTagsStore $changeTagsStore)

	doesWrites ()
	Indicates whether POST requests to this special page require write access to the wiki.

	execute ( $par)
	Default execute method Checks user permissions.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

Public Member Functions inherited from MediaWiki\SpecialPage\UnlistedSpecialPage
	__construct ( $name, $restriction='', $function=false, $file='default')

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page.

	getName ()
	Get the canonical, unlocalized name of this special page without namespace.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getShortDescription (string $path='')
	Similar to getDescription, but takes into account subpages and designed for display in tabs.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false)
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Protected Member Functions
	buildCheckBoxes ()

	failure ( $status)
	Report that the submit operation failed.

	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

	getList ()
	Get the list object for this request.

	getTagSelect ( $selectedTags, $label)
	Returns a <select multiple> element with a list of change tags that can be applied by users.

	showConvenienceLinks ()
	Show some useful links in the subtitle.

	showForm ()
	Show a list of items that we will operate on, and show a form which allows the user to modify the tags applied to those items.

	submit ()
	UI entry point for form submission.

	success ()
	Report that the submit operation succeeded.

Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	getAuthManager ()

	getCacheTTL ()

	getHookContainer ()

	getHookRunner ()

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSpecialPageFactory ()

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset, ?SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Protected Attributes
bool	$wasSaved = false
	Was the DB modified in this request.

Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource	$mContext
	Current request context.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used as the message key for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

static	newSearchPage (User $user)
	Get the users preferred search page.

Static Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Detailed Description

Add or remove change tags to individual revisions.

A lot of this was copied out of SpecialRevisiondelete.

Since: 1.25

Definition at line 48 of file SpecialEditTags.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialEditTags::__construct	(	PermissionManager	$permissionManager,
		ChangeTagsStore	$changeTagsStore )

Parameters

PermissionManager $permissionManager

Definition at line 78 of file SpecialEditTags.php.

Member Function Documentation

◆ buildCheckBoxes()

MediaWiki\Specials\SpecialEditTags::buildCheckBoxes ( )

protected

Returns: string HTML

Definition at line 323 of file SpecialEditTags.php.

References MediaWiki\Html\element(), MediaWiki\SpecialPage\SpecialPage\getLanguage(), MediaWiki\Specials\SpecialEditTags\getList(), MediaWiki\Specials\SpecialEditTags\getTagSelect(), and MediaWiki\SpecialPage\SpecialPage\msg().

Referenced by MediaWiki\Specials\SpecialEditTags\showForm().

◆ doesWrites()

MediaWiki\Specials\SpecialEditTags::doesWrites ( )

Indicates whether POST requests to this special page require write access to the wiki.

Subclasses must override this method to return true if any of the operations that they perform on POST requests are not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that some subclasses might only perform "safe" operations even for POST requests, particularly in the case where large input parameters are required.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 85 of file SpecialEditTags.php.

◆ execute()

MediaWiki\Specials\SpecialEditTags::execute ( $subPage )

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stability: stable: to override

Parameters

string | null $subPage

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 89 of file SpecialEditTags.php.

References MediaWiki\SpecialPage\SpecialPage\checkPermissions(), MediaWiki\SpecialPage\SpecialPage\checkReadOnly(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getRequest(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\SpecialPage\SpecialPage\outputHeader(), MediaWiki\SpecialPage\SpecialPage\setHeaders(), MediaWiki\Specials\SpecialEditTags\showConvenienceLinks(), MediaWiki\Specials\SpecialEditTags\showForm(), and MediaWiki\Specials\SpecialEditTags\submit().

◆ failure()

MediaWiki\Specials\SpecialEditTags::failure ( $status )

protected

Report that the submit operation failed.

Parameters

Status $status

Definition at line 489 of file SpecialEditTags.php.

References MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\msg(), and MediaWiki\Specials\SpecialEditTags\showForm().

Referenced by MediaWiki\Specials\SpecialEditTags\submit().

◆ getDescription()

MediaWiki\Specials\SpecialEditTags::getDescription ( )

Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

Derived classes can override this, but usually it is easier to keep the default behavior.

Returning a string from this method has been deprecated since 1.41.

Stability: stable: to override

Returns: string|Message

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 502 of file SpecialEditTags.php.

References MediaWiki\SpecialPage\SpecialPage\msg().

◆ getGroupName()

MediaWiki\Specials\SpecialEditTags::getGroupName ( )

protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 506 of file SpecialEditTags.php.

◆ getList()

MediaWiki\Specials\SpecialEditTags::getList ( )

protected

Get the list object for this request.

Returns: ChangeTagsList

Definition at line 236 of file SpecialEditTags.php.

References ChangeTagsList\factory(), and MediaWiki\SpecialPage\SpecialPage\getContext().

Referenced by MediaWiki\Specials\SpecialEditTags\buildCheckBoxes(), MediaWiki\Specials\SpecialEditTags\showForm(), and MediaWiki\Specials\SpecialEditTags\submit().

◆ getTagSelect()

MediaWiki\Specials\SpecialEditTags::getTagSelect	(		$selectedTags,
			$label )

protected

Returns a <select multiple> element with a list of change tags that can be applied by users.

Parameters

array	$selectedTags	The tags that should be preselected in the list. Any tags in this list, but not in the list returned by ChangeTagsStore::listExplicitlyDefinedTags, will be appended to the <select> element.
string	$label	The text of a <label> to precede the <select>