Filter handler which allows to search on multiple fields.
@Plugin(
id = "combine"
)
Expanded class hierarchy of Combine
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}");
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Combine:: |
function |
Overrides String:: |
||
Combine:: |
function |
Overrides String:: |
||
Combine:: |
function |
Overrides String:: |
||
Combine:: |
function |
Overrides String:: |
||
Combine:: |
function |
Overrides String:: |
||
Combine:: |
function |
Overrides String:: |
||
Combine:: |
function |
Overrides String:: |
||
Combine:: |
function |
Overrides String:: |
||
Combine:: |
function |
Overrides String:: |
||
String:: |
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:: |
function |
Build strings from the operators() for 'select' options Overrides FilterPluginBase:: |
||
String:: |
function | |||
String:: |
function |
Provide a simple textfield for equality Overrides FilterPluginBase:: |
||
String:: |
function | |||
String:: |
function | |||
String:: |
function | |||
String:: |
function | |||
FilterPluginBase:: |
function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | ||
FilterPluginBase:: |
function | Shortcut to display the operator form. | ||
FilterPluginBase:: |
function | Options form subform for setting the operator. | 4 | |
FilterPluginBase:: |
function | Validate the operator form. | ||
FilterPluginBase:: |
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:: |
function | Shortcut to display the value form. | ||
FilterPluginBase:: |
function | Validate the options form. | 3 | |
FilterPluginBase:: |
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:: |
function | Shortcut to display the exposed options form. | ||
FilterPluginBase:: |
function | Shortcut to display the build_group/hide button. | ||
FilterPluginBase:: |
function | Validate the build group options form. | 1 | |
FilterPluginBase:: |
function | Save new group items, re-enumerates and remove groups marked to delete. | ||
FilterPluginBase:: |
function | Provide default options for exposed filters. | ||
FilterPluginBase:: |
function | Build a form containing a group of operator | values to apply as a single filter. | ||
FilterPluginBase:: |
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:: |
function | Make some translations to a form item to make it more suitable to exposing. | ||
FilterPluginBase:: |
function | Sanitizes the HTML select element's options. | ||
FilterPluginBase:: |
function | |||
FilterPluginBase:: |
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:: |
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:: |
function | Can this filter be used in OR groups? | 1 | |
Combine:: |
property |
Overrides HandlerBase:: |
||
String:: |
property |
Disable the possibility to force a single value. Overrides FilterPluginBase:: |
||
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 use operators. | 2 | |
FilterPluginBase:: |
property | Disable the possibility to allow a exposed input to be optional. | ||
Combine:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides String:: |
|
HandlerBase:: |
protected | function | Sanitize the value for output. | |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
PluginBase:: |
protected | function | ||
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
Combine:: |
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:: |
|
Combine:: |
public | function |
Add this filter to the query. Overrides String:: |
|
String:: |
public | function |
Display the filter on the administrative summary Overrides FilterPluginBase:: |
|
FilterPluginBase:: |
public | function |
Provide some extra help to get the operator/value easier to use. Overrides HandlerBase:: |
3 |
FilterPluginBase:: |
public | function |
Determine if a filter can be exposed. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Simple validate handler Overrides HandlerBase:: |
1 |
FilterPluginBase:: |
public | function |
Simple submit handler Overrides HandlerBase:: |
|
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:: |
public | function |
Provide default options for exposed filters. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function |
Render our chunk of the exposed filter form when selecting Overrides HandlerBase:: |
|
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 |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides HandlerBase:: |
|
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:: |
|
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
|
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 | 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:: |
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 | function | Determines the entity type used by this handler. | |
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 | Provide a list of additional theme functions for the theme information page | |
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. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
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 | |
HandlerBase:: |
public static | function | Figure out what timezone we're in; needed for some date manipulations. | |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
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. |