class GroupByNumeric

Same name in this branch

8.9.x core/modules/views/src/Plugin/views/sort/GroupByNumeric.php \Drupal\views\Plugin\views\sort\GroupByNumeric
8.9.x core/modules/views/src/Plugin/views/filter/GroupByNumeric.php \Drupal\views\Plugin\views\filter\GroupByNumeric

Same name and namespace in other branches

11.x core/modules/views/src/Plugin/views/sort/GroupByNumeric.php \Drupal\views\Plugin\views\sort\GroupByNumeric
11.x core/modules/views/src/Plugin/views/filter/GroupByNumeric.php \Drupal\views\Plugin\views\filter\GroupByNumeric
11.x core/modules/views/src/Plugin/views/argument/GroupByNumeric.php \Drupal\views\Plugin\views\argument\GroupByNumeric
10 core/modules/views/src/Plugin/views/sort/GroupByNumeric.php \Drupal\views\Plugin\views\sort\GroupByNumeric
10 core/modules/views/src/Plugin/views/filter/GroupByNumeric.php \Drupal\views\Plugin\views\filter\GroupByNumeric
10 core/modules/views/src/Plugin/views/argument/GroupByNumeric.php \Drupal\views\Plugin\views\argument\GroupByNumeric
9 core/modules/views/src/Plugin/views/sort/GroupByNumeric.php \Drupal\views\Plugin\views\sort\GroupByNumeric
9 core/modules/views/src/Plugin/views/filter/GroupByNumeric.php \Drupal\views\Plugin\views\filter\GroupByNumeric
9 core/modules/views/src/Plugin/views/argument/GroupByNumeric.php \Drupal\views\Plugin\views\argument\GroupByNumeric

Simple handler for arguments using group by.

Plugin annotation

@ViewsArgument("groupby_numeric");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
  - class \Drupal\views\Plugin\views\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface extends \Drupal\Core\Plugin\PluginBase
    - class \Drupal\views\Plugin\views\HandlerBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface extends \Drupal\views\Plugin\views\PluginBase
      - class \Drupal\views\Plugin\views\argument\ArgumentPluginBase implements \Drupal\Core\Cache\CacheableDependencyInterface extends \Drupal\views\Plugin\views\HandlerBase
        class \Drupal\views\Plugin\views\argument\GroupByNumeric extends \Drupal\views\Plugin\views\argument\ArgumentPluginBase

Expanded class hierarchy of GroupByNumeric

File

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

Namespace

Drupal\views\Plugin\views\argument

View on git.drupalcode.org

View source

class GroupByNumeric extends ArgumentPluginBase {
  public function query($group_by = FALSE) {
    $this->ensureMyTable();
    $field = $this->getField();
    $placeholder = $this->placeholder();
    $this->query
      ->addHavingExpression(0, "{$field} = {$placeholder}", [
      $placeholder => $this->argument,
    ]);
  }
  public function adminLabel($short = FALSE) {
    return $this->getField(parent::adminLabel($short));
  }
  
  /**
   * {@inheritdoc}
   */
  public function getSortName() {
    return $this->t('Numerical', [], [
      'context' => 'Sort order',
    ]);
  }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
ArgumentPluginBase::$argument	public	property
ArgumentPluginBase::$name_field	public	property	The field to use for the name to use in the summary, which is the displayed output. For example, for the node: nid argument, the argument itself is the nid, but node.title is displayed.
ArgumentPluginBase::$name_table	public	property	The table to use for the name, should it not be in the same table as the argument.
ArgumentPluginBase::$validator	public	property
ArgumentPluginBase::$value	public	property
ArgumentPluginBase::buildOptionsForm	public	function
ArgumentPluginBase::calculateDependencies	public	function
ArgumentPluginBase::decodeValidatorId	public static	function	Revert sanitized validator options.
ArgumentPluginBase::defaultAccessDenied	public	function	Default action: access denied.
ArgumentPluginBase::defaultAction	public	function	Handle the default action, which means our argument wasn't present.
ArgumentPluginBase::defaultActions	protected	function	Provide a list of default behaviors for this argument if the argument is not present.
ArgumentPluginBase::defaultArgumentForm	public	function	Provide a form for selecting the default argument when the default action is set to provide default argument.
ArgumentPluginBase::defaultDefault	protected	function	This just returns true. The view argument builder will know where to find the argument from.
ArgumentPluginBase::defaultEmpty	public	function	Default action: empty
ArgumentPluginBase::defaultIgnore	public	function	Default action: ignore.
ArgumentPluginBase::defaultNotFound	protected	function	Default action: not found.
ArgumentPluginBase::defaultSummary	protected	function	Default action: summary.
ArgumentPluginBase::defaultSummaryForm	public	function	Provide a form for selecting further summary options when the default action is set to display one.
ArgumentPluginBase::defineOptions	protected	function
ArgumentPluginBase::encodeValidatorId	public static	function	Sanitize validator options including derivatives with : for js.
ArgumentPluginBase::exceptionTitle	public	function
ArgumentPluginBase::getCacheContexts	public	function
ArgumentPluginBase::getCacheMaxAge	public	function
ArgumentPluginBase::getCacheTags	public	function
ArgumentPluginBase::getContextDefinition	public	function	Returns a context definition for this argument.
ArgumentPluginBase::getDefaultArgument	public	function	Get a default argument, if available.
ArgumentPluginBase::getPlugin	public	function	Get the display or row plugin, if it exists.
ArgumentPluginBase::getTitle	public	function	Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title().
ArgumentPluginBase::getTokenHelp	protected	function	Provide token help information for the argument.
ArgumentPluginBase::getValue	public	function	Get the value of this argument.
ArgumentPluginBase::hasDefaultArgument	public	function	Determine if the argument is set to provide a default argument.
ArgumentPluginBase::init	public	function	Overrides Drupal\views\Plugin\views\HandlerBase:init().
ArgumentPluginBase::isException	public	function
ArgumentPluginBase::needsStylePlugin	public	function	Determine if the argument needs a style plugin.
ArgumentPluginBase::preRenderMoveArgumentOptions	public static	function	Moves argument options into their place.
ArgumentPluginBase::processContainerRadios	public static	function	Custom form radios process function.
ArgumentPluginBase::processSummaryArguments	public	function	Process the summary arguments for display.
ArgumentPluginBase::setArgument	public	function	Set the input for this argument
ArgumentPluginBase::submitOptionsForm	public	function
ArgumentPluginBase::summaryArgument	public	function	Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->getUrl().
ArgumentPluginBase::summaryBasics	public	function	Some basic summary behavior that doesn't need to be repeated as much as code that goes into summaryQuery()
ArgumentPluginBase::summaryName	public	function	Provides the name to use for the summary. By default this is just the name field.
ArgumentPluginBase::summaryNameField	protected	function	Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric.
ArgumentPluginBase::summaryQuery	protected	function	Build the info for the summary query.
ArgumentPluginBase::summarySort	public	function	Sorts the summary based upon the user's selection. The base variant of this is usually adequate.
ArgumentPluginBase::title	public	function	Get the title this argument will assign the view, given the argument.
ArgumentPluginBase::trustedCallbacks	public static	function
ArgumentPluginBase::unpackArgumentValue	protected	function	Splits an argument into value and operator properties on this instance.
ArgumentPluginBase::validateArgument	public	function	Validate that this argument works. By default, all arguments are valid.
ArgumentPluginBase::validateFail	public	function	How to act if validation fails.
ArgumentPluginBase::validateMenuArgument	public	function	Called by the menu system to validate an argument.
ArgumentPluginBase::validateOptionsForm	public	function
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function
DependencySerializationTrait::__wakeup	public	function
GroupByNumeric::adminLabel	public	function	Return a string representing this handler's name in the UI.	Overrides HandlerBase::adminLabel
GroupByNumeric::getSortName	public	function	Return a description of how the argument would normally be sorted.	Overrides ArgumentPluginBase::getSortName
GroupByNumeric::query	public	function	Set up the query for this argument.	Overrides ArgumentPluginBase::query
HandlerBase::$field	public	property	With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler	protected	property	The module handler.
HandlerBase::$query	public	property	Where the $query object will reside:
HandlerBase::$realField	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
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::acceptExposedInput	public	function	Take input from exposed handlers and assign to this handler, if necessary.
HandlerBase::access	public	function			1
HandlerBase::adminSummary	public	function
HandlerBase::breakString	public static	function
HandlerBase::broken	public	function
HandlerBase::buildExposedForm	public	function	Render our chunk of the exposed handler form when selecting
HandlerBase::buildExposeForm	public	function	Form for exposed handler options.
HandlerBase::buildExtraOptionsForm	public	function	Provide a form for setting options.
HandlerBase::buildGroupByForm	public	function	Provide a form for aggregation settings.		1
HandlerBase::canExpose	public	function	Determine if a handler can be exposed.
HandlerBase::caseTransform	protected	function	Transform a string by a certain method.
HandlerBase::defaultExposeOptions	public	function	Set new exposed option defaults when exposed setting is flipped on.
HandlerBase::defineExtraOptions	public	function	Provide defaults for the handler.
HandlerBase::displayExposedForm	public	function	Displays the Expose form.
HandlerBase::ensureMyTable	public	function
HandlerBase::exposedInfo	public	function	Get information about the exposed form for the form renderer.
HandlerBase::getDateField	public	function	Creates cross-database SQL dates.
HandlerBase::getDateFormat	public	function	Creates cross-database SQL date formatting.
HandlerBase::getEntityType	public	function
HandlerBase::getField	public	function
HandlerBase::getJoin	public	function
HandlerBase::getModuleHandler	protected	function	Gets the module handler.
HandlerBase::getTableJoin	public static	function
HandlerBase::getViewsData	protected	function	Gets views data service.
HandlerBase::hasExtraOptions	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.
HandlerBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter.
HandlerBase::isExposed	public	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput	public	function	Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.
HandlerBase::placeholder	protected	function	Provides a unique placeholders for handlers.
HandlerBase::postExecute	public	function
HandlerBase::preQuery	public	function
HandlerBase::sanitizeValue	public	function
HandlerBase::setModuleHandler	public	function	Sets the module handler.
HandlerBase::setRelationship	public	function
HandlerBase::setViewsData	public	function
HandlerBase::showExposeButton	public	function	Shortcut to display the expose/hide button.
HandlerBase::showExposeForm	public	function	Shortcut to display the exposed options form.
HandlerBase::storeExposedInput	public	function	If set to remember exposed input in the session, store it there.
HandlerBase::submitExposed	public	function	Submit the exposed handler form
HandlerBase::submitExposeForm	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitExtraOptionsForm	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
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. There is no need for this function to actually store the data.		1
HandlerBase::submitTemporaryForm	public	function	A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
HandlerBase::usesGroupBy	public	function	Provides the handler some groupby.
HandlerBase::validate	public	function
HandlerBase::validateExposed	public	function	Validate the exposed handler form
HandlerBase::validateExposeForm	public	function	Validate the options form.
HandlerBase::validateExtraOptionsForm	public	function	Validate the options form.
HandlerBase::__construct	public	function	Constructs a Handler object.		4
MessengerTrait::$messenger	protected	property	The messenger.		3
MessengerTrait::messenger	public	function	Gets the messenger.		3
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.		1
PluginBase::$definition	public	property	Plugins's 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::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.
PluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form.
PluginBase::$view	public	property	The top object of a view.
PluginBase::create	public static	function			5
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function
PluginBase::getAvailableGlobalTokens	public	function
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function			1
PluginBase::getPluginId	public	function
PluginBase::getProvider	public	function
PluginBase::getRenderer	protected	function	Returns the render API renderer.
PluginBase::globalTokenForm	public	function
PluginBase::globalTokenReplace	public	function
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function
PluginBase::preRenderAddFieldsetMarkup	public static	function
PluginBase::preRenderFlattenData	public static	function
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			1
PluginBase::themeFunctions	public	function
PluginBase::unpackOptions	public	function
PluginBase::usesOptions	public	function
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.		1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

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

class GroupByNumeric

Plugin annotation

Hierarchy

Related topics

File

Namespace

Members

API Navigation

Breadcrumb

class GroupByNumeric

Plugin annotation

Hierarchy

Related topics

File

Namespace

Members

API Navigation