Field handler to provide simple renderer that allows linking to a node.
@Plugin(
id = "search",
module = "search"
)
Expanded class hierarchy of Search
class Search extends FilterPluginBase {
var $always_multiple = TRUE;
/**
* Stores an extended query extender from the search module.
*
* This value extends the query extender to be able to provide methods
* which returns the protected values.
*
* @var Drupal\search\ViewsSearchQuery
*/
var $search_query = NULL;
/**
* Checks if the search query has been parsed.
*/
var $parsed = FALSE;
protected function defineOptions() {
$options = parent::defineOptions();
$options['operator']['default'] = 'optional';
return $options;
}
/**
* Provide simple equality operator
*/
function operator_form(&$form, &$form_state) {
$form['operator'] = array(
'#type' => 'radios',
'#title' => t('On empty input'),
'#default_value' => $this->operator,
'#options' => array(
'optional' => t('Show All'),
'required' => t('Show None'),
),
);
}
/**
* Provide a simple textfield for equality
*/
function value_form(&$form, &$form_state) {
$form['value'] = array(
'#type' => 'textfield',
'#size' => 15,
'#default_value' => $this->value,
'#attributes' => array(
'title' => t('Enter the terms you wish to search for.'),
),
'#title' => empty($form_state['exposed']) ? t('Value') : '',
);
}
/**
* Validate the options form.
*/
public function validateExposed(&$form, &$form_state) {
if (!isset($this->options['expose']['identifier'])) {
return;
}
$key = $this->options['expose']['identifier'];
if (!empty($form_state['values'][$key])) {
$this
->query_parse_search_expression($form_state['values'][$key]);
if (count($this->search_query
->words()) == 0) {
form_set_error($key, format_plural(config('search.settings')
->get('index.minimum_word_size'), 'You must include at least one positive keyword with 1 character or more.', 'You must include at least one positive keyword with @count characters or more.'));
}
}
}
/**
* Take sure that parseSearchExpression is runned and everything is set up for it.
*
* @param $input
* The search phrase which was input by the user.
*/
function query_parse_search_expression($input) {
if (!isset($this->search_query)) {
$this->parsed = TRUE;
$this->search_query = db_select('search_index', 'i', array(
'target' => 'slave',
))
->extend('Drupal\\search\\ViewsSearchQuery');
$this->search_query
->searchExpression($input, $this->view->base_table);
$this->search_query
->publicParseSearchExpression();
}
}
/**
* Add this filter to the query.
*
* Due to the nature of fapi, the value and the operator have an unintended
* level of indirection. You will find them in $this->operator
* and $this->value respectively.
*/
public function query() {
// Since attachment views don't validate the exposed input, parse the search
// expression if required.
if (!$this->parsed) {
$this
->query_parse_search_expression($this->value);
}
$required = FALSE;
if (!isset($this->search_query)) {
$required = TRUE;
}
else {
$words = $this->search_query
->words();
if (empty($words)) {
$required = TRUE;
}
}
if ($required) {
if ($this->operator == 'required') {
$this->query
->add_where($this->options['group'], 'FALSE');
}
}
else {
$search_index = $this
->ensureMyTable();
$search_condition = db_and();
// Create a new join to relate the 'serach_total' table to our current 'search_index' table.
$definition = array(
'table' => 'search_total',
'field' => 'word',
'left_table' => $search_index,
'left_field' => 'word',
);
$join = drupal_container()
->get('plugin.manager.views.join')
->createInstance('standard', $definition);
$search_total = $this->query
->add_relationship('search_total', $join, $search_index);
$this->search_score = $this->query
->add_field('', "SUM({$search_index}.score * {$search_total}.count)", 'score', array(
'aggregate' => TRUE,
));
if (empty($this->query->relationships[$this->relationship])) {
$base_table = $this->view->storage
->get('base_table');
}
else {
$base_table = $this->query->relationships[$this->relationship]['base'];
}
$search_condition
->condition("{$search_index}.type", $base_table);
if (!$this->search_query
->simple()) {
$search_dataset = $this->query
->add_table('search_dataset');
$conditions = $this->search_query
->conditions();
$condition_conditions =& $conditions
->conditions();
foreach ($condition_conditions as $key => &$condition) {
// Take sure we just look at real conditions.
if (is_numeric($key)) {
// Replace the conditions with the table alias of views.
$this->search_query
->condition_replace_string('d.', "{$search_dataset}.", $condition);
}
}
$search_conditions =& $search_condition
->conditions();
$search_conditions = array_merge($search_conditions, $condition_conditions);
}
else {
// Stores each condition, so and/or on the filter level will still work.
$or = db_or();
foreach ($words as $word) {
$or
->condition("{$search_index}.word", $word);
}
$search_condition
->condition($or);
}
$this->query
->add_where($this->options['group'], $search_condition);
$this->query
->add_groupby("{$search_index}.sid");
$matches = $this->search_query
->matches();
$placeholder = $this
->placeholder();
$this->query
->add_having_expression($this->options['group'], "COUNT(*) >= {$placeholder}", array(
$placeholder => $matches,
));
}
// Set to NULL to prevent PDO exception when views object is cached.
$this->search_query = NULL;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FilterPluginBase:: |
property | Disable the possibility to allow a exposed input to be optional. | ||
FilterPluginBase:: |
property | Contains the information of the selected item in a gruped filter. | ||
FilterPluginBase:: |
property | Disable the possibility to use operators. | 2 | |
FilterPluginBase:: |
property | Contains the operator which is used on the query. | ||
FilterPluginBase:: |
property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. | ||
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 |
Display the filter on the administrative summary Overrides HandlerBase:: |
7 |
FilterPluginBase:: |
public | function |
Render our chunk of the exposed filter form when selecting Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Options form subform for exposed filter options. Overrides HandlerBase:: |
2 |
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:: |
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 | Provide default options for exposed filters. | ||
FilterPluginBase:: |
function | Save new group items, re-enumerates and remove groups marked to delete. | ||
FilterPluginBase:: |
function | Validate the build group options form. | 1 | |
FilterPluginBase:: |
public | function |
Determine if a filter can be exposed. Overrides HandlerBase:: |
2 |
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 | Can this filter be used in OR groups? | 1 | |
FilterPluginBase:: |
function | |||
FilterPluginBase:: |
public | function |
Provide default options for exposed filters. Overrides HandlerBase:: |
2 |
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:: |
function | Make some translations to a form item to make it more suitable to exposing. | ||
FilterPluginBase:: |
function | Build a form containing a group of operator | values to apply as a single filter. | ||
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:: |
public | function |
Provide some extra help to get the operator/value easier to use. Overrides HandlerBase:: |
3 |
FilterPluginBase:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
function | Provide a list of options for the default operator form. Should be overridden by classes that don't override operator_form | 4 | |
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 | Validate the operator form. | ||
FilterPluginBase:: |
function | Sanitizes the HTML select element's options. | ||
FilterPluginBase:: |
public | function |
Shortcut to display the expose/hide button. Overrides HandlerBase:: |
|
FilterPluginBase:: |
function | Shortcut to display the build_group/hide button. | ||
FilterPluginBase:: |
function | Shortcut to display the exposed options form. | ||
FilterPluginBase:: |
function | Shortcut to display the operator form. | ||
FilterPluginBase:: |
function | Shortcut to display the value form. | ||
FilterPluginBase:: |
public | function |
If set to remember exposed input in the session, store it there. Overrides HandlerBase:: |
|
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:: |
public | function |
Simple submit handler Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Simple validate handler Overrides HandlerBase:: |
1 |
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 | Validate the options form. | 3 | |
HandlerBase:: |
public | property | When a field has been moved this property is set. | |
HandlerBase:: |
public | property | When a table has been moved this property is set. | |
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
public | property | Where the $query object will reside: | 1 |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
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 | function | Check whether current user has access to this handler. | 6 |
HandlerBase:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
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 | 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 | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
HandlerBase:: |
public | function | Determines the entity type used by this handler. | |
HandlerBase:: |
public | function | Shortcut to get a handler's raw field value. | |
HandlerBase:: |
public | function | Get the join object that should be used for this handler. | |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
HandlerBase:: |
public static | function | Figure out what timezone we're in; needed for some date manipulations. | |
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 | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function | Run after the view is executed, before the result is cached. | |
HandlerBase:: |
public | function | Run before the view is built. | 1 |
HandlerBase:: |
protected | function | Sanitize the value for output. | |
HandlerBase:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
HandlerBase:: |
public | function | Shortcut to display the exposed options form. | |
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 | 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 | 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 | Provides the handler some groupby. | 2 |
HandlerBase:: |
public | function |
Validates the handler against the complete View. Overrides PluginBase:: |
1 |
HandlerBase:: |
public | function | Validate the options form. | |
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
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 | Returns the usesOptions property. | 8 |
Search:: |
property |
Disable the possibility to force a single value. Overrides FilterPluginBase:: |
||
Search:: |
property | Checks if the search query has been parsed. | ||
Search:: |
property | Stores an extended query extender from the search module. | ||
Search:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides FilterPluginBase:: |
|
Search:: |
function |
Provide simple equality operator Overrides FilterPluginBase:: |
||
Search:: |
public | function |
Add this filter to the query. Overrides FilterPluginBase:: |
|
Search:: |
function | Take sure that parseSearchExpression is runned and everything is set up for it. | ||
Search:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
Search:: |
function |
Provide a simple textfield for equality Overrides FilterPluginBase:: |