UserExpire.php in User Expire 8

Namespace

Drupal\user_expire\Plugin\RulesAction

File

src/Plugin/RulesAction/UserExpire.php

<?php

namespace Drupal\user_expire\Plugin\RulesAction;

use Drupal\rules\Core\RulesActionBase;
use Drupal\Core\Database\Connection;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides "Expire User" action.
 *
 * @RulesAction(
 *   id = "rules_user_expire",
 *   label = @Translation("Set a user expiration date"),
 *   category = @Translation("User"),
 *   context = {
 *     "user" = @ContextDefinition("entity:user",
 *       label = @Translation("User"),
 *       description = @Translation("Specifies the user, that should be expired.")
 *     ),
 *    "expiration" = @ContextDefinition("date",
 *       label = @Translation("Date"),
 *       description = @Translation("Specifies the date, when user should be expired.")
 *     )
 *   }
 * )
 */
class UserExpire extends RulesActionBase {

  /**
   * The database service.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * Constructs a \Drupal\user_expire\Plugin\RulesAction\UserExpire 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\Database\Connection $database
   *   The database service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $database) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->database = $database;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('database'));
  }

  /**
   * Expire user.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user object.
   * @param mixed $expiration
   *   User expiration date.
   */
  protected function doExecute(UserInterface $user, $expiration = NULL) {
    if (!empty($expiration)) {

      // If there's an expiration, save it.
      $this->database
        ->merge('user_expire')
        ->key([
        'uid' => $user
          ->id(),
      ])
        ->fields([
        'uid' => $user
          ->id(),
        'expiration' => $expiration,
      ])
        ->execute();
      $user->expiration = $expiration;
      user_expire_notify_user($user);
    }
    else {

      // If the expiration is not set, delete any value that might be set.
      if (!$user
        ->isNew()) {

        // New accounts can't have a record to delete.
        // Existing records (!is_new) might.
        // Remove user expiration times for this user.
        $deleted = $this->database
          ->delete('user_expire')
          ->condition('uid', $user
          ->id())
          ->execute();

        // Notify user that expiration time has been deleted.
        if ($deleted) {
          \Drupal::messenger()
            ->addMessage($this
            ->t("%name's expiration date has been reset.", [
            '%name' => $user
              ->getAccountName(),
          ]));
        }
      }
    }
  }

}

Classes

Name	Description
UserExpire	Provides "Expire User" action.