You are here

interface UserManagementServiceInterface in Auto Purge Users 8.3

Same name and namespace in other branches
  1. 8.2 src/Services/UserManagementServiceInterface.php \Drupal\purge_users\Services\UserManagementServiceInterface

Contract for the purge service.

Hierarchy

Expanded class hierarchy of UserManagementServiceInterface

All classes that implement UserManagementServiceInterface

2 files declare their use of UserManagementServiceInterface
NotifyUsersQueueWorker.php in src/Plugin/QueueWorker/NotifyUsersQueueWorker.php
PurgeUsersQueueWorker.php in src/Plugin/QueueWorker/PurgeUsersQueueWorker.php

File

src/Services/UserManagementServiceInterface.php, line 10

Namespace

Drupal\purge_users\Services
View source
interface UserManagementServiceInterface {

  /**
   * Cancel a user and anonymize it.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user to block.
   * @param string $method
   *   The cancel method to use.
   */
  public function purgeUser(UserInterface $user, string $method);

  /**
   * Sends a user notification before cancel and anonymize it.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user to block.
   */
  public function notifyUser(UserInterface $user) : void;

}

Members

Namesort descending Modifiers Type Description Overrides
UserManagementServiceInterface::notifyUser public function Sends a user notification before cancel and anonymize it. 1
UserManagementServiceInterface::purgeUser public function Cancel a user and anonymize it. 1