class OpenIDConnectLoginForm in OpenID Connect / OAuth client 2.x

Provides the OpenID Connect login form.

@package Drupal\openid_connect\Form

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\openid_connect\Form\OpenIDConnectLoginForm

File

src/Form/OpenIDConnectLoginForm.php, line 17

Namespace

Drupal\openid_connect\Form

class OpenIDConnectLoginForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The OpenID Connect claims.
   *
   * @var \Drupal\openid_connect\OpenIDConnectClaims
   */
  protected $claims;

  /**
   * The OpenID Connect session service.
   *
   * @var \Drupal\openid_connect\OpenIDConnectSessionInterface
   */
  protected $session;

  /**
   * The constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\openid_connect\OpenIDConnectClaims $claims
   *   The OpenID Connect claims.
   * @param \Drupal\openid_connect\OpenIDConnectSessionInterface $session
   *   The OpenID Connect session service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, OpenIDConnectClaims $claims, OpenIDConnectSessionInterface $session) {
    $this->entityTypeManager = $entity_type_manager;
    $this->claims = $claims;
    $this->session = $session;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : OpenIDConnectLoginForm {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('openid_connect.claims'), $container
      ->get('openid_connect.session'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'openid_connect_login_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) : array {
    $clients = $this->entityTypeManager
      ->getStorage('openid_connect_client')
      ->loadByProperties([
      'status' => TRUE,
    ]);
    foreach ($clients as $client_id => $client) {

      /** @var \Drupal\openid_connect\OpenIDConnectClientEntityInterface $client */
      $form['openid_connect_client_' . $client_id . '_login'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Log in with @client_title', [
          '@client_title' => $client
            ->label(),
        ]),
        '#name' => $client_id,
        '#prefix' => '<div>',
        '#suffix' => '</div>',
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->session
      ->saveDestination();
    $client_name = $form_state
      ->getTriggeringElement()['#name'];

    /** @var \Drupal\openid_connect\OpenIDConnectClientEntityInterface $client */
    $client = $this->entityTypeManager
      ->getStorage('openid_connect_client')
      ->loadByProperties([
      'id' => $client_name,
    ])[$client_name];
    $plugin = $client
      ->getPlugin();
    $scopes = $this->claims
      ->getScopes($plugin);
    $this->session
      ->saveOp('login');
    $response = $plugin
      ->authorize($scopes);
    $form_state
      ->setResponse($response);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route.
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
OpenIDConnectLoginForm::$claims	protected	property	The OpenID Connect claims.
OpenIDConnectLoginForm::$entityTypeManager	protected	property	The entity type manager.
OpenIDConnectLoginForm::$session	protected	property	The OpenID Connect session service.
OpenIDConnectLoginForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
OpenIDConnectLoginForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
OpenIDConnectLoginForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
OpenIDConnectLoginForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
OpenIDConnectLoginForm::__construct	public	function	The constructor.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.