class EntityFetchByField
Provides a 'Fetch entities by field' action.
@todo Add access callback information from Drupal 7.
Plugin annotation
@RulesAction(
id = "rules_entity_fetch_by_field",
label = @Translation("Fetch entities by field"),
category = @Translation("Entity"),
context_definitions = {
"type" = @ContextDefinition("string",
label = @Translation("Entity type"),
description = @Translation("Specify the type of the entity that should be fetched."),
options_provider = "\Drupal\rules\TypedData\Options\EntityTypeOptions",
),
"field_name" = @ContextDefinition("string",
label = @Translation("Field name"),
description = @Translation("Name of the field by which the entity is to be selected."),
options_provider = "\Drupal\rules\TypedData\Options\FieldListOptions",
),
"field_value" = @ContextDefinition("any",
label = @Translation("Field value"),
description = @Translation("The field value of the entity to be fetched.")
),
"limit" = @ContextDefinition("integer",
label = @Translation("Limit"),
description = @Translation("Limit the maximum number of fetched entities. Leave blank for all matching entities."),
default_value = NULL,
required = FALSE
),
},
provides = {
"entity_fetched" = @ContextDefinition("entity",
label = @Translation("Fetched entity"),
multiple = TRUE
),
}
)
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\rules\Core\RulesActionBase implements \Drupal\rules\Core\RulesActionInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\rules\Plugin\RulesAction\EntityFetchByField implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\rules\Core\RulesActionBase
- class \Drupal\rules\Core\RulesActionBase implements \Drupal\rules\Core\RulesActionInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of EntityFetchByField
File
-
src/
Plugin/ RulesAction/ EntityFetchByField.php, line 49
Namespace
Drupal\rules\Plugin\RulesActionView source
class EntityFetchByField extends RulesActionBase implements ContainerFactoryPluginInterface {
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* Constructs a EntityFetchByField object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->entityTypeManager = $entity_type_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager'));
}
/**
* {@inheritdoc}
*/
public function refineContextDefinitions(array $selected_data) {
if ($type = $this->getContextValue('type')) {
$this->pluginDefinition['provides']['entity_fetched']
->setDataType("entity:{$type}");
}
}
/**
* Executes the action with the given context.
*
* @param string $type
* The entity type id.
* @param string $field_name
* Name of the field by which the entity is to be selected.
* @param mixed $field_value
* The field value of the entity to be fetched.
* @param int $limit
* Limit on the maximum number of fetched entities.
*/
protected function doExecute($type, $field_name, $field_value, $limit = NULL) {
$storage = $this->entityTypeManager
->getStorage($type);
// When retrieving entities, if $limit is not set there is no need to use
// the query object directly.
if (is_null($limit)) {
$entities = $storage->loadByProperties([
$field_name => $field_value,
]);
}
else {
$query = $storage->getQuery();
$entity_ids = $query->accessCheck(TRUE)
->condition($field_name, $field_value, '=')
->range(0, $limit)
->execute();
$entities = $storage->loadMultiple($entity_ids);
}
// Set provided value.
// @todo Ensure that the provided context has the correct entity type.
$this->setProvidedValue('entity_fetched', $entities);
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
|---|---|---|---|---|---|---|
| ConfigurationAccessControlTrait::checkConfigurationAccess | public | function | Checks configuration permission. | |||
| ContextAwarePluginTrait::$context | protected | property | The data objects representing the context of this plugin. | |||
| ContextAwarePluginTrait::$initializedContextConfig | protected | property | Tracks whether the context has been initialized from configuration. | |||
| ContextAwarePluginTrait::getCacheContexts | public | function | 9 | |||
| ContextAwarePluginTrait::getCacheMaxAge | public | function | 7 | |||
| ContextAwarePluginTrait::getCacheTags | public | function | 4 | |||
| ContextAwarePluginTrait::getContext | public | function | ||||
| ContextAwarePluginTrait::getContextDefinition | public | function | ||||
| ContextAwarePluginTrait::getContextDefinitions | public | function | ||||
| ContextAwarePluginTrait::getContextMapping | public | function | ||||
| ContextAwarePluginTrait::getContexts | public | function | ||||
| ContextAwarePluginTrait::getContextValue | public | function | Aliased as: traitGetContextValue | |||
| ContextAwarePluginTrait::getContextValues | public | function | ||||
| ContextAwarePluginTrait::getPluginDefinition | abstract public | function | 1 | |||
| ContextAwarePluginTrait::setContext | public | function | 1 | |||
| ContextAwarePluginTrait::setContextMapping | public | function | ||||
| ContextAwarePluginTrait::setContextValue | public | function | ||||
| ContextAwarePluginTrait::validateContexts | public | function | ||||
| ContextProviderTrait::$providedContext | protected | property | The data objects that are provided by this plugin. | |||
| ContextProviderTrait::getProvidedContext | public | function | ||||
| ContextProviderTrait::getProvidedContextDefinition | public | function | ||||
| ContextProviderTrait::getProvidedContextDefinitions | public | function | ||||
| ContextProviderTrait::setProvidedValue | public | function | ||||
| ContextProviderTrait::upcastEntityId | public | function | Upcasts an entity id to a full entity object. | |||
| 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 | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | ||
| EntityFetchByField::$entityTypeManager | protected | property | The entity type manager. | |||
| EntityFetchByField::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | ||
| EntityFetchByField::doExecute | protected | function | Executes the action with the given context. | |||
| EntityFetchByField::refineContextDefinitions | public | function | Refines used and provided context definitions based upon context values. | Overrides RulesActionBase::refineContextDefinitions | ||
| EntityFetchByField::__construct | public | function | Constructs a EntityFetchByField object. | Overrides PluginBase::__construct | ||
| ExecutablePluginTrait::getLabelValue | protected | function | Get the translated label from the plugin definition. | |||
| ExecutablePluginTrait::summary | public | function | Get the translated summary from the label annotation. | 4 | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
| PluginBase::$pluginId | protected | property | The plugin_id. | |||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | |||
| RulesActionBase::$configuration | protected | property | The plugin configuration. | Overrides PluginBase::$configuration | ||
| RulesActionBase::access | public | function | Checks object access. | Overrides RulesActionInterface::access | ||
| RulesActionBase::assertMetadata | public | function | Asserts additional metadata for the selected data. | Overrides ContextAwarePluginInterface::assertMetadata | ||
| RulesActionBase::autoSaveContext | public | function | Returns a list of context names that should be auto-saved after execution. | Overrides RulesActionInterface::autoSaveContext | 14 | |
| RulesActionBase::calculateDependencies | public | function | @todo this documentation is not actually inherited from any interface. Do we need this empty implementation? |
|||
| RulesActionBase::defaultConfiguration | public | function | @todo this documentation is not actually inherited from any interface. Do we need this empty implementation? |
|||
| RulesActionBase::execute | public | function | Executes the plugin. | Overrides ExecutableInterface::execute | 2 | |
| RulesActionBase::executeMultiple | public | function | @todo this documentation is not actually inherited from any interface. Do we need this empty implementation? |
|||
| RulesActionBase::getConfiguration | public | function | @todo this documentation is not actually inherited from any interface. | |||
| RulesActionBase::getContextValue | public | function | Gets the value for a defined context. | Overrides ContextAwarePluginInterface::getContextValue | ||
| RulesActionBase::setConfiguration | public | function | @todo this documentation is not actually inherited from any interface. | |||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| 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. | 2 | ||
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |