MockChangesListFilterGroup Class Reference
Inheritance diagram for MockChangesListFilterGroup:
Collaboration diagram for MockChangesListFilterGroup:
Public Member Functions | |
| addOptions (FormOptions $opts, $allowDefaults, $isStructuredFiltersEnabled) | |
| All the options represented by this filter group to $opts. More... | |
| createFilter (array $filterDefinition) | |
| Creates a filter of the appropriate type for this group, from the definition. More... | |
| modifyQuery (IDatabase $dbr, ChangesListSpecialPage $specialPage, &$tables, &$fields, &$conds, &$query_options, &$join_conds, FormOptions $opts, $isStructuredFiltersEnabled) | |
| Modifies the query to include the filter group. More... | |
| registerFilter (MockChangesListFilter $filter) | |
 Public Member Functions inherited from ChangesListFilterGroup | |
| __construct (array $groupDefinition) | |
| Create a new filter group with the specified configuration. More... | |
| 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 () | |
| getJsData () | |
| Gets the JS data in the format required by the front-end of the structured UI. More... | |
| getName () | |
| getPriority () | |
| getTitle () | |
| getType () | |
| setUnidirectionalConflict ( $other, $globalDescription, $contextDescription) | |
| Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object. More... | |
Additional Inherited Members | |
| Public Attributes inherited from ChangesListFilterGroup | |
| const | DEFAULT_PRIORITY = -100 |
| const | RESERVED_NAME_CHAR = '_' |
| Protected Attributes inherited from ChangesListFilterGroup | |
| $conflictingFilters = [] | |
| Array of associative arrays with conflict information. More... | |
| $conflictingGroups = [] | |
| Array of associative arrays with conflict information. More... | |
| $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
Definition at line 5 of file MockChangesListFilterGroup.php.
Member Function Documentation
◆ addOptions()
| MockChangesListFilterGroup::addOptions | ( | FormOptions | $opts, |
| $allowDefaults, | |||
| $isStructuredFiltersEnabled | |||
| ) |
All the options represented by this filter group to $opts.
- Parameters
-
FormOptions $opts bool $allowDefaults bool $isStructuredFiltersEnabled
Reimplemented from ChangesListFilterGroup.
Definition at line 19 of file MockChangesListFilterGroup.php.
◆ createFilter()
| MockChangesListFilterGroup::createFilter | ( | array | $filterDefinition | ) |
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 6 of file MockChangesListFilterGroup.php.
◆ modifyQuery()
| MockChangesListFilterGroup::modifyQuery | ( | IDatabase | $dbr, |
| ChangesListSpecialPage | $specialPage, | ||
| & | $tables, | ||
| & | $fields, | ||
| & | $conds, | ||
| & | $query_options, | ||
| & | $join_conds, | ||
| FormOptions | $opts, | ||
| $isStructuredFiltersEnabled | |||
| ) |
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 from ChangesListFilterGroup.
Definition at line 14 of file MockChangesListFilterGroup.php.
◆ registerFilter()
| MockChangesListFilterGroup::registerFilter | ( | MockChangesListFilter | $filter | ) |
Definition at line 10 of file MockChangesListFilterGroup.php.
References $filter.
The documentation for this class was generated from the following file:
- tests/phpunit/mocks/MockChangesListFilterGroup.php
