UserEmailVerificationVerifyEvent.php in User email verification 8

Namespace

Drupal\user_email_verification\Event

File

src/Event/UserEmailVerificationVerifyEvent.php

<?php

namespace Drupal\user_email_verification\Event;

use Drupal\user\UserInterface;
use Symfony\Component\EventDispatcher\Event;

/**
 * Wraps a user email verification event for event subscribers.
 *
 * @ingroup user_email_verification
 */
class UserEmailVerificationVerifyEvent extends Event {

  /**
   * The user account being verify.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $user;

  /**
   * Notify the user as blocked account.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $notifyAsBlocked;

  /**
   * Constructs a user email verification event object.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user account being verify.
   * @param bool $notify_as_blocked
   *   Whether to notify the user as blocked account.
   */
  public function __construct(UserInterface $user, $notify_as_blocked = FALSE) {
    $this->user = $user;
    $this->notifyAsBlocked = $notify_as_blocked;
  }

  /**
   * Get the user account being verify.
   *
   * @return \Drupal\user\UserInterface
   *   The user account.
   */
  public function getUser() {
    return $this->user;
  }

  /**
   * Gets whether if the user must be notified as blocked account.
   *
   * @return bool
   *   The user account.
   */
  public function notifyAsBlocked() : bool {
    return $this->notifyAsBlocked;
  }

  /**
   * Sets whether if the user must be notified as blocked account.
   *
   * @param bool $notify_as_blocked
   *   Whether the user must be notified as blocked account.
   */
  public function setNotifyAsBlocked($notify_as_blocked) {
    $this->notifyAsBlocked = $notify_as_blocked;
  }

}

Classes

Name	Description
UserEmailVerificationVerifyEvent	Wraps a user email verification event for event subscribers.