class EntityFetchById

Provides a 'Fetch entity by id' action.

@todo Add access callback information from Drupal 7. @todo Port for rules_entity_action_type_options.

Plugin annotation


@RulesAction(
  id = "rules_entity_fetch_by_id",
  label = @Translation("Fetch entity by id"),
  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",
      assignment_restriction = "input"
    ),
    "entity_id" = @ContextDefinition("integer",
      label = @Translation("Identifier"),
      description = @Translation("The id of the entity that should be fetched.")
    ),
  },
  provides = {
    "entity_fetched" = @ContextDefinition("entity",
      label = @Translation("Fetched entity")
    ),
  }
)

Hierarchy

Expanded class hierarchy of EntityFetchById

File

src/Plugin/RulesAction/EntityFetchById.php, line 39

Namespace

Drupal\rules\Plugin\RulesAction
View source 
class EntityFetchById extends RulesActionBase implements ContainerFactoryPluginInterface {
    
    /**
     * The entity type manager service.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a EntityFetchById 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 int $entity_id
     *   The entity id.
     */
    protected function doExecute($type, $entity_id) {
        $storage = $this->entityTypeManager
            ->getStorage($type);
        $entity = $storage->load($entity_id);
        $this->setProvidedValue('entity_fetched', $entity);
    }

}

Members

Title 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.
EntityFetchById::$entityTypeManager protected property The entity type manager service.
EntityFetchById::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityFetchById::doExecute protected function Executes the action with the given context.
EntityFetchById::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides RulesActionBase::refineContextDefinitions
EntityFetchById::__construct public function Constructs a EntityFetchById object.
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
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RulesActionBase::$configuration protected property The plugin 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.