class GroupByNumeric

Same name in this branch
  1. 11.x core/modules/views/src/Plugin/views/sort/GroupByNumeric.php \Drupal\views\Plugin\views\sort\GroupByNumeric
  2. 11.x core/modules/views/src/Plugin/views/argument/GroupByNumeric.php \Drupal\views\Plugin\views\argument\GroupByNumeric
Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/sort/GroupByNumeric.php \Drupal\views\Plugin\views\sort\GroupByNumeric
  2. 9 core/modules/views/src/Plugin/views/filter/GroupByNumeric.php \Drupal\views\Plugin\views\filter\GroupByNumeric
  3. 9 core/modules/views/src/Plugin/views/argument/GroupByNumeric.php \Drupal\views\Plugin\views\argument\GroupByNumeric
  4. 8.9.x core/modules/views/src/Plugin/views/sort/GroupByNumeric.php \Drupal\views\Plugin\views\sort\GroupByNumeric
  5. 8.9.x core/modules/views/src/Plugin/views/filter/GroupByNumeric.php \Drupal\views\Plugin\views\filter\GroupByNumeric
  6. 8.9.x core/modules/views/src/Plugin/views/argument/GroupByNumeric.php \Drupal\views\Plugin\views\argument\GroupByNumeric
  7. 10 core/modules/views/src/Plugin/views/sort/GroupByNumeric.php \Drupal\views\Plugin\views\sort\GroupByNumeric
  8. 10 core/modules/views/src/Plugin/views/filter/GroupByNumeric.php \Drupal\views\Plugin\views\filter\GroupByNumeric
  9. 10 core/modules/views/src/Plugin/views/argument/GroupByNumeric.php \Drupal\views\Plugin\views\argument\GroupByNumeric

Simple filter to handle greater than/less than filters.

Hierarchy

Expanded class hierarchy of GroupByNumeric

Related topics

File

core/modules/views/src/Plugin/views/filter/GroupByNumeric.php, line 12

Namespace

Drupal\views\Plugin\views\filter
View source
class GroupByNumeric extends NumericFilter {
    public function query() {
        $this->ensureMyTable();
        $field = $this->getField();
        $info = $this->operators();
        if (!empty($info[$this->operator]['method'])) {
            $this->{$info[$this->operator]['method']}($field);
        }
    }
    protected function opBetween($field) {
        $placeholder_min = $this->placeholder();
        $placeholder_max = $this->placeholder();
        if ($this->operator == 'between') {
            $this->query
                ->addHavingExpression($this->options['group'], "{$field} >= {$placeholder_min}", [
                $placeholder_min => $this->value['min'],
            ]);
            $this->query
                ->addHavingExpression($this->options['group'], "{$field} <= {$placeholder_max}", [
                $placeholder_max => $this->value['max'],
            ]);
        }
        else {
            $this->query
                ->addHavingExpression($this->options['group'], "{$field} < {$placeholder_min} OR {$field} > {$placeholder_max}", [
                $placeholder_min => $this->value['min'],
                $placeholder_max => $this->value['max'],
            ]);
        }
    }
    protected function opSimple($field) {
        $placeholder = $this->placeholder();
        $this->query
            ->addHavingExpression($this->options['group'], "{$field} {$this->operator} {$placeholder}", [
            $placeholder => $this->value['value'],
        ]);
    }
    protected function opEmpty($field) {
        if ($this->operator == 'empty') {
            $operator = "IS NULL";
        }
        else {
            $operator = "IS NOT NULL";
        }
        $this->query
            ->addHavingExpression($this->options['group'], "{$field} {$operator}");
    }
    public function adminLabel($short = FALSE) {
        return $this->getField(parent::adminLabel($short));
    }
    public function canGroup() {
        return FALSE;
    }

}

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::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 Overrides CacheableDependencyInterface::getCacheContexts 6
FilterPluginBase::getCacheMaxAge public function Overrides CacheableDependencyInterface::getCacheMaxAge
FilterPluginBase::getCacheTags public function 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 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 Overrides PluginBase::trustedCallbacks
FilterPluginBase::validate public function 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
GroupByNumeric::adminLabel public function Overrides HandlerBase::adminLabel
GroupByNumeric::canGroup public function Overrides FilterPluginBase::canGroup
GroupByNumeric::opBetween protected function Overrides NumericFilter::opBetween
GroupByNumeric::opEmpty protected function Overrides NumericFilter::opEmpty
GroupByNumeric::opSimple protected function Overrides NumericFilter::opSimple
GroupByNumeric::query public function Overrides NumericFilter::query
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 Overrides ViewsHandlerInterface::access 5
HandlerBase::breakString public static function Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function 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 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 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 Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function 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 Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function 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
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 43
NumericFilter::$alwaysMultiple protected property Overrides FilterPluginBase::$alwaysMultiple
NumericFilter::acceptExposedInput public function Do some minor translation of the exposed input. Overrides FilterPluginBase::acceptExposedInput 1
NumericFilter::adminSummary public function Overrides FilterPluginBase::adminSummary
NumericFilter::buildExposeForm public function Overrides FilterPluginBase::buildExposeForm
NumericFilter::defaultExposeOptions public function Overrides FilterPluginBase::defaultExposeOptions
NumericFilter::defineOptions protected function Overrides FilterPluginBase::defineOptions 1
NumericFilter::operatorOptions public function Provide a list of all the numeric operators. Overrides FilterPluginBase::operatorOptions
NumericFilter::operators public function 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::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 Overrides ContainerFactoryPluginInterface::create 61
PluginBase::destroy public function 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 Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function 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 Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function 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 Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function 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.