MediaWiki  master
ChangeTags Class Reference
Collaboration diagram for ChangeTags:

Static Public Member Functions

static activateTagWithChecks ($tag, $reason, User $user, $ignoreWarnings=false, array $logEntryTags=[])
 Activates a tag, checking whether it is allowed first, and adding a log entry afterwards. More...
 
static addTags ($tags, $rc_id=null, $rev_id=null, $log_id=null, $params=null, RecentChange $rc=null)
 Add tags to a change given its rc_id, rev_id and/or log_id. More...
 
static addTagsAccompanyingChangeWithChecks (array $tags, $rc_id, $rev_id, $log_id, $params, User $user)
 Adds tags to a given change, checking whether it is allowed first, but without adding a log entry. More...
 
static buildTagFilterSelector ($selected= '', $ooui=false, IContextSource $context=null)
 Build a text box to select a change tag. More...
 
static canActivateTag ($tag, User $user=null)
 Is it OK to allow the user to activate this tag? More...
 
static canAddTagsAccompanyingChange (array $tags, User $user=null)
 Is it OK to allow the user to apply all the specified tags at the same time as they edit/make the change? More...
 
static canCreateTag ($tag, User $user=null)
 Is it OK to allow the user to create this tag? More...
 
static canDeactivateTag ($tag, User $user=null)
 Is it OK to allow the user to deactivate this tag? More...
 
static canDeleteTag ($tag, User $user=null)
 Is it OK to allow the user to delete this tag? More...
 
static canUpdateTags (array $tagsToAdd, array $tagsToRemove, User $user=null)
 Is it OK to allow the user to adds and remove the given tags tags to/from a change? More...
 
static createTagWithChecks ($tag, $reason, User $user, $ignoreWarnings=false, array $logEntryTags=[])
 Creates a tag by adding a row to the valid_tag table. More...
 
static deactivateTagWithChecks ($tag, $reason, User $user, $ignoreWarnings=false, array $logEntryTags=[])
 Deactivates a tag, checking whether it is allowed first, and adding a log entry afterwards. More...
 
static defineTag ($tag)
 Defines a tag in the valid_tag table, without checking that the tag name is valid. More...
 
static deleteTagEverywhere ($tag)
 Permanently removes all traces of a tag from the DB. More...
 
static deleteTagWithChecks ($tag, $reason, User $user, $ignoreWarnings=false, array $logEntryTags=[])
 Deletes a tag, checking whether it is allowed first, and adding a log entry afterwards. More...
 
static formatSummaryRow ($tags, $page, IContextSource $context=null)
 Creates HTML for the given tags. More...
 
static listDefinedTags ()
 Basically lists defined tags which count even if they aren't applied to anything. More...
 
static listExplicitlyDefinedTags ()
 Lists tags explicitly defined in the valid_tag table of the database. More...
 
static listExtensionActivatedTags ()
 
static listExtensionDefinedTags ()
 Call listSoftwareDefinedTags directly. More...
 
static listSoftwareActivatedTags ()
 Lists those tags which core or extensions report as being "active". More...
 
static listSoftwareDefinedTags ()
 Lists tags defined by core or extensions using the ListDefinedTags hook. More...
 
static modifyDisplayQuery (&$tables, &$fields, &$conds, &$join_conds, &$options, $filter_tag=false)
 Applies all tags-related changes to a query. More...
 
static purgeTagCacheAll ()
 Invalidates the short-term cache of defined tags used by the list*DefinedTags functions, as well as the tag statistics cache. More...
 
static purgeTagUsageCache ()
 Invalidates the tag statistics cache only. More...
 
static showTagEditingUI (User $user)
 Indicate whether change tag editing UI is relevant. More...
 
static tagDescription ($tag, IContextSource $context)
 Get a short description for a tag. More...
 
static tagUsageStatistics ()
 Returns a map of any tags used on the wiki to number of edits tagged with them, ordered descending by the hitcount. More...
 
static undefineTag ($tag)
 Removes a tag from the valid_tag table. More...
 
static updateTags ($tagsToAdd, $tagsToRemove, &$rc_id=null, &$rev_id=null, &$log_id=null, $params=null, RecentChange $rc=null, User $user=null)
 Add and remove tags to/from a change given its rc_id, rev_id and/or log_id, without verifying that the tags exist or are valid. More...
 
static updateTagsWithChecks ($tagsToAdd, $tagsToRemove, $rc_id, $rev_id, $log_id, $params, $reason, User $user)
 Adds and/or removes tags to/from a given change, checking whether it is allowed first, and adding a log entry afterwards. More...
 

Public Attributes

const MAX_DELETE_USES = 5000
 Can't delete tags with more than this many uses. More...
 

Static Protected Member Functions

static logTagManagementAction ($action, $tag, $reason, User $user, $tagCount=null, array $logEntryTags=[])
 Writes a tag action into the tag management log. More...
 
static restrictedTagError ($msgOne, $msgMulti, $tags)
 Helper function to generate a fatal status with a 'not-allowed' type error. More...
 
static updateTagSummaryRow (&$tagsToAdd, &$tagsToRemove, $rc_id, $rev_id, $log_id, &$prevTags=[])
 Adds or removes a given set of tags to/from the relevant row of the tag_summary table. More...
 

Static Private Attributes

static string[] $coreTags = [ 'mw-contentmodelchange' ]
 

Detailed Description

Definition at line 26 of file ChangeTags.php.

Member Function Documentation

static ChangeTags::activateTagWithChecks (   $tag,
  $reason,
User  $user,
  $ignoreWarnings = false,
array  $logEntryTags = [] 
)
static

Activates a tag, checking whether it is allowed first, and adding a log entry afterwards.

Includes a call to ChangeTag::canActivateTag(), so your code doesn't need to do that.

Parameters
string$tag
string$reason
User$userWho to give credit for the action
bool$ignoreWarningsCan be used for API interaction, default false
array$logEntryTagsChange tags to apply to the entry that will be created in the tag management log
Returns
Status If successful, the Status contains the ID of the added log entry as its value
Since
1.25

Definition at line 844 of file ChangeTags.php.

References $tag, and StatusValue\newGood().

static ChangeTags::addTags (   $tags,
  $rc_id = null,
  $rev_id = null,
  $log_id = null,
  $params = null,
RecentChange  $rc = null 
)
static

Add tags to a change given its rc_id, rev_id and/or log_id.

Parameters
string|string[]$tags Tags to add to the change
int | null$rc_idThe rc_id of the change to add the tags to
int | null$rev_idThe rev_id of the change to add the tags to
int | null$log_idThe log_id of the change to add the tags to
string$paramsParams to put in the ct_params field of table 'change_tag'
RecentChange | null$rcRecent change, in case the tagging accompanies the action (this should normally be the case)
Exceptions
MWException
Returns
bool False if no changes are made, otherwise true

Definition at line 136 of file ChangeTags.php.

References $params.

Referenced by MovePage\moveToInternal(), ApiTag\processIndividual(), and RecentChange\save().

static ChangeTags::addTagsAccompanyingChangeWithChecks ( array  $tags,
  $rc_id,
  $rev_id,
  $log_id,
  $params,
User  $user 
)
static

Adds tags to a given change, checking whether it is allowed first, but without adding a log entry.

Useful for cases where the tag is being added along with the action that generated the change (e.g. tagging an edit as it is being made).

Extensions should not use this function, unless directly handling a user request to add a particular tag. Normally, extensions should call ChangeTags::updateTags() instead.

Parameters
array$tagsTags to apply
int | null$rc_idThe rc_id of the change to add the tags to
int | null$rev_idThe rev_id of the change to add the tags to
int | null$log_idThe log_id of the change to add the tags to
string$paramsParams to put in the ct_params field of table 'change_tag' when adding tags
User$userWho to give credit for the action
Returns
Status
Since
1.25

Definition at line 438 of file ChangeTags.php.

References $params, and StatusValue\newGood().

static ChangeTags::buildTagFilterSelector (   $selected = '',
  $ooui = false,
IContextSource  $context = null 
)
static

Build a text box to select a change tag.

Parameters
string$selectedTag to select by default
bool$oouiUse an OOUI TextInputWidget as selector instead of a non-OOUI input field You need to call OutputPage::enableOOUI() yourself.
IContextSource | null$context
Note
Even though it takes null as a valid argument, an IContextSource is preferred in a new code, as the null value can change in the future
Returns
array an array of (label, selector)

Definition at line 678 of file ChangeTags.php.

References $context, ContextSource\getConfig(), RequestContext\getMain(), Xml\input(), ContextSource\msg(), and Html\rawElement().

Referenced by HTMLTagFilter\getDiv(), SpecialRecentChanges\getExtraOptions(), HTMLTagFilter\getTableRow(), HistoryAction\onView(), and LogEventsList\showOptions().

static ChangeTags::canActivateTag (   $tag,
User  $user = null 
)
static

Is it OK to allow the user to activate this tag?

Parameters
string$tagTag that you are interested in activating
User | null$userUser whose permission you wish to check, or null if you don't care (e.g. maintenance scripts)
Returns
Status
Since
1.25

Definition at line 801 of file ChangeTags.php.

References $tag, $user, StatusValue\newFatal(), and StatusValue\newGood().

Referenced by SpecialTags\doTagRow().

static ChangeTags::canAddTagsAccompanyingChange ( array  $tags,
User  $user = null 
)
static

Is it OK to allow the user to apply all the specified tags at the same time as they edit/make the change?

Parameters
array$tagsTags that you are interested in applying
User | null$userUser whose permission you wish to check, or null if you don't care (e.g. maintenance scripts)
Returns
Status
Since
1.25

Definition at line 395 of file ChangeTags.php.

References $user, StatusValue\newFatal(), and StatusValue\newGood().

Referenced by ApiImageRotate\execute(), ApiManageTags\execute(), ApiTag\execute(), ApiProtect\execute(), ApiUndelete\execute(), ApiMove\execute(), ApiRevisionDelete\execute(), ApiImport\execute(), ApiPatrol\execute(), ApiEditPage\execute(), ApiUnblock\execute(), ApiBlock\execute(), ApiDelete\execute(), ApiRollback\execute(), ApiUserrights\execute(), ApiSetPageLanguage\execute(), ApiBase\getParameterFromSettings(), EditPage\internalAttemptSave(), ApiUpload\performUpload(), and SpecialUpload\processUpload().

static ChangeTags::canCreateTag (   $tag,
User  $user = null 
)
static

Is it OK to allow the user to create this tag?

Parameters
string$tagTag that you are interested in creating
User | null$userUser whose permission you wish to check, or null if you don't care (e.g. maintenance scripts)
Returns
Status
Since
1.25

Definition at line 936 of file ChangeTags.php.

References $tag, $title, $user, Title\makeTitleSafe(), StatusValue\newFatal(), StatusValue\newGood(), NS_MEDIAWIKI, and Hooks\run().

static ChangeTags::canDeactivateTag (   $tag,
User  $user = null 
)
static

Is it OK to allow the user to deactivate this tag?

Parameters
string$tagTag that you are interested in deactivating
User | null$userUser whose permission you wish to check, or null if you don't care (e.g. maintenance scripts)
Returns
Status
Since
1.25

Definition at line 873 of file ChangeTags.php.

References $tag, $user, StatusValue\newFatal(), and StatusValue\newGood().

Referenced by SpecialTags\doTagRow().

static ChangeTags::canDeleteTag (   $tag,
User  $user = null 
)
static

Is it OK to allow the user to delete this tag?

Parameters
string$tagTag that you are interested in deleting
User | null$userUser whose permission you wish to check, or null if you don't care (e.g. maintenance scripts)
Returns
Status
Since
1.25

Definition at line 1071 of file ChangeTags.php.

References $status, $tag, $user, StatusValue\newFatal(), StatusValue\newGood(), and Hooks\run().

Referenced by SpecialTags\doTagRow(), and SpecialTags\showDeleteTagForm().

static ChangeTags::canUpdateTags ( array  $tagsToAdd,
array  $tagsToRemove,
User  $user = null 
)
static

Is it OK to allow the user to adds and remove the given tags tags to/from a change?

Parameters
array$tagsToAddTags that you are interested in adding
array$tagsToRemoveTags that you are interested in removing
User | null$userUser whose permission you wish to check, or null if you don't care (e.g. maintenance scripts)
Returns
Status
Since
1.25

Definition at line 466 of file ChangeTags.php.

References $user, StatusValue\newFatal(), and StatusValue\newGood().

static ChangeTags::createTagWithChecks (   $tag,
  $reason,
User  $user,
  $ignoreWarnings = false,
array  $logEntryTags = [] 
)
static

Creates a tag by adding a row to the valid_tag table.

Includes a call to ChangeTag::canDeleteTag(), so your code doesn't need to do that.

Parameters
string$tag
string$reason
User$userWho to give credit for the action
bool$ignoreWarningsCan be used for API interaction, default false
array$logEntryTagsChange tags to apply to the entry that will be created in the tag management log
Returns
Status If successful, the Status contains the ID of the added log entry as its value
Since
1.25

Definition at line 990 of file ChangeTags.php.

References $tag, and StatusValue\newGood().

Referenced by SpecialTags\processCreateTagForm().

static ChangeTags::deactivateTagWithChecks (   $tag,
  $reason,
User  $user,
  $ignoreWarnings = false,
array  $logEntryTags = [] 
)
static

Deactivates a tag, checking whether it is allowed first, and adding a log entry afterwards.

Includes a call to ChangeTag::canDeactivateTag(), so your code doesn't need to do that.

Parameters
string$tag
string$reason
User$userWho to give credit for the action
bool$ignoreWarningsCan be used for API interaction, default false
array$logEntryTagsChange tags to apply to the entry that will be created in the tag management log
Returns
Status If successful, the Status contains the ID of the added log entry as its value
Since
1.25

Definition at line 907 of file ChangeTags.php.

References $tag, and StatusValue\newGood().

static ChangeTags::defineTag (   $tag)
static

Defines a tag in the valid_tag table, without checking that the tag name is valid.

Extensions should NOT use this function; they can use the ListDefinedTags hook instead.

Parameters
string$tagTag to create
Since
1.25

Definition at line 726 of file ChangeTags.php.

References $tag, DB_MASTER, and wfGetDB().

static ChangeTags::deleteTagEverywhere (   $tag)
static

Permanently removes all traces of a tag from the DB.

Good for removing misspelt or temporary tags.

This function should be directly called by maintenance scripts only, never by user-facing code. See deleteTagWithChecks() for functionality that can safely be exposed to users.

Parameters
string$tagTag to remove
Returns
Status The returned status will be good unless a hook changed it
Since
1.25

Definition at line 1022 of file ChangeTags.php.

References $status, $tag, as, DB_MASTER, StatusValue\newGood(), Hooks\run(), wfDebug(), and wfGetDB().

static ChangeTags::deleteTagWithChecks (   $tag,
  $reason,
User  $user,
  $ignoreWarnings = false,
array  $logEntryTags = [] 
)
static

Deletes a tag, checking whether it is allowed first, and adding a log entry afterwards.

Includes a call to ChangeTag::canDeleteTag(), so your code doesn't need to do that.

Parameters
string$tag
string$reason
User$userWho to give credit for the action
bool$ignoreWarningsCan be used for API interaction, default false
array$logEntryTagsChange tags to apply to the entry that will be created in the tag management log
Returns
Status If successful, the Status contains the ID of the added log entry as its value
Since
1.25

Definition at line 1121 of file ChangeTags.php.

References $tag.

static ChangeTags::formatSummaryRow (   $tags,
  $page,
IContextSource  $context = null 
)
static

Creates HTML for the given tags.

Parameters
string$tagsComma-separated list of tags
string$pageA label for the type of action which is being displayed, for example: 'history', 'contributions' or 'newpages'
IContextSource | null$context
Note
Even though it takes null as a valid argument, an IContextSource is preferred in a new code, as the null value is subject to change in the future
Returns
array Array with two items: (html, classes)
  • html: String: HTML for displaying the tags (empty string when param $tags is empty)
  • classes: Array of strings: CSS classes used in the generated html, one class for each tag

Definition at line 52 of file ChangeTags.php.

References $context, $tag, as, Sanitizer\escapeClass(), ContextSource\getLanguage(), RequestContext\getMain(), ContextSource\msg(), and Xml\tags().

Referenced by SpecialUndelete\diffHeader(), SpecialUndelete\formatRevisionRow(), SpecialNewpages\formatRow(), ContribsPager\formatRow(), ChangeTagsRevisionItem\getHTML(), ChangeTagsLogItem\getHTML(), RevDelRevisionItem\getHTML(), HistoryPager\historyLine(), ChangesList\insertTags(), LogEventsList\logLine(), and DifferenceEngine\showDiffPage().

static ChangeTags::listDefinedTags ( )
static

Basically lists defined tags which count even if they aren't applied to anything.

It returns a union of the results of listExplicitlyDefinedTags() and listExtensionDefinedTags().

Returns
string[] Array of strings: tags

Definition at line 1196 of file ChangeTags.php.

Referenced by ApiFeedContributions\getAllowedParams().

static ChangeTags::listExplicitlyDefinedTags ( )
static

Lists tags explicitly defined in the valid_tag table of the database.

Tags in table 'change_tag' which are not in table 'valid_tag' are not included.

Tries memcached first.

Returns
string[] Array of strings: tags
Since
1.25

Definition at line 1212 of file ChangeTags.php.

References $dbr, $fname, array(), DB_REPLICA, ObjectCache\getMainWANInstance(), IExpiringStore\TTL_MINUTE, IExpiringStore\TTL_PROC_LONG, use, wfGetDB(), and wfMemcKey().

Referenced by ApiQueryTags\execute(), ApiHelp\getHelpInternal(), ApiParamInfo\getModuleInfo(), SpecialEditTags\getTagSelect(), and SpecialTags\showTagList().

static ChangeTags::listExtensionActivatedTags ( )
static
See also
listSoftwareActivatedTags
Deprecated:
since 1.28 call listSoftwareActivatedTags directly
Returns
array

Definition at line 1184 of file ChangeTags.php.

References wfDeprecated().

static ChangeTags::listExtensionDefinedTags ( )
static

Call listSoftwareDefinedTags directly.

See also
listSoftwareDefinedTags
Deprecated:
since 1.28

Definition at line 1273 of file ChangeTags.php.

References wfDeprecated().

static ChangeTags::listSoftwareActivatedTags ( )
static

Lists those tags which core or extensions report as being "active".

Returns
array
Since
1.25

Definition at line 1155 of file ChangeTags.php.

References array(), DB_REPLICA, ObjectCache\getMainWANInstance(), Hooks\isRegistered(), Hooks\run(), IExpiringStore\TTL_MINUTE, IExpiringStore\TTL_PROC_LONG, use, wfGetDB(), and wfMemcKey().

Referenced by ApiQueryTags\execute(), SpecialTags\showDeleteTagForm(), and SpecialTags\showTagList().

static ChangeTags::listSoftwareDefinedTags ( )
static

Lists tags defined by core or extensions using the ListDefinedTags hook.

Extensions need only define those tags they deem to be in active use.

Tries memcached first.

Returns
string[] Array of strings: tags
Since
1.25

Definition at line 1244 of file ChangeTags.php.

References array(), DB_REPLICA, ObjectCache\getMainWANInstance(), Hooks\isRegistered(), Hooks\run(), IExpiringStore\TTL_MINUTE, IExpiringStore\TTL_PROC_LONG, use, wfGetDB(), and wfMemcKey().

Referenced by ApiQueryTags\execute(), and SpecialTags\showTagList().

static ChangeTags::logTagManagementAction (   $action,
  $tag,
  $reason,
User  $user,
  $tagCount = null,
array  $logEntryTags = [] 
)
staticprotected

Writes a tag action into the tag management log.

Parameters
string$action
string$tag
string$reason
User$userWho to attribute the action to
int$tagCountFor deletion only, how many usages the tag had before it was deleted.
array$logEntryTagsChange tags to apply to the entry that will be created in the tag management log
Returns
int ID of the inserted log entry
Since
1.25

Definition at line 767 of file ChangeTags.php.

References $params, $tag, DB_MASTER, Title\newFromText(), and wfGetDB().

static ChangeTags::modifyDisplayQuery ( $tables,
$fields,
$conds,
$join_conds,
$options,
  $filter_tag = false 
)
static

Applies all tags-related changes to a query.

Handles selecting tags, and filtering. Needs $tables to be set up properly, so we can figure out which join conditions to use.

Parameters
string | array$tablesTable names, see Database::select
string | array$fieldsFields used in query, see Database::select
string | array$condsConditions used in query, see Database::select
array$join_condsJoin conditions, see Database::select
array$optionsOptions, see Database::select
bool | string$filter_tagTag to select on
Exceptions
MWExceptionWhen unable to determine appropriate JOIN condition for tagging

Definition at line 632 of file ChangeTags.php.

References $tables, $wgRequest, DB_REPLICA, global, and wfGetDB().

Referenced by SpecialRecentChangesLinked\doMainQuery(), SpecialRecentChanges\doMainQuery(), SpecialWatchlist\doMainQuery(), ChangesListSpecialPage\doMainQuery(), ChangeTagsLogList\doQuery(), ChangeTagsRevisionList\doQuery(), RevDelArchiveList\doQuery(), RevDelRevisionList\doQuery(), NewPagesPager\getQueryInfo(), ContribsPager\getQueryInfo(), LogPager\getQueryInfo(), HistoryPager\getQueryInfo(), and PageArchive\listRevisions().

static ChangeTags::purgeTagCacheAll ( )
static

Invalidates the short-term cache of defined tags used by the list*DefinedTags functions, as well as the tag statistics cache.

Since
1.25

Definition at line 1283 of file ChangeTags.php.

References $cache, ObjectCache\getMainWANInstance(), and wfMemcKey().

static ChangeTags::purgeTagUsageCache ( )
static

Invalidates the tag statistics cache only.

Since
1.25

Definition at line 1297 of file ChangeTags.php.

References $cache, ObjectCache\getMainWANInstance(), and wfMemcKey().

static ChangeTags::restrictedTagError (   $msgOne,
  $msgMulti,
  $tags 
)
staticprotected

Helper function to generate a fatal status with a 'not-allowed' type error.

Parameters
string$msgOneMessage key to use in the case of one tag
string$msgMultiMessage key to use in the case of more than one tag
array$tagsRestricted tags (passed as $1 into the message, count of $tags passed as $2)
Returns
Status
Since
1.25

Definition at line 378 of file ChangeTags.php.

References $lang, RequestContext\getMain(), and StatusValue\newFatal().

static ChangeTags::showTagEditingUI ( User  $user)
static

Indicate whether change tag editing UI is relevant.

Returns true if the user has the necessary right and there are any editable tags defined.

This intentionally doesn't check "any addable || any deletable", because it seems like it would be more confusing than useful if the checkboxes suddenly showed up because some abuse filter stopped defining a tag and then suddenly disappeared when someone deleted all uses of that tag.

Parameters
User$user
Returns
bool

Definition at line 1360 of file ChangeTags.php.

References User\isAllowed().

Referenced by LogEventsList\__construct(), HistoryPager\__construct(), and SpecialLog\getActionButtons().

static ChangeTags::tagDescription (   $tag,
IContextSource  $context 
)
static

Get a short description for a tag.

Checks if message key "mediawiki:tag-$tag" exists. If it does not, returns the HTML-escaped tag name. Uses the message if the message exists, provided it is not disabled. If the message is disabled, we consider the tag hidden, and return false.

Parameters
string$tagTag
IContextSource$context
Returns
string|bool Tag description or false if tag is to be hidden.
Since
1.25 Returns false if tag is to be hidden.

Definition at line 107 of file ChangeTags.php.

References $tag, and IContextSource\msg().

Referenced by SpecialTags\doTagRow(), and ApiQueryTags\execute().

static ChangeTags::tagUsageStatistics ( )
static

Returns a map of any tags used on the wiki to number of edits tagged with them, ordered descending by the hitcount.

This does not include tags defined somewhere that have never been applied.

Keeps a short-term cache in memory, so calling this multiple times in the same request should be fine.

Returns
array Array of string => int

Definition at line 1313 of file ChangeTags.php.

References $dbr, $fname, $out, $res, array(), as, DB_REPLICA, ObjectCache\getMainWANInstance(), IExpiringStore\TTL_MINUTE, IExpiringStore\TTL_PROC_LONG, use, wfGetDB(), and wfMemcKey().

Referenced by SpecialTags\showDeleteTagForm(), and SpecialTags\showTagList().

static ChangeTags::undefineTag (   $tag)
static

Removes a tag from the valid_tag table.

The tag may remain in use by extensions, and may still show up as 'defined' if an extension is setting it from the ListDefinedTags hook.

Parameters
string$tagTag to remove
Since
1.25

Definition at line 745 of file ChangeTags.php.

References $tag, DB_MASTER, and wfGetDB().

static ChangeTags::updateTags (   $tagsToAdd,
  $tagsToRemove,
$rc_id = null,
$rev_id = null,
$log_id = null,
  $params = null,
RecentChange  $rc = null,
User  $user = null 
)
static

Add and remove tags to/from a change given its rc_id, rev_id and/or log_id, without verifying that the tags exist or are valid.

If a tag is present in both $tagsToAdd and $tagsToRemove, it will be removed.

This function should only be used by extensions to manipulate tags they have registered using the ListDefinedTags hook. When dealing with user input, call updateTagsWithChecks() instead.

Parameters
string | array | null$tagsToAddTags to add to the change
string | array | null$tagsToRemoveTags to remove from the change
int | null&$rc_idThe rc_id of the change to add the tags to. Pass a variable whose value is null if the rc_id is not relevant or unknown.
int | null&$rev_idThe rev_id of the change to add the tags to. Pass a variable whose value is null if the rev_id is not relevant or unknown.
int | null&$log_idThe log_id of the change to add the tags to. Pass a variable whose value is null if the log_id is not relevant or unknown.
string$paramsParams to put in the ct_params field of table 'change_tag' when adding tags
RecentChange | null$rcRecent change being tagged, in case the tagging accompanies the action
User | null$userTagging user, in case the tagging is subsequent to the tagged action
Exceptions
MWExceptionWhen $rc_id, $rev_id and $log_id are all null
Returns
array Index 0 is an array of tags actually added, index 1 is an array of tags actually removed, index 2 is an array of tags present on the revision or log entry before any changes were made
Since
1.25

Definition at line 173 of file ChangeTags.php.

References $params, $tag, $user, array(), as, DB_MASTER, Hooks\run(), and wfGetDB().

static ChangeTags::updateTagSummaryRow ( $tagsToAdd,
$tagsToRemove,
  $rc_id,
  $rev_id,
  $log_id,
$prevTags = [] 
)
staticprotected

Adds or removes a given set of tags to/from the relevant row of the tag_summary table.

Modifies the tagsToAdd and tagsToRemove arrays to reflect the tags that were actually added and/or removed.

Parameters
array&$tagsToAdd
array&$tagsToRemoveIf a tag is present in both $tagsToAdd and $tagsToRemove, it will be removed
int | null$rc_idNull if not known or not applicable
int | null$rev_idNull if not known or not applicable
int | null$log_idNull if not known or not applicable
array&$prevTagsOptionally outputs a list of the tags that were in the tag_summary row to begin with
Returns
bool True if any modifications were made, otherwise false
Since
1.25

Definition at line 318 of file ChangeTags.php.

References DB_MASTER, and wfGetDB().

static ChangeTags::updateTagsWithChecks (   $tagsToAdd,
  $tagsToRemove,
  $rc_id,
  $rev_id,
  $log_id,
  $params,
  $reason,
User  $user 
)
static

Adds and/or removes tags to/from a given change, checking whether it is allowed first, and adding a log entry afterwards.

Includes a call to ChangeTag::canUpdateTags(), so your code doesn't need to do that. However, it doesn't check whether the *_id parameters are a valid combination. That is up to you to enforce. See ApiTag::execute() for an example.

Parameters
array | null$tagsToAddIf none, pass array() or null
array | null$tagsToRemoveIf none, pass array() or null
int | null$rc_idThe rc_id of the change to add the tags to
int | null$rev_idThe rev_id of the change to add the tags to
int | null$log_idThe log_id of the change to add the tags to
string$paramsParams to put in the ct_params field of table 'change_tag' when adding tags
string$reasonComment for the log
User$userWho to give credit for the action
Returns
Status If successful, the value of this Status object will be an object (stdClass) with the following fields:
  • logId: the ID of the added log entry, or null if no log entry was added (i.e. no operation was performed)
  • addedTags: an array containing the tags that were actually added
  • removedTags: an array containing the tags that were actually removed
Since
1.25

Definition at line 529 of file ChangeTags.php.

References $params, $rev, DB_MASTER, SpecialPage\getTitleFor(), list, StatusValue\newFatal(), Revision\newFromId(), StatusValue\newGood(), User\pingLimiter(), RevDelLogList\suggestTarget(), and wfGetDB().

Referenced by ApiTag\processIndividual(), ChangeTagsLogList\updateChangeTagsOnAll(), and ChangeTagsRevisionList\updateChangeTagsOnAll().

Member Data Documentation

string [] ChangeTags::$coreTags = [ 'mw-contentmodelchange' ]
staticprivate

Definition at line 37 of file ChangeTags.php.

const ChangeTags::MAX_DELETE_USES = 5000

Can't delete tags with more than this many uses.

Similar in intent to the bigdelete user right

Todo:
Use the job queue for tag deletion to avoid this restriction

Definition at line 32 of file ChangeTags.php.


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