class UserDeleteController in Delete all 2.x

Returns responses for devel module routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\delete_all\Controller\DeleteControllerBase
    • class \Drupal\delete_all\Controller\UserDeleteController

3 files declare their use of UserDeleteController

DeleteAllCommands.php in src/Commands/DeleteAllCommands.php

delete_all.drush.inc in drush/delete_all.drush.inc

delete all Drush command

PeopleDelete.php in src/Form/PeopleDelete.php

File

src/Controller/UserDeleteController.php, line 10

Namespace

Drupal\delete_all\Controller

class UserDeleteController extends DeleteControllerBase {

  /**
   * Get uids of the users to delete.
   *
   * @param array $roles
   *   Array of roles.
   *
   * @return array
   *   Array of uids of users to delete.
   */
  public function getUserToDelete($roles = FALSE) {
    $users_to_delete = [];

    // Get the uids of users to delete by role.
    if ($roles !== FALSE) {
      foreach ($roles as $role) {
        if (isset($role) && !empty($role)) {
          $uids = $this->connection
            ->select('user__roles', 'ur')
            ->fields('ur', [
            'entity_id',
          ])
            ->condition('roles_target_id', $role)
            ->execute()
            ->fetchCol('uid');
          $users_to_delete = array_merge($users_to_delete, $uids);

          // Exclude anonymous users and root.
          $users_to_delete = array_diff($users_to_delete, [
            0,
            1,
          ]);
        }
      }
    }
    else {
      $users_to_delete = FALSE;
    }
    return $users_to_delete;
  }

  /**
   *
   */
  public function getUserDeleteBatch($users_to_delete = FALSE) {

    // Define batch.
    $batch = [
      'operations' => [
        [
          'delete_all_users_batch_delete',
          [
            $users_to_delete,
          ],
        ],
      ],
      'finished' => 'delete_all_users_batch_delete_finished',
      'title' => $this
        ->t('Deleting users'),
      'init_message' => $this
        ->t('User deletion is starting.'),
      'progress_message' => $this
        ->t('Deleting users...'),
      'error_message' => $this
        ->t('User deletion has encountered an error.'),
    ];
    return $batch;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	46
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
DeleteControllerBase::$connection	protected	property
DeleteControllerBase::__construct	public	function
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UserDeleteController::getUserDeleteBatch	public	function
UserDeleteController::getUserToDelete	public	function	Get uids of the users to delete.