class Combine

Filter handler which allows to search on multiple fields.

Plugin annotation


@Plugin(
  id = "combine"
)

Hierarchy

Expanded class hierarchy of Combine

Related topics

Views field handlers
Handlers to tell Views how to build and display fields.

File

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

Namespace

Drupal\views\Plugin\views\filter
View source
class Combine extends String {

  /**
   * @var views_plugin_query_default
   */
  var $query;
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['fields'] = array(
      'default' => array(),
    );
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $this->view
      ->initStyle();

    // Allow to choose all fields as possible
    if ($this->view->style_plugin
      ->usesFields()) {
      $options = array();
      foreach ($this->view->display_handler
        ->getHandlers('field') as $name => $field) {
        $options[$name] = $field
          ->adminLabel(TRUE);
      }
      if ($options) {
        $form['fields'] = array(
          '#type' => 'select',
          '#title' => t('Choose fields to combine for filtering'),
          '#description' => t("This filter doesn't work for very special field handlers."),
          '#multiple' => TRUE,
          '#options' => $options,
          '#default_value' => $this->options['fields'],
        );
      }
      else {
        form_set_error('', t('You have to add some fields to be able to use this filter.'));
      }
    }
  }
  public function query() {
    $this->view
      ->_build('field');
    $fields = array();

    // Only add the fields if they have a proper field and table alias.
    foreach ($this->options['fields'] as $id) {
      $field = $this->view->field[$id];

      // Always add the table of the selected fields to be sure a table alias exists.
      $field
        ->ensureMyTable();
      if (!empty($field->field_alias) && !empty($field->field_alias)) {
        $fields[] = "{$field->tableAlias}.{$field->realField}";
      }
    }
    if ($fields) {
      $count = count($fields);
      $separated_fields = array();
      foreach ($fields as $key => $field) {
        $separated_fields[] = $field;
        if ($key < $count - 1) {
          $separated_fields[] = "' '";
        }
      }
      $expression = implode(', ', $separated_fields);
      $expression = "CONCAT_WS(' ', {$expression})";
      $info = $this
        ->operators();
      if (!empty($info[$this->operator]['method'])) {
        $this
          ->{$info[$this->operator]['method']}($expression);
      }
    }
  }

  // By default things like op_equal uses add_where, that doesn't support
  // complex expressions, so override all operators.
  function op_equal($field) {
    $placeholder = $this
      ->placeholder();
    $operator = $this
      ->operator();
    $this->query
      ->add_where_expression($this->options['group'], "{$field} {$operator} {$placeholder}", array(
      $placeholder => $this->value,
    ));
  }
  function op_contains($field) {
    $placeholder = $this
      ->placeholder();
    $this->query
      ->add_where_expression($this->options['group'], "{$field} LIKE {$placeholder}", array(
      $placeholder => '%' . db_like($this->value) . '%',
    ));
  }
  function op_starts($field) {
    $placeholder = $this
      ->placeholder();
    $this->query
      ->add_where_expression($this->options['group'], "{$field} LIKE {$placeholder}", array(
      $placeholder => db_like($this->value) . '%',
    ));
  }
  function op_not_starts($field) {
    $placeholder = $this
      ->placeholder();
    $this->query
      ->add_where_expression($this->options['group'], "{$field} NOT LIKE {$placeholder}", array(
      $placeholder => db_like($this->value) . '%',
    ));
  }
  function op_ends($field) {
    $placeholder = $this
      ->placeholder();
    $this->query
      ->add_where_expression($this->options['group'], "{$field} LIKE {$placeholder}", array(
      $placeholder => '%' . db_like($this->value),
    ));
  }
  function op_not_ends($field) {
    $placeholder = $this
      ->placeholder();
    $this->query
      ->add_where_expression($this->options['group'], "{$field} NOT LIKE {$placeholder}", array(
      $placeholder => '%' . db_like($this->value),
    ));
  }
  function op_not($field) {
    $placeholder = $this
      ->placeholder();
    $this->query
      ->add_where_expression($this->options['group'], "{$field} NOT LIKE {$placeholder}", array(
      $placeholder => '%' . db_like($this->value) . '%',
    ));
  }
  function op_regex($field) {
    $placeholder = $this
      ->placeholder();
    $this->query
      ->add_where_expression($this->options['group'], "{$field} RLIKE {$placeholder}", array(
      $placeholder => $this->value,
    ));
  }
  function op_empty($field) {
    if ($this->operator == 'empty') {
      $operator = "IS NULL";
    }
    else {
      $operator = "IS NOT NULL";
    }
    $this->query
      ->add_where_expression($this->options['group'], "{$field} {$operator}");
  }

}

Members

Namesort ascending Modifiers Type Description Overrides
String::value_form function Provide a simple textfield for equality Overrides FilterPluginBase::value_form
String::op_word function
String::op_shorter function
String::op_longer function
String::operator_values function
String::operator_options function Build strings from the operators() for 'select' options Overrides FilterPluginBase::operator_options
String::operators function This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array.
String::operator function
String::adminSummary public function Display the filter on the administrative summary Overrides FilterPluginBase::adminSummary
String::$always_multiple property Disable the possibility to force a single value. Overrides FilterPluginBase::$always_multiple
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::setOptionDefaults protected function
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::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::$view public property The top object of a view. 1
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$discovery protected property The discovery object.
PluginBase::$definition public property Plugins's definition
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::validateExposed public function Validate the exposed handler form 4
HandlerBase::validate public function Validates the handler against the complete View. Overrides PluginBase::validate 1
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
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::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::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::submitExposed public function Submit the exposed handler form
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::sanitizeValue protected function Sanitize the value for output.
HandlerBase::preQuery public function Run before the view is built. 1
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::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
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::getTimezone public static function Figure out what timezone we're in; needed for some date manipulations.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getSQLFormat public function Creates cross-database SQL date formatting.
HandlerBase::getSQLDateField public function Creates cross-database SQL dates.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::getEntityType public function Determines the entity type used by this handler.
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
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
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. 9
HandlerBase::access public function Check whether current user has access to this handler. 6
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$relationship public property The relationship used for this field.
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::$actualTable public property When a table has been moved this property is set.
HandlerBase::$actualField public property When a field has been moved this property is set.
FilterPluginBase::value_validate function Validate the options form. 3
FilterPluginBase::value_submit 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::validateOptionsForm public function Simple validate handler Overrides HandlerBase::validateOptionsForm 1
FilterPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
FilterPluginBase::submitOptionsForm public function Simple submit handler Overrides HandlerBase::submitOptionsForm
FilterPluginBase::store_group_input 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::show_value_form function Shortcut to display the value form.
FilterPluginBase::show_operator_form function Shortcut to display the operator form.
FilterPluginBase::show_build_group_form function Shortcut to display the exposed options form.
FilterPluginBase::show_build_group_button function Shortcut to display the build_group/hide button.
FilterPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
FilterPluginBase::prepare_filter_select_options function Sanitizes the HTML select element's options.
FilterPluginBase::operator_validate function Validate the operator form.
FilterPluginBase::operator_submit 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::operator_form function Options form subform for setting the operator. 4
FilterPluginBase::multipleExposedInput public function Returns TRUE if users can select multiple groups items of a grouped exposed filter. Overrides HandlerBase::multipleExposedInput
FilterPluginBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase::isAGroup
FilterPluginBase::init public function Provide some extra help to get the operator/value easier to use. Overrides HandlerBase::init 3
FilterPluginBase::group_multiple_exposed_input 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::group_form function Build a form containing a group of operator | values to apply as a single filter.
FilterPluginBase::exposed_translate function Make some translations to a form item to make it more suitable to exposing.
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::defaultExposeOptions public function Provide default options for exposed filters. Overrides HandlerBase::defaultExposeOptions 2
FilterPluginBase::convert_exposed_input function
FilterPluginBase::can_group function Can this filter be used in OR groups? 1
FilterPluginBase::can_build_group 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 2
FilterPluginBase::build_group_validate function Validate the build group options form. 1
FilterPluginBase::build_group_submit function Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::build_group_options function Provide default options for exposed filters.
FilterPluginBase::build_group_form 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::buildExposeForm public function Options form subform for exposed filter options. Overrides HandlerBase::buildExposeForm 2
FilterPluginBase::buildExposedForm public function Render our chunk of the exposed filter form when selecting Overrides HandlerBase::buildExposedForm
FilterPluginBase::acceptExposedInput public function Check to see if input from the exposed filters should change the behavior of this filter. Overrides HandlerBase::acceptExposedInput 2
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::$no_operator property Disable the possibility to use operators. 2
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.
Combine::query public function Add this filter to the query. Overrides String::query
Combine::op_starts function Overrides String::op_starts
Combine::op_regex function Overrides String::op_regex
Combine::op_not_starts function Overrides String::op_not_starts
Combine::op_not_ends function Overrides String::op_not_ends
Combine::op_not function Overrides String::op_not
Combine::op_equal function Overrides String::op_equal
Combine::op_ends function Overrides String::op_ends
Combine::op_empty function Overrides String::op_empty
Combine::op_contains function Overrides String::op_contains
Combine::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides String::defineOptions
Combine::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 FilterPluginBase::buildOptionsForm
Combine::$query property Overrides HandlerBase::$query