class StringFilter

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/filter/StringFilter.php \Drupal\views\Plugin\views\filter\StringFilter
  2. 8.9.x core/modules/views/src/Plugin/views/filter/StringFilter.php \Drupal\views\Plugin\views\filter\StringFilter
  3. 10 core/modules/views/src/Plugin/views/filter/StringFilter.php \Drupal\views\Plugin\views\filter\StringFilter

Basic textfield filter to handle string filtering commands.

Including equality, like, not like, etc.

Hierarchy

Expanded class hierarchy of StringFilter

Related topics

File

core/modules/views/src/Plugin/views/filter/StringFilter.php, line 17

Namespace

Drupal\views\Plugin\views\filter
View source
class StringFilter extends FilterPluginBase implements FilterOperatorsInterface {
    
    /**
     * All words separated by spaces or sentences encapsulated by double quotes.
     */
    const WORDS_PATTERN = '/ (-?)("[^"]+"|[^" ]+)/i';
    
    /**
     * Exposed filter options.
     *
     * @var bool
     */
    protected $alwaysMultiple = TRUE;
    
    /**
     * The database connection.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $connection;
    
    /**
     * Constructs a new StringFilter object.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Database\Connection $connection
     *   The database connection.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $connection) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->connection = $connection;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('database'));
    }
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['expose']['contains']['required'] = [
            'default' => FALSE,
        ];
        $options['expose']['contains']['placeholder'] = [
            'default' => '',
        ];
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultExposeOptions() {
        parent::defaultExposeOptions();
        $this->options['expose']['placeholder'] = NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildExposeForm(&$form, FormStateInterface $form_state) {
        parent::buildExposeForm($form, $form_state);
        $form['expose']['placeholder'] = [
            '#type' => 'textfield',
            '#default_value' => $this->options['expose']['placeholder'],
            '#title' => $this->t('Placeholder'),
            '#size' => 40,
            '#description' => $this->t('Hint text that appears inside the field when empty.'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function operators() {
        $operators = [
            '=' => [
                'title' => $this->t('Is equal to'),
                'short' => $this->t('='),
                'method' => 'opEqual',
                'values' => 1,
            ],
            '!=' => [
                'title' => $this->t('Is not equal to'),
                'short' => $this->t('!='),
                'method' => 'opEqual',
                'values' => 1,
            ],
            'contains' => [
                'title' => $this->t('Contains'),
                'short' => $this->t('contains'),
                'method' => 'opContains',
                'values' => 1,
            ],
            'word' => [
                'title' => $this->t('Contains any word'),
                'short' => $this->t('has word'),
                'method' => 'opContainsWord',
                'values' => 1,
            ],
            'allwords' => [
                'title' => $this->t('Contains all words'),
                'short' => $this->t('has all'),
                'method' => 'opContainsWord',
                'values' => 1,
            ],
            'starts' => [
                'title' => $this->t('Starts with'),
                'short' => $this->t('begins'),
                'method' => 'opStartsWith',
                'values' => 1,
            ],
            'not_starts' => [
                'title' => $this->t('Does not start with'),
                'short' => $this->t('not_begins'),
                'method' => 'opNotStartsWith',
                'values' => 1,
            ],
            'ends' => [
                'title' => $this->t('Ends with'),
                'short' => $this->t('ends'),
                'method' => 'opEndsWith',
                'values' => 1,
            ],
            'not_ends' => [
                'title' => $this->t('Does not end with'),
                'short' => $this->t('not_ends'),
                'method' => 'opNotEndsWith',
                'values' => 1,
            ],
            'not' => [
                'title' => $this->t('Does not contain'),
                'short' => $this->t('!has'),
                'method' => 'opNotLike',
                'values' => 1,
            ],
            'shorterthan' => [
                'title' => $this->t('Length is shorter than'),
                'short' => $this->t('shorter than'),
                'method' => 'opShorterThan',
                'values' => 1,
            ],
            'longerthan' => [
                'title' => $this->t('Length is longer than'),
                'short' => $this->t('longer than'),
                'method' => 'opLongerThan',
                'values' => 1,
            ],
            'regular_expression' => [
                'title' => $this->t('Regular expression'),
                'short' => $this->t('regex'),
                'method' => 'opRegex',
                'values' => 1,
            ],
            'not_regular_expression' => [
                'title' => $this->t('Negated regular expression'),
                'short' => $this->t('not regex'),
                'method' => 'opNotRegex',
                'values' => 1,
            ],
        ];
        // If the definition allows for the empty operator, add it.
        if (!empty($this->definition['allow empty'])) {
            $operators += [
                'empty' => [
                    'title' => $this->t('Is empty (NULL)'),
                    'method' => 'opEmpty',
                    'short' => $this->t('empty'),
                    'values' => 0,
                ],
                'not empty' => [
                    'title' => $this->t('Is not empty (NOT NULL)'),
                    'method' => 'opEmpty',
                    'short' => $this->t('not empty'),
                    'values' => 0,
                ],
            ];
        }
        return $operators;
    }
    
    /**
     * Build strings from the operators() for 'select' options.
     */
    public function operatorOptions($which = 'title') {
        $options = [];
        foreach ($this->operators() as $id => $info) {
            $options[$id] = $info[$which];
        }
        return $options;
    }
    public function adminSummary() {
        if ($this->isAGroup()) {
            return $this->t('grouped');
        }
        if (!empty($this->options['exposed'])) {
            return $this->t('exposed');
        }
        $options = $this->operatorOptions('short');
        $output = '';
        if (!empty($options[$this->operator])) {
            $output = $options[$this->operator];
        }
        if (in_array($this->operator, $this->operatorValues(1))) {
            $output .= ' ' . $this->value;
        }
        return $output;
    }
    protected function operatorValues($values = 1) {
        $options = [];
        foreach ($this->operators() as $id => $info) {
            if (isset($info['values']) && $info['values'] == $values) {
                $options[] = $id;
            }
        }
        return $options;
    }
    
    /**
     * Provide a simple textfield for equality.
     */
    protected function valueForm(&$form, FormStateInterface $form_state) {
        // We have to make some choices when creating this as an exposed
        // filter form. For example, if the operator is locked and thus
        // not rendered, we can't render dependencies; instead we only
        // render the form items we need.
        $which = 'all';
        if (!empty($form['operator'])) {
            $source = ':input[name="options[operator]"]';
        }
        if ($exposed = $form_state->get('exposed')) {
            $identifier = $this->options['expose']['identifier'];
            if (empty($this->options['expose']['use_operator']) || empty($this->options['expose']['operator_id'])) {
                // Exposed and locked.
                $which = in_array($this->operator, $this->operatorValues(1)) ? 'value' : 'none';
            }
            else {
                $source = ':input[name="' . $this->options['expose']['operator_id'] . '"]';
            }
        }
        if ($which == 'all' || $which == 'value') {
            $form['value'] = [
                '#type' => 'textfield',
                '#title' => $this->t('Value'),
                '#size' => 30,
                '#default_value' => $this->value,
            ];
            if (!empty($this->options['expose']['placeholder'])) {
                $form['value']['#attributes']['placeholder'] = $this->options['expose']['placeholder'];
            }
            $user_input = $form_state->getUserInput();
            if ($exposed && !isset($user_input[$identifier])) {
                $user_input[$identifier] = $this->value;
                $form_state->setUserInput($user_input);
            }
            if ($which == 'all') {
                // Setup #states for all operators with one value.
                foreach ($this->operatorValues(1) as $operator) {
                    $form['value']['#states']['visible'][] = [
                        $source => [
                            'value' => $operator,
                        ],
                    ];
                }
            }
        }
        if (!isset($form['value'])) {
            // Ensure there is something in the 'value'.
            $form['value'] = [
                '#type' => 'value',
                '#value' => NULL,
            ];
        }
    }
    
    /**
     * Get the query operator.
     *
     * @return string
     *   Returns LIKE or NOT LIKE or the database specific equivalent based on the
     *   query's operator.
     */
    public function operator() {
        return $this->getConditionOperator($this->operator == '=' ? 'LIKE' : 'NOT LIKE');
    }
    
    /**
     * Get specified condition operator mapping value.
     *
     * @param string $operator
     *   Condition operator.
     *
     * @return string
     *   Specified condition operator mapping value.
     */
    protected function getConditionOperator($operator) {
        $mapping = $this->connection
            ->mapConditionOperator($operator);
        return $mapping['operator'] ?? $operator;
    }
    
    /**
     * 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() {
        $this->ensureMyTable();
        $field = "{$this->tableAlias}.{$this->realField}";
        $info = $this->operators();
        if (!empty($info[$this->operator]['method'])) {
            $this->{$info[$this->operator]['method']}($field);
        }
    }
    
    /**
     * Adds a where clause for the operation, 'equals'.
     */
    public function opEqual($field) {
        $this->query
            ->addWhere($this->options['group'], $field, $this->value, $this->operator());
    }
    protected function opContains($field) {
        $operator = $this->getConditionOperator('LIKE');
        $this->query
            ->addWhere($this->options['group'], $field, '%' . $this->connection
            ->escapeLike($this->value) . '%', $operator);
    }
    protected function opContainsWord($field) {
        $where = $this->operator == 'word' ? $this->query
            ->getConnection()
            ->condition('OR') : $this->query
            ->getConnection()
            ->condition('AND');
        // Don't filter on empty strings.
        if (empty($this->value)) {
            return;
        }
        preg_match_all(static::WORDS_PATTERN, ' ' . $this->value, $matches, PREG_SET_ORDER);
        $operator = $this->getConditionOperator('LIKE');
        foreach ($matches as $match) {
            $phrase = FALSE;
            // Strip off phrase quotes
            if ($match[2][0] == '"') {
                $match[2] = substr($match[2], 1, -1);
                $phrase = TRUE;
            }
            $words = trim($match[2], ',?!();:-');
            $words = $phrase ? [
                $words,
            ] : preg_split('/ /', $words, -1, PREG_SPLIT_NO_EMPTY);
            foreach ($words as $word) {
                $where->condition($field, '%' . $this->connection
                    ->escapeLike(trim($word, " ,!?")) . '%', $operator);
            }
        }
        if ($where->count() === 0) {
            return;
        }
        // Previously this was a call_user_func_array but that's unnecessary
        // as views will unpack an array that is a single arg.
        $this->query
            ->addWhere($this->options['group'], $where);
    }
    protected function opStartsWith($field) {
        $operator = $this->getConditionOperator('LIKE');
        $this->query
            ->addWhere($this->options['group'], $field, $this->connection
            ->escapeLike($this->value) . '%', $operator);
    }
    protected function opNotStartsWith($field) {
        $operator = $this->getConditionOperator('NOT LIKE');
        $this->query
            ->addWhere($this->options['group'], $field, $this->connection
            ->escapeLike($this->value) . '%', $operator);
    }
    protected function opEndsWith($field) {
        $operator = $this->getConditionOperator('LIKE');
        $this->query
            ->addWhere($this->options['group'], $field, '%' . $this->connection
            ->escapeLike($this->value), $operator);
    }
    protected function opNotEndsWith($field) {
        $operator = $this->getConditionOperator('NOT LIKE');
        $this->query
            ->addWhere($this->options['group'], $field, '%' . $this->connection
            ->escapeLike($this->value), $operator);
    }
    protected function opNotLike($field) {
        $operator = $this->getConditionOperator('NOT LIKE');
        $this->query
            ->addWhere($this->options['group'], $field, '%' . $this->connection
            ->escapeLike($this->value) . '%', $operator);
    }
    protected function opShorterThan($field) {
        $placeholder = $this->placeholder();
        // Type cast the argument to an integer because the SQLite database driver
        // has to do some specific alterations to the query base on that data type.
        $this->query
            ->addWhereExpression($this->options['group'], "LENGTH({$field}) < {$placeholder}", [
            $placeholder => (int) $this->value,
        ]);
    }
    protected function opLongerThan($field) {
        $placeholder = $this->placeholder();
        // Type cast the argument to an integer because the SQLite database driver
        // has to do some specific alterations to the query base on that data type.
        $this->query
            ->addWhereExpression($this->options['group'], "LENGTH({$field}) > {$placeholder}", [
            $placeholder => (int) $this->value,
        ]);
    }
    
    /**
     * Filters by a regular expression.
     *
     * @param string $field
     *   The expression pointing to the queries field, for example "foo.bar".
     */
    protected function opRegex($field) {
        $this->query
            ->addWhere($this->options['group'], $field, $this->value, 'REGEXP');
    }
    
    /**
     * Filters by a negated regular expression.
     *
     * @param string $field
     *   The expression pointing to the queries field, for example "foo.bar".
     */
    protected function opNotRegex($field) {
        $this->query
            ->addWhere($this->options['group'], $field, $this->value, 'NOT REGEXP');
    }
    protected function opEmpty($field) {
        if ($this->operator == 'empty') {
            $operator = "IS NULL";
        }
        else {
            $operator = "IS NOT NULL";
        }
        $this->query
            ->addWhere($this->options['group'], $field, NULL, $operator);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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
FilterPluginBase::$group_info public property
FilterPluginBase::$no_operator public property 1
FilterPluginBase::$operator public property Contains the operator which is used on the query.
FilterPluginBase::$tableAliases public property Keyed array by alias of table relations.
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) &quot;0&quot;.
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::buildOptionsForm public function Provide the basic form which calls through to subforms. Overrides HandlerBase::buildOptionsForm 2
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 6
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&#039;s options.
FilterPluginBase::RESTRICTED_IDENTIFIERS constant A list of restricted identifiers.
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::validate public function Validate that the plugin is correct and can be saved. Overrides HandlerBase::validate 2
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::$is_handler public property
HandlerBase::$moduleHandler protected property The module handler. 2
HandlerBase::$query public property Where the $query object will reside. 7
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 5
HandlerBase::adminLabel public function Return a string representing this handler&#039;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 &#039;broken&#039;. Overrides ViewsHandlerInterface::broken
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 2
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies 11
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&#039;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. 2
HandlerBase::isExposed public function Determine if this item is &#039;exposed&#039;.
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. 1
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. 5
HandlerBase::validateExtraOptionsForm public function Validate the options form. 1
PluginBase::$definition public property Plugins&#039; 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::$position public property The handler position.
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&#039; 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::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides FilterPluginBase::defineOptions 1
StringFilter::getConditionOperator protected function Get specified condition operator mapping value.
StringFilter::opContains protected function 1
StringFilter::opContainsWord protected function 1
StringFilter::opEmpty protected function 1
StringFilter::opEndsWith protected function 1
StringFilter::opEqual public function Adds a where clause for the operation, &#039;equals&#039;. 1
StringFilter::operator public function Get the query operator.
StringFilter::operatorOptions public function Build strings from the operators() for &#039;select&#039; options. Overrides FilterPluginBase::operatorOptions
StringFilter::operators public function Returns an array of operator information, keyed by operator ID. Overrides FilterOperatorsInterface::operators
StringFilter::operatorValues protected function
StringFilter::opLongerThan protected function
StringFilter::opNotEndsWith protected function 1
StringFilter::opNotLike protected function 1
StringFilter::opNotRegex protected function Filters by a negated regular expression.
StringFilter::opNotStartsWith protected function 1
StringFilter::opRegex protected function Filters by a regular expression. 1
StringFilter::opShorterThan protected function
StringFilter::opStartsWith protected function 1
StringFilter::query public function Add this filter to the query. Overrides FilterPluginBase::query 1
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.