class DeleteActionDeriver in Entity API 8

Provides a delete action for each content entity type.

Hierarchy

• class \Drupal\Component\Plugin\Derivative\DeriverBase implements DeriverInterface
  • class \Drupal\entity\Plugin\Action\Derivative\DeleteActionDeriver implements ContainerDeriverInterface

File

src/Plugin/Action/Derivative/DeleteActionDeriver.php, line 16

Namespace

Drupal\entity\Plugin\Action\Derivative

class DeleteActionDeriver extends DeriverBase implements ContainerDeriverInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new DeleteActionDeriver object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, $base_plugin_id) {
    return new static($container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getDerivativeDefinitions($base_plugin_definition) {
    if (empty($this->derivatives)) {
      $definitions = [];
      foreach ($this
        ->getParticipatingEntityTypes() as $entity_type_id => $entity_type) {
        $definition = $base_plugin_definition;
        $definition['label'] = t('Delete @entity_type (Deprecated)', [
          '@entity_type' => $entity_type
            ->getSingularLabel(),
        ]);
        $definition['type'] = $entity_type_id;
        $definition['confirm_form_route_name'] = 'entity.' . $entity_type_id . '.delete_multiple_form';
        $definitions[$entity_type_id] = $definition;
      }
      $this->derivatives = $definitions;
    }
    return parent::getDerivativeDefinitions($base_plugin_definition);
  }

  /**
   * Gets a list of participating entity types.
   *
   * The list consists of all content entity types with a delete-multiple-form
   * link template.
   *
   * @return \Drupal\Core\Entity\EntityTypeInterface[]
   *   The participating entity types, keyed by entity type id.
   */
  protected function getParticipatingEntityTypes() {
    $entity_types = $this->entityTypeManager
      ->getDefinitions();
    $entity_types = array_filter($entity_types, function (EntityTypeInterface $entity_type) {

      // Core requires a "delete-multiple-confirm" form to be declared as well,
      // if it's missing, it's safe to assume that the entity type is still
      // relying on previous Entity API contrib behavior.
      return $entity_type
        ->hasLinkTemplate('delete-multiple-form') && !$entity_type
        ->hasHandlerClass('form', 'delete-multiple-confirm');
    });
    return $entity_types;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DeleteActionDeriver::$entityTypeManager	protected	property	The entity type manager.
DeleteActionDeriver::create	public static	function	Creates a new class instance. Overrides ContainerDeriverInterface::create
DeleteActionDeriver::getDerivativeDefinitions	public	function	Gets the definition of all derivatives of a base plugin. Overrides DeriverBase::getDerivativeDefinitions
DeleteActionDeriver::getParticipatingEntityTypes	protected	function	Gets a list of participating entity types.
DeleteActionDeriver::__construct	public	function	Constructs a new DeleteActionDeriver object.
DeriverBase::$derivatives	protected	property	List of derivative definitions.	1
DeriverBase::getDerivativeDefinition	public	function	Gets the definition of a derivative plugin. Overrides DeriverInterface::getDerivativeDefinition