MediaWiki REL1_39
|
Represents a filter (used on ChangesListSpecialPage and descendants) More...
Public Member Functions | |
__construct (array $filterDefinition) | |
Creates a new filter with the specified configuration, and registers it to the specified group. | |
activelyInConflictWithFilter (ChangesListFilter $filter, FormOptions $opts) | |
Check if the conflict with a filter is currently "active". | |
activelyInConflictWithGroup (ChangesListFilterGroup $group, FormOptions $opts) | |
Check if the conflict with a group is currently "active". | |
applyCssClassIfNeeded (IContextSource $ctx, RecentChange $rc, array &$classes) | |
Add CSS class if needed. | |
conflictsWith ( $other, $globalKey, $forwardKey, $backwardKey) | |
Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object. | |
displaysOnStructuredUi () | |
Checks whether the filter should display on the structured UI This refers to the exact filter. | |
displaysOnUnstructuredUi () | |
Checks whether the filter should display on the unstructured UI. | |
getConflictingFilters () | |
Get filters conflicting with this filter. | |
getConflictingGroups () | |
Get groups conflicting with this filter. | |
getDescription () | |
getGroup () | |
getJsData () | |
Gets the JS data required by the front-end of the structured UI. | |
getLabel () | |
getName () | |
getPriority () | |
isFeatureAvailableOnStructuredUi () | |
Checks whether an equivalent feature for this filter is available on the structured UI. | |
isSelected (FormOptions $opts) | |
Checks whether this filter is selected in the provided options. | |
setAsSupersetOf (ChangesListFilter $other) | |
Marks that the current instance is (also) a superset of the filter passed in. | |
setDefaultHighlightColor ( $defaultHighlightColor) | |
setUnidirectionalConflict ( $other, $globalDescription, $contextDescription) | |
Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object. | |
Protected Member Functions | |
getCssClass () | |
Gets the CSS class. | |
getSiblings () | |
Get filters in the same group. | |
Protected Attributes | |
array | $conflictingFilters = [] |
Array of associative arrays with conflict information. | |
array | $conflictingGroups = [] |
Array of associative arrays with conflict information. | |
string null | $cssClassSuffix |
CSS class suffix used for attribution, e.g. | |
string | $defaultHighlightColor |
string | $description |
i18n key of description for structured UI | |
ChangesListFilterGroup | $group |
Group. | |
callable | $isRowApplicableCallable |
Callable that returns true if and only if a row is attributed to this filter. | |
string | $label |
i18n key of label for structured UI | |
string | $name |
Filter name. | |
int | $priority |
Priority integer. | |
array | $subsetFilters = [] |
Array of associative arrays with subset information. | |
Represents a filter (used on ChangesListSpecialPage and descendants)
Definition at line 29 of file ChangesListFilter.php.
ChangesListFilter::__construct | ( | array | $filterDefinition | ) |
Creates a new filter with the specified configuration, and registers it to the specified group.
It infers which UI (it can be either or both) to display the filter on based on which messages are provided.
If 'label' is provided, it will be displayed on the structured UI. Thus, 'label', 'description', and sub-class parameters are optional depending on which UI it's for.
array | $filterDefinition | ChangesListFilter definition
|
Definition at line 143 of file ChangesListFilter.php.
ChangesListFilter::activelyInConflictWithFilter | ( | ChangesListFilter | $filter, |
FormOptions | $opts ) |
Check if the conflict with a filter is currently "active".
ChangesListFilter | $filter | |
FormOptions | $opts |
Definition at line 460 of file ChangesListFilter.php.
References getSiblings(), and isSelected().
ChangesListFilter::activelyInConflictWithGroup | ( | ChangesListFilterGroup | $group, |
FormOptions | $opts ) |
Check if the conflict with a group is currently "active".
ChangesListFilterGroup | $group | |
FormOptions | $opts |
Definition at line 436 of file ChangesListFilter.php.
References $group, ChangesListFilterGroup\anySelected(), and getSiblings().
ChangesListFilter::applyCssClassIfNeeded | ( | IContextSource | $ctx, |
RecentChange | $rc, | ||
array & | $classes ) |
Add CSS class if needed.
IContextSource | $ctx | Context source |
RecentChange | $rc | Recent changes object |
array | &$classes | Non-associative array of CSS class names; appended to if needed |
Definition at line 350 of file ChangesListFilter.php.
References getCssClass().
ChangesListFilter::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.
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 195 of file ChangesListFilter.php.
References setUnidirectionalConflict().
ChangesListFilter::displaysOnStructuredUi | ( | ) |
Checks whether the filter should display on the structured UI This refers to the exact filter.
See also isFeatureAvailableOnStructuredUi.
Definition at line 308 of file ChangesListFilter.php.
Referenced by isFeatureAvailableOnStructuredUi().
|
abstract |
Checks whether the filter should display on the unstructured UI.
Reimplemented in ChangesListBooleanFilter, and ChangesListStringOptionsFilter.
ChangesListFilter::getConflictingFilters | ( | ) |
Get filters conflicting with this filter.
Definition at line 425 of file ChangesListFilter.php.
ChangesListFilter::getConflictingGroups | ( | ) |
Get groups conflicting with this filter.
Definition at line 416 of file ChangesListFilter.php.
|
protected |
Gets the CSS class.
Definition at line 335 of file ChangesListFilter.php.
References $cssClassSuffix.
Referenced by applyCssClassIfNeeded(), and getJsData().
ChangesListFilter::getDescription | ( | ) |
Definition at line 291 of file ChangesListFilter.php.
References $description.
Referenced by getJsData().
ChangesListFilter::getGroup | ( | ) |
Definition at line 277 of file ChangesListFilter.php.
References $group.
Referenced by getSiblings(), ChangesListStringOptionsFilter\isSelected(), and setAsSupersetOf().
ChangesListFilter::getJsData | ( | ) |
Gets the JS data required by the front-end of the structured UI.
Reimplemented in ChangesListBooleanFilter.
Definition at line 367 of file ChangesListFilter.php.
References $defaultHighlightColor, $priority, $subsetFilters, getCssClass(), getDescription(), getLabel(), and getName().
ChangesListFilter::getLabel | ( | ) |
Definition at line 284 of file ChangesListFilter.php.
References $label.
Referenced by getJsData().
ChangesListFilter::getName | ( | ) |
Definition at line 270 of file ChangesListFilter.php.
References $name.
Referenced by getJsData(), ChangesListBooleanFilter\isActive(), ChangesListBooleanFilter\isSelected(), ChangesListStringOptionsFilter\isSelected(), ChangesListBooleanFilterGroup\registerFilter(), ChangesListStringOptionsFilterGroup\registerFilter(), and setAsSupersetOf().
ChangesListFilter::getPriority | ( | ) |
Definition at line 326 of file ChangesListFilter.php.
References $priority.
Referenced by ChangesListFilterGroup\getJsData().
|
protected |
Get filters in the same group.
Definition at line 485 of file ChangesListFilter.php.
References getGroup().
Referenced by activelyInConflictWithFilter(), activelyInConflictWithGroup(), and ChangesListBooleanFilter\isSelected().
ChangesListFilter::isFeatureAvailableOnStructuredUi | ( | ) |
Checks whether an equivalent feature for this filter is available on the structured UI.
This can either be the exact filter, or a new filter that replaces it.
Reimplemented in ChangesListBooleanFilter.
Definition at line 319 of file ChangesListFilter.php.
References displaysOnStructuredUi().
|
abstract |
Checks whether this filter is selected in the provided options.
FormOptions | $opts |
Reimplemented in ChangesListBooleanFilter, and ChangesListStringOptionsFilter.
Referenced by activelyInConflictWithFilter(), and ChangesListFilterGroup\anySelected().
ChangesListFilter::setAsSupersetOf | ( | ChangesListFilter | $other | ) |
Marks that the current instance is (also) a superset of the filter passed in.
This can be called more than once.
This means that anything in the results for the other filter is also in the results for this one.
ChangesListFilter | $other | The filter the current instance is a superset of |
Definition at line 254 of file ChangesListFilter.php.
References getGroup(), and getName().
ChangesListFilter::setDefaultHighlightColor | ( | $defaultHighlightColor | ) |
string | $defaultHighlightColor |
Definition at line 497 of file ChangesListFilter.php.
References $defaultHighlightColor.
ChangesListFilter::setUnidirectionalConflict | ( | $other, | |
$globalDescription, | |||
$contextDescription ) |
Marks that the given ChangesListFilterGroup or ChangesListFilter conflicts with this object.
Internal use ONLY.
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 224 of file ChangesListFilter.php.
Referenced by conflictsWith().
|
protected |
Array of associative arrays with conflict information.
See setUnidirectionalConflict
Definition at line 89 of file ChangesListFilter.php.
|
protected |
Array of associative arrays with conflict information.
See setUnidirectionalConflict
Definition at line 81 of file ChangesListFilter.php.
|
protected |
CSS class suffix used for attribution, e.g.
'bot'.
In this example, if bot actions are included in the result set, this CSS class will then be included in all bot-flagged actions.
Definition at line 45 of file ChangesListFilter.php.
Referenced by getCssClass().
|
protected |
Definition at line 108 of file ChangesListFilter.php.
Referenced by getJsData(), and setDefaultHighlightColor().
|
protected |
i18n key of description for structured UI
Definition at line 73 of file ChangesListFilter.php.
Referenced by getDescription().
|
protected |
Group.
ChangesListFilterGroup this belongs to
Definition at line 59 of file ChangesListFilter.php.
Referenced by activelyInConflictWithGroup(), and getGroup().
|
protected |
Callable that returns true if and only if a row is attributed to this filter.
Definition at line 52 of file ChangesListFilter.php.
|
protected |
i18n key of label for structured UI
Definition at line 66 of file ChangesListFilter.php.
Referenced by getLabel().
|
protected |
|
protected |
Priority integer.
Higher value means higher up in the group's filter list.
Definition at line 103 of file ChangesListFilter.php.
Referenced by getJsData(), and getPriority().
|
protected |
Array of associative arrays with subset information.
Definition at line 96 of file ChangesListFilter.php.
Referenced by getJsData().