class Combine
Same name in other branches
- 8.9.x core/modules/views/src/Plugin/views/filter/Combine.php \Drupal\views\Plugin\views\filter\Combine
- 10 core/modules/views/src/Plugin/views/filter/Combine.php \Drupal\views\Plugin\views\filter\Combine
- 11.x core/modules/views/src/Plugin/views/filter/Combine.php \Drupal\views\Plugin\views\filter\Combine
Filter handler which allows to search on multiple fields.
Plugin annotation
@ViewsFilter("combine");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\filter\StringFilter extends \Drupal\views\Plugin\views\filter\FilterPluginBase
- class \Drupal\views\Plugin\views\filter\Combine extends \Drupal\views\Plugin\views\filter\StringFilter
- class \Drupal\views\Plugin\views\filter\StringFilter extends \Drupal\views\Plugin\views\filter\FilterPluginBase
- class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Combine
Related topics
18 string references to 'Combine'
- FilterCombineTest::testFilterCombineAllWords in core/
modules/ views/ tests/ src/ Kernel/ Handler/ FilterCombineTest.php - Tests the Combine field filter with the 'allwords' operator.
- FilterCombineTest::testFilterCombineContains in core/
modules/ views/ tests/ src/ Kernel/ Handler/ FilterCombineTest.php - FilterCombineTest::testFilterCombineContainsFieldsOverwritten in core/
modules/ views/ tests/ src/ Kernel/ Handler/ FilterCombineTest.php - Tests if the filter can handle removed fields.
- FilterCombineTest::testFilterCombineEnds in core/
modules/ views/ tests/ src/ Kernel/ Handler/ FilterCombineTest.php - Tests the Combine field filter using the 'ends' operator.
- FilterCombineTest::testFilterCombineEqual in core/
modules/ views/ tests/ src/ Kernel/ Handler/ FilterCombineTest.php - Tests the Combine field filter using the 'equal' operator.
File
-
core/
modules/ views/ src/ Plugin/ views/ filter/ Combine.php, line 14
Namespace
Drupal\views\Plugin\views\filterView source
class Combine extends StringFilter {
/**
* @var \Drupal\views\Plugin\views\query\QueryPluginBase
*/
public $query;
protected function defineOptions() {
$options = parent::defineOptions();
$options['fields'] = [
'default' => [],
];
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$this->view
->initStyle();
// Allow to choose all fields as possible
if ($this->view->style_plugin
->usesFields()) {
$options = [];
foreach ($this->view->display_handler
->getHandlers('field') as $name => $field) {
// Only allow clickSortable fields. Fields without clickSorting will
// probably break in the Combine filter.
if ($field->clickSortable()) {
$options[$name] = $field->adminLabel(TRUE);
}
}
if ($options) {
$form['fields'] = [
'#type' => 'select',
'#title' => $this->t('Choose fields to combine for filtering'),
'#description' => $this->t("This filter doesn't work for very special field handlers."),
'#multiple' => TRUE,
'#options' => $options,
'#default_value' => $this->options['fields'],
];
}
else {
$form_state->setErrorByName('', $this->t('You have to add some fields to be able to use this filter.'));
}
}
}
public function query() {
$this->view
->_build('field');
$fields = [];
// Only add the fields if they have a proper field and table alias.
foreach ($this->options['fields'] as $id) {
// Overridden fields can lead to fields missing from a display that are
// still set in the non-overridden combined filter.
if (!isset($this->view->field[$id])) {
// If fields are no longer available that are needed to filter by, make
// sure no results are shown to prevent displaying more then intended.
$this->view->build_info['fail'] = TRUE;
continue;
}
$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->tableAlias) && !empty($field->realField)) {
$fields[] = "{$field->tableAlias}.{$field->realField}";
}
}
if ($fields) {
// We do not use the CONCAT_WS operator when there is only a single field.
// Using the CONCAT_WS operator with a single field is not a problem for
// the by core supported databases. Only the MS SQL Server requires the
// CONCAT_WS operator to be used with at least three arguments.
if (count($fields) == 1) {
$expression = reset($fields);
}
else {
// Multiple fields are separated by 3 spaces so that so that search
// strings that contain spaces are still only matched to single field
// values and not to multi-field values that exist only because we do
// the concatenation/LIKE trick.
$expression = implode(", ' ', ", $fields);
$expression = "CONCAT_WS(' ', {$expression})";
}
$info = $this->operators();
if (!empty($info[$this->operator]['method'])) {
$this->{$info[$this->operator]['method']}($expression);
}
}
}
/**
* {@inheritdoc}
*/
public function validate() {
$errors = parent::validate();
if ($this->displayHandler
->usesFields()) {
$fields = $this->displayHandler
->getHandlers('field');
foreach ($this->options['fields'] as $id) {
if (!isset($fields[$id])) {
// Combined field filter only works with fields that are in the field
// settings.
$errors[] = $this->t('Field %field set in %filter is not set in display %display.', [
'%field' => $id,
'%filter' => $this->adminLabel(),
'%display' => $this->displayHandler->display['display_title'],
]);
break;
}
elseif (!$fields[$id]->clickSortable()) {
// Combined field filter only works with simple fields. If the field
// is not click sortable we can assume it is not a simple field.
// @todo change this check to isComputed. See
// https://www.drupal.org/node/2349465
$errors[] = $this->t('Field %field set in %filter is not usable for this filter type. Combined field filter only works for simple fields.', [
'%field' => $fields[$id]->adminLabel(),
'%filter' => $this->adminLabel(),
]);
}
}
}
else {
$errors[] = $this->t('%display: %filter can only be used on displays that use fields. Set the style or row format for that display to one using fields to use the combine field filter.', [
'%display' => $this->displayHandler->display['display_title'],
'%filter' => $this->adminLabel(),
]);
}
return $errors;
}
/**
* {@inheritdoc}
*/
public function opEqual($expression) {
// By default, things like opEqual uses add_where, that doesn't support
// complex expressions, so override opEqual (and all operators below).
$placeholder = $this->placeholder();
$operator = $this->getConditionOperator($this->operator());
$this->query
->addWhereExpression($this->options['group'], "{$expression} {$operator} {$placeholder}", [
$placeholder => $this->value,
]);
}
protected function opContains($expression) {
$placeholder = $this->placeholder();
$operator = $this->getConditionOperator('LIKE');
$this->query
->addWhereExpression($this->options['group'], "{$expression} {$operator} {$placeholder}", [
$placeholder => '%' . $this->connection
->escapeLike($this->value) . '%',
]);
}
/**
* Filters by one or more words.
*
* By default opContainsWord uses add_where, that doesn't support complex
* expressions.
*
* @param string $expression
* The expression to add to the query.
*/
protected function opContainsWord($expression) {
$placeholder = $this->placeholder();
// Don't filter on empty strings.
if (empty($this->value)) {
return;
}
// Match all words separated by spaces or sentences encapsulated by double
// quotes.
preg_match_all(static::WORDS_PATTERN, ' ' . $this->value, $matches, PREG_SET_ORDER);
// Switch between the 'word' and 'allwords' operator.
$type = $this->operator == 'word' ? 'OR' : 'AND';
$group = $this->query
->setWhereGroup($type);
$operator = $this->getConditionOperator('LIKE');
foreach ($matches as $match_key => $match) {
$temp_placeholder = $placeholder . '_' . $match_key;
// Clean up the user input and remove the sentence delimiters.
$word = trim($match[2], ',?!();:-"');
$this->query
->addWhereExpression($group, "{$expression} {$operator} {$temp_placeholder}", [
$temp_placeholder => '%' . $this->connection
->escapeLike($word) . '%',
]);
}
}
protected function opStartsWith($expression) {
$placeholder = $this->placeholder();
$operator = $this->getConditionOperator('LIKE');
$this->query
->addWhereExpression($this->options['group'], "{$expression} {$operator} {$placeholder}", [
$placeholder => $this->connection
->escapeLike($this->value) . '%',
]);
}
protected function opNotStartsWith($expression) {
$placeholder = $this->placeholder();
$operator = $this->getConditionOperator('NOT LIKE');
$this->query
->addWhereExpression($this->options['group'], "{$expression} {$operator} {$placeholder}", [
$placeholder => $this->connection
->escapeLike($this->value) . '%',
]);
}
protected function opEndsWith($expression) {
$placeholder = $this->placeholder();
$operator = $this->getConditionOperator('LIKE');
$this->query
->addWhereExpression($this->options['group'], "{$expression} {$operator} {$placeholder}", [
$placeholder => '%' . $this->connection
->escapeLike($this->value),
]);
}
protected function opNotEndsWith($expression) {
$placeholder = $this->placeholder();
$operator = $this->getConditionOperator('NOT LIKE');
$this->query
->addWhereExpression($this->options['group'], "{$expression} {$operator} {$placeholder}", [
$placeholder => '%' . $this->connection
->escapeLike($this->value),
]);
}
protected function opNotLike($expression) {
$placeholder = $this->placeholder();
$operator = $this->getConditionOperator('NOT LIKE');
$this->query
->addWhereExpression($this->options['group'], "{$expression} {$operator} {$placeholder}", [
$placeholder => '%' . $this->connection
->escapeLike($this->value) . '%',
]);
}
protected function opRegex($expression) {
$placeholder = $this->placeholder();
$this->query
->addWhereExpression($this->options['group'], "{$expression} REGEXP {$placeholder}", [
$placeholder => $this->value,
]);
}
protected function opEmpty($expression) {
if ($this->operator == 'empty') {
$operator = "IS NULL";
}
else {
$operator = "IS NOT NULL";
}
$this->query
->addWhereExpression($this->options['group'], "{$expression} {$operator}");
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Combine::$query | public | property | Overrides HandlerBase::$query | ||
Combine::buildOptionsForm | public | function | Provide the basic form which calls through to subforms. | Overrides FilterPluginBase::buildOptionsForm | |
Combine::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides StringFilter::defineOptions | |
Combine::opContains | protected | function | Overrides StringFilter::opContains | ||
Combine::opContainsWord | protected | function | Filters by one or more words. | Overrides StringFilter::opContainsWord | |
Combine::opEmpty | protected | function | Overrides StringFilter::opEmpty | ||
Combine::opEndsWith | protected | function | Overrides StringFilter::opEndsWith | ||
Combine::opEqual | public | function | Adds a where clause for the operation, 'equals'. | Overrides StringFilter::opEqual | |
Combine::opNotEndsWith | protected | function | Overrides StringFilter::opNotEndsWith | ||
Combine::opNotLike | protected | function | Overrides StringFilter::opNotLike | ||
Combine::opNotStartsWith | protected | function | Overrides StringFilter::opNotStartsWith | ||
Combine::opRegex | protected | function | Filters by a regular expression. | Overrides StringFilter::opRegex | |
Combine::opStartsWith | protected | function | Overrides StringFilter::opStartsWith | ||
Combine::query | public | function | Add this filter to the query. | Overrides StringFilter::query | |
Combine::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides FilterPluginBase::validate | |
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 an 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 | The value. | ||
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) "0". | ||
FilterPluginBase::buildExposedFiltersGroupForm | protected | function | Build the form to let users create the group of exposed filters. | ||
FilterPluginBase::buildExposedForm | public | function | Render our chunk of the exposed filter form when selecting. | Overrides HandlerBase::buildExposedForm | |
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::buildValueWrapper | protected | function | Builds wrapper for value and operator forms. | ||
FilterPluginBase::canBuildGroup | protected | function | Determine if a filter can be converted into a group. | ||
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. | 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 | Builds a group form. | ||
FilterPluginBase::groupMultipleExposedInput | public | function | Group multiple exposed input. | ||
FilterPluginBase::hasValidGroupedValue | protected | function | Determines if the given grouped filter entry has a valid value. | 1 | |
FilterPluginBase::init | public | function | Overrides \Drupal\views\Plugin\views\HandlerBase::init(). | Overrides HandlerBase::init | 4 |
FilterPluginBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | Overrides HandlerBase::isAGroup | |
FilterPluginBase::multipleExposedInput | public | function | Multiple exposed input. | 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. | ||
FilterPluginBase::operatorValidate | protected | function | Validate the operator form. | ||
FilterPluginBase::prepareFilterSelectOptions | protected | function | Sanitizes the HTML select element'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. | ||
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::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. | 1 | |
FilterPluginBase::valueValidate | protected | function | Validate the options form. | 3 | |
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::$realField | public | property | The real field. | ||
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'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 'broken'. | 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 | Ensures that the main table for this handler is in the query. | 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'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 | Determines if the handler has extra options. | 1 | |
HandlerBase::isExposed | public | function | Determine if this item is 'exposed'. | ||
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 | Sets up any needed relationship. | 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. | ||
HandlerBase::submitExtraOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | ||
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. | 1 | |
HandlerBase::submitTemporaryForm | public | function | Submits a temporary form. | ||
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. | ||
PluginBase::$definition | public | property | Plugins' 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::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 | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | |
PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 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 | |
StringFilter::$alwaysMultiple | protected | property | Exposed filter options. | Overrides FilterPluginBase::$alwaysMultiple | |
StringFilter::$connection | protected | property | The database connection. | ||
StringFilter::adminSummary | public | function | Display the filter on the administrative summary. | Overrides FilterPluginBase::adminSummary | |
StringFilter::buildExposeForm | public | function | Options form subform for exposed filter options. | Overrides FilterPluginBase::buildExposeForm | |
StringFilter::create | public static | function | Creates an instance of the plugin. | Overrides PluginBase::create | |
StringFilter::defaultExposeOptions | public | function | Provide default options for exposed filters. | Overrides FilterPluginBase::defaultExposeOptions | |
StringFilter::getConditionOperator | protected | function | Get specified condition operator mapping value. | ||
StringFilter::operator | public | function | Get the query operator. | ||
StringFilter::operatorOptions | public | function | Build strings from the operators() for 'select' options. | Overrides FilterPluginBase::operatorOptions | |
StringFilter::operators | public | function | Get the operators. | ||
StringFilter::operatorValues | protected | function | |||
StringFilter::opLongerThan | protected | function | |||
StringFilter::opShorterThan | protected | function | |||
StringFilter::valueForm | protected | function | Provide a simple textfield for equality. | Overrides FilterPluginBase::valueForm | |
StringFilter::WORDS_PATTERN | constant | All words separated by spaces or sentences encapsulated by double quotes. | |||
StringFilter::__construct | public | function | Constructs a new StringFilter object. | Overrides HandlerBase::__construct | |
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.