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

Inheritance diagram for ChangesListFilterGroup:

[legend]

Public Member Functions
	__construct (array $groupDefinition)
	Create a new filter group with the specified configuration.

	addOptions (FormOptions $opts, $allowDefaults, $isStructuredFiltersEnabled)
	All the options represented by this filter group to $opts.

	anySelected (FormOptions $opts)
	Check if any filter in this group is selected.

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

	getConflictingFilters ()
	Get filters conflicting with this filter group.

	getConflictingGroups ()
	Get groups conflicting with this filter group.

	getFilter ( $name)
	Get filter by name.

	getFilters ()

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

	getName ()

	getPriority ()

	getTitle ()

	getType ()

	modifyQuery (IDatabase $dbr, ChangesListSpecialPage $specialPage, &$tables, &$fields, &$conds, &$query_options, &$join_conds, FormOptions $opts, $isStructuredFiltersEnabled)
	Modifies the query to include the filter group.

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

Public Attributes
const	DEFAULT_PRIORITY = -100

const	RESERVED_NAME_CHAR = '_'

Protected Member Functions
	createFilter (array $filterDefinition)
	Creates a filter of the appropriate type for this group, from the definition.

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

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

	$filters
	Associative array of filters, as ChangesListFilter objects, with filter name as key.

	$isFullCoverage
	Whether this group is full coverage.

	$name
	Name (internal identifier)

	$priority
	Priority integer.

	$title
	i18n key for title

	$type
	Type, from a TYPE constant of a subclass.

	$whatsThisBody
	i18n key for body of What's This?

	$whatsThisHeader
	i18n key for header of What's This?

	$whatsThisLinkText
	i18n key for What's This? link

	$whatsThisUrl
	URL of What's This? link.

Detailed Description

Represents a filter group (used on ChangesListSpecialPage and descendants)

Since: 1.29

Definition at line 36 of file ChangesListFilterGroup.php.

Constructor & Destructor Documentation

◆ __construct()

ChangesListFilterGroup::__construct ( array $groupDefinition )

Create a new filter group with the specified configuration.

Parameters

array

$groupDefinition

Configuration of group

$groupDefinition['name'] string Group name; use camelCase with no punctuation
$groupDefinition['title'] string i18n key for title (optional, can be omitted only if none of the filters in the group display in the structured UI)
$groupDefinition['type'] string A type constant from a subclass of this one
$groupDefinition['priority'] int Priority integer. Higher value means higher up in the group list (optional, defaults to -100).
$groupDefinition['filters'] array Numeric array of filter definitions, each of which is an associative array to be passed to the filter constructor. However, 'priority' is optional for the filters. Any filter that has priority unset will be put to the bottom, in the order given.
$groupDefinition['isFullCoverage'] bool Whether the group is full coverage; if true, this means that checking every item in the group means no changes list entries are filtered out.
$groupDefinition['whatsThisHeader'] string i18n key for header of "What's This" popup (optional).
$groupDefinition['whatsThisBody'] string i18n key for body of "What's This" popup (optional).
$groupDefinition['whatsThisUrl'] string URL for main link of "What's This" popup (optional).
$groupDefinition['whatsThisLinkText'] string i18n key of text for main link of "What's This" popup (optional).

Reimplemented in ChangesListBooleanFilterGroup, and ChangesListStringOptionsFilterGroup.

Definition at line 155 of file ChangesListFilterGroup.php.

References createFilter(), DEFAULT_PRIORITY, and type.

Member Function Documentation

◆ addOptions()

ChangesListFilterGroup::addOptions	(	FormOptions	$opts,
			$allowDefaults,
			$isStructuredFiltersEnabled )

abstract

All the options represented by this filter group to $opts.

Parameters

FormOptions	$opts
bool	$allowDefaults
bool	$isStructuredFiltersEnabled

Reimplemented in ChangesListBooleanFilterGroup, ChangesListStringOptionsFilterGroup, and MockChangesListFilterGroup.

◆ anySelected()

ChangesListFilterGroup::anySelected ( FormOptions $opts )

Check if any filter in this group is selected.

Parameters

FormOptions $opts

Returns: bool

Definition at line 435 of file ChangesListFilterGroup.php.

References getFilters(), and ChangesListFilter\isSelected().

◆ conflictsWith()

ChangesListFilterGroup::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 232 of file ChangesListFilterGroup.php.

References setUnidirectionalConflict().

◆ createFilter()

ChangesListFilterGroup::createFilter ( array $filterDefinition )

abstractprotected

Creates a filter of the appropriate type for this group, from the definition.

Parameters

array $filterDefinition Filter definition

Returns: ChangesListFilter Filter

Reimplemented in ChangesListBooleanFilterGroup, ChangesListStringOptionsFilterGroup, and MockChangesListFilterGroup.

Referenced by __construct().

◆ getConflictingFilters()

ChangesListFilterGroup::getConflictingFilters ( )

Get filters conflicting with this filter group.

Returns: ChangesListFilter[]

Definition at line 420 of file ChangesListFilterGroup.php.

References $conflictingFilters.

◆ getConflictingGroups()

ChangesListFilterGroup::getConflictingGroups ( )

Get groups conflicting with this filter group.

Returns: ChangesListFilterGroup[]

Definition at line 406 of file ChangesListFilterGroup.php.

References $conflictingGroups.

◆ getFilter()

ChangesListFilterGroup::getFilter ( $name )

Get filter by name.

Parameters

string $name Filter name

Returns: ChangesListFilter|null Specified filter, or null if it is not registered

Definition at line 324 of file ChangesListFilterGroup.php.

References $name.

◆ getFilters()

ChangesListFilterGroup::getFilters ( )

Returns: ChangesListFilter[] Associative array of ChangesListFilter objects, with filter name as key

Definition at line 314 of file ChangesListFilterGroup.php.

References $filters.

Referenced by ChangesListBooleanFilterGroup\addOptions(), anySelected(), and ChangesListBooleanFilterGroup\modifyQuery().

◆ getJsData()

ChangesListFilterGroup::getJsData ( )

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

Returns: array|null Associative array, or null if there are no filters that display in the structured UI. messageKeys is a special top-level value, with the value being an array of the message keys to send to the client.

Reimplemented in ChangesListStringOptionsFilterGroup.

Definition at line 335 of file ChangesListFilterGroup.php.

References $isFullCoverage, $name, $output, $priority, $title, $type, $whatsThisBody, $whatsThisHeader, $whatsThisLinkText, and $whatsThisUrl.

◆ getName()

ChangesListFilterGroup::getName ( )

Returns: string Internal name

Definition at line 285 of file ChangesListFilterGroup.php.

References $name.

Referenced by ChangesListStringOptionsFilterGroup\addOptions(), ChangesListStringOptionsFilterGroup\modifyQuery(), and ChangesListSpecialPage\registerFilterGroup().

◆ getPriority()

ChangesListFilterGroup::getPriority ( )

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

Definition at line 306 of file ChangesListFilterGroup.php.

References $priority.

◆ getTitle()

ChangesListFilterGroup::getTitle ( )

Returns: string i18n key for title

Definition at line 292 of file ChangesListFilterGroup.php.

References $title.

◆ getType()

ChangesListFilterGroup::getType ( )

Returns: string Type (TYPE constant from a subclass)

Definition at line 299 of file ChangesListFilterGroup.php.

References $type.

◆ modifyQuery()

ChangesListFilterGroup::modifyQuery	(	IDatabase	$dbr,
		ChangesListSpecialPage	$specialPage,
		&	$tables,
		&	$fields,
		&	$conds,
		&	$query_options,
		&	$join_conds,
		FormOptions	$opts,
			$isStructuredFiltersEnabled )

abstract

Modifies the query to include the filter group.

The modification is only done if the filter group is in effect. This means that one or more valid and allowed filters were selected.

Parameters

IDatabase	$dbr	Database, for addQuotes, makeList, and similar
ChangesListSpecialPage	$specialPage	Current special page
array	&$tables	Array of tables; see IDatabase::select $table
array	&$fields	Array of fields; see IDatabase::select $vars
array	&$conds	Array of conditions; see IDatabase::select $conds
array	&$query_options	Array of query options; see IDatabase::select $options
array	&$join_conds	Array of join conditions; see IDatabase::select $join_conds
FormOptions	$opts	Wrapper for the current request options and their defaults
bool	$isStructuredFiltersEnabled	True if the Structured UI is currently enabled

Reimplemented in ChangesListBooleanFilterGroup, ChangesListStringOptionsFilterGroup, and MockChangesListFilterGroup.

◆ setUnidirectionalConflict()

ChangesListFilterGroup::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 261 of file ChangesListFilterGroup.php.

Referenced by conflictsWith().

Member Data Documentation

◆ $conflictingFilters

array ChangesListFilterGroup::$conflictingFilters = []

protected

Array of associative arrays with conflict information.

See setUnidirectionalConflict

Definition at line 123 of file ChangesListFilterGroup.php.

Referenced by getConflictingFilters().

◆ $conflictingGroups

array ChangesListFilterGroup::$conflictingGroups = []

protected

Array of associative arrays with conflict information.

See setUnidirectionalConflict

Definition at line 115 of file ChangesListFilterGroup.php.

Referenced by getConflictingGroups().

◆ $filters

array ChangesListFilterGroup::$filters

protected

Associative array of filters, as ChangesListFilter objects, with filter name as key.

Definition at line 99 of file ChangesListFilterGroup.php.

Referenced by getFilters().

◆ $isFullCoverage

bool ChangesListFilterGroup::$isFullCoverage

protected

Whether this group is full coverage.

This means that checking every item in the group means no changes list (e.g. RecentChanges) entries are filtered out.

Definition at line 107 of file ChangesListFilterGroup.php.

Referenced by getJsData().

◆ $name

string ChangesListFilterGroup::$name

protected

Name (internal identifier)

Definition at line 42 of file ChangesListFilterGroup.php.

Referenced by getFilter(), getJsData(), and getName().

◆ $priority

string ChangesListFilterGroup::$priority

protected

Priority integer.

Higher values means higher up in the group list.

Definition at line 92 of file ChangesListFilterGroup.php.

Referenced by getJsData(), and getPriority().

◆ $title

string ChangesListFilterGroup::$title

protected

i18n key for title

Definition at line 49 of file ChangesListFilterGroup.php.

Referenced by getJsData(), and getTitle().

◆ $type

string ChangesListFilterGroup::$type

protected

Type, from a TYPE constant of a subclass.

Definition at line 84 of file ChangesListFilterGroup.php.

Referenced by getJsData(), and getType().

◆ $whatsThisBody

string null ChangesListFilterGroup::$whatsThisBody

protected

i18n key for body of What's This?

Definition at line 63 of file ChangesListFilterGroup.php.

Referenced by getJsData().

◆ $whatsThisHeader

string null ChangesListFilterGroup::$whatsThisHeader

protected

i18n key for header of What's This?

Definition at line 56 of file ChangesListFilterGroup.php.

Referenced by getJsData().

◆ $whatsThisLinkText

string null ChangesListFilterGroup::$whatsThisLinkText

protected

i18n key for What's This? link

Definition at line 77 of file ChangesListFilterGroup.php.

Referenced by getJsData().

◆ $whatsThisUrl

string null ChangesListFilterGroup::$whatsThisUrl

protected

URL of What's This? link.

Definition at line 70 of file ChangesListFilterGroup.php.

Referenced by getJsData().

◆ DEFAULT_PRIORITY

const ChangesListFilterGroup::DEFAULT_PRIORITY = -100

Definition at line 125 of file ChangesListFilterGroup.php.

Referenced by __construct().

◆ RESERVED_NAME_CHAR

const ChangesListFilterGroup::RESERVED_NAME_CHAR = '_'

Definition at line 127 of file ChangesListFilterGroup.php.

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

includes/changes/ChangesListFilterGroup.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addOptions()

◆ anySelected()

◆ conflictsWith()

◆ createFilter()

◆ getConflictingFilters()

◆ getConflictingGroups()

◆ getFilter()

◆ getFilters()

◆ getJsData()

◆ getName()

◆ getPriority()

◆ getTitle()

◆ getType()

◆ modifyQuery()

◆ setUnidirectionalConflict()

Member Data Documentation

◆ $conflictingFilters

◆ $conflictingGroups

◆ $filters

◆ $isFullCoverage

◆ $name

◆ $priority

◆ $title

◆ $type

◆ $whatsThisBody

◆ $whatsThisHeader

◆ $whatsThisLinkText

◆ $whatsThisUrl

◆ DEFAULT_PRIORITY

◆ RESERVED_NAME_CHAR