MediaWiki master
|
Represents a hide-based boolean filter (used on ChangesListSpecialPage and descendants) More...
Inherits ChangesListFilter.
Public Member Functions | ||||
__construct ( $filterDefinition) | ||||
Create a new filter with the specified configuration. | ||||
displaysOnUnstructuredUi () | ||||
Checks whether the filter should display on the unstructured UI.
| ||||
getDefault ( $structuredUI=false) | ||||
Get the default value. | ||||
getJsData () | ||||
Gets the JS data required by the front-end of the structured UI.
| ||||
getShowHide () | ||||
isActive (FormOptions $opts, $isStructuredUI) | ||||
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.
| ||||
isSelected (FormOptions $opts) | ||||
Checks whether this filter is selected in the provided options.
| ||||
modifyQuery (IReadableDatabase $dbr, ChangesListSpecialPage $specialPage, &$tables, &$fields, &$conds, &$query_options, &$join_conds) | ||||
Modifies the query to include the filter. | ||||
setDefault ( $defaultValue) | ||||
Sets default. | ||||
Public Member Functions inherited from ChangesListFilter | ||||
__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, string $globalKey, string $forwardKey, string $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. | ||||
getConflictingFilters () | ||||
Get filters conflicting with this filter. | ||||
getConflictingGroups () | ||||
Get groups conflicting with this filter. | ||||
getDescription () | ||||
getGroup () | ||||
getLabel () | ||||
getName () | ||||
getPriority () | ||||
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 Attributes | |
bool | $activeValue |
Value that defined when this filter is considered active. | |
bool | $defaultValue |
Default. | |
bool | $isReplacedInStructuredUi |
Whether there is a feature designed to replace this filter available on the structured UI. | |
callable | $queryCallable |
Callable used to do the actual query modification; see constructor. | |
string | $showHide |
Main unstructured UI i18n key. | |
Protected Attributes inherited from ChangesListFilter | |
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. | |
Additional Inherited Members | |
Protected Member Functions inherited from ChangesListFilter | |
getCssClass () | |
Gets the CSS class. | |
getSiblings () | |
Get filters in the same group. | |
Represents a hide-based boolean filter (used on ChangesListSpecialPage and descendants)
Definition at line 32 of file ChangesListBooleanFilter.php.
ChangesListBooleanFilter::__construct | ( | $filterDefinition | ) |
Create a new filter with the specified configuration.
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. If 'showHide' is provided, it will be displayed on the unstructured UI. Thus, 'label', 'description', and 'showHide' are optional depending on which UI it's for.
array | $filterDefinition | ChangesListFilter definition
|
Definition at line 109 of file ChangesListBooleanFilter.php.
References setDefault().
ChangesListBooleanFilter::displaysOnUnstructuredUi | ( | ) |
Checks whether the filter should display on the unstructured UI.
Reimplemented from ChangesListFilter.
Definition at line 164 of file ChangesListBooleanFilter.php.
ChangesListBooleanFilter::getDefault | ( | $structuredUI = false | ) |
Get the default value.
bool | $structuredUI | Are we currently showing the structured UI |
Definition at line 137 of file ChangesListBooleanFilter.php.
ChangesListBooleanFilter::getJsData | ( | ) |
Gets the JS data required by the front-end of the structured UI.
Reimplemented from ChangesListFilter.
Definition at line 210 of file ChangesListBooleanFilter.php.
ChangesListBooleanFilter::getShowHide | ( | ) |
Definition at line 157 of file ChangesListBooleanFilter.php.
ChangesListBooleanFilter::isActive | ( | FormOptions | $opts, |
$isStructuredUI ) |
FormOptions | $opts | Query parameters merged with defaults |
bool | $isStructuredUI | Whether the structured UI is currently enabled |
Definition at line 236 of file ChangesListBooleanFilter.php.
References ChangesListFilter\getName().
ChangesListBooleanFilter::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 from ChangesListFilter.
Definition at line 171 of file ChangesListBooleanFilter.php.
ChangesListBooleanFilter::isSelected | ( | FormOptions | $opts | ) |
Checks whether this filter is selected in the provided options.
FormOptions | $opts |
Reimplemented from ChangesListFilter.
Definition at line 221 of file ChangesListBooleanFilter.php.
References ChangesListFilter\getName(), and ChangesListFilter\getSiblings().
ChangesListBooleanFilter::modifyQuery | ( | IReadableDatabase | $dbr, |
ChangesListSpecialPage | $specialPage, | ||
& | $tables, | ||
& | $fields, | ||
& | $conds, | ||
& | $query_options, | ||
& | $join_conds ) |
Modifies the query to include the filter.
This is only called if the filter is in effect (taking into account the default).
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 |
Definition at line 188 of file ChangesListBooleanFilter.php.
References MediaWiki\SpecialPage\SpecialPage\getContext().
ChangesListBooleanFilter::setDefault | ( | $defaultValue | ) |
Sets default.
It must be a boolean.
It will be coerced to boolean.
bool | $defaultValue |
Definition at line 150 of file ChangesListBooleanFilter.php.
Referenced by __construct().
|
protected |
Value that defined when this filter is considered active.
Definition at line 67 of file ChangesListBooleanFilter.php.
|
protected |
Default.
Definition at line 53 of file ChangesListBooleanFilter.php.
|
protected |
Whether there is a feature designed to replace this filter available on the structured UI.
Definition at line 46 of file ChangesListBooleanFilter.php.
|
protected |
Callable used to do the actual query modification; see constructor.
Definition at line 60 of file ChangesListBooleanFilter.php.
|
protected |
Main unstructured UI i18n key.
Definition at line 38 of file ChangesListBooleanFilter.php.