You are here

interface MagicUrlInterface in Open Social 8.8

Same name and namespace in other branches
  1. 8.9 modules/custom/social_magic_login/src/Service/MagicUrlInterface.php \Drupal\social_magic_login\Service\MagicUrlInterface
  2. 8.5 modules/custom/social_magic_login/src/Service/MagicUrlInterface.php \Drupal\social_magic_login\Service\MagicUrlInterface
  3. 8.6 modules/custom/social_magic_login/src/Service/MagicUrlInterface.php \Drupal\social_magic_login\Service\MagicUrlInterface
  4. 8.7 modules/custom/social_magic_login/src/Service/MagicUrlInterface.php \Drupal\social_magic_login\Service\MagicUrlInterface
  5. 10.3.x modules/custom/social_magic_login/src/Service/MagicUrlInterface.php \Drupal\social_magic_login\Service\MagicUrlInterface
  6. 10.0.x modules/custom/social_magic_login/src/Service/MagicUrlInterface.php \Drupal\social_magic_login\Service\MagicUrlInterface
  7. 10.1.x modules/custom/social_magic_login/src/Service/MagicUrlInterface.php \Drupal\social_magic_login\Service\MagicUrlInterface
  8. 10.2.x modules/custom/social_magic_login/src/Service/MagicUrlInterface.php \Drupal\social_magic_login\Service\MagicUrlInterface

Interface that allows the generation of one-time login links.

Hierarchy

Expanded class hierarchy of MagicUrlInterface

All classes that implement MagicUrlInterface

File

modules/custom/social_magic_login/src/Service/MagicUrlInterface.php, line 11

Namespace

Drupal\social_magic_login\Service
View source
interface MagicUrlInterface {

  /**
   * Create a magic login link.
   *
   * @param \Drupal\user\UserInterface $account
   *   An object containing the user account.
   * @param string $destination
   *   The uri of the final destination.
   * @param array $options
   *   (optional) A keyed array of settings. Supported options are:
   *   - langcode: A language code to be used when generating locale-sensitive
   *    URLs. If langcode is NULL the users preferred language is used.
   *
   * @return \Drupal\Core\Url|null
   *   An url based on the magic login route.
   */
  public function create(UserInterface $account, string $destination, array $options) : ?Url;

}

Members

Namesort descending Modifiers Type Description Overrides
MagicUrlInterface::create public function Create a magic login link. 1