class CancelUser

Same name and namespace in other branches
  1. 9 core/modules/user/src/Plugin/Action/CancelUser.php \Drupal\user\Plugin\Action\CancelUser
  2. 8.9.x core/modules/user/src/Plugin/Action/CancelUser.php \Drupal\user\Plugin\Action\CancelUser
  3. 11.x core/modules/user/src/Plugin/Action/CancelUser.php \Drupal\user\Plugin\Action\CancelUser

Cancels a user account.

Attributes

#[Action(id: 'user_cancel_user_action', label: new TranslatableMarkup('Cancel the selected user accounts'), type: 'user', confirm_form_route_name: 'user.multiple_cancel_confirm')]

Hierarchy

Expanded class hierarchy of CancelUser

File

core/modules/user/src/Plugin/Action/CancelUser.php, line 16

Namespace

Drupal\user\Plugin\Action
View source
class CancelUser extends ActionBase implements ContainerFactoryPluginInterface {
  
  /**
   * The tempstore factory.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;
  
  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;
  
  /**
   * Constructs a CancelUser 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\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, PrivateTempStoreFactory $temp_store_factory, AccountInterface $current_user) {
    $this->currentUser = $current_user;
    $this->tempStoreFactory = $temp_store_factory;
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('tempstore.private'), $container->get('current_user'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $entities) {
    $this->tempStoreFactory
      ->get('user_user_operations_cancel')
      ->set($this->currentUser
      ->id(), $entities);
  }
  
  /**
   * {@inheritdoc}
   */
  public function execute($object = NULL) {
    $this->executeMultiple([
      $object,
    ]);
  }
  
  /**
   * {@inheritdoc}
   */
  public function access($object, ?AccountInterface $account = NULL, $return_as_object = FALSE) {
    /** @var \Drupal\user\UserInterface $object */
    return $object->access('delete', $account, $return_as_object);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CancelUser::$currentUser protected property The current user.
CancelUser::$tempStoreFactory protected property The tempstore factory.
CancelUser::access public function Checks object access. Overrides ActionInterface::access
CancelUser::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CancelUser::execute public function Executes the plugin. Overrides ExecutableInterface::execute
CancelUser::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
CancelUser::__construct public function Constructs a CancelUser object. Overrides PluginBase::__construct
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 2
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange] 2
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
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 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. 3
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.

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