abstract class UserAuthenticator in Social API 3.x

Manages Drupal authentication tasks for Social API.

Hierarchy

• class \Drupal\social_api\User\UserAuthenticator

File

src/User/UserAuthenticator.php, line 13

Namespace

Drupal\social_api\User

abstract class UserAuthenticator {

  /**
   * The Drupal Entity Manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The current Drupal user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * The Messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * The Drupal logger factory.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $loggerFactory;

  /**
   * The entity type.
   *
   * @var string
   */
  protected $entityType;

  /**
   * The Social API user manager.
   *
   * @var \Drupal\social_api\User\UserManagerInterface
   */
  protected $userManager;

  /**
   * The Social API data handler.
   *
   * @var \Drupal\social_api\SocialApiDataHandler
   */
  protected $dataHandler;

  /**
   * Session keys to nullify is user could not be logged in.
   *
   * @var array
   */
  protected $sessionKeys;

  /**
   * The implementer plugin id.
   *
   * @var string
   */
  protected $pluginId;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   Used to get current active user.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   Used to display messages to user.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   Used for logging errors.
   * @param \Drupal\social_api\User\UserManagerInterface $user_manager
   *   The Social API user manager.
   * @param \Drupal\social_api\SocialApiDataHandler $data_handler
   *   Used to interact with session.
   */
  public function __construct(AccountProxyInterface $current_user, MessengerInterface $messenger, LoggerChannelFactoryInterface $logger_factory, UserManagerInterface $user_manager, SocialApiDataHandler $data_handler) {
    $this->currentUser = $current_user;
    $this->messenger = $messenger;
    $this->loggerFactory = $logger_factory;
    $this->userManager = $user_manager;
    $this->dataHandler = $data_handler;
  }

  /**
   * Sets the implementer plugin id.
   *
   * This value is used to generate customized logs, messages, and event
   * dispatchers.
   *
   * @param string $plugin_id
   *   The plugin id.
   */
  public function setPluginId($plugin_id) {
    $this->pluginId = $plugin_id;
    $this->userManager
      ->setPluginId($plugin_id);
  }

  /**
   * Gets the implementer plugin id.
   *
   * @return string
   *   The plugin id.
   */
  public function getPluginId() {
    return $this->pluginId;
  }

  /**
   * Sets the session keys to nullify if user could not logged in.
   *
   * @param array $session_keys
   *   The session keys to nullify.
   */
  public function setSessionKeysToNullify(array $session_keys) {
    $this->sessionKeys = $session_keys;
  }

  /**
   * Nullifies session keys if user could not logged in.
   */
  public function nullifySessionKeys() {
    if (!empty($this->sessionKeys)) {
      array_walk($this->sessionKeys, function ($session_key) {
        $this->dataHandler
          ->set($this->dataHandler
          ->getSessionPrefix() . $session_key, NULL);
      });
    }
  }

  /**
   * Returns the current user.
   *
   * @return \Drupal\Core\Session\AccountProxyInterface
   *   The current Drupal user.
   */
  public function currentUser() {
    return $this->currentUser;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
UserAuthenticator::$currentUser	protected	property	The current Drupal user.
UserAuthenticator::$dataHandler	protected	property	The Social API data handler.
UserAuthenticator::$entityType	protected	property	The entity type.
UserAuthenticator::$entityTypeManager	protected	property	The Drupal Entity Manager.
UserAuthenticator::$loggerFactory	protected	property	The Drupal logger factory.
UserAuthenticator::$messenger	protected	property	The Messenger service.
UserAuthenticator::$pluginId	protected	property	The implementer plugin id.
UserAuthenticator::$sessionKeys	protected	property	Session keys to nullify is user could not be logged in.
UserAuthenticator::$userManager	protected	property	The Social API user manager.
UserAuthenticator::currentUser	public	function	Returns the current user.
UserAuthenticator::getPluginId	public	function	Gets the implementer plugin id.
UserAuthenticator::nullifySessionKeys	public	function	Nullifies session keys if user could not logged in.
UserAuthenticator::setPluginId	public	function	Sets the implementer plugin id.
UserAuthenticator::setSessionKeysToNullify	public	function	Sets the session keys to nullify if user could not logged in.
UserAuthenticator::__construct	public	function	Constructor.