Simple filter to handle matching of boolean values
Definition items:
@PluginID("boolean");
Expanded class hierarchy of BooleanOperator
class BooleanOperator extends FilterPluginBase {
// exposed filter options
var $always_multiple = TRUE;
// Don't display empty space where the operator would be.
var $no_operator = TRUE;
// Whether to accept NULL as a false value or not
var $accept_null = FALSE;
/**
* Overrides \Drupal\views\Plugin\views\filter\FilterPluginBase::init().
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
parent::init($view, $display, $options);
$this->value_value = t('True');
if (isset($this->definition['label'])) {
$this->value_value = $this->definition['label'];
}
if (isset($this->definition['accept null'])) {
$this->accept_null = (bool) $this->definition['accept null'];
}
elseif (isset($this->definition['accept_null'])) {
$this->accept_null = (bool) $this->definition['accept_null'];
}
$this->value_options = NULL;
}
/**
* Return the possible options for this filter.
*
* Child classes should override this function to set the possible values
* for the filter. Since this is a boolean filter, the array should have
* two possible keys: 1 for "True" and 0 for "False", although the labels
* can be whatever makes sense for the filter. These values are used for
* configuring the filter, when the filter is exposed, and in the admin
* summary of the filter. Normally, this should be static data, but if it's
* dynamic for some reason, child classes should use a guard to reduce
* database hits as much as possible.
*/
public function getValueOptions() {
if (isset($this->definition['type'])) {
if ($this->definition['type'] == 'yes-no') {
$this->value_options = array(
1 => t('Yes'),
0 => t('No'),
);
}
if ($this->definition['type'] == 'on-off') {
$this->value_options = array(
1 => t('On'),
0 => t('Off'),
);
}
if ($this->definition['type'] == 'enabled-disabled') {
$this->value_options = array(
1 => t('Enabled'),
0 => t('Disabled'),
);
}
}
// Provide a fallback if the above didn't set anything.
if (!isset($this->value_options)) {
$this->value_options = array(
1 => t('True'),
0 => t('False'),
);
}
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['value']['default'] = FALSE;
return $options;
}
protected function operatorForm(&$form, &$form_state) {
$form['operator'] = array();
}
protected function valueForm(&$form, &$form_state) {
if (empty($this->value_options)) {
// Initialize the array of possible values for this filter.
$this
->getValueOptions();
}
if (!empty($form_state['exposed'])) {
// Exposed filter: use a select box to save space.
$filter_form_type = 'select';
}
else {
// Configuring a filter: use radios for clarity.
$filter_form_type = 'radios';
}
$form['value'] = array(
'#type' => $filter_form_type,
'#title' => $this->value_value,
'#options' => $this->value_options,
'#default_value' => $this->value,
);
if (!empty($this->options['exposed'])) {
$identifier = $this->options['expose']['identifier'];
if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier])) {
$form_state['input'][$identifier] = $this->value;
}
// If we're configuring an exposed filter, add an <Any> option.
if (empty($form_state['exposed']) || empty($this->options['expose']['required'])) {
$any_label = config('views.settings')
->get('ui.exposed_filter_any_label') == 'old_any' ? '<Any>' : t('- Any -');
if ($form['value']['#type'] != 'select') {
$any_label = check_plain($any_label);
}
$form['value']['#options'] = array(
'All' => $any_label,
) + $form['value']['#options'];
}
}
}
protected function valueValidate($form, &$form_state) {
if ($form_state['values']['options']['value'] == 'All' && !empty($form_state['values']['options']['expose']['required'])) {
form_set_error('value', t('You must select a value unless this is an non-required exposed filter.'));
}
}
public function adminSummary() {
if ($this
->isAGroup()) {
return t('grouped');
}
if (!empty($this->options['exposed'])) {
return t('exposed');
}
if (empty($this->value_options)) {
$this
->getValueOptions();
}
// Now that we have the valid options for this filter, just return the
// human-readable label based on the current value. The value_options
// array is keyed with either 0 or 1, so if the current value is not
// empty, use the label for 1, and if it's empty, use the label for 0.
return $this->value_options[!empty($this->value)];
}
public function defaultExposeOptions() {
parent::defaultExposeOptions();
$this->options['expose']['operator_id'] = '';
$this->options['expose']['label'] = $this->value_value;
$this->options['expose']['required'] = TRUE;
}
public function query() {
$this
->ensureMyTable();
$field = "{$this->tableAlias}.{$this->realField}";
if (empty($this->value)) {
if ($this->accept_null) {
$or = db_or()
->condition($field, 0, '=')
->condition($field, NULL, 'IS NULL');
$this->query
->addWhere($this->options['group'], $or);
}
else {
$this->query
->addWhere($this->options['group'], $field, 0, '=');
}
}
else {
if (!empty($this->definition['use_equal'])) {
$this->query
->addWhere($this->options['group'], $field, 1, '=');
}
else {
$this->query
->addWhere($this->options['group'], $field, 0, '<>');
}
}
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BooleanOperator:: |
public | function |
Overrides \Drupal\views\Plugin\views\filter\FilterPluginBase::init(). Overrides FilterPluginBase:: |
1 |
BooleanOperator:: |
public | function | Return the possible options for this filter. | |
BooleanOperator:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides FilterPluginBase:: |
|
BooleanOperator:: |
protected | function |
Options form subform for setting the operator. Overrides FilterPluginBase:: |
|
BooleanOperator:: |
protected | function |
Options form subform for setting options. Overrides FilterPluginBase:: |
|
BooleanOperator:: |
protected | function |
Validate the options form. Overrides FilterPluginBase:: |
|
BooleanOperator:: |
public | function |
Display the filter on the administrative summary Overrides FilterPluginBase:: |
|
BooleanOperator:: |
public | function |
Provide default options for exposed filters. Overrides FilterPluginBase:: |
|
BooleanOperator:: |
public | function |
Add this filter to the query. Overrides FilterPluginBase:: |
2 |
FilterPluginBase:: |
public | function |
Determine if a filter can be exposed. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
protected | function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | |
FilterPluginBase:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Provide the basic form which calls through to subforms.
If overridden, it is best to call through to the parent,
or to at least make sure all of the functions in this form
are called. Overrides HandlerBase:: |
3 |
FilterPluginBase:: |
public | function |
Simple validate handler Overrides HandlerBase:: |
1 |
FilterPluginBase:: |
public | function |
Simple submit handler Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | Shortcut to display the operator form. | |
FilterPluginBase:: |
public | function | Provide a list of options for the default operator form. Should be overridden by classes that don't override operatorForm | 4 |
FilterPluginBase:: |
protected | function | Validate the operator form. | |
FilterPluginBase:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
FilterPluginBase:: |
protected | function | Shortcut to display the value form. | |
FilterPluginBase:: |
protected | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
FilterPluginBase:: |
public | function | Shortcut to display the exposed options form. | |
FilterPluginBase:: |
protected | function | Shortcut to display the build_group/hide button. | |
FilterPluginBase:: |
public | function | Displays the Build Group form. | |
FilterPluginBase:: |
public | function |
Shortcut to display the expose/hide button. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Options form subform for exposed filter options. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Validate the build group options form. | 1 |
FilterPluginBase:: |
protected | function | Save new group items, re-enumerates and remove groups marked to delete. | |
FilterPluginBase:: |
protected | function | Provide default options for exposed filters. | |
FilterPluginBase:: |
public | function | Build a form containing a group of operator | values to apply as a single filter. | |
FilterPluginBase:: |
public | function |
Render our chunk of the exposed filter form when selecting Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' | |
FilterPluginBase:: |
public | function | Add a new group to the exposed filter groups. | |
FilterPluginBase:: |
protected | function | Make some translations to a form item to make it more suitable to exposing. | |
FilterPluginBase:: |
protected | function | Sanitizes the HTML select element's options. | |
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. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | ||
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:: |
public | function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group. | |
FilterPluginBase:: |
public | function |
Check to see if input from the exposed filters should change
the behavior of this filter. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function |
If set to remember exposed input in the session, store it there. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | Can this filter be used in OR groups? | 1 |
FilterPluginBase:: |
protected static | function | Filter by no empty values, though allow to use "0". | |
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
3 |
HandlerBase:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
HandlerBase:: |
public | function | Shortcut to get a handler's raw field value. | |
HandlerBase:: |
public | function | Sanitize the value for output. | |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Provides the handler some groupby. | 2 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
HandlerBase:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Validate the options form. | |
HandlerBase:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
HandlerBase:: |
public | function | Validate the exposed handler form | 4 |
HandlerBase:: |
public | function | Submit the exposed handler form | |
HandlerBase:: |
public | function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
HandlerBase:: |
public | function | Shortcut to display the exposed options form. | |
HandlerBase:: |
public | function | Check whether current user has access to this handler. | 6 |
HandlerBase:: |
public | function | Run before the view is built. | 1 |
HandlerBase:: |
public | function | Run after the view is executed, before the result is cached. | |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
HandlerBase:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
public | function | Get the join object that should be used for this handler. | |
HandlerBase:: |
public | function |
Validates the handler against the complete View. Overrides PluginBase:: |
1 |
HandlerBase:: |
public | function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 6 |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
HandlerBase:: |
public | function | Determines the entity type used by this handler. | |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Numeric only. | |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Works for strings. | |
HandlerBase:: |
public | function | Displays the Expose form. | |
HandlerBase:: |
public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
BooleanOperator:: |
property |
Disable the possibility to force a single value. Overrides FilterPluginBase:: |
||
BooleanOperator:: |
property |
Disable the possibility to use operators. Overrides FilterPluginBase:: |
||
BooleanOperator:: |
property | |||
FilterPluginBase:: |
property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. | ||
FilterPluginBase:: |
property | Contains the operator which is used on the query. | ||
FilterPluginBase:: |
property | Contains the information of the selected item in a gruped filter. | ||
FilterPluginBase:: |
property | Disable the possibility to allow a exposed input to be optional. | ||
HandlerBase:: |
public | property | Where the $query object will reside: | 1 |
HandlerBase:: |
public | property | The table this handler is attached to. | |
HandlerBase:: |
public | property | The alias of the table of this handler which is used in the query. | |
HandlerBase:: |
public | property | When a table has been moved this property is set. | |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
public | property | When a field has been moved this property is set. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |