Special page for adding and removing change tags to individual revisions. More...

Inheritance diagram for SpecialEditTags:

[legend]

Collaboration diagram for SpecialEditTags:

[legend]

Public Member Functions
	__construct ()

	doesWrites ()
	Indicates whether this special page may perform database writes.

	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 UnlistedSpecialPage
	__construct ( $name, $restriction='', $function=false, $file='default')

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

Public Member Functions inherited from 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.

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

	getConfig ()
	Shortcut to get main config object.

	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 name of this Special Page.

	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.

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

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

	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.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

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

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

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

	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.

	run ( $subPage)
	Entry point.

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

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

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	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 SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

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

	getCacheTTL ()

	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.

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

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

	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 SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Attributes
array	$ids
	Target ID list.

bool	$isAllowed
	Whether user is allowed to perform the action.

string	$reason

ChangeTagsList	$revList
	Storing the list of items to be tagged.

bool	$submitClicked
	True if the submit button was clicked, and the form was posted.

Title	$targetObj
	Title object for target parameter.

string	$typeName
	Deletion type, may be revision or logentry.

Additional Inherited Members
Static Public Member Functions inherited from 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 Protected Member Functions inherited from 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

Special page for adding and removing change tags to individual revisions.

A lot of this is copied out of SpecialRevisiondelete.

Since: 1.25

Definition at line 29 of file SpecialEditTags.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialEditTags::__construct ( )

Definition at line 54 of file SpecialEditTags.php.

Member Function Documentation

◆ buildCheckBoxes()

SpecialEditTags::buildCheckBoxes ( )

protected

Returns: string HTML

Definition at line 292 of file SpecialEditTags.php.

References $html, SpecialPage\getLanguage(), getList(), getTagSelect(), SpecialPage\msg(), and plain.

Referenced by showForm().

◆ doesWrites()

SpecialEditTags::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 58 of file SpecialEditTags.php.

◆ execute()

SpecialEditTags::execute ( $subPage )

Default execute method Checks user permissions.

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

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 62 of file SpecialEditTags.php.

References $ids, $output, $request, $targetObj, SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getUser(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), showConvenienceLinks(), showForm(), LogEventsList\showLogExtract(), submit(), and RevisionDeleter\suggestTarget().

◆ failure()

SpecialEditTags::failure ( $status )

protected

Report that the submit operation failed.

Parameters

Status $status

Definition at line 458 of file SpecialEditTags.php.

References SpecialPage\getOutput(), SpecialPage\msg(), and showForm().

Referenced by submit().

◆ getDescription()

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.

Returns: string

Reimplemented from SpecialPage.

Definition at line 466 of file SpecialEditTags.php.

References SpecialPage\msg().

◆ getGroupName()

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'.

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 470 of file SpecialEditTags.php.

◆ getList()

SpecialEditTags::getList ( )

protected

Get the list object for this request.

Returns: ChangeTagsList

Definition at line 195 of file SpecialEditTags.php.

References $revList, ChangeTagsList\factory(), and SpecialPage\getContext().

Referenced by buildCheckBoxes(), showForm(), and submit().

◆ getTagSelect()

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 ChangeTags::listExplicitlyDefinedTags, will be appended to the <select> element.
string	$label	The text of a <label> to precede the <select>

Returns: array HTML <label> element at index 0, HTML <select> element at index 1

Definition at line 365 of file SpecialEditTags.php.

References $result, and ChangeTags\listExplicitlyDefinedTags().

Referenced by buildCheckBoxes().

◆ showConvenienceLinks()

SpecialEditTags::showConvenienceLinks ( )

protected

Show some useful links in the subtitle.

Definition at line 155 of file SpecialEditTags.php.

References SpecialPage\$linkRenderer, SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), SpecialPage\getSkin(), SpecialPage\getTitleFor(), SpecialPage\msg(), and text.

Referenced by execute().

◆ showForm()

SpecialEditTags::showForm ( )

protected

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.

Definition at line 208 of file SpecialEditTags.php.

References $out, SpecialPage\addHelpLink(), buildCheckBoxes(), SpecialPage\getConfig(), SpecialPage\getLanguage(), getList(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), MIGRATION_OLD, SpecialPage\msg(), and text.

Referenced by execute(), failure(), and success().

◆ submit()

SpecialEditTags::submit ( )

protected

UI entry point for form submission.

Exceptions

PermissionsError

Returns: bool

Definition at line 388 of file SpecialEditTags.php.

References $request, failure(), getList(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getUser(), and success().

Referenced by execute().

◆ success()

SpecialEditTags::success ( )

protected

Report that the submit operation succeeded.

Definition at line 444 of file SpecialEditTags.php.

References SpecialPage\getOutput(), SpecialPage\msg(), and showForm().

Referenced by submit().

Member Data Documentation

◆ $ids

array SpecialEditTags::$ids

private

Target ID list.

Definition at line 37 of file SpecialEditTags.php.

Referenced by execute().

◆ $isAllowed

bool SpecialEditTags::$isAllowed

private

Whether user is allowed to perform the action.

Definition at line 49 of file SpecialEditTags.php.

◆ $reason

string SpecialEditTags::$reason

private

Definition at line 52 of file SpecialEditTags.php.

◆ $revList

ChangeTagsList SpecialEditTags::$revList

private

Storing the list of items to be tagged.

Definition at line 46 of file SpecialEditTags.php.

Referenced by getList().

◆ $submitClicked

bool SpecialEditTags::$submitClicked

private

True if the submit button was clicked, and the form was posted.

Definition at line 34 of file SpecialEditTags.php.

◆ $targetObj

Title SpecialEditTags::$targetObj

private

Title object for target parameter.

Definition at line 40 of file SpecialEditTags.php.

Referenced by execute().

◆ $typeName

string SpecialEditTags::$typeName

private

Deletion type, may be revision or logentry.

Definition at line 43 of file SpecialEditTags.php.

◆ $wasSaved

bool SpecialEditTags::$wasSaved = false

protected

Was the DB modified in this request.

Definition at line 31 of file SpecialEditTags.php.

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

includes/specials/SpecialEditTags.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildCheckBoxes()

◆ doesWrites()

◆ execute()

◆ failure()

◆ getDescription()

◆ getGroupName()

◆ getList()

◆ getTagSelect()

◆ showConvenienceLinks()

◆ showForm()

◆ submit()

◆ success()

Member Data Documentation

◆ $ids

◆ $isAllowed

◆ $reason

◆ $revList

◆ $submitClicked

◆ $targetObj

◆ $typeName

◆ $wasSaved