Represents a filter group with multiple string options. More...

Inherits MediaWiki\RecentChanges\ChangesListFilterGroup.

Collaboration diagram for MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup:

[legend]

Public Member Functions

__construct (array $groupDefinition)

Create a new filter group with the specified configuration.

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

Add all the options represented by this filter group to $opts.

Parameters

FormOptions	$opts
bool	$allowDefaults
bool	$isStructuredFiltersEnabled

getDefault ()

Gets default of filter group.

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.

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

Modifies the query to include the filter group (legacy interface).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

IReadableDatabase	$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

registerFilter (ChangesListStringOptionsFilter $filter)

Registers a filter in this group.

setDefault ( $defaultValue)

Sets default of filter group.

Public Member Functions inherited from MediaWiki\RecentChanges\ChangesListFilterGroup

anySelected (FormOptions $opts)

Check if any filter in this group is selected.

conflictsWith ( $other, string $globalKey, string $forwardKey, string $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 ()

getName ()

getPriority ()

getTitle ()

getType ()

modifyChangesListQuery (ChangesListQuery $query, 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	ALL = 'all'
	Signifies that all options in the group are selected.

const	NONE = ''
	Signifies that no options in the group are selected, meaning the group has no effect.

const	SEPARATOR = ';'
	Delimiter.

const	TYPE = 'string_options'
	Type marker, used by JavaScript.

Protected Member Functions

createFilter (array $filterDefinition)

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

Parameters

array $filterDefinition

Returns: ChangesListFilter Filter

Protected Attributes
string	$defaultValue
	Default parameter value.

callable null	$queryCallable
	Callable used to do the actual query modification; see constructor.

Protected Attributes inherited from MediaWiki\RecentChanges\ChangesListFilterGroup
array	$conflictingFilters = []
	Array of associative arrays with conflict information.

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

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

bool	$isFullCoverage
	Whether this group is full coverage.

string	$name
	Name (internal identifier)

int	$priority
	Priority integer.

string	$title
	i18n key for title

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

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

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

string null	$whatsThisLinkText
	i18n key for What's This? link

string null	$whatsThisUrl
	URL of What's This? link.

Detailed Description

Represents a filter group with multiple string options.

They are passed to the server as a single form parameter separated by a delimiter. The parameter name is the group name. E.g. groupname=opt1;opt2 .

If all options are selected they are replaced by the term "all".

There is also a single DB query modification for the whole group.

Since: 1.29

Author: Matthew Flaschen

Definition at line 27 of file ChangesListStringOptionsFilterGroup.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup::__construct ( array $groupDefinition )

Create a new filter group with the specified configuration.

Parameters

array

$groupDefinition

Configuration of group

$groupDefinition['name'] string Group name
$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['priority'] int Priority integer. Higher means higher in the group list.
$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['default'] string Default for group.
$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['queryCallable'] callable Callable accepting parameters:
- string $specialPageClassName Class name of current special page
- IContextSource $context Context, for e.g. user
- IDatabase $dbr Database, for addQuotes, makeList, and similar
- 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
- array $selectedValues The allowed and requested values, lower-cased and sorted
$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 from MediaWiki\RecentChanges\ChangesListFilterGroup.

Definition at line 101 of file ChangesListStringOptionsFilterGroup.php.

References MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup\setDefault(), and MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup\TYPE.

Member Function Documentation

◆ addOptions()

MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup::addOptions	(	FormOptions	$opts,
			$allowDefaults,
			$isStructuredFiltersEnabled )

Add all the options represented by this filter group to $opts.

Parameters

FormOptions	$opts
bool	$allowDefaults
bool	$isStructuredFiltersEnabled

Reimplemented from MediaWiki\RecentChanges\ChangesListFilterGroup.

Definition at line 231 of file ChangesListStringOptionsFilterGroup.php.

References MediaWiki\Html\FormOptions\add(), MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup\getDefault(), and MediaWiki\RecentChanges\ChangesListFilterGroup\getName().

◆ createFilter()

MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup::createFilter ( array $filterDefinition )

protected

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

Parameters

array $filterDefinition

Returns: ChangesListFilter Filter

Reimplemented from MediaWiki\RecentChanges\ChangesListFilterGroup.

Definition at line 145 of file ChangesListStringOptionsFilterGroup.php.

◆ getDefault()

MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup::getDefault ( )

Gets default of filter group.

Returns: string

Definition at line 138 of file ChangesListStringOptionsFilterGroup.php.

References MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup\$defaultValue.

Referenced by MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup\addOptions(), and MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup\getJsData().

◆ getJsData()

MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup::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 from MediaWiki\RecentChanges\ChangesListFilterGroup.

Definition at line 219 of file ChangesListStringOptionsFilterGroup.php.

References MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup\getDefault(), and MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup\SEPARATOR.

◆ modifyQuery()

MediaWiki\RecentChanges\ChangesListStringOptionsFilterGroup::modifyQuery	(	IReadableDatabase	$dbr,
		ChangesListSpecialPage	$specialPage,
		&	$tables,
		&	$fields,
		&	$conds,
		&	$query_options,
		&	$join_conds,
		FormOptions	$opts,
			$isStructuredFiltersEnabled )

Modifies the query to include the filter group (legacy interface).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

IReadableDatabase	$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