class BooleanOperator

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/filter/BooleanOperator.php \Drupal\views\Plugin\views\filter\BooleanOperator
  2. 10 core/modules/views/src/Plugin/views/filter/BooleanOperator.php \Drupal\views\Plugin\views\filter\BooleanOperator
  3. 11.x core/modules/views/src/Plugin/views/filter/BooleanOperator.php \Drupal\views\Plugin\views\filter\BooleanOperator

Simple filter to handle matching of boolean values

Definition items:

  • label: (REQUIRED) The label for the checkbox.
  • type: For basic 'true false' types, an item can specify the following:
    • true-false: True/false (this is the default)
    • yes-no: Yes/No
    • on-off: On/Off
    • enabled-disabled: Enabled/Disabled
  • accept null: Treat a NULL value as false.
  • use_equal: If you use this flag the query will use = 1 instead of <> 0. This might be helpful for performance reasons.

Plugin annotation

@ViewsFilter("boolean");

Hierarchy

Expanded class hierarchy of BooleanOperator

Related topics

2 files declare their use of BooleanOperator
Current.php in core/modules/user/src/Plugin/views/filter/Current.php
FilterBooleanOperatorDefaultTest.php in core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterBooleanOperatorDefaultTest.php

File

core/modules/views/src/Plugin/views/filter/BooleanOperator.php, line 28

Namespace

Drupal\views\Plugin\views\filter
View source
class BooleanOperator extends FilterPluginBase {
    
    /**
     * The equal query operator.
     *
     * @var string
     */
    const EQUAL = '=';
    
    /**
     * The non equal query operator.
     *
     * @var string
     */
    const NOT_EQUAL = '<>';
    // exposed filter options
    protected $alwaysMultiple = TRUE;
    // Whether to accept NULL as a false value or not
    public $accept_null = FALSE;
    
    /**
     * {@inheritdoc}
     */
    public function operatorOptions($which = 'title') {
        $options = [];
        foreach ($this->operators() as $id => $info) {
            $options[$id] = $info[$which];
        }
        return $options;
    }
    
    /**
     * Returns an array of operator information.
     *
     * @return array
     */
    protected function operators() {
        return [
            '=' => [
                'title' => $this->t('Is equal to'),
                'method' => 'queryOpBoolean',
                'short' => $this->t('='),
                'values' => 1,
                'query_operator' => self::EQUAL,
            ],
            '!=' => [
                'title' => $this->t('Is not equal to'),
                'method' => 'queryOpBoolean',
                'short' => $this->t('!='),
                'values' => 1,
                'query_operator' => self::NOT_EQUAL,
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
        parent::init($view, $display, $options);
        $this->value_value = $this->t('True');
        if (isset($this->definition['label'])) {
            $this->value_value = $this->definition['label'];
        }
        elseif (isset($this->definition['title'])) {
            $this->value_value = $this->definition['title'];
        }
        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->valueOptions = 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->valueOptions = [
                    1 => $this->t('Yes'),
                    0 => $this->t('No'),
                ];
            }
            if ($this->definition['type'] == 'on-off') {
                $this->valueOptions = [
                    1 => $this->t('On'),
                    0 => $this->t('Off'),
                ];
            }
            if ($this->definition['type'] == 'enabled-disabled') {
                $this->valueOptions = [
                    1 => $this->t('Enabled'),
                    0 => $this->t('Disabled'),
                ];
            }
        }
        // Provide a fallback if the above didn't set anything.
        if (!isset($this->valueOptions)) {
            $this->valueOptions = [
                1 => $this->t('True'),
                0 => $this->t('False'),
            ];
        }
    }
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['value']['default'] = FALSE;
        return $options;
    }
    protected function valueForm(&$form, FormStateInterface $form_state) {
        if (empty($this->valueOptions)) {
            // Initialize the array of possible values for this filter.
            $this->getValueOptions();
        }
        if ($exposed = $form_state->get('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'] = [
            '#type' => $filter_form_type,
            '#title' => $this->value_value,
            '#options' => $this->valueOptions,
            '#default_value' => $this->value,
        ];
        if (!empty($this->options['exposed'])) {
            $identifier = $this->options['expose']['identifier'];
            $user_input = $form_state->getUserInput();
            if ($exposed && !isset($user_input[$identifier])) {
                $user_input[$identifier] = $this->value;
                $form_state->setUserInput($user_input);
            }
            // If we're configuring an exposed filter, add an - Any - option.
            if (!$exposed || empty($this->options['expose']['required'])) {
                $form['value']['#options'] = [
                    'All' => $this->t('- Any -'),
                ] + $form['value']['#options'];
            }
        }
    }
    protected function valueValidate($form, FormStateInterface $form_state) {
        if ($form_state->getValue([
            'options',
            'value',
        ]) == 'All' && !$form_state->isValueEmpty([
            'options',
            'expose',
            'required',
        ])) {
            $form_state->setErrorByName('value', $this->t('You must select a value unless this is an non-required exposed filter.'));
        }
    }
    public function adminSummary() {
        if ($this->isAGroup()) {
            return $this->t('grouped');
        }
        if (!empty($this->options['exposed'])) {
            return $this->t('exposed');
        }
        if (empty($this->valueOptions)) {
            $this->getValueOptions();
        }
        // Now that we have the valid options for this filter, just return the
        // human-readable label based on the current value.  The valueOptions
        // 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->operator . ' ' . $this->valueOptions[!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;
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $this->ensureMyTable();
        $field = "{$this->tableAlias}.{$this->realField}";
        $info = $this->operators();
        if (!empty($info[$this->operator]['method'])) {
            call_user_func([
                $this,
                $info[$this->operator]['method'],
            ], $field, $info[$this->operator]['query_operator']);
        }
    }
    
    /**
     * Adds a where condition to the query for a boolean value.
     *
     * @param string $field
     *   The field name to add the where condition for.
     * @param string $query_operator
     *   (optional) Either self::EQUAL or self::NOT_EQUAL. Defaults to
     *   self::EQUAL.
     */
    protected function queryOpBoolean($field, $query_operator = self::EQUAL) {
        if (empty($this->value)) {
            if ($this->accept_null) {
                if ($query_operator === self::EQUAL) {
                    $condition = (new Condition('OR'))->condition($field, 0, $query_operator)
                        ->isNull($field);
                }
                else {
                    $condition = (new Condition('AND'))->condition($field, 0, $query_operator)
                        ->isNotNull($field);
                }
                $this->query
                    ->addWhere($this->options['group'], $condition);
            }
            else {
                $this->query
                    ->addWhere($this->options['group'], $field, 0, $query_operator);
            }
        }
        else {
            if (!empty($this->definition['use_equal'])) {
                // Forces a self::EQUAL operator instead of a self::NOT_EQUAL for
                // performance reasons.
                if ($query_operator === self::EQUAL) {
                    $this->query
                        ->addWhere($this->options['group'], $field, 1, self::EQUAL);
                }
                else {
                    $this->query
                        ->addWhere($this->options['group'], $field, 0, self::EQUAL);
                }
            }
            else {
                $this->query
                    ->addWhere($this->options['group'], $field, 1, $query_operator);
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BooleanOperator::$accept_null public property
BooleanOperator::$alwaysMultiple protected property Disable the possibility to force a single value. Overrides FilterPluginBase::$alwaysMultiple
BooleanOperator::adminSummary public function Display the filter on the administrative summary Overrides FilterPluginBase::adminSummary
BooleanOperator::defaultExposeOptions public function Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
BooleanOperator::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides FilterPluginBase::defineOptions
BooleanOperator::EQUAL constant The equal query operator.
BooleanOperator::getValueOptions public function Return the possible options for this filter.
BooleanOperator::init public function Overrides \Drupal\views\Plugin\views\HandlerBase::init(). Overrides FilterPluginBase::init 1
BooleanOperator::NOT_EQUAL constant The non equal query operator.
BooleanOperator::operatorOptions public function Provide a list of options for the default operator form.
Should be overridden by classes that don&#039;t override operatorForm
Overrides FilterPluginBase::operatorOptions
BooleanOperator::operators protected function Returns an array of operator information.
BooleanOperator::query public function Add this filter to the query. Overrides FilterPluginBase::query 3
BooleanOperator::queryOpBoolean protected function Adds a where condition to the query for a boolean value.
BooleanOperator::valueForm protected function Options form subform for setting options. Overrides FilterPluginBase::valueForm
BooleanOperator::valueValidate protected function Validate the options form. Overrides FilterPluginBase::valueValidate
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
FilterPluginBase::$always_required public property Disable the possibility to allow a exposed input to be optional.
FilterPluginBase::$group_info public property Contains the information of the selected item in a grouped filter.
FilterPluginBase::$no_operator public property Disable the possibility to use operators. 1
FilterPluginBase::$operator public property Contains the operator which is used on the query.
FilterPluginBase::$value public property Contains the actual value of the field,either configured in the views ui
or entered in the exposed filters.
FilterPluginBase::acceptExposedInput public function Determines if the input from a filter should change the generated query. Overrides HandlerBase::acceptExposedInput 2
FilterPluginBase::addGroupForm public function Add a new group to the exposed filter groups.
FilterPluginBase::arrayFilterZero protected static function Filter by no empty values, though allow the use of (string) &quot;0&quot;.
FilterPluginBase::buildExposedFiltersGroupForm protected function Build the form to let users create the group of exposed filters.
This form is displayed when users click on button &#039;Build group&#039;
FilterPluginBase::buildExposedForm public function Render our chunk of the exposed filter form when selecting Overrides HandlerBase::buildExposedForm
FilterPluginBase::buildExposeForm public function Options form subform for exposed filter options. Overrides HandlerBase::buildExposeForm 4
FilterPluginBase::buildGroupForm public function Displays the Build Group form.
FilterPluginBase::buildGroupOptions protected function Provide default options for exposed filters.
FilterPluginBase::buildGroupSubmit protected function Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupValidate protected function Validate the build group options form.
FilterPluginBase::buildOptionsForm 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::buildOptionsForm 2
FilterPluginBase::canBuildGroup protected function Determine if a filter can be converted into a group.
Only exposed filters with operators available can be converted into groups.
FilterPluginBase::canExpose public function Determine if a filter can be exposed. Overrides HandlerBase::canExpose 5
FilterPluginBase::canGroup public function Can this filter be used in OR groups? 1
FilterPluginBase::convertExposedInput public function Transform the input from a grouped filter into a standard filter.
FilterPluginBase::exposedInfo 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::exposedInfo
FilterPluginBase::exposedTranslate protected function Make some translations to a form item to make it more suitable to
exposing.
FilterPluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 7
FilterPluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
FilterPluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 1
FilterPluginBase::groupForm public function Build a form containing a group of operator | values to apply as a
single filter.
FilterPluginBase::groupMultipleExposedInput 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::hasValidGroupedValue protected function Determines if the given grouped filter entry has a valid value. 1
FilterPluginBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase::isAGroup
FilterPluginBase::multipleExposedInput public function Returns TRUE if users can select multiple groups items of a
grouped exposed filter.
Overrides HandlerBase::multipleExposedInput
FilterPluginBase::operatorForm protected function Options form subform for setting the operator. 6
FilterPluginBase::operatorSubmit 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::operatorValidate protected function Validate the operator form.
FilterPluginBase::prepareFilterSelectOptions protected function Sanitizes the HTML select element&#039;s options.
FilterPluginBase::showBuildGroupButton protected function Shortcut to display the build_group/hide button.
FilterPluginBase::showBuildGroupForm public function Shortcut to display the exposed options form.
FilterPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
FilterPluginBase::showOperatorForm public function Shortcut to display the operator form.
FilterPluginBase::showValueForm protected function Shortcut to display the value form.
FilterPluginBase::storeExposedInput public function If set to remember exposed input in the session, store it there. Overrides HandlerBase::storeExposedInput
FilterPluginBase::storeGroupInput 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::submitOptionsForm public function Simple submit handler Overrides PluginBase::submitOptionsForm
FilterPluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
FilterPluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides HandlerBase::validate 2
FilterPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
FilterPluginBase::validateIdentifier protected function Validates a filter identifier.
FilterPluginBase::validateOptionsForm public function Simple validate handler Overrides PluginBase::validateOptionsForm 1
FilterPluginBase::valueSubmit 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
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler protected property The module handler. 3
HandlerBase::$query public property Where the $query object will reside: 7
HandlerBase::$realField public property The actual field in the database table, maybe different
on other kind of query plugins/special handlers.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData protected property The views data service.
HandlerBase::access public function Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access 4
HandlerBase::adminLabel public function Return a string representing this handler&#039;s name in the UI. Overrides ViewsHandlerInterface::adminLabel 4
HandlerBase::breakString public static function Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function Determines if the handler is considered &#039;broken&#039;, meaning it&#039;s a
placeholder used when a handler can&#039;t be found.
Overrides ViewsHandlerInterface::broken
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies 10
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used
a lot.
Overrides ViewsHandlerInterface::ensureMyTable 2
HandlerBase::getDateField public function Creates cross-database SQL dates. 2
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting. 2
HandlerBase::getEntityType public function Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Shortcut to get a handler&#039;s raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData protected function Gets views data service.
HandlerBase::hasExtraOptions public function If a handler has &#039;extra options&#039; it will get a little settings widget and
another form called extra_options.
1
HandlerBase::isExposed public function Determine if this item is &#039;exposed&#039;, meaning it provides form elements
to let users modify the view.
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Run before the view is built. Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship
it needs.
Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData public function
HandlerBase::showExposeForm public function Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::submitExposed public function Submit the exposed handler form
HandlerBase::submitExposeForm 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::submitExtraOptionsForm 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::submitFormCalculateOptions public function Calculates options stored on the handler 1
HandlerBase::submitGroupByForm 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::submitTemporaryForm public function A submit handler that is used for storing temporary items when using
multi-step changes, such as ajax requests.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 13
HandlerBase::validateExposed public function Validate the exposed handler form 4
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 44
PluginBase::$definition public property Plugins&#039;s definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 62
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays
so that defaults don&#039;t get totally blown away.
Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views&#039; tokens in a given string. The resulting string will be
sanitized with Xss::filterAdmin.
1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.