class PurgeUsersQueueWorker in Auto Purge Users 8

Processes cron queue.

Plugin annotation

@QueueWorker(
  id = "purge_users",
  title = @Translation("Purge Users Tasks Worker: Purge Users"),
  cron = {"time" = 15}
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Queue\QueueWorkerBase implements QueueWorkerInterface
    • class \Drupal\purge_users\Plugin\QueueWorker\PurgeUsersQueueWorker uses StringTranslationTrait

File

src/Plugin/QueueWorker/PurgeUsersQueueWorker.php, line 17

Namespace

Drupal\purge_users\Plugin\QueueWorker

class PurgeUsersQueueWorker extends QueueWorkerBase {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function processItem($account) {
    $name = $account
      ->get('name')->value;
    $mail = $account
      ->get('mail')->value;
    $uid = $account
      ->get('uid')->value;

    // Send a notification email.
    $config = \Drupal::config('purge_users.settings');
    $send_notification = $config
      ->get('send_email_notification');
    $method = $config
      ->get('purge_user_cancel_method');
    if ($method != 'user_cancel_delete') {

      // Allow modules to add further sets to this batch.
      $handler = \Drupal::moduleHandler();
      $handler
        ->invokeAll('user_cancel', array(
        array(),
        $account,
        $method,
      ));
    }
    if ($send_notification == 1) {
      purge_users_send_notification_email($account);
    }
    user_delete($uid);

    // Log purged user.
    $message = $this
      ->t('Purged user: %name < %mail >', array(
      '%name' => $name,
      '%mail' => $mail,
    ));
    \Drupal::logger('purge_users')
      ->notice($message);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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	3
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
PurgeUsersQueueWorker::processItem	public	function	Works on a single queue item. Overrides QueueWorkerInterface::processItem
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.