Represents a filter (used on ChangesListSpecialPage and descendants) More...

Inheritance diagram for ChangesListFilter:

[legend]

Collaboration diagram for ChangesListFilter:

Public Member Functions
	__construct (array $filterDefinition)
	Creates a new filter with the specified configuration, and registers it to the specified group.

	activelyInConflictWithFilter (ChangesListFilter $filter, FormOptions $opts)
	Check if the conflict with a filter is currently "active".

	activelyInConflictWithGroup (ChangesListFilterGroup $group, FormOptions $opts)
	Check if the conflict with a group is currently "active".

	applyCssClassIfNeeded (IContextSource $ctx, RecentChange $rc, array &$classes)
	Add CSS class if needed.

	conflictsWith ( $other, $globalKey, $forwardKey, $backwardKey)
	Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object.

	displaysOnStructuredUi ()
	Checks whether the filter should display on the structured UI This refers to the exact filter.

	displaysOnUnstructuredUi ()
	Checks whether the filter should display on the unstructured UI.

	getConflictingFilters ()
	Get filters conflicting with this filter.

	getConflictingGroups ()
	Get groups conflicting with this filter.

	getDescription ()

	getGroup ()

	getJsData ()
	Gets the JS data required by the front-end of the structured UI.

	getLabel ()

	getName ()

	getPriority ()

	isFeatureAvailableOnStructuredUi ()
	Checks whether an equivalent feature for this filter is available on the structured UI.

	isSelected (FormOptions $opts)
	Checks whether this filter is selected in the provided options.

	setAsSupersetOf (ChangesListFilter $other)
	Marks that the current instance is (also) a superset of the filter passed in.

	setDefaultHighlightColor ( $defaultHighlightColor)

	setUnidirectionalConflict ( $other, $globalDescription, $contextDescription)
	Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object.

Protected Member Functions
	getCssClass ()
	Gets the CSS class.

	getSiblings ()
	Get filters in the same group.

Protected Attributes
array	$conflictingFilters = []
	Array of associative arrays with conflict information.

array	$conflictingGroups = []
	Array of associative arrays with conflict information.

string null	$cssClassSuffix
	CSS class suffix used for attribution, e.g.

string	$defaultHighlightColor

string	$description
	i18n key of description for structured UI

ChangesListFilterGroup	$group
	Group.

callable	$isRowApplicableCallable
	Callable that returns true if and only if a row is attributed to this filter.

string	$label
	i18n key of label for structured UI

string	$name
	Filter name.

int	$priority
	Priority integer.

array	$subsetFilters = []
	Array of associative arrays with subset information.

Private Member Functions
	hasConflictWithFilter (ChangesListFilter $filter)

	hasConflictWithGroup (ChangesListFilterGroup $group)

Private Attributes
const	RESERVED_NAME_CHAR = '_'

Detailed Description

Represents a filter (used on ChangesListSpecialPage and descendants)

Since: 1.29

Definition at line 29 of file ChangesListFilter.php.

Constructor & Destructor Documentation

◆ __construct()

ChangesListFilter::__construct ( array $filterDefinition )

Creates a new filter with the specified configuration, and registers it to the specified group.

It infers which UI (it can be either or both) to display the filter on based on which messages are provided.

If 'label' is provided, it will be displayed on the structured UI. Thus, 'label', 'description', and sub-class parameters are optional depending on which UI it's for.

Parameters

array

$filterDefinition

ChangesListFilter definition

$filterDefinition['name'] string Name of filter; use lowercase with no punctuation
$filterDefinition['cssClassSuffix'] string CSS class suffix, used to mark that a particular row belongs to this filter (when a row is included by the filter) (optional)
$filterDefinition['isRowApplicableCallable'] Callable taking two parameters, the IContextSource, and the RecentChange object for the row, and returning true if the row is attributed to this filter. The above CSS class will then be automatically added (optional, required if cssClassSuffix is used).
$filterDefinition['group'] ChangesListFilterGroup Group. Filter group this belongs to.
$filterDefinition['label'] string i18n key of label for structured UI.
$filterDefinition['description'] string i18n key of description for structured UI.
$filterDefinition['priority'] int Priority integer. Higher value means higher up in the group's filter list.

-param array{name:string,cssClassSuffix?:string,isRowApplicableCallable?:callable,group:ChangesListFilterGroup,label:string,description:string,priority:int} $filterDefinition

Definition at line 144 of file ChangesListFilter.php.

Member Function Documentation

◆ activelyInConflictWithFilter()

ChangesListFilter::activelyInConflictWithFilter	(	ChangesListFilter	$filter,
		FormOptions	$opts
	)

Check if the conflict with a filter is currently "active".

Parameters

ChangesListFilter	$filter
FormOptions	$opts

Returns: bool

Definition at line 470 of file ChangesListFilter.php.

References getSiblings(), and isSelected().

◆ activelyInConflictWithGroup()

ChangesListFilter::activelyInConflictWithGroup	(	ChangesListFilterGroup	$group,
		FormOptions	$opts
	)

Check if the conflict with a group is currently "active".

Parameters

ChangesListFilterGroup	$group
FormOptions	$opts

Returns: bool

Definition at line 446 of file ChangesListFilter.php.

References $group, ChangesListFilterGroup\anySelected(), and getSiblings().

◆ applyCssClassIfNeeded()

ChangesListFilter::applyCssClassIfNeeded	(	IContextSource	$ctx,
		RecentChange	$rc,
		array &	$classes
	)

Add CSS class if needed.

Parameters

IContextSource	$ctx	Context source
RecentChange	$rc	Recent changes object
array	&$classes	Non-associative array of CSS class names; appended to if needed

Definition at line 350 of file ChangesListFilter.php.

References getCssClass().

◆ conflictsWith()

ChangesListFilter::conflictsWith	(	$other,
		$globalKey,
		$forwardKey,
		$backwardKey
	)

Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object.

WARNING: This means there is a conflict when both things are shown (not filtered out), even for the hide-based filters. So e.g. conflicting with 'hideanons' means there is a conflict if only anonymous users are shown.

Parameters

ChangesListFilterGroup \| ChangesListFilter	$other
string	$globalKey	i18n key for top-level conflict message
string	$forwardKey	i18n key for conflict message in this direction (when in UI context of $this object)
string	$backwardKey	i18n key for conflict message in reverse direction (when in UI context of $other object)

Definition at line 195 of file ChangesListFilter.php.

References setUnidirectionalConflict().

◆ displaysOnStructuredUi()

ChangesListFilter::displaysOnStructuredUi ( )

Checks whether the filter should display on the structured UI This refers to the exact filter.

See also isFeatureAvailableOnStructuredUi.

Returns: bool Whether to display

Definition at line 308 of file ChangesListFilter.php.

Referenced by isFeatureAvailableOnStructuredUi().

◆ displaysOnUnstructuredUi()

ChangesListFilter::displaysOnUnstructuredUi ( )

abstract

Checks whether the filter should display on the unstructured UI.

Returns: bool Whether to display

Reimplemented in ChangesListBooleanFilter, and ChangesListStringOptionsFilter.

◆ getConflictingFilters()

ChangesListFilter::getConflictingFilters ( )

Get filters conflicting with this filter.

Returns: ChangesListFilter[]

Definition at line 430 of file ChangesListFilter.php.

References $conflictingFilters.

Referenced by ChangesListSpecialPage\areFiltersInConflict(), and hasConflictWithFilter().

◆ getConflictingGroups()

ChangesListFilter::getConflictingGroups ( )

Get groups conflicting with this filter.

Returns: ChangesListFilterGroup[]

Definition at line 416 of file ChangesListFilter.php.

References $conflictingGroups.

Referenced by hasConflictWithGroup().

◆ getCssClass()

ChangesListFilter::getCssClass ( )

protected

Gets the CSS class.

Returns: string|null CSS class, or null if not defined

Definition at line 335 of file ChangesListFilter.php.

References $cssClassSuffix.

Referenced by applyCssClassIfNeeded(), and getJsData().

◆ getDescription()

ChangesListFilter::getDescription ( )

Returns: string i18n key of description for structured UI

Definition at line 291 of file ChangesListFilter.php.

References $description.

Referenced by getJsData().

◆ getGroup()

ChangesListFilter::getGroup ( )

Returns: ChangesListFilterGroup Group this belongs to

Definition at line 277 of file ChangesListFilter.php.

References $group.

Referenced by getSiblings(), ChangesListStringOptionsFilter\isSelected(), and setAsSupersetOf().

◆ getJsData()

ChangesListFilter::getJsData ( )

Gets the JS data required by the front-end of the structured UI.

Returns: array Associative array Data required by the front-end. messageKeys is a special top-level value, with the value being an array of the message keys to send to the client.

Reimplemented in ChangesListBooleanFilter.

Definition at line 367 of file ChangesListFilter.php.

References $defaultHighlightColor, $priority, $subsetFilters, getCssClass(), getDescription(), getLabel(), and getName().

◆ getLabel()

ChangesListFilter::getLabel ( )

Returns: string i18n key of label for structured UI

Definition at line 284 of file ChangesListFilter.php.

References $label.

Referenced by getJsData().

◆ getName()

ChangesListFilter::getName ( )

Returns: string Name, e.g. hideanons

Definition at line 270 of file ChangesListFilter.php.

References $name.

Referenced by getJsData(), ChangesListBooleanFilter\isActive(), ChangesListBooleanFilter\isSelected(), ChangesListStringOptionsFilter\isSelected(), ChangesListBooleanFilterGroup\registerFilter(), ChangesListStringOptionsFilterGroup\registerFilter(), and setAsSupersetOf().

◆ getPriority()

ChangesListFilter::getPriority ( )

Returns: int Priority. Higher value means higher up in the group list

Definition at line 326 of file ChangesListFilter.php.

References $priority.

◆ getSiblings()

ChangesListFilter::getSiblings ( )

protected

Get filters in the same group.

Returns: ChangesListFilter[]

Definition at line 495 of file ChangesListFilter.php.

References getGroup().

Referenced by activelyInConflictWithFilter(), activelyInConflictWithGroup(), and ChangesListBooleanFilter\isSelected().

◆ hasConflictWithFilter()

ChangesListFilter::hasConflictWithFilter ( ChangesListFilter $filter )

private

Definition at line 486 of file ChangesListFilter.php.

References getConflictingFilters().

◆ hasConflictWithGroup()

ChangesListFilter::hasConflictWithGroup ( ChangesListFilterGroup $group )

private

Definition at line 459 of file ChangesListFilter.php.

References $group, and getConflictingGroups().

◆ isFeatureAvailableOnStructuredUi()

ChangesListFilter::isFeatureAvailableOnStructuredUi ( )

Checks whether an equivalent feature for this filter is available on the structured UI.

This can either be the exact filter, or a new filter that replaces it.

Returns: bool

Reimplemented in ChangesListBooleanFilter.

Definition at line 319 of file ChangesListFilter.php.

References displaysOnStructuredUi().

◆ isSelected()

ChangesListFilter::isSelected ( FormOptions $opts )

abstract

Checks whether this filter is selected in the provided options.

Parameters

FormOptions $opts

Returns: bool

Reimplemented in ChangesListBooleanFilter, and ChangesListStringOptionsFilter.

Referenced by activelyInConflictWithFilter(), and ChangesListFilterGroup\anySelected().

◆ setAsSupersetOf()

ChangesListFilter::setAsSupersetOf ( ChangesListFilter $other )

Marks that the current instance is (also) a superset of the filter passed in.

This can be called more than once.

This means that anything in the results for the other filter is also in the results for this one.

Parameters

ChangesListFilter $other The filter the current instance is a superset of

Definition at line 254 of file ChangesListFilter.php.

References getGroup(), and getName().

◆ setDefaultHighlightColor()

ChangesListFilter::setDefaultHighlightColor ( $defaultHighlightColor )

Parameters

string $defaultHighlightColor

Definition at line 507 of file ChangesListFilter.php.

References $defaultHighlightColor.

◆ setUnidirectionalConflict()

ChangesListFilter::setUnidirectionalConflict	(	$other,
		$globalDescription,
		$contextDescription
	)

Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object.

Internal use ONLY.

Parameters

ChangesListFilterGroup \| ChangesListFilter	$other
string	$globalDescription	i18n key for top-level conflict message
string	$contextDescription	i18n key for conflict message in this direction (when in UI context of $this object)

Definition at line 224 of file ChangesListFilter.php.

Referenced by conflictsWith().

Member Data Documentation

◆ $conflictingFilters

array ChangesListFilter::$conflictingFilters = []

protected

Array of associative arrays with conflict information.

See setUnidirectionalConflict

Definition at line 89 of file ChangesListFilter.php.

Referenced by getConflictingFilters().

◆ $conflictingGroups

array ChangesListFilter::$conflictingGroups = []

protected

Array of associative arrays with conflict information.

See setUnidirectionalConflict

Definition at line 81 of file ChangesListFilter.php.

Referenced by getConflictingGroups().

◆ $cssClassSuffix

string null ChangesListFilter::$cssClassSuffix

protected

CSS class suffix used for attribution, e.g.

'bot'.

In this example, if bot actions are included in the result set, this CSS class will then be included in all bot-flagged actions.

Definition at line 45 of file ChangesListFilter.php.

Referenced by getCssClass().

◆ $defaultHighlightColor

string ChangesListFilter::$defaultHighlightColor

protected

Definition at line 108 of file ChangesListFilter.php.

Referenced by getJsData(), and setDefaultHighlightColor().

◆ $description

string ChangesListFilter::$description

protected

i18n key of description for structured UI

Definition at line 73 of file ChangesListFilter.php.

Referenced by getDescription().

◆ $group

ChangesListFilterGroup ChangesListFilter::$group

protected

Group.

ChangesListFilterGroup this belongs to

Definition at line 59 of file ChangesListFilter.php.

Referenced by activelyInConflictWithGroup(), getGroup(), and hasConflictWithGroup().

◆ $isRowApplicableCallable

callable ChangesListFilter::$isRowApplicableCallable

protected

Callable that returns true if and only if a row is attributed to this filter.

Definition at line 52 of file ChangesListFilter.php.

◆ $label

string ChangesListFilter::$label

protected

i18n key of label for structured UI

Definition at line 66 of file ChangesListFilter.php.

Referenced by getLabel().

◆ $name

string ChangesListFilter::$name

protected

Filter name.

Definition at line 35 of file ChangesListFilter.php.

Referenced by getName().

◆ $priority

int ChangesListFilter::$priority

protected

Priority integer.

Higher value means higher up in the group's filter list.

Definition at line 103 of file ChangesListFilter.php.

Referenced by getJsData(), and getPriority().

◆ $subsetFilters

array ChangesListFilter::$subsetFilters = []

protected

Array of associative arrays with subset information.

Definition at line 96 of file ChangesListFilter.php.

Referenced by getJsData().

◆ RESERVED_NAME_CHAR

const ChangesListFilter::RESERVED_NAME_CHAR = '_'

private

Definition at line 110 of file ChangesListFilter.php.

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

includes/changes/ChangesListFilter.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activelyInConflictWithFilter()

◆ activelyInConflictWithGroup()

◆ applyCssClassIfNeeded()

◆ conflictsWith()

◆ displaysOnStructuredUi()

◆ displaysOnUnstructuredUi()

◆ getConflictingFilters()

◆ getConflictingGroups()

◆ getCssClass()

◆ getDescription()

◆ getGroup()

◆ getJsData()

◆ getLabel()

◆ getName()

◆ getPriority()

◆ getSiblings()

◆ hasConflictWithFilter()

◆ hasConflictWithGroup()

◆ isFeatureAvailableOnStructuredUi()

◆ isSelected()

◆ setAsSupersetOf()

◆ setDefaultHighlightColor()

◆ setUnidirectionalConflict()

Member Data Documentation

◆ $conflictingFilters

◆ $conflictingGroups

◆ $cssClassSuffix

◆ $defaultHighlightColor

◆ $description

◆ $group

◆ $isRowApplicableCallable

◆ $label

◆ $name

◆ $priority

◆ $subsetFilters

◆ RESERVED_NAME_CHAR