class GroupByNumeric in Drupal 10

Simple filter to handle greater than/less than filters.

Plugin annotation

@ViewsFilter("groupby_numeric");

Hierarchy

• class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements CacheableDependencyInterface
  • class \Drupal\views\Plugin\views\filter\NumericFilter
    • class \Drupal\views\Plugin\views\filter\GroupByNumeric

Related topics

Views filter handler plugins

Plugins that handle views filtering.

File

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

Namespace

Drupal\views\Plugin\views\filter

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

Name	Modifiers	Type	Description	Overrides
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	Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
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.
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.	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.	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. This only needs to be overridden for particularly complex forms. And maybe not even then.
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	Build a form containing a group of operator | values to apply as a single filter.
FilterPluginBase::groupMultipleExposedInput	public	function	Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
FilterPluginBase::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().	2
FilterPluginBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter.
FilterPluginBase::multipleExposedInput	public	function	Returns TRUE if users can select multiple groups items of a grouped exposed filter.
FilterPluginBase::operatorForm	protected	function	Options form subform for setting the operator.	5
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.
FilterPluginBase::showOperatorForm	public	function	Shortcut to display the operator form.
FilterPluginBase::showValueForm	protected	function	Shortcut to display the value form.
FilterPluginBase::storeExposedInput	public	function
FilterPluginBase::storeGroupInput	public	function	If set to remember exposed input in the session, store it there.
FilterPluginBase::submitOptionsForm	public	function	Simple submit handler.
FilterPluginBase::trustedCallbacks	public static	function
FilterPluginBase::validate	public	function		2
FilterPluginBase::validateExposeForm	public	function	Validate the options form.
FilterPluginBase::validateIdentifier	protected	function	Validates a filter identifier.
FilterPluginBase::validateOptionsForm	public	function	Simple validate handler.	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.	2
GroupByNumeric::adminLabel	public	function
GroupByNumeric::canGroup	public	function	Can this filter be used in OR groups? Overrides FilterPluginBase::canGroup
GroupByNumeric::opBetween	protected	function	Filters by operator between. Overrides NumericFilter::opBetween
GroupByNumeric::opEmpty	protected	function	Overrides NumericFilter::opEmpty
GroupByNumeric::opSimple	protected	function	Overrides NumericFilter::opSimple
GroupByNumeric::query	public	function	Add this filter to the query. Overrides NumericFilter::query
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	Overrides FilterPluginBase::defineOptions	1
NumericFilter::operatorOptions	public	function	Provide a list of all the numeric operators. Overrides FilterPluginBase::operatorOptions
NumericFilter::operators	public	function
NumericFilter::operatorValues	protected	function
NumericFilter::opRegex	protected	function	Filters by a regular expression.
NumericFilter::valueForm	protected	function	Provide a simple textfield for equality. Overrides FilterPluginBase::valueForm	1