You are here

Home » API reference » Fancy File Delete 2.0.x » DeleteFilesAction.php

class DeleteFilesAction in Fancy File Delete 2.0.x

Deletes Files.

Plugin annotation


@Action(
  id = "delete_files_action",
  label = @Translation("Delete Files"),
  type = "",
  pass_view = TRUE
)

Hierarchy

Expanded class hierarchy of DeleteFilesAction

File

src/Plugin/Action/DeleteFilesAction.php, line 23

Namespace

Drupal\fancy_file_delete\Plugin\Action
View source 
class DeleteFilesAction extends ViewsBulkOperationsActionBase implements ContainerFactoryPluginInterface {

  /**
   * The Batch Service.
   *
   * @var \Drupal\fancy_file_delete\FancyFileDeleteBatch
   */
  protected $batch;

  /**
   * Constructs a new DeleteFilesAction action.
   *
   * @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\fancy_file_delete\FancyFileDeleteBatch
   *   The Batch Service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, FancyFileDeleteBatch $batch) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->batch = $batch;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('fancy_file_delete.batch'));
  }

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $entities) {

    // Set entities to batch our way.
    $values = [];
    foreach ($entities as $entity) {
      if ($entity instanceof UnmanagedFiles) {
        $values[] = $entity
          ->getPath();
      }
      elseif ($entity instanceof File) {
        $values[] = $entity
          ->id();
      }
    }

    // Send to batch.
    $this->batch
      ->setBatch($values, FALSE);
  }

  /**
   * {@inheritdoc}
   */
  public function execute($entity = NULL) {
    $this
      ->executeMultiple([
      $entity,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    return $object
      ->access('delete', $account, $return_as_object);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DeleteFilesAction::$batch protected property The Batch Service.
DeleteFilesAction::access public function Checks object access. Overrides ActionInterface::access
DeleteFilesAction::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DeleteFilesAction::execute public function Executes the plugin. Overrides ExecutableInterface::execute 1
DeleteFilesAction::executeMultiple public function Execute action on multiple entities. Overrides ViewsBulkOperationsActionBase::executeMultiple 1
DeleteFilesAction::__construct public function Constructs a new DeleteFilesAction action. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
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. 4
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.
ViewsBulkOperationsActionBase::$configuration protected property Configuration array. Overrides PluginBase::$configuration
ViewsBulkOperationsActionBase::$context protected property Action context.
ViewsBulkOperationsActionBase::$view protected property The processed view.
ViewsBulkOperationsActionBase::customAccess public static function Default custom access callback.
ViewsBulkOperationsActionBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ViewsBulkOperationsActionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ViewsBulkOperationsActionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ViewsBulkOperationsActionBase::setContext public function Set action context. Overrides ViewsBulkOperationsActionInterface::setContext
ViewsBulkOperationsActionBase::setView public function Set view object. Overrides ViewsBulkOperationsActionInterface::setView
ViewsBulkOperationsActionBase::submitConfigurationForm public function Default configuration form submit handler. 1
ViewsBulkOperationsActionBase::validateConfigurationForm public function Default configuration form validator.
ViewsBulkOperationsActionCompletedTrait::finished public static function Batch finished callback. 1
ViewsBulkOperationsActionCompletedTrait::message public static function Set message function wrapper. 1
ViewsBulkOperationsActionCompletedTrait::translate public static function Translation function wrapper. 1