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

Inheritance diagram for ChangesListStringOptionsFilterGroup:

Collaboration diagram for ChangesListStringOptionsFilterGroup:

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

	getDefault ()
	Gets default of filter group. More...

	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. More...

	isPerGroupRequestParameter ()
	Check whether the URL parameter is for the group, or for individual filters.Defaults can also be defined on the group if and only if this is true. Returns bool True if and only if the URL parameter is per-group More...

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

	registerFilter (ChangesListStringOptionsFilter $filter)
	Registers a filter in this group. More...

	setDefault ( $defaultValue)
	Sets default of filter group. More...

Public Member Functions inherited from ChangesListFilterGroup
	anySelected (FormOptions $opts)
	Check if any filter in this group is selected. More...

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

	getConflictingFilters ()
	Get filters conflicting with this filter group. More...

	getConflictingGroups ()
	Get groups conflicting with this filter group. More...

	getFilter ( $name)
	Get filter by name. More...

	getFilters ()

	getName ()

	getPriority ()

	getTitle ()

	getType ()

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

Public Attributes
const	ALL = 'all'
	Signifies that all options in the group are selected. More...

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

const	SEPARATOR = ';'
	Delimiter. More...

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

Public Attributes inherited from ChangesListFilterGroup
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.

Parameters

array $filterDefinition Filter definition

Returns: ChangesListFilter Filter

More...

Protected Attributes
	$defaultValue
	Defaul parameter value. More...

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

Protected Attributes inherited from ChangesListFilterGroup
	$conflictingFilters = []

	$conflictingGroups = []

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

	$isFullCoverage
	Whether this group is full coverage. More...

	$name
	Name (internal identifier) More...

	$priority
	Priority integer. More...

	$title
	i18n key for title More...

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

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

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

	$whatsThisLinkText
	i18n key for What's This? link More...

	$whatsThisUrl
	URL of What's This? link. More...

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

Definition at line 39 of file ChangesListStringOptionsFilterGroup.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ChangesListFilterGroup.

Definition at line 111 of file ChangesListStringOptionsFilterGroup.php.

References setDefault(), and TYPE.

Member Function Documentation

◆ createFilter()

ChangesListStringOptionsFilterGroup::createFilter ( array $filterDefinition )

protected

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

Parameters

array $filterDefinition Filter definition

Returns: ChangesListFilter Filter

Reimplemented from ChangesListFilterGroup.

Definition at line 157 of file ChangesListStringOptionsFilterGroup.php.

◆ getDefault()

ChangesListStringOptionsFilterGroup::getDefault ( )

Gets default of filter group.

Returns: string $defaultValue

Definition at line 150 of file ChangesListStringOptionsFilterGroup.php.

References $defaultValue.

Referenced by getJsData().

◆ getJsData()

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 ChangesListFilterGroup.

Definition at line 235 of file ChangesListStringOptionsFilterGroup.php.

References $output, getDefault(), and SEPARATOR.

◆ isPerGroupRequestParameter()

ChangesListStringOptionsFilterGroup::isPerGroupRequestParameter ( )

Check whether the URL parameter is for the group, or for individual filters.Defaults can also be defined on the group if and only if this is true.

Returns: bool True if and only if the URL parameter is per-group

Reimplemented from ChangesListFilterGroup.

Definition at line 132 of file ChangesListStringOptionsFilterGroup.php.

◆ modifyQuery()

ChangesListStringOptionsFilterGroup::modifyQuery	(	IDatabase	$dbr,
		ChangesListSpecialPage	$specialPage,
		&	$tables,
		&	$fields,
		&	$conds,
		&	$query_options,
		&	$join_conds,
			$value
	)

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
string	$value	URL parameter value