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.

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

	getDefault ()
	Gets default of filter group.

	getJsData ()
	@inheritDoc

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

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

	setDefault ( $defaultValue)
	Sets default of filter group.

Public Member Functions inherited from ChangesListFilterGroup
	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 ()

	getName ()

	getPriority ()

	getTitle ()

	getType ()

	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.

Public Attributes inherited from ChangesListFilterGroup
const	DEFAULT_PRIORITY = -100

const	RESERVED_NAME_CHAR = '_'

Protected Member Functions
	createFilter (array $filterDefinition)
	@inheritDoc

Protected Attributes
	$defaultValue
	Defaul parameter value.

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

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

Private Member Functions
	isActive ( $isStructuredUI)
	Check if this filter group is currently active.

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

Definition at line 111 of file ChangesListStringOptionsFilterGroup.php.

References setDefault(), and TYPE.

Member Function Documentation

◆ addOptions()

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

@inheritDoc

Reimplemented from ChangesListFilterGroup.

Definition at line 234 of file ChangesListStringOptionsFilterGroup.php.

References FormOptions\add(), getDefault(), and ChangesListFilterGroup\getName().

◆ createFilter()

ChangesListStringOptionsFilterGroup::createFilter ( array $filterDefinition )

protected

@inheritDoc

Reimplemented from ChangesListFilterGroup.

Definition at line 150 of file ChangesListStringOptionsFilterGroup.php.

◆ getDefault()

ChangesListStringOptionsFilterGroup::getDefault ( )

Gets default of filter group.

Returns: string $defaultValue

Definition at line 143 of file ChangesListStringOptionsFilterGroup.php.

References $defaultValue.

Referenced by addOptions(), and getJsData().

◆ getJsData()

ChangesListStringOptionsFilterGroup::getJsData ( )

@inheritDoc

Reimplemented from ChangesListFilterGroup.

Definition at line 222 of file ChangesListStringOptionsFilterGroup.php.

References $output, getDefault(), and SEPARATOR.

◆ isActive()

ChangesListStringOptionsFilterGroup::isActive ( $isStructuredUI )

private

Check if this filter group is currently active.

Parameters

bool $isStructuredUI Is structured filters UI current enabled

Returns: bool

Definition at line 244 of file ChangesListStringOptionsFilterGroup.php.

Referenced by modifyQuery().

◆ modifyQuery()

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