class Equality in Drupal 10
Same name and namespace in other branches
- 8 core/modules/views/src/Plugin/views/filter/Equality.php \Drupal\views\Plugin\views\filter\Equality
- 9 core/modules/views/src/Plugin/views/filter/Equality.php \Drupal\views\Plugin\views\filter\Equality
Simple filter to handle equal to / not equal to filters.
Plugin annotation
@ViewsFilter("equality");
Hierarchy
- class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements CacheableDependencyInterface
- class \Drupal\views\Plugin\views\filter\Equality
Expanded class hierarchy of Equality
Related topics
1 string reference to 'Equality'
- views.filter.schema.yml in core/
modules/ views/ config/ schema/ views.filter.schema.yml - core/modules/views/config/schema/views.filter.schema.yml
File
- core/
modules/ views/ src/ Plugin/ views/ filter/ Equality.php, line 14
Namespace
Drupal\views\Plugin\views\filterView source
class Equality extends FilterPluginBase {
/**
* Exposed filter options.
*
* @var bool
*/
protected $alwaysMultiple = TRUE;
/**
* Provide simple equality operator.
*/
public function operatorOptions() {
return [
'=' => $this
->t('Is equal to'),
'!=' => $this
->t('Is not equal to'),
];
}
/**
* Provide a simple textfield for equality.
*/
protected function valueForm(&$form, FormStateInterface $form_state) {
$form['value'] = [
'#type' => 'textfield',
'#title' => $this
->t('Value'),
'#size' => 30,
'#default_value' => $this->value,
];
if ($form_state
->get('exposed')) {
$identifier = $this->options['expose']['identifier'];
$user_input = $form_state
->getUserInput();
if (!isset($user_input[$identifier])) {
$user_input[$identifier] = $this->value;
$form_state
->setUserInput($user_input);
}
}
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Equality:: |
protected | property |
Exposed filter options. Overrides FilterPluginBase:: |
|
Equality:: |
public | function |
Provide simple equality operator. Overrides FilterPluginBase:: |
|
Equality:: |
protected | function |
Provide a simple textfield for equality. Overrides FilterPluginBase:: |
|
FilterPluginBase:: |
public | property | Disable the possibility to allow an exposed input to be optional. | |
FilterPluginBase:: |
public | property | Contains the information of the selected item in a grouped filter. | |
FilterPluginBase:: |
public | property | Disable the possibility to use operators. | 1 |
FilterPluginBase:: |
public | property | Contains the operator which is used on the query. | |
FilterPluginBase:: |
public | property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. | |
FilterPluginBase:: |
public | function | Determines if the input from a filter should change the generated query. | 2 |
FilterPluginBase:: |
public | function | Add a new group to the exposed filter groups. | |
FilterPluginBase:: |
public | function | Display the filter on the administrative summary. | 9 |
FilterPluginBase:: |
protected static | function | Filter by no empty values, though allow the use of (string) "0". | |
FilterPluginBase:: |
protected | function | Build the form to let users create the group of exposed filters. | |
FilterPluginBase:: |
public | function | Render our chunk of the exposed filter form when selecting. | |
FilterPluginBase:: |
public | function | Options form subform for exposed filter options. | 4 |
FilterPluginBase:: |
public | function | Displays the Build Group form. | |
FilterPluginBase:: |
protected | function | Provide default options for exposed filters. | |
FilterPluginBase:: |
protected | function | Save new group items, re-enumerates and remove groups marked to delete. | |
FilterPluginBase:: |
protected | function | Validate the build group options form. | |
FilterPluginBase:: |
public | function | Provide the basic form which calls through to subforms. | 2 |
FilterPluginBase:: |
protected | function | Builds wrapper for value and operator forms. | |
FilterPluginBase:: |
protected | function | Determine if a filter can be converted into a group. | |
FilterPluginBase:: |
public | function | Determine if a filter can be exposed. | 5 |
FilterPluginBase:: |
public | function | Can this filter be used in OR groups? | 1 |
FilterPluginBase:: |
public | function | Transform the input from a grouped filter into a standard filter. | |
FilterPluginBase:: |
public | function | Provide default options for exposed filters. | 3 |
FilterPluginBase:: |
protected | function | 4 | |
FilterPluginBase:: |
public | function | Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then. | |
FilterPluginBase:: |
protected | function | Make some translations to a form item to make it more suitable to exposing. | |
FilterPluginBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
6 |
FilterPluginBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
FilterPluginBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
1 |
FilterPluginBase:: |
public | function | Build a form containing a group of operator | values to apply as a single filter. | |
FilterPluginBase:: |
public | function | Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected. | |
FilterPluginBase:: |
protected | function | Determines if the given grouped filter entry has a valid value. | 1 |
FilterPluginBase:: |
public | function | Overrides \Drupal\views\Plugin\views\HandlerBase::init(). | 2 |
FilterPluginBase:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | |
FilterPluginBase:: |
public | function | Returns TRUE if users can select multiple groups items of a grouped exposed filter. | |
FilterPluginBase:: |
protected | function | Options form subform for setting the operator. | 5 |
FilterPluginBase:: |
public | function | Perform any necessary changes to the form values prior to storage. | |
FilterPluginBase:: |
protected | function | Validate the operator form. | |
FilterPluginBase:: |
protected | function | Sanitizes the HTML select element's options. | |
FilterPluginBase:: |
public | function | Add this filter to the query. | 13 |
FilterPluginBase:: |
protected | function | Shortcut to display the build_group/hide button. | |
FilterPluginBase:: |
public | function | Shortcut to display the exposed options form. | |
FilterPluginBase:: |
public | function | Shortcut to display the expose/hide button. | |
FilterPluginBase:: |
public | function | Shortcut to display the operator form. | |
FilterPluginBase:: |
protected | function | Shortcut to display the value form. | |
FilterPluginBase:: |
public | function | ||
FilterPluginBase:: |
public | function | If set to remember exposed input in the session, store it there. | |
FilterPluginBase:: |
public | function | Simple submit handler. | |
FilterPluginBase:: |
public static | function | ||
FilterPluginBase:: |
public | function | 2 | |
FilterPluginBase:: |
public | function | Validate the options form. | |
FilterPluginBase:: |
protected | function | Validates a filter identifier. | |
FilterPluginBase:: |
public | function | Simple validate handler. | 1 |
FilterPluginBase:: |
protected | function | Perform any necessary changes to the form values prior to storage. | 1 |
FilterPluginBase:: |
protected | function | Validate the options form. | 2 |