class DeleteAction

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Action/Plugin/Action/DeleteAction.php \Drupal\Core\Action\Plugin\Action\DeleteAction
  2. 10 core/lib/Drupal/Core/Action/Plugin/Action/DeleteAction.php \Drupal\Core\Action\Plugin\Action\DeleteAction
  3. 11.x core/lib/Drupal/Core/Action/Plugin/Action/DeleteAction.php \Drupal\Core\Action\Plugin\Action\DeleteAction

Redirects to an entity deletion form.

Plugin annotation


@Action(
  id = "entity:delete_action",
  action_label = @Translation("Delete"),
  deriver = "Drupal\Core\Action\Plugin\Action\Derivative\EntityDeleteActionDeriver",
)

Hierarchy

Expanded class hierarchy of DeleteAction

File

core/lib/Drupal/Core/Action/Plugin/Action/DeleteAction.php, line 19

Namespace

Drupal\Core\Action\Plugin\Action
View source
class DeleteAction extends EntityActionBase {
    
    /**
     * The tempstore object.
     *
     * @var \Drupal\Core\TempStore\SharedTempStore
     */
    protected $tempStore;
    
    /**
     * The current user.
     *
     * @var \Drupal\Core\Session\AccountInterface
     */
    protected $currentUser;
    
    /**
     * Constructs a new DeleteAction 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.
     * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
     *   The tempstore factory.
     * @param \Drupal\Core\Session\AccountInterface $current_user
     *   Current user.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, PrivateTempStoreFactory $temp_store_factory, AccountInterface $current_user) {
        $this->currentUser = $current_user;
        $this->tempStore = $temp_store_factory->get('entity_delete_multiple_confirm');
        parent::__construct($configuration, $plugin_id, $plugin_definition, $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'), $container->get('tempstore.private'), $container->get('current_user'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function executeMultiple(array $entities) {
        
        /** @var \Drupal\Core\Entity\EntityInterface[] $entities */
        $selection = [];
        foreach ($entities as $entity) {
            $langcode = $entity->language()
                ->getId();
            $selection[$entity->id()][$langcode] = $langcode;
        }
        $this->tempStore
            ->set($this->currentUser
            ->id() . ':' . $this->getPluginDefinition()['type'], $selection);
    }
    
    /**
     * {@inheritdoc}
     */
    public function execute($object = NULL) {
        $this->executeMultiple([
            $object,
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
        return $object->access('delete', $account, $return_as_object);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DeleteAction::$currentUser protected property The current user.
DeleteAction::$tempStore protected property The tempstore object.
DeleteAction::access public function Checks object access. Overrides ActionInterface::access
DeleteAction::create public static function Creates an instance of the plugin. Overrides EntityActionBase::create
DeleteAction::execute public function Executes the plugin. Overrides ExecutableInterface::execute
DeleteAction::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
DeleteAction::__construct public function Constructs a new DeleteAction object. Overrides EntityActionBase::__construct
EntityActionBase::$entityTypeManager protected property The entity type manager.
EntityActionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
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

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