class CancelUser

Same name in other branches
  1. 8.9.x core/modules/user/src/Plugin/Action/CancelUser.php \Drupal\user\Plugin\Action\CancelUser
  2. 10 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.

Plugin annotation


@Action(
  id = "user_cancel_user_action",
  label = @Translation("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 21

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 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.
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.