MediaWiki
master
|
Static Public Member Functions | |
static | activateTagWithChecks (string $tag, string $reason, Authority $performer, bool $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, Authority $performer) |
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, Authority $performer=null) |
Is it OK to allow the user to activate this tag? More... | |
static | canAddTagsAccompanyingChange (array $tags, Authority $performer=null, $checkBlock=true) |
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, Authority $performer=null) |
Is it OK to allow the user to create this tag? More... | |
static | canDeactivateTag ( $tag, Authority $performer=null) |
Is it OK to allow the user to deactivate this tag? More... | |
static | canDeleteTag ( $tag, Authority $performer=null, int $flags=0) |
Is it OK to allow the user to delete this tag? More... | |
static | canUpdateTags (array $tagsToAdd, array $tagsToRemove, Authority $performer=null) |
Is it OK to allow the user to adds and remove the given tags to/from a change? More... | |
static | createTagWithChecks (string $tag, string $reason, Authority $performer, bool $ignoreWarnings=false, array $logEntryTags=[]) |
Creates a tag by adding it to change_tag_def table. More... | |
static | deactivateTagWithChecks (string $tag, string $reason, Authority $performer, bool $ignoreWarnings=false, array $logEntryTags=[]) |
Deactivates a tag, checking whether it is allowed first, and adding a log entry afterwards. More... | |
static | defineTag ( $tag) |
Set ctd_user_defined = 1 in change_tag_def 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 (string $tag, string $reason, Authority $performer, bool $ignoreWarnings=false, array $logEntryTags=[]) |
Deletes a tag, checking whether it is allowed first, and adding a log entry afterwards. More... | |
static | formatSummaryRow ( $tags, $unused, MessageLocalizer $localizer=null) |
Creates HTML for the given tags. More... | |
static | getChangeTagList (MessageLocalizer $localizer, Language $lang) |
Get information about change tags for tag filter dropdown menus. More... | |
static | getChangeTagListSummary (MessageLocalizer $localizer, Language $lang) |
Get information about change tags, without parsing messages, for tag filter dropdown menus. More... | |
static | getDisplayTableName () |
Get the name of the change_tag table to use for modifyDisplayQuery(). More... | |
static | getSoftwareTags ( $all=false) |
Loads defined core tags, checks for invalid types (if not array), and filters for supported and enabled (if $all is false) tags only. More... | |
static | getTags (IReadableDatabase $db, $rc_id=null, $rev_id=null, $log_id=null) |
Return all the tags associated with the given recent change ID, revision ID, and/or log entry ID. More... | |
static | getTagsWithData (IReadableDatabase $db, $rc_id=null, $rev_id=null, $log_id=null) |
Return all the tags associated with the given recent change ID, revision ID, and/or log entry ID, along with any data stored with the tag. More... | |
static | isTagNameValid ( $tag) |
Is the tag name valid? 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 change_tag_def table of the database. 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 | makeTagSummarySubquery ( $tables) |
Make the tag summary subquery based on the given tables and return it. More... | |
static | modifyDisplayQuery (&$tables, &$fields, &$conds, &$join_conds, &$options, $filter_tag='', bool $exclude=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 | showTagEditingUI (Authority $performer) |
Indicate whether change tag editing UI is relevant. More... | |
static | tagDescription ( $tag, MessageLocalizer $context) |
Get a short description for a tag. More... | |
static | tagLongDescriptionMessage ( $tag, MessageLocalizer $context) |
Get the message object for the tag's long description. More... | |
static | tagShortDescriptionMessage ( $tag, MessageLocalizer $context) |
Get the message object for the tag's short description. 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) |
Update ctd_user_defined = 0 field in change_tag_def. More... | |
static | updateTags ( $tagsToAdd, $tagsToRemove, &$rc_id=null, &$rev_id=null, &$log_id=null, $params=null, RecentChange $rc=null, UserIdentity $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, string $reason, Authority $performer) |
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 | BYPASS_MAX_USAGE_CHECK = 1 |
Flag for canDeleteTag(). More... | |
const | DISPLAY_TABLE_ALIAS = 'changetagdisplay' |
const | REVERT_TAGS = [ self::TAG_ROLLBACK, self::TAG_UNDO, self::TAG_MANUAL_REVERT ] |
List of tags which denote a revert of some sort. More... | |
const | TAG_BLANK = 'mw-blank' |
The tagged edit blanks the page (replaces it with the empty string). More... | |
const | TAG_CHANGED_REDIRECT_TARGET = 'mw-changed-redirect-target' |
The tagged edit changes the target of a redirect page. More... | |
const | TAG_CONTENT_MODEL_CHANGE = 'mw-contentmodelchange' |
The tagged edit changes the content model of the page. More... | |
const | TAG_MANUAL_REVERT = 'mw-manual-revert' |
The tagged edit restores the page to an earlier revision. More... | |
const | TAG_NEW_REDIRECT = 'mw-new-redirect' |
The tagged edit creates a new redirect (either by creating a new page or turning an existing page into a redirect). More... | |
const | TAG_REMOVED_REDIRECT = 'mw-removed-redirect' |
The tagged edit turns a redirect page into a non-redirect. More... | |
const | TAG_REPLACE = 'mw-replace' |
The tagged edit removes more than 90% of the content of the page. More... | |
const | TAG_REVERTED = 'mw-reverted' |
The tagged edit is reverted by a subsequent edit (which is tagged by one of TAG_ROLLBACK, TAG_UNDO, TAG_MANUAL_REVERT). More... | |
const | TAG_ROLLBACK = 'mw-rollback' |
The tagged edit is a rollback (undoes the previous edit and all immediately preceding edits by the same user, and was performed via the "rollback" link available to advanced users or via the rollback API). More... | |
const | TAG_SERVER_SIDE_UPLOAD = 'mw-server-side-upload' |
This tagged edit was performed while importing media files using the importImages.php maintenance script. More... | |
const | TAG_UNDO = 'mw-undo' |
The tagged edit is was performed via the "undo" link. More... | |
Static Public Attributes | |
static bool | $avoidReopeningTablesForTesting = false |
If true, this class attempts to avoid reopening database tables within the same query, to avoid the "Can't reopen table" error when operating on temporary tables while running tests. More... | |
Static Protected Member Functions | |
static | restrictedTagError ( $msgOne, $msgMulti, $tags) |
Helper function to generate a fatal status with a 'not-allowed' type error. More... | |
Definition at line 36 of file ChangeTags.php.
|
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.
string | $tag | |
string | $reason | |
Authority | $performer | who to check permissions and give credit for the action |
bool | $ignoreWarnings | Can be used for API interaction, default false |
array | $logEntryTags | Change tags to apply to the entry that will be created in the tag management log |
Definition at line 1126 of file ChangeTags.php.
References canActivateTag(), MediaWiki\Permissions\Authority\getUser(), and StatusValue\newGood().
Referenced by ApiManageTags\execute().
|
static |
Add tags to a change given its rc_id, rev_id and/or log_id.
string | string[] | $tags | Tags to add to the change |
int | null | $rc_id | The rc_id of the change to add the tags to |
int | null | $rev_id | The rev_id of the change to add the tags to |
int | null | $log_id | The log_id of the change to add the tags to |
string | null | $params | Params to put in the ct_params field of table 'change_tag' |
RecentChange | null | $rc | Recent change, in case the tagging accompanies the action (this should normally be the case) |
Definition at line 296 of file ChangeTags.php.
References updateTags().
Referenced by addTagsAccompanyingChangeWithChecks(), ImportableOldRevisionImporter\import(), MediaWiki\Storage\RevertedTagUpdate\markAsReverted(), ApiTag\processIndividual(), ManualLogEntry\publish(), and RecentChange\save().
|
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.
string[] | $tags | Tags to apply |
int | null | $rc_id | The rc_id of the change to add the tags to |
int | null | $rev_id | The rev_id of the change to add the tags to |
int | null | $log_id | The log_id of the change to add the tags to |
string | $params | Params to put in the ct_params field of table 'change_tag' when adding tags |
Authority | $performer | Who to give credit for the action |
Definition at line 632 of file ChangeTags.php.
References addTags(), canAddTagsAccompanyingChange(), and StatusValue\newGood().
|
static |
Build a text box to select a change tag.
string | $selected | Tag to select by default |
bool | $ooui | Use an OOUI TextInputWidget as selector instead of a non-OOUI input field You need to call OutputPage::enableOOUI() yourself. |
IContextSource | null | $context |
Definition at line 987 of file ChangeTags.php.
References getChangeTagList(), RequestContext\getMain(), Xml\input(), and Xml\listDropDownOptionsOoui().
Referenced by HTMLTagFilter\getDiv(), SpecialRecentChanges\getExtraOptions(), HTMLTagFilter\getOOUI(), and HTMLTagFilter\getTableRow().
|
static |
Is it OK to allow the user to activate this tag?
string | $tag | Tag that you are interested in activating |
Authority | null | $performer | whose permission you wish to check, or null if you don't care (e.g. maintenance scripts) |
Definition at line 1079 of file ChangeTags.php.
References listDefinedTags(), StatusValue\newFatal(), StatusValue\newGood(), and tagUsageStatistics().
Referenced by activateTagWithChecks(), and SpecialTags\showActivateDeactivateForm().
|
static |
Is it OK to allow the user to apply all the specified tags at the same time as they edit/make the change?
Extensions should not use this function, unless directly handling a user request to add a tag to a revision or log entry that the user is making.
string[] | $tags | Tags that you are interested in applying |
Authority | null | $performer | whose permission you wish to check, or null to check for a generic non-blocked user with the relevant rights |
bool | $checkBlock | Whether to check the blocked status of $performer |
Definition at line 577 of file ChangeTags.php.
References listExplicitlyDefinedTags(), StatusValue\newFatal(), StatusValue\newGood(), and restrictedTagError().
Referenced by addTagsAccompanyingChangeWithChecks(), ApiEditPage\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiManageTags\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetPageLanguage\execute(), ApiTag\execute(), ApiUserrights\execute(), MediaWiki\Page\MovePage\moveIfAllowed(), ApiUpload\performUpload(), SpecialUpload\processUpload(), ContentModelChange\setTags(), and Wikimedia\ParamValidator\ParamValidator\TypeDef\TagsDef\validate().
|
static |
Is it OK to allow the user to create this tag?
Extensions should NOT use this function. In most cases, a tag can be defined using the ListDefinedTags hook without any checking.
string | $tag | Tag that you are interested in creating |
Authority | null | $performer | whose permission you wish to check, or null if you don't care (e.g. maintenance scripts) |
Definition at line 1254 of file ChangeTags.php.
References isTagNameValid(), StatusValue\newFatal(), StatusValue\newGood(), and tagUsageStatistics().
Referenced by createTagWithChecks().
|
static |
Is it OK to allow the user to deactivate this tag?
string | $tag | Tag that you are interested in deactivating |
Authority | null | $performer | whose permission you wish to check, or null if you don't care (e.g. maintenance scripts) |
Definition at line 1154 of file ChangeTags.php.
References StatusValue\newFatal(), and StatusValue\newGood().
Referenced by deactivateTagWithChecks(), and SpecialTags\showActivateDeactivateForm().
|
static |
Is it OK to allow the user to delete this tag?
string | $tag | Tag that you are interested in deleting |
Authority | null | $performer | whose permission you wish to check, or null if you don't care (e.g. maintenance scripts) |
int | $flags | Use ChangeTags::BYPASS_MAX_USAGE_CHECK to ignore whether there are more uses than we would normally allow to be deleted through the user interface. |
Definition at line 1357 of file ChangeTags.php.
References listSoftwareDefinedTags(), StatusValue\newFatal(), StatusValue\newGood(), and tagUsageStatistics().
Referenced by deleteTagWithChecks(), DeleteTag\execute(), and SpecialTags\showDeleteTagForm().
|
static |
Is it OK to allow the user to adds and remove the given tags to/from a change?
Extensions should not use this function, unless directly handling a user request to add or remove tags from an existing revision or log entry.
string[] | $tagsToAdd | Tags that you are interested in adding |
string[] | $tagsToRemove | Tags that you are interested in removing |
Authority | null | $performer | whose permission you wish to check, or null to check for a generic non-blocked user with the relevant rights |
Definition at line 662 of file ChangeTags.php.
References listExplicitlyDefinedTags(), listSoftwareDefinedTags(), StatusValue\newFatal(), StatusValue\newGood(), and restrictedTagError().
Referenced by updateTagsWithChecks().
|
static |
Creates a tag by adding it to change_tag_def
table.
Extensions should NOT use this function; they can use the ListDefinedTags hook instead.
Includes a call to ChangeTag::canCreateTag(), so your code doesn't need to do that.
string | $tag | |
string | $reason | |
Authority | $performer | who to check permissions and give credit for the action |
bool | $ignoreWarnings | Can be used for API interaction, default false |
array | $logEntryTags | Change tags to apply to the entry that will be created in the tag management log |
Definition at line 1307 of file ChangeTags.php.
References canCreateTag(), defineTag(), MediaWiki\Permissions\Authority\getUser(), and StatusValue\newGood().
Referenced by ApiManageTags\execute(), AddChangeTag\execute(), and SpecialTags\processCreateTagForm().
|
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.
string | $tag | |
string | $reason | |
Authority | $performer | who to check permissions and give credit for the action |
bool | $ignoreWarnings | Can be used for API interaction, default false |
array | $logEntryTags | Change tags to apply to the entry that will be created in the tag management log |
Definition at line 1192 of file ChangeTags.php.
References canDeactivateTag(), MediaWiki\Permissions\Authority\getUser(), and StatusValue\newGood().
Referenced by ApiManageTags\execute().
|
static |
Set ctd_user_defined = 1 in change_tag_def without checking that the tag name is valid.
Extensions should NOT use this function; they can use the ListDefinedTags hook instead.
string | $tag | Tag to create |
Definition at line 1053 of file ChangeTags.php.
Referenced by createTagWithChecks().
|
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.
string | $tag | Tag to remove |
Definition at line 1341 of file ChangeTags.php.
Referenced by deleteTagWithChecks(), and DeleteTag\execute().
|
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.
string | $tag | |
string | $reason | |
Authority | $performer | who to check permissions and give credit for the action |
bool | $ignoreWarnings | Can be used for API interaction, default false |
array | $logEntryTags | Change tags to apply to the entry that will be created in the tag management log |
Definition at line 1417 of file ChangeTags.php.
References canDeleteTag(), deleteTagEverywhere(), MediaWiki\Permissions\Authority\getUser(), and tagUsageStatistics().
Referenced by ApiManageTags\execute().
|
static |
Creates HTML for the given tags.
string | $tags | Comma-separated list of tags |
null | string | $unused | Unused (formerly: $page) |
MessageLocalizer | null | $localizer |
Definition at line 162 of file ChangeTags.php.
References Sanitizer\escapeClass(), RequestContext\getMain(), tagDescription(), and Xml\tags().
Referenced by MediaWiki\Specials\SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), SpecialNewpages\formatRow(), HistoryPager\formatRow(), ContribsPager\formatRow(), ChangeTagsLogItem\getHTML(), ChangeTagsRevisionItem\getHTML(), RevDelLogItem\getHTML(), RevDelRevisionItem\getHTML(), ChangesList\insertTags(), LogEventsList\logLine(), and DifferenceEngine\showDiffPage().
|
static |
Get information about change tags for tag filter dropdown menus.
This manipulates the label and description of each tag, which are parsed, stripped and (in the case of description) truncated versions of these messages. Message parsing is expensive, so to detect whether the tag list has changed, use getChangeTagListSummary() instead.
MessageLocalizer | $localizer | |
Language | $lang |
Definition at line 1617 of file ChangeTags.php.
References $lang, getChangeTagListSummary(), MessageLocalizer\msg(), and Sanitizer\stripAllTags().
Referenced by buildTagFilterSelector(), and ChangesListSpecialPage\getRcFiltersConfigVars().
|
static |
Get information about change tags, without parsing messages, for tag filter dropdown menus.
Message contents are the raw values (->plain()), because parsing messages is expensive. Even though we're not parsing messages, building a data structure with the contents of hundreds of i18n messages is still not cheap (see T223260#5370610), so this function caches its output in WANCache for up to 24 hours.
Returns an array of associative arrays with information about each tag:
This data is consumed by the mediawiki.rcfilters.filters.ui
module, specifically mw.rcfilters.dm.FilterGroup
and mw.rcfilters.dm.FilterItem
.
MessageLocalizer | $localizer | |
Language | $lang |
Definition at line 1571 of file ChangeTags.php.
References $lang, Sanitizer\escapeClass(), tagLongDescriptionMessage(), tagShortDescriptionMessage(), and tagUsageStatistics().
Referenced by getChangeTagList(), and ChangesListSpecialPage\getRcFiltersConfigSummary().
|
static |
Get the name of the change_tag table to use for modifyDisplayQuery().
This also does first-call initialisation of the table in testing mode.
Definition at line 932 of file ChangeTags.php.
References DB_REPLICA, and wfGetDB().
Referenced by modifyDisplayQuery().
|
static |
Loads defined core tags, checks for invalid types (if not array), and filters for supported and enabled (if $all is false) tags only.
bool | $all | If true, return all valid defined tags. Otherwise, return only enabled ones. |
Definition at line 145 of file ChangeTags.php.
Referenced by ImportImages\execute(), ContentHandler\getChangeTag(), listSoftwareActivatedTags(), and RevertedTagUpdateJob\run().
|
static |
Return all the tags associated with the given recent change ID, revision ID, and/or log entry ID.
IReadableDatabase | $db | the database to query |
int | null | $rc_id | |
int | null | $rev_id | |
int | null | $log_id |
Definition at line 539 of file ChangeTags.php.
Referenced by MediaWiki\Storage\RevertedTagUpdate\getChangeTags(), and updateTags().
|
static |
Return all the tags associated with the given recent change ID, revision ID, and/or log entry ID, along with any data stored with the tag.
IReadableDatabase | $db | the database to query |
int | null | $rc_id | |
int | null | $rev_id | |
int | null | $log_id |
Definition at line 523 of file ChangeTags.php.
|
static |
Is the tag name valid?
string | $tag | Tag that you are interested in creating |
Definition at line 1218 of file ChangeTags.php.
References $title, StatusValue\newFatal(), StatusValue\newGood(), and NS_MEDIAWIKI.
Referenced by canCreateTag().
|
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 listSoftwareDefinedTags()
Definition at line 1486 of file ChangeTags.php.
References listExplicitlyDefinedTags(), and listSoftwareDefinedTags().
Referenced by canActivateTag(), and ApiFeedContributions\getAllowedParams().
|
static |
Lists tags explicitly defined in the change_tag_def
table of the database.
Tries memcached first.
Definition at line 1501 of file ChangeTags.php.
Referenced by canAddTagsAccompanyingChange(), canUpdateTags(), ApiQueryTags\execute(), Wikimedia\ParamValidator\ParamValidator\TypeDef\TagsDef\getEnumValues(), MediaWiki\Specials\SpecialEditTags\getTagSelect(), and listDefinedTags().
|
static |
Lists those tags which core or extensions report as being "active".
Definition at line 1452 of file ChangeTags.php.
References DB_REPLICA, getSoftwareTags(), and wfGetDB().
Referenced by ApiQueryTags\execute(), and SpecialTags\showDeleteTagForm().
|
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.
Definition at line 1515 of file ChangeTags.php.
Referenced by canDeleteTag(), canUpdateTags(), ApiQueryTags\execute(), and listDefinedTags().
|
static |
Make the tag summary subquery based on the given tables and return it.
string | array | $tables | Table names, see Database::select |
Definition at line 972 of file ChangeTags.php.
Referenced by ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), modifyDisplayQuery(), ApiQueryRecentChanges\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), and ApiQueryRevisions\run().
|
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.
WARNING: If $filter_tag contains more than one tag and $exclude is false, this function will add DISTINCT, which may cause performance problems for your query unless you put the ID field of your table at the end of the ORDER BY, and set a GROUP BY equal to the ORDER BY. For example, if you had ORDER BY foo_timestamp DESC, you will now need GROUP BY foo_timestamp, foo_id ORDER BY foo_timestamp DESC, foo_id DESC.
string | array | &$tables | Table names, see Database::select |
string | array | &$fields | Fields used in query, see Database::select |
string | array | &$conds | Conditions used in query, see Database::select |
array | &$join_conds | Join conditions, see Database::select |
string | array | &$options | Options, see Database::select |
string | array | false | null | $filter_tag | Tag(s) to select on (OR) |
bool | $exclude | If true, exclude tag(s) from $filter_tag (NOR) |
Definition at line 845 of file ChangeTags.php.
References DISPLAY_TABLE_ALIAS, getDisplayTableName(), and makeTagSummarySubquery().
Referenced by ChangesListSpecialPage\doMainQuery(), SpecialRecentChanges\doMainQuery(), SpecialWatchlist\doMainQuery(), SpecialRecentChangesLinked\doMainQuery(), ChangeTagsLogList\doQuery(), ChangeTagsRevisionList\doQuery(), RevDelArchiveList\doQuery(), RevDelLogList\doQuery(), RevDelRevisionList\doQuery(), HistoryPager\getQueryInfo(), LogPager\getQueryInfo(), ContribsPager\getQueryInfo(), DeletedContribsPager\getQueryInfo(), MergeHistoryPager\getQueryInfo(), NewPagesPager\getQueryInfo(), and MediaWiki\Revision\ArchivedRevisionLookup\listRevisions().
|
static |
Invalidates the short-term cache of defined tags used by the list*DefinedTags functions, as well as the tag statistics cache.
Definition at line 1525 of file ChangeTags.php.
Referenced by DeleteTag\execute().
|
staticprotected |
Helper function to generate a fatal status with a 'not-allowed' type error.
string | $msgOne | Message key to use in the case of one tag |
string | $msgMulti | Message key to use in the case of more than one tag |
string[] | $tags | Restricted tags (passed as $1 into the message, count of $tags passed as $2) |
Definition at line 553 of file ChangeTags.php.
References $lang, RequestContext\getMain(), and StatusValue\newFatal().
Referenced by canAddTagsAccompanyingChange(), and canUpdateTags().
|
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.
Authority | $performer |
Definition at line 1659 of file ChangeTags.php.
References MediaWiki\Permissions\Authority\isAllowed().
Referenced by LogEventsList\__construct(), and HistoryPager\__construct().
|
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.
string | $tag | |
MessageLocalizer | $context |
Definition at line 252 of file ChangeTags.php.
References tagShortDescriptionMessage().
Referenced by ApiQueryTags\execute(), and formatSummaryRow().
|
static |
Get the message object for the tag's long description.
Checks if message key "mediawiki:tag-$tag-description" exists. If it does not, or if message is disabled, returns false. Otherwise, returns the message object for the long description.
string | $tag | |
MessageLocalizer | $context |
Definition at line 269 of file ChangeTags.php.
References MessageLocalizer\msg().
Referenced by getChangeTagListSummary().
|
static |
Get the message object for the tag's short description.
Checks if message key "mediawiki:tag-$tag" exists. If it does not, returns the tag name in a RawMessage. If the message exists, it is used, provided it is not disabled. If the message is disabled, we consider the tag hidden, and return false.
string | $tag | |
MessageLocalizer | $context |
Definition at line 222 of file ChangeTags.php.
References MessageLocalizer\msg(), and Message\plaintextParam().
Referenced by getChangeTagListSummary(), and tagDescription().
|
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.
Definition at line 1537 of file ChangeTags.php.
Referenced by canActivateTag(), canCreateTag(), canDeleteTag(), deleteTagWithChecks(), ApiQueryTags\execute(), getChangeTagListSummary(), and SpecialTags\showDeleteTagForm().
|
static |
Update ctd_user_defined = 0 field in change_tag_def.
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.
string | $tag | Tag to remove |
Definition at line 1066 of file ChangeTags.php.
|
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.
string | array | null | $tagsToAdd | Tags to add to the change |
string | array | null | $tagsToRemove | Tags to remove from the change |
int | null | &$rc_id | The 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_id | The 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_id | The 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 | null | $params | Params to put in the ct_params field of table 'change_tag' when adding tags |
RecentChange | null | $rc | Recent change being tagged, in case the tagging accompanies the action |
UserIdentity | null | $user | Tagging user, in case the tagging is subsequent to the tagged action |
Definition at line 332 of file ChangeTags.php.
References getTags().
Referenced by addTags(), and updateTagsWithChecks().
|
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 ChangeTags::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.
Extensions should generally avoid this function. Call ChangeTags::updateTags() instead, unless directly handling a user request to add or remove tags from an existing revision or log entry.
array | null | $tagsToAdd | If none, pass [] or null |
array | null | $tagsToRemove | If none, pass [] or null |
int | null | $rc_id | The rc_id of the change to add the tags to |
int | null | $rev_id | The rev_id of the change to add the tags to |
int | null | $log_id | The log_id of the change to add the tags to |
string | null | $params | Params to put in the ct_params field of table 'change_tag' when adding tags |
string | $reason | Comment for the log |
Authority | $performer | who to check permissions and give credit for the action |
Definition at line 736 of file ChangeTags.php.
References canUpdateTags(), SpecialPage\getTitleFor(), MediaWiki\Permissions\Authority\getUser(), StatusValue\newFatal(), StatusValue\newGood(), RevDelLogList\suggestTarget(), and updateTags().
Referenced by ApiTag\processIndividual(), ChangeTagsLogList\updateChangeTagsOnAll(), and ChangeTagsRevisionList\updateChangeTagsOnAll().
|
static |
If true, this class attempts to avoid reopening database tables within the same query, to avoid the "Can't reopen table" error when operating on temporary tables while running tests.
Definition at line 135 of file ChangeTags.php.
const ChangeTags::BYPASS_MAX_USAGE_CHECK = 1 |
Flag for canDeleteTag().
Definition at line 104 of file ChangeTags.php.
Referenced by DeleteTag\execute().
const ChangeTags::DISPLAY_TABLE_ALIAS = 'changetagdisplay' |
Definition at line 123 of file ChangeTags.php.
Referenced by SpecialRecentChanges\doMainQuery(), and modifyDisplayQuery().
const ChangeTags::REVERT_TAGS = [ self::TAG_ROLLBACK, self::TAG_UNDO, self::TAG_MANUAL_REVERT ] |
List of tags which denote a revert of some sort.
(See also TAG_REVERTED.)
Definition at line 99 of file ChangeTags.php.
Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getRevertedCount(), and MediaWiki\Rest\Handler\PageHistoryHandler\run().
const ChangeTags::TAG_BLANK = 'mw-blank' |
The tagged edit blanks the page (replaces it with the empty string).
Definition at line 57 of file ChangeTags.php.
const ChangeTags::TAG_CHANGED_REDIRECT_TARGET = 'mw-changed-redirect-target' |
The tagged edit changes the target of a redirect page.
Definition at line 53 of file ChangeTags.php.
const ChangeTags::TAG_CONTENT_MODEL_CHANGE = 'mw-contentmodelchange' |
The tagged edit changes the content model of the page.
Definition at line 40 of file ChangeTags.php.
const ChangeTags::TAG_MANUAL_REVERT = 'mw-manual-revert' |
The tagged edit restores the page to an earlier revision.
The associated tag data is a JSON containing the edit result (see EditResult::jsonSerialize()).
Definition at line 82 of file ChangeTags.php.
const ChangeTags::TAG_NEW_REDIRECT = 'mw-new-redirect' |
The tagged edit creates a new redirect (either by creating a new page or turning an existing page into a redirect).
Definition at line 45 of file ChangeTags.php.
const ChangeTags::TAG_REMOVED_REDIRECT = 'mw-removed-redirect' |
The tagged edit turns a redirect page into a non-redirect.
Definition at line 49 of file ChangeTags.php.
const ChangeTags::TAG_REPLACE = 'mw-replace' |
The tagged edit removes more than 90% of the content of the page.
Definition at line 61 of file ChangeTags.php.
const ChangeTags::TAG_REVERTED = 'mw-reverted' |
The tagged edit is reverted by a subsequent edit (which is tagged by one of TAG_ROLLBACK, TAG_UNDO, TAG_MANUAL_REVERT).
Multiple edits might be reverted by the same edit.
The associated tag data is a JSON containing the edit result (see EditResult::jsonSerialize()) with an extra 'revertId' field containing the revision ID of the reverting edit.
Definition at line 90 of file ChangeTags.php.
Referenced by MediaWiki\Storage\RevertedTagUpdate\markAsReverted().
const ChangeTags::TAG_ROLLBACK = 'mw-rollback' |
The tagged edit is a rollback (undoes the previous edit and all immediately preceding edits by the same user, and was performed via the "rollback" link available to advanced users or via the rollback API).
The associated tag data is a JSON containing the edit result (see EditResult::jsonSerialize()).
Definition at line 69 of file ChangeTags.php.
const ChangeTags::TAG_SERVER_SIDE_UPLOAD = 'mw-server-side-upload' |
This tagged edit was performed while importing media files using the importImages.php maintenance script.
Definition at line 94 of file ChangeTags.php.
Referenced by ImportImages\execute().
const ChangeTags::TAG_UNDO = 'mw-undo' |
The tagged edit is was performed via the "undo" link.
(Usually this means that it undoes some previous edit, but the undo workflow includes an edit step so it could be anything.)
The associated tag data is a JSON containing the edit result (see EditResult::jsonSerialize()).
Definition at line 76 of file ChangeTags.php.