class ManyToOne
Same name in this branch
- 11.x core/modules/views/src/Plugin/views/filter/ManyToOne.php \Drupal\views\Plugin\views\filter\ManyToOne
Same name in other branches
- 9 core/modules/views/src/Plugin/views/filter/ManyToOne.php \Drupal\views\Plugin\views\filter\ManyToOne
- 9 core/modules/views/src/Plugin/views/argument/ManyToOne.php \Drupal\views\Plugin\views\argument\ManyToOne
- 8.9.x core/modules/views/src/Plugin/views/filter/ManyToOne.php \Drupal\views\Plugin\views\filter\ManyToOne
- 8.9.x core/modules/views/src/Plugin/views/argument/ManyToOne.php \Drupal\views\Plugin\views\argument\ManyToOne
- 10 core/modules/views/src/Plugin/views/filter/ManyToOne.php \Drupal\views\Plugin\views\filter\ManyToOne
- 10 core/modules/views/src/Plugin/views/argument/ManyToOne.php \Drupal\views\Plugin\views\argument\ManyToOne
Argument handler for many to one relationships.
An argument handler for use in fields that have a many to one relationship with the table(s) to the left. This adds a bunch of options that are reasonably common with this type of relationship. Definition terms:
- numeric: If true, the field will be considered numeric. Probably should always be set TRUE as views_handler_argument_string has many to one capabilities.
- zero is null: If true, a 0 will be handled as empty, so for example a default argument can be provided or a summary can be shown.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\argument\ArgumentPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\argument\ManyToOne extends \Drupal\views\Plugin\views\argument\ArgumentPluginBase
- class \Drupal\views\Plugin\views\argument\ArgumentPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of ManyToOne
Related topics
2 files declare their use of ManyToOne
- IndexTid.php in core/
modules/ taxonomy/ src/ Plugin/ views/ argument/ IndexTid.php - RolesRid.php in core/
modules/ user/ src/ Plugin/ views/ argument/ RolesRid.php
File
-
core/
modules/ views/ src/ Plugin/ views/ argument/ ManyToOne.php, line 26
Namespace
Drupal\views\Plugin\views\argumentView source
class ManyToOne extends ArgumentPluginBase {
/**
* The many-to-one helper.
*/
public ManyToOneHelper $helper;
/**
* {@inheritdoc}
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, ?array &$options = NULL) {
parent::init($view, $display, $options);
$this->helper = new ManyToOneHelper($this);
// Ensure defaults for these, during summaries and stuff:
$this->operator = 'or';
$this->value = [];
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['break_phrase'] = [
'default' => FALSE,
];
$options['add_table'] = [
'default' => FALSE,
];
$options['require_value'] = [
'default' => FALSE,
];
if (isset($this->helper)) {
$this->helper
->defineOptions($options);
}
else {
$helper = new ManyToOneHelper($this);
$helper->defineOptions($options);
}
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
// Allow '+' for "or". Allow ',' for "and".
$form['break_phrase'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow multiple values'),
'#description' => $this->t('If selected, users can enter multiple values in the form of 1+2+3 (for OR) or 1,2,3 (for AND).'),
'#default_value' => !empty($this->options['break_phrase']),
'#group' => 'options][more',
];
$form['add_table'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow multiple filter values to work together'),
'#description' => $this->t('If selected, multiple instances of this filter can work together, as though multiple values were supplied to the same filter. This setting is not compatible with the "Reduce duplicates" setting.'),
'#default_value' => !empty($this->options['add_table']),
'#group' => 'options][more',
];
$form['require_value'] = [
'#type' => 'checkbox',
'#title' => $this->t('Do not display items with no value in summary'),
'#default_value' => !empty($this->options['require_value']),
'#group' => 'options][more',
];
$this->helper
->buildOptionsForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function ensureMyTable() {
$this->helper
->ensureMyTable();
}
public function query($group_by = FALSE) {
$empty = FALSE;
if (isset($this->definition['zero is null']) && $this->definition['zero is null']) {
if (empty($this->argument)) {
$empty = TRUE;
}
}
else {
if (!isset($this->argument)) {
$empty = TRUE;
}
}
if ($empty) {
parent::ensureMyTable();
$this->query
->addWhere(0, "{$this->tableAlias}.{$this->realField}", NULL, 'IS NULL');
return;
}
if (!empty($this->options['break_phrase'])) {
$force_int = !empty($this->definition['numeric']);
$this->unpackArgumentValue($force_int);
}
else {
$this->value = [
$this->argument,
];
$this->operator = 'or';
}
$this->helper
->addFilter();
}
public function title() {
if (!$this->argument) {
return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : $this->t('Uncategorized');
}
if (!empty($this->options['break_phrase'])) {
$force_int = !empty($this->definition['numeric']);
$this->unpackArgumentValue($force_int);
}
else {
$this->value = [
$this->argument,
];
$this->operator = 'or';
}
// @todo Both of these should check definition for alternate keywords.
if (empty($this->value)) {
return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : $this->t('Uncategorized');
}
if ($this->value === [
-1,
]) {
return !empty($this->definition['invalid input']) ? $this->definition['invalid input'] : $this->t('Invalid input');
}
return implode($this->operator == 'or' ? ' + ' : ', ', $this->titleQuery());
}
protected function summaryQuery() {
$field = $this->table . '.' . $this->field;
$join = $this->getJoin();
if (!empty($this->options['require_value'])) {
$join->type = 'INNER';
}
if (empty($this->options['add_table']) || empty($this->view->many_to_one_tables[$field])) {
$this->tableAlias = $this->query
->ensureTable($this->table, $this->relationship, $join);
}
else {
$this->tableAlias = $this->helper
->summaryJoin();
}
// Add the field.
$this->base_alias = $this->query
->addField($this->tableAlias, $this->realField);
$this->summaryNameField();
return $this->summaryBasics();
}
public function summaryArgument($data) {
$value = $data->{$this->base_alias};
if (empty($value)) {
$value = 0;
}
return $value;
}
/**
* Override for specific title lookups.
*/
public function titleQuery() {
return $this->value;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ArgumentPluginBase::$argument | public | property | |||
ArgumentPluginBase::$argument_validated | public | property | |||
ArgumentPluginBase::$base_alias | public | property | |||
ArgumentPluginBase::$count_alias | public | property | |||
ArgumentPluginBase::$is_default | public | property | |||
ArgumentPluginBase::$name_alias | public | property | |||
ArgumentPluginBase::$name_field | public | property | |||
ArgumentPluginBase::$name_table | public | property | |||
ArgumentPluginBase::$name_table_alias | public | property | |||
ArgumentPluginBase::$operator | public | property | The operator used for the query: or|and. | ||
ArgumentPluginBase::$tableAliases | public | property | Keyed array by alias of table relations. | ||
ArgumentPluginBase::$validated_title | public | property | |||
ArgumentPluginBase::$validator | public | property | |||
ArgumentPluginBase::$value | public | property | 1 | ||
ArgumentPluginBase::adminSummary | public | function | Overrides HandlerBase::adminSummary | ||
ArgumentPluginBase::calculateDependencies | public | function | Overrides HandlerBase::calculateDependencies | ||
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 | Default actions. | 3 | |
ArgumentPluginBase::defaultArgumentForm | public | function | Provides a form for selecting the default argument. | 1 | |
ArgumentPluginBase::defaultDefault | protected | function | Returns true, since the argument builder knows where to find the argument. | ||
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 | Provides a form for selecting summary options. | ||
ArgumentPluginBase::encodeValidatorId | public static | function | Sanitize validator options including derivatives with : for js. | ||
ArgumentPluginBase::exceptionTitle | public | function | |||
ArgumentPluginBase::getCacheContexts | public | function | Overrides CacheableDependencyInterface::getCacheContexts | ||
ArgumentPluginBase::getCacheMaxAge | public | function | Overrides CacheableDependencyInterface::getCacheMaxAge | ||
ArgumentPluginBase::getCacheTags | public | function | Overrides CacheableDependencyInterface::getCacheTags | ||
ArgumentPluginBase::getContextDefinition | public | function | Returns a context definition for this argument. | 2 | |
ArgumentPluginBase::getDefaultArgument | public | function | Get a default argument, if available. | 1 | |
ArgumentPluginBase::getPlugin | public | function | Get the display or row plugin, if it exists. | ||
ArgumentPluginBase::getSortName | public | function | Return a description of how the argument would normally be sorted. | 5 | |
ArgumentPluginBase::getTitle | public | function | Determines the title to use for the view. | ||
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::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 | Overrides PluginBase::submitOptionsForm | ||
ArgumentPluginBase::summaryBasics | public | function | Adds basic information to the summary query. | ||
ArgumentPluginBase::summaryName | public | function | Provides the name to use for the summary, defaults to the name field. | 9 | |
ArgumentPluginBase::summaryNameField | protected | function | Adds the name field, which is the field displayed in summary queries. | ||
ArgumentPluginBase::summarySort | public | function | Sorts the summary based upon the user's selection. | ||
ArgumentPluginBase::trustedCallbacks | public static | function | Overrides PluginBase::trustedCallbacks | ||
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 | Overrides PluginBase::validateOptionsForm | ||
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 | |
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::acceptExposedInput | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | |
HandlerBase::access | public | function | Overrides ViewsHandlerInterface::access | 5 | |
HandlerBase::adminLabel | public | function | Overrides ViewsHandlerInterface::adminLabel | 4 | |
HandlerBase::breakString | public static | function | Overrides ViewsHandlerInterface::breakString | ||
HandlerBase::broken | public | function | Overrides ViewsHandlerInterface::broken | ||
HandlerBase::buildExposedForm | public | function | Render our chunk of the exposed handler form when selecting. | 1 | |
HandlerBase::buildExposeForm | public | function | Form for exposed handler options. | 2 | |
HandlerBase::buildExtraOptionsForm | public | function | Provide a form for setting options. | 2 | |
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | |
HandlerBase::canExpose | public | function | Determine if a handler can be exposed. | 2 | |
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. | 2 | |
HandlerBase::defineExtraOptions | public | function | Provide defaults for the handler. | ||
HandlerBase::displayExposedForm | public | function | Displays the Expose form. | ||
HandlerBase::exposedInfo | public | function | Get information about the exposed form for the form renderer. | 1 | |
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::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 | |
HandlerBase::isExposed | public | function | Determine if this item is 'exposed'. | ||
HandlerBase::multipleExposedInput | public | function | Define if the exposed input has to be submitted multiple times. | 1 | |
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::showExposeButton | public | function | Shortcut to display the expose/hide button. | 2 | |
HandlerBase::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | |
HandlerBase::storeExposedInput | public | function | If set to remember exposed input in the session, store it there. | 1 | |
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::validate | public | function | Overrides PluginBase::validate | 2 | |
HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 5 | |
HandlerBase::validateExposeForm | public | function | Validate the options form. | 2 | |
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | 1 | |
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 43 |
ManyToOne::$helper | public | property | The many-to-one helper. | ||
ManyToOne::buildOptionsForm | public | function | Overrides ArgumentPluginBase::buildOptionsForm | ||
ManyToOne::defineOptions | protected | function | Overrides ArgumentPluginBase::defineOptions | ||
ManyToOne::ensureMyTable | public | function | Overrides HandlerBase::ensureMyTable | ||
ManyToOne::init | public | function | Overrides ArgumentPluginBase::init | ||
ManyToOne::query | public | function | Overrides ArgumentPluginBase::query | ||
ManyToOne::summaryArgument | public | function | Overrides ArgumentPluginBase::summaryArgument | ||
ManyToOne::summaryQuery | protected | function | Overrides ArgumentPluginBase::summaryQuery | ||
ManyToOne::title | public | function | Overrides ArgumentPluginBase::title | ||
ManyToOne::titleQuery | public | function | Override for specific title lookups. | 2 | |
PluginBase::$definition | public | property | Plugins' 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' 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.