final class ExternalAuthEvents in External Authentication 2.0.x

Defines events for the externalauth module.

Hierarchy

• class \Drupal\externalauth\Event\ExternalAuthEvents

See also

\Drupal\externalauth\Event\ExternalAuthRegisterEvent

\Drupal\externalauth\Event\ExternalAuthAuthmapAlterEvent

1 file declares its use of ExternalAuthEvents

ExternalAuth.php in src/ExternalAuth.php

File

src/Event/ExternalAuthEvents.php, line 11

Namespace

Drupal\externalauth\Event

final class ExternalAuthEvents {

  /**
   * Name of the event fired after a Drupal user was logged in.
   *
   * This event allows modules to react on the fact that a user logged in
   * to Drupal, following the authentication with an external service.
   * The event listener method receives a
   * \Drupal\externalauth\Event\ExternalAuthLoginEvent instance.
   *
   * @Event
   *
   * @see \Drupal\externalauth\Event\ExternalAuthLoginEvent
   *
   * @var string
   */
  const LOGIN = 'externalauth.login';

  /**
   * Name of the event fired after a Drupal user was registered.
   *
   * This event allows modules to react on the fact that a new "external" user
   * was registered, following the authentication with an external service.
   * The event listener method receives a
   * \Drupal\externalauth\Event\ExternalAuthRegisterEvent instance.
   *
   * @Event
   *
   * @see \Drupal\externalauth\Event\ExternalAuthRegisterEvent
   *
   * @var string
   */
  const REGISTER = 'externalauth.register';

  /**
   * Name of the event fired to alter the authmap data before it is stored.
   *
   * This event allows modules to alter the data from the external
   * authentication service that will be stored in the Drupal database, to map
   * Drupal users to external identities.
   *
   * The event listener method receives a
   * \Drupal\externalauth\Event\ExternalAuthAuthmapAlterEvent instance.
   *
   * @Event
   *
   * @see \Drupal\externalauth\Event\ExternalAuthAuthmapAlterEvent
   *
   * @var string
   */
  const AUTHMAP_ALTER = 'externalauth.authmap_alter';

}

Members

Name	Modifiers	Type	Description	Overrides
ExternalAuthEvents::AUTHMAP_ALTER		constant	Name of the event fired to alter the authmap data before it is stored.
ExternalAuthEvents::LOGIN		constant	Name of the event fired after a Drupal user was logged in.
ExternalAuthEvents::REGISTER		constant	Name of the event fired after a Drupal user was registered.