class DeleteAction in Entity Reference Integrity 8

Extends the core DeleteAction plugin.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\Core\Action\Plugin\Action\EntityActionBase implements DependentPluginInterface, ContainerFactoryPluginInterface
        • class \Drupal\Core\Action\Plugin\Action\DeleteAction
          • class \Drupal\entity_reference_integrity_enforce\Plugin\Action\DeleteAction

See also

\Drupal\Core\Action\Plugin\Action\DeleteAction

2 files declare their use of DeleteAction

DeleteActionTest.php in modules/entity_reference_integrity_enforce/tests/src/Kernel/DeleteActionTest.php

entity_reference_integrity_enforce.module in modules/entity_reference_integrity_enforce/entity_reference_integrity_enforce.module

Module file.

File

modules/entity_reference_integrity_enforce/src/Plugin/Action/DeleteAction.php, line 18

Namespace

Drupal\entity_reference_integrity_enforce\Plugin\Action

class DeleteAction extends CoreDeleteAction {

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {

    // First check if the account has access.
    $access = parent::access($object, $account, TRUE);

    // Bail if the object is not an entity or access is denied.
    if (!$object instanceof EntityInterface || !$access
      ->isAllowed()) {
      return $return_as_object ? $access : $access
        ->isAllowed();
    }

    // Check for dependent entities.
    $has_dependents = FALSE;
    $enabled_entity_type_ids = \Drupal::config('entity_reference_integrity_enforce.settings')
      ->get('enabled_entity_type_ids');
    if (in_array($object
      ->getEntityTypeId(), $enabled_entity_type_ids, TRUE)) {
      $has_dependents = $this->entityTypeManager
        ->getHandler($object
        ->getEntityTypeId(), 'entity_reference_integrity')
        ->hasDependents($object);
    }

    // Deny access if it has dependents.
    $reason = $this
      ->t('Can not delete the @entity_type_label %entity_label as it is being referenced by another entity.', [
      '@entity_type_label' => $object
        ->getEntityType()
        ->getLabel(),
      '%entity_label' => $object
        ->label(),
    ])
      ->render();
    $integrity_access = AccessResult::forbiddenIf($has_dependents, $reason);
    $access = $access
      ->orIf($integrity_access);
    return $return_as_object ? $access : $access
      ->isAllowed();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DeleteAction::$currentUser	protected	property	The current user.
DeleteAction::$tempStore	protected	property	The tempstore object.
DeleteAction::access	public	function	Checks object access. Overrides DeleteAction::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	2
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		1
DependencySerializationTrait::__wakeup	public	function		2
EntityActionBase::$entityTypeManager	protected	property	The entity type manager.
EntityActionBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
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::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.