An individual filter in a ChangesListStringOptionsFilterGroup. More...

Inherits MediaWiki\RecentChanges\ChangesListFilter.

Collaboration diagram for MediaWiki\RecentChanges\ChangesListStringOptionsFilter:

[legend]

Public Member Functions

displaysOnUnstructuredUi ()

Checks whether the filter should display on the unstructured UI.

Returns: bool Whether to display

isActive (FormOptions $opts, $isStructuredUI)

Parameters

FormOptions	$opts	Query parameters merged with defaults
bool	$isStructuredUI	Whether the structured UI is currently enabled

Returns: bool Whether this filter should be considered active

isSelected (FormOptions $opts)

Checks whether this filter is selected in the provided options.

Parameters

FormOptions $opts

Returns: bool

Public Member Functions inherited from MediaWiki\RecentChanges\ChangesListFilter

__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, string $globalKey, string $forwardKey, string $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.

getAction ()

Get the action to apply to the ChangesListQuery for filtering.

getConflictingFilters ()

Get filters conflicting with this filter.

getConflictingGroups ()

Get groups conflicting with this filter.

getCssClass ()

Gets the CSS class.

getDescription ()

getGroup ()

getHighlightAction ()

Get the action to apply to the ChangesListQuery for highlighting.

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.

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.

Additional Inherited Members
Protected Member Functions inherited from MediaWiki\RecentChanges\ChangesListFilter
	getSiblings ()
	Get filters in the same group.

Protected Attributes inherited from MediaWiki\RecentChanges\ChangesListFilter
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 null	$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.