class 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

@PluginID("boolean");

Hierarchy

Expanded class hierarchy of BooleanOperator

Related topics

1 file declares its use of BooleanOperator
Current.php in drupal/core/modules/user/lib/Drupal/user/Plugin/views/filter/Current.php
Definition of views_handler_filter_user_current.

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/filter/BooleanOperator.php, line 32
Definition of Drupal\views\Plugin\views\filter\BooleanOperator.

Namespace

Drupal\views\Plugin\views\filter
View source
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, '<>');
      }
    }
  }

}

Members

Name Modifiers Type Description Overridessort ascending
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. 9
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
HandlerBase::access public function Check whether current user has access to this handler. 6
HandlerBase::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
FilterPluginBase::operatorOptions public function Provide a list of options for the default operator form. Should be overridden by classes that don't override operatorForm 4
HandlerBase::validateExposed public function Validate the exposed handler form 4
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 3
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 3
BooleanOperator::query public function Add this filter to the query. Overrides FilterPluginBase::query 2
FilterPluginBase::canExpose public function Determine if a filter can be exposed. Overrides HandlerBase::canExpose 2
FilterPluginBase::buildExposeForm public function Options form subform for exposed filter options. Overrides HandlerBase::buildExposeForm 2
FilterPluginBase::acceptExposedInput public function Check to see if input from the exposed filters should change the behavior of this filter. Overrides HandlerBase::acceptExposedInput 2
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
PluginBase::destroy public function Clears a plugin. 2
BooleanOperator::init public function Overrides \Drupal\views\Plugin\views\filter\FilterPluginBase::init(). Overrides FilterPluginBase::init 1
FilterPluginBase::validateOptionsForm public function Simple validate handler Overrides HandlerBase::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
FilterPluginBase::buildGroupValidate protected function Validate the build group options form. 1
FilterPluginBase::canGroup public function Can this filter be used in OR groups? 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 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::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::validate public function Validates the handler against the complete View. Overrides PluginBase::validate 1
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
HandlerBase::$query public property Where the $query object will reside: 1
PluginBase::$view public property The top object of a view. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
BooleanOperator::getValueOptions public function Return the possible options for this filter.
BooleanOperator::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides FilterPluginBase::defineOptions
BooleanOperator::operatorForm protected function Options form subform for setting the operator. Overrides FilterPluginBase::operatorForm
BooleanOperator::valueForm protected function Options form subform for setting options. Overrides FilterPluginBase::valueForm
BooleanOperator::valueValidate protected function Validate the options form. Overrides FilterPluginBase::valueValidate
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
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::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase::isAGroup
FilterPluginBase::submitOptionsForm public function Simple submit handler Overrides HandlerBase::submitOptionsForm
FilterPluginBase::showOperatorForm public function Shortcut to display the operator form.
FilterPluginBase::operatorValidate protected function Validate the operator form.
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::showValueForm protected function Shortcut to display the value form.
FilterPluginBase::showBuildGroupForm public function Shortcut to display the exposed options form.
FilterPluginBase::showBuildGroupButton protected function Shortcut to display the build_group/hide button.
FilterPluginBase::buildGroupForm public function Displays the Build Group form.
FilterPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
FilterPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
FilterPluginBase::buildGroupSubmit protected function Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupOptions protected function Provide default options for exposed filters.
FilterPluginBase::groupForm public function Build a form containing a group of operator | values to apply as a single filter.
FilterPluginBase::buildExposedForm public function Render our chunk of the exposed filter form when selecting Overrides HandlerBase::buildExposedForm
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 'Build group'
FilterPluginBase::addGroupForm public function Add a new group to the exposed filter groups.
FilterPluginBase::exposedTranslate protected function Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::prepareFilterSelectOptions protected function Sanitizes the HTML select element's options.
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::convertExposedInput public function
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::multipleExposedInput public function Returns TRUE if users can select multiple groups items of a grouped exposed filter. Overrides HandlerBase::multipleExposedInput
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::storeExposedInput public function If set to remember exposed input in the session, store it there. Overrides HandlerBase::storeExposedInput
FilterPluginBase::arrayFilterZero protected static function Filter by no empty values, though allow to use "0".
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::sanitizeValue public function Sanitize the value for output.
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::validateExtraOptionsForm public function Validate the options form.
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::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::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached.
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting.
HandlerBase::getDateField public function Creates cross-database SQL dates.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getEntityType public function Determines the entity type used by this handler.
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::submitTemporaryForm public function A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
BooleanOperator::$always_multiple property Disable the possibility to force a single value. Overrides FilterPluginBase::$always_multiple
BooleanOperator::$no_operator property Disable the possibility to use operators. Overrides FilterPluginBase::$no_operator
BooleanOperator::$accept_null property
FilterPluginBase::$value property Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::$operator property Contains the operator which is used on the query.
FilterPluginBase::$group_info property Contains the information of the selected item in a gruped filter.
FilterPluginBase::$always_required property Disable the possibility to allow a exposed input to be optional.
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::$actualTable public property When a table has been moved this property is set.
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$relationship public property The relationship used for this field.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$definition public property Plugins's definition
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$pluginDefinition protected property The plugin implementation definition.