class NumericFilter

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

Simple filter to handle greater than/less than filters.

Hierarchy

Expanded class hierarchy of NumericFilter

Related topics

2 files declare their use of NumericFilter
HandlerAllTest.php in core/modules/views/tests/src/Kernel/Handler/HandlerAllTest.php
NumericFilterTest.php in core/modules/views/tests/src/Unit/Plugin/views/filter/NumericFilterTest.php

File

core/modules/views/src/Plugin/views/filter/NumericFilter.php, line 13

Namespace

Drupal\views\Plugin\views\filter
View source
class NumericFilter extends FilterPluginBase implements FilterOperatorsInterface {
    protected $alwaysMultiple = TRUE;
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['value'] = [
            'contains' => [
                'min' => [
                    'default' => '',
                ],
                'max' => [
                    'default' => '',
                ],
                'value' => [
                    'default' => '',
                ],
            ],
        ];
        $options['expose']['contains']['placeholder'] = [
            'default' => '',
        ];
        $options['expose']['contains']['min_placeholder'] = [
            'default' => '',
        ];
        $options['expose']['contains']['max_placeholder'] = [
            'default' => '',
        ];
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultExposeOptions() {
        parent::defaultExposeOptions();
        $this->options['expose']['min_placeholder'] = NULL;
        $this->options['expose']['max_placeholder'] = NULL;
        $this->options['expose']['placeholder'] = NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildExposeForm(&$form, FormStateInterface $form_state) {
        parent::buildExposeForm($form, $form_state);
        $form['expose']['min_placeholder'] = [
            '#type' => 'textfield',
            '#default_value' => $this->options['expose']['min_placeholder'],
            '#title' => $this->t('Min placeholder'),
            '#size' => 40,
            '#description' => $this->t('Hint text that appears inside the Min field when empty.'),
        ];
        $form['expose']['max_placeholder'] = [
            '#type' => 'textfield',
            '#default_value' => $this->options['expose']['max_placeholder'],
            '#title' => $this->t('Max placeholder'),
            '#size' => 40,
            '#description' => $this->t('Hint text that appears inside the Max field when empty.'),
        ];
        // Setup #states for all operators with two value.
        $states = [
            [
                ':input[name="options[expose][use_operator]"]' => [
                    'checked' => TRUE,
                ],
            ],
        ];
        foreach ($this->operatorValues(2) as $operator) {
            $states[] = [
                ':input[name="options[operator]"]' => [
                    'value' => $operator,
                ],
            ];
        }
        $form['expose']['min_placeholder']['#states']['visible'] = $states;
        $form['expose']['max_placeholder']['#states']['visible'] = $states;
        $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.'),
        ];
        // Setup #states for all operators with one value.
        $form['expose']['placeholder']['#states']['visible'] = [
            [
                ':input[name="options[expose][use_operator]"]' => [
                    'checked' => TRUE,
                ],
            ],
        ];
        foreach ($this->operatorValues(1) as $operator) {
            $form['expose']['placeholder']['#states']['visible'][] = [
                ':input[name="options[operator]"]' => [
                    'value' => $operator,
                ],
            ];
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function operators() {
        $operators = [
            '<' => [
                'title' => $this->t('Is less than'),
                'method' => 'opSimple',
                'short' => $this->t('<'),
                'values' => 1,
            ],
            '<=' => [
                'title' => $this->t('Is less than or equal to'),
                'method' => 'opSimple',
                'short' => $this->t('<='),
                'values' => 1,
            ],
            '=' => [
                'title' => $this->t('Is equal to'),
                'method' => 'opSimple',
                'short' => $this->t('='),
                'values' => 1,
            ],
            '!=' => [
                'title' => $this->t('Is not equal to'),
                'method' => 'opSimple',
                'short' => $this->t('!='),
                'values' => 1,
            ],
            '>=' => [
                'title' => $this->t('Is greater than or equal to'),
                'method' => 'opSimple',
                'short' => $this->t('>='),
                'values' => 1,
            ],
            '>' => [
                'title' => $this->t('Is greater than'),
                'method' => 'opSimple',
                'short' => $this->t('>'),
                'values' => 1,
            ],
            'between' => [
                'title' => $this->t('Is between'),
                'method' => 'opBetween',
                'short' => $this->t('between'),
                'values' => 2,
            ],
            'not between' => [
                'title' => $this->t('Is not between'),
                'method' => 'opBetween',
                'short' => $this->t('not between'),
                'values' => 2,
            ],
            '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;
    }
    
    /**
     * Provide a list of all the numeric operators.
     */
    public function operatorOptions($which = 'title') {
        $options = [];
        foreach ($this->operators() as $id => $info) {
            $options[$id] = $info[$which];
        }
        return $options;
    }
    protected function operatorValues($values = 1) {
        $options = [];
        foreach ($this->operators() as $id => $info) {
            if ($info['values'] == $values) {
                $options[] = $id;
            }
        }
        return $options;
    }
    
    /**
     * Provide a simple textfield for equality.
     */
    protected function valueForm(&$form, FormStateInterface $form_state) {
        $form['value']['#tree'] = TRUE;
        // 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(2)) ? 'minmax' : 'value';
            }
            else {
                $source = ':input[name="' . $this->options['expose']['operator_id'] . '"]';
            }
        }
        $user_input = $form_state->getUserInput();
        if ($which == 'all') {
            $form['value']['value'] = [
                '#type' => 'textfield',
                '#title' => !$exposed ? $this->t('Value') : '',
                '#size' => 30,
                '#default_value' => $this->value['value'],
            ];
            if (!empty($this->options['expose']['placeholder'])) {
                $form['value']['value']['#attributes']['placeholder'] = $this->options['expose']['placeholder'];
            }
            // Setup #states for all operators with one value.
            foreach ($this->operatorValues(1) as $operator) {
                $form['value']['value']['#states']['visible'][] = [
                    $source => [
                        'value' => $operator,
                    ],
                ];
            }
            if ($exposed && !isset($user_input[$identifier]['value'])) {
                $user_input[$identifier]['value'] = $this->value['value'];
                $form_state->setUserInput($user_input);
            }
        }
        elseif ($which == 'value') {
            // When exposed we drop the value-value and just do value if
            // the operator is locked.
            $form['value'] = [
                '#type' => 'textfield',
                '#title' => !$exposed ? $this->t('Value') : '',
                '#size' => 30,
                '#default_value' => $this->value['value'],
            ];
            if (!empty($this->options['expose']['placeholder'])) {
                $form['value']['#attributes']['placeholder'] = $this->options['expose']['placeholder'];
            }
            if ($exposed && !isset($user_input[$identifier])) {
                $user_input[$identifier] = $this->value['value'];
                $form_state->setUserInput($user_input);
            }
        }
        // Minimum and maximum form fields are associated to some specific operators
        // like 'between'. Ensure that min and max fields are only visible if
        // the associated operator is not excluded from the operator list.
        $two_value_operators_available = $which == 'all' || $which == 'minmax';
        if (!empty($this->options['expose']['operator_limit_selection']) && !empty($this->options['expose']['operator_list'])) {
            $two_value_operators_available = FALSE;
            foreach ($this->options['expose']['operator_list'] as $operator) {
                if (in_array($operator, $this->operatorValues(2), TRUE)) {
                    $two_value_operators_available = TRUE;
                    break;
                }
            }
        }
        if ($two_value_operators_available) {
            $form['value']['min'] = [
                '#type' => 'textfield',
                '#title' => $this->t('Min'),
                '#size' => 30,
                '#default_value' => $this->value['min'],
            ];
            if (!empty($this->options['expose']['min_placeholder'])) {
                $form['value']['min']['#attributes']['placeholder'] = $this->options['expose']['min_placeholder'];
            }
            $form['value']['max'] = [
                '#type' => 'textfield',
                '#title' => $this->t('Max'),
                '#size' => 30,
                '#default_value' => $this->value['max'],
            ];
            if (!empty($this->options['expose']['max_placeholder'])) {
                $form['value']['max']['#attributes']['placeholder'] = $this->options['expose']['max_placeholder'];
            }
            if ($which == 'all') {
                $states = [];
                // Setup #states for all operators with two values.
                foreach ($this->operatorValues(2) as $operator) {
                    $states['#states']['visible'][] = [
                        $source => [
                            'value' => $operator,
                        ],
                    ];
                }
                $form['value']['min'] += $states;
                $form['value']['max'] += $states;
            }
            if ($exposed && !isset($user_input[$identifier]['min'])) {
                $user_input[$identifier]['min'] = $this->value['min'];
            }
            if ($exposed && !isset($user_input[$identifier]['max'])) {
                $user_input[$identifier]['max'] = $this->value['max'];
            }
            if (!isset($form['value'])) {
                // Ensure there is something in the 'value'.
                $form['value'] = [
                    '#type' => 'value',
                    '#value' => NULL,
                ];
            }
        }
    }
    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);
        }
    }
    
    /**
     * Filters by operator between.
     *
     * @param object $field
     *   The views field.
     */
    protected function opBetween($field) {
        if (is_numeric($this->value['min']) && is_numeric($this->value['max'])) {
            $operator = $this->operator == 'between' ? 'BETWEEN' : 'NOT BETWEEN';
            $this->query
                ->addWhere($this->options['group'], $field, [
                $this->value['min'],
                $this->value['max'],
            ], $operator);
        }
        elseif (is_numeric($this->value['min'])) {
            $operator = $this->operator == 'between' ? '>=' : '<';
            $this->query
                ->addWhere($this->options['group'], $field, $this->value['min'], $operator);
        }
        elseif (is_numeric($this->value['max'])) {
            $operator = $this->operator == 'between' ? '<=' : '>';
            $this->query
                ->addWhere($this->options['group'], $field, $this->value['max'], $operator);
        }
    }
    protected function opSimple($field) {
        $this->query
            ->addWhere($this->options['group'], $field, $this->value['value'], $this->operator);
    }
    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);
    }
    
    /**
     * 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['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['value'], 'NOT REGEXP');
    }
    public function adminSummary() {
        if ($this->isAGroup()) {
            return $this->t('grouped');
        }
        if (!empty($this->options['exposed'])) {
            return $this->t('exposed');
        }
        $options = $this->operatorOptions('short');
        $output = $options[$this->operator];
        if (in_array($this->operator, $this->operatorValues(2))) {
            $output .= ' ' . $this->t('@min and @max', [
                '@min' => $this->value['min'],
                '@max' => $this->value['max'],
            ]);
        }
        elseif (in_array($this->operator, $this->operatorValues(1))) {
            $output .= ' ' . $this->value['value'];
        }
        return $output;
    }
    
    /**
     * Do some minor translation of the exposed input.
     */
    public function acceptExposedInput($input) {
        if (empty($this->options['exposed'])) {
            return TRUE;
        }
        // Rewrite the input value so that it's in the correct format so that
        // the parent gets the right data.
        $key = $this->isAGroup() ? 'group_info' : 'expose';
        if (empty($this->options[$key]['identifier'])) {
            // Invalid identifier configuration. Value can't be resolved.
            return FALSE;
        }
        $value =& $input[$this->options[$key]['identifier']];
        if (!is_array($value)) {
            $value = [
                'value' => $value,
            ];
        }
        $rc = parent::acceptExposedInput($input);
        if (empty($this->options['expose']['required'])) {
            // We have to do some of our own checking for non-required filters.
            $info = $this->operators();
            if (!empty($info[$this->operator]['values'])) {
                switch ($info[$this->operator]['values']) {
                    case 1:
                        if ($value['value'] === '') {
                            return FALSE;
                        }
                        break;
                    case 2:
                        if ($value['min'] === '' && $value['max'] === '') {
                            return FALSE;
                        }
                        break;
                }
            }
        }
        return $rc;
    }

}

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::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. 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&#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. 1
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.
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.
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 42
NumericFilter::$alwaysMultiple protected property Disable the possibility to force a single value. Overrides FilterPluginBase::$alwaysMultiple
NumericFilter::acceptExposedInput public function Do some minor translation of the exposed input. Overrides FilterPluginBase::acceptExposedInput 1
NumericFilter::adminSummary public function Display the filter on the administrative summary. Overrides FilterPluginBase::adminSummary
NumericFilter::buildExposeForm public function Options form subform for exposed filter options. Overrides FilterPluginBase::buildExposeForm
NumericFilter::defaultExposeOptions public function Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
NumericFilter::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides FilterPluginBase::defineOptions 1
NumericFilter::opBetween protected function Filters by operator between. 2
NumericFilter::opEmpty protected function 1
NumericFilter::operatorOptions public function Provide a list of all the numeric operators. Overrides FilterPluginBase::operatorOptions
NumericFilter::operators public function Returns an array of operator information, keyed by operator ID. Overrides FilterOperatorsInterface::operators
NumericFilter::operatorValues protected function
NumericFilter::opNotRegex protected function Filters by a negated regular expression.
NumericFilter::opRegex protected function Filters by a regular expression.
NumericFilter::opSimple protected function 2
NumericFilter::query public function Add this filter to the query. Overrides FilterPluginBase::query 2
NumericFilter::valueForm protected function Provide a simple textfield for equality. Overrides FilterPluginBase::valueForm 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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 60
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
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.