class EntityArgument
Same name in other branches
- 11.x core/modules/views/src/Plugin/views/argument/EntityArgument.php \Drupal\views\Plugin\views\argument\EntityArgument
Argument handler to accept an entity ID value.
This handler accepts the identifiers of entities themselves. The definition defines the `entity_type` parameter to determine what kind of ID to load. Entity reference ID values are handled by EntityReferenceArgument.
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\NumericArgument extends \Drupal\views\Plugin\views\argument\ArgumentPluginBase
- class \Drupal\views\Plugin\views\argument\EntityArgument extends \Drupal\views\Plugin\views\argument\NumericArgument implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\views\Plugin\views\argument\NumericArgument 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 EntityArgument
See also
\Drupal\views\Plugin\views\argument\EntityReferenceArgument
Related topics
5 files declare their use of EntityArgument
- Fid.php in core/
modules/ file/ src/ Plugin/ views/ argument/ Fid.php - Nid.php in core/
modules/ node/ src/ Plugin/ views/ argument/ Nid.php - Taxonomy.php in core/
modules/ taxonomy/ src/ Plugin/ views/ argument/ Taxonomy.php - Uid.php in core/
modules/ user/ src/ Plugin/ views/ argument/ Uid.php - VocabularyVid.php in core/
modules/ taxonomy/ src/ Plugin/ views/ argument/ VocabularyVid.php
File
-
core/
modules/ views/ src/ Plugin/ views/ argument/ EntityArgument.php, line 23
Namespace
Drupal\views\Plugin\views\argumentView source
class EntityArgument extends NumericArgument implements ContainerFactoryPluginInterface {
protected EntityRepositoryInterface $entityRepository;
protected EntityTypeManagerInterface $entityTypeManager;
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityRepositoryInterface|EntityStorageInterface|EntityTypeManagerInterface $entityRepository, ?EntityTypeManagerInterface $entityTypeManager = NULL) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
if (!$entityRepository instanceof EntityRepositoryInterface) {
@trigger_error('Passing either \\Drupal\\Core\\Entity\\EntityStorageInterface or \\Drupal\\Core\\Entity\\EntityTypeManagerInterface to ' . __METHOD__ . '() as argument 4 is deprecated in drupal:10.3.0 and will be removed before drupal:11.0.0. Pass a Drupal\\Core\\Entity\\EntityRepositoryInterface instead. See https://www.drupal.org/node/3441945', E_USER_DEPRECATED);
$entityRepository = \Drupal::service('entity.repository');
}
$this->entityRepository = $entityRepository;
if ($entityTypeManager === NULL) {
@trigger_error('Not passing the \\Drupal\\Core\\Entity\\EntityTypeManagerInterface to ' . __METHOD__ . '() as argument 5 is deprecated in drupal:10.3.0 and will be required before drupal:11.0.0. See https://www.drupal.org/node/3441945', E_USER_DEPRECATED);
$entityTypeManager = \Drupal::service('entity_type.manager');
}
$this->entityTypeManager = $entityTypeManager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity.repository'), $container->get('entity_type.manager'));
}
/**
* {@inheritdoc}
*/
public function titleQuery() {
$titles = [];
$entities = $this->entityTypeManager
->getStorage($this->definition['entity_type'])
->loadMultiple($this->value);
foreach ($entities as $entity) {
$titles[$entity->id()] = $this->entityRepository
->getTranslationFromContext($entity)
->label();
}
return $titles;
}
/**
* Array of deprecated storage properties that legacy classes might access.
*
* This class is replacing many separate plugins from different core modules,
* each of which had a storage property for their own entity type. We can't
* use Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait since
* these are not registered as services, but are the storage "sub-service"
* from the entityTypeManager for each entity type.
*/
protected array $deprecatedStorageProperties = [
'nodeStorage' => 'node',
'termStorage' => 'taxonomy_term',
'vocabularyStorage' => 'taxonomy_vocabulary',
'storage' => 'user',
];
/**
* Allows to access deprecated/removed properties.
*
* This method must be public.
*/
public function __get($name) {
if (isset($this->deprecatedStorageProperties[$name])) {
$storage_name = $this->deprecatedStorageProperties[$name];
$class_name = static::class;
// phpcs:ignore Drupal.Semantics.FunctionTriggerError
@trigger_error("The property {$name} ({$storage_name} storage service) is deprecated in {$class_name} and will be removed before Drupal 11.0.0. See https://www.drupal.org/node/3441945", E_USER_DEPRECATED);
return $this->entityTypeManager
->getStorage($storage_name);
}
}
}
Members
Title Sort descending | Deprecated | 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::adminSummary | public | function | Provide text for the administrative summary. | Overrides HandlerBase::adminSummary | ||
ArgumentPluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | 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 | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | ||
ArgumentPluginBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | ||
ArgumentPluginBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | ||
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::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::init | public | function | Overrides Drupal\views\Plugin\views\HandlerBase:init(). | Overrides HandlerBase::init | 5 | |
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 | Handle any special handling on the validate form. | Overrides PluginBase::submitOptionsForm | ||
ArgumentPluginBase::summaryArgument | public | function | Provides the argument to use to link from the summary to the next level. | 4 | ||
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::summaryQuery | protected | function | Build the info for the summary query. | 3 | ||
ArgumentPluginBase::summarySort | public | function | Sorts the summary based upon the user's selection. | |||
ArgumentPluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | 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 | Validate the options form. | 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 | ||
EntityArgument::$deprecatedStorageProperties | protected | property | Array of deprecated storage properties that legacy classes might access. | |||
EntityArgument::$entityRepository | protected | property | ||||
EntityArgument::$entityTypeManager | protected | property | ||||
EntityArgument::create | public static | function | Creates an instance of the plugin. | Overrides PluginBase::create | ||
EntityArgument::titleQuery | public | function | Override for specific title lookups. | Overrides NumericArgument::titleQuery | ||
EntityArgument::__construct | public | function | Constructs a Handler object. | Overrides HandlerBase::__construct | ||
EntityArgument::__get | public | function | Allows to access deprecated/removed properties. | |||
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 | Check whether given user has access to this handler. | Overrides ViewsHandlerInterface::access | 5 | |
HandlerBase::adminLabel | public | function | Return a string representing this handler'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 'broken'. | 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. | 1 | ||
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::ensureMyTable | public | function | Ensures that the main table for this handler is in the query. | Overrides ViewsHandlerInterface::ensureMyTable | 2 | |
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 | Determines the entity type used by this handler. | Overrides ViewsHandlerInterface::getEntityType | ||
HandlerBase::getField | public | function | Shortcut to get a handler'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::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 | 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::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. | |||
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 | Validate that the plugin is correct and can be saved. | Overrides PluginBase::validate | 2 | |
HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 4 | ||
HandlerBase::validateExposeForm | public | function | Validate the options form. | 2 | ||
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | |||
NumericArgument::$value | public | property | The actual value which is used for querying. | Overrides ArgumentPluginBase::$value | ||
NumericArgument::buildOptionsForm | public | function | Provide a form to edit options for this plugin. | Overrides ArgumentPluginBase::buildOptionsForm | 1 | |
NumericArgument::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides ArgumentPluginBase::defineOptions | 1 | |
NumericArgument::getContextDefinition | public | function | Returns a context definition for this argument. | Overrides ArgumentPluginBase::getContextDefinition | ||
NumericArgument::getSortName | public | function | Return a description of how the argument would normally be sorted. | Overrides ArgumentPluginBase::getSortName | ||
NumericArgument::query | public | function | Set up the query for this argument. | Overrides ArgumentPluginBase::query | ||
NumericArgument::title | public | function | Get the title this argument will assign the view, given the argument. | Overrides ArgumentPluginBase::title | ||
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::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' 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. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | 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.