class Oauth2ClientPluginConfigForm in OAuth2 Client 8.3

Configure OAuth2 Client settings for this site.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\oauth2_client\Form\Oauth2ClientPluginConfigForm

Expanded class hierarchy of Oauth2ClientPluginConfigForm

1 string reference to 'Oauth2ClientPluginConfigForm'

oauth2_client.routing.yml in ./oauth2_client.routing.yml: oauth2_client.routing.yml

File

src/Form/Oauth2ClientPluginConfigForm.php, line 14

Namespace

Drupal\oauth2_client\Form

View source

class Oauth2ClientPluginConfigForm extends FormBase {

  /**
   * The plugin being configured.
   *
   * @var \Drupal\oauth2_client\Plugin\Oauth2Client\Oauth2ClientPluginInterface
   */
  protected $plugin;

  /**
   * The Drupal state api.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * Injected client service.
   *
   * @var \Drupal\oauth2_client\Service\Oauth2ClientService
   */
  protected $clientService;

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $routeMatch = $instance
      ->getRouteMatch();
    $pluginId = $routeMatch
      ->getParameter('plugin');

    /** @var \Drupal\oauth2_client\PluginManager\Oauth2ClientPluginManager $pluginManager */
    $pluginManager = $container
      ->get('oauth2_client.plugin_manager');
    $config = $instance
      ->configFactory()
      ->get('oauth2_client.credentials.' . $pluginId)
      ->getRawData();
    $instance->plugin = $pluginManager
      ->createInstance($pluginId, $config);
    $instance->state = $container
      ->get('state');
    $instance->clientService = $container
      ->get('oauth2_client.service');
    $instance->messenger = $container
      ->get('messenger');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'oauth2_client_oauth2_client_plugin_config';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['title'] = [
      '#type' => 'html_tag',
      '#tag' => 'h2',
      '#value' => $this->plugin
        ->getName(),
    ];
    $form['plugin'] = [];
    $subformState = SubformState::createForSubform($form['plugin'], $form, $form_state);
    $form['plugin'] = $this->plugin
      ->buildConfigurationForm($form['plugin'], $subformState);
    $form['plugin']['#tree'] = TRUE;
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
      '#button_type' => 'primary',
    ];
    $form['actions']['test'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save and request token'),
      '#submit' => [
        '::testToken',
      ],
      '#button_type' => 'secondary',
    ];
    $form['#description'] = $this
      ->t('<em>Save</em> will simply save this configuration. <em>Save and request token</em> will save this configuration and then request and store a token for future use.');

    // By default, render the form using system-config-form.html.twig.
    $form['#theme'] = 'system_config_form';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $subformState = SubformState::createForSubform($form['plugin'], $form, $form_state);
    $this->plugin
      ->validateConfigurationForm($form['plugin'], $subformState);
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $subformState = SubformState::createForSubform($form['plugin'], $form, $form_state);
    $this->plugin
      ->submitConfigurationForm($form['plugin'], $subformState);
    $form_state
      ->setRedirect('oauth2_client.oauth2_client_plugin_list');
    $this->messenger
      ->addStatus($this
      ->t('Configuration saved for <em>@label</em>', [
      '@label' => $this->plugin
        ->getName(),
    ]));
  }

  /**
   * Additional submit function for saving both config and token.
   *
   * @param array $form
   *   The current form build.
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   The current form state object.
   */
  public function testToken(array &$form, FormStateInterface $formState) {
    $this
      ->submitForm($form, $formState);

    // Try to obtain a token.
    try {

      // Clear the existing token.
      $this->clientService
        ->clearAccessToken($this->plugin
        ->getId());
      $values = $formState
        ->getValues();
      $provider = $values['plugin']['credential_provider'];
      $credentials = $values['plugin'][$provider];
      $user = $credentials['username'] ?? NULL;
      $password = $credentials['password'] ?? NULL;
      $token = $this->clientService
        ->getAccessToken($this->plugin
        ->getId(), $user, $password);
      if ($token instanceof AccessTokenInterface) {
        $formState
          ->setRedirect('oauth2_client.oauth2_client_plugin_list');
      }
    } catch (\Exception $e) {
      $formState
        ->disableRedirect();

      // Failed to get the access token.
      $this->messenger
        ->addError($this
        ->t('Unable to obtain an OAuth token. The error message is: @message', [
        '@message' => $e
          ->getMessage(),
      ]));
      watchdog_exception('Oauth2 Client', $e);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
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.	1
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. Overrides UrlGeneratorTrait::redirect
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.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
Oauth2ClientPluginConfigForm::$clientService	protected	property	Injected client service.
Oauth2ClientPluginConfigForm::$messenger	protected	property	The messenger service. Overrides MessengerTrait::$messenger
Oauth2ClientPluginConfigForm::$plugin	protected	property	The plugin being configured.
Oauth2ClientPluginConfigForm::$state	protected	property	The Drupal state api.
Oauth2ClientPluginConfigForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
Oauth2ClientPluginConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
Oauth2ClientPluginConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
Oauth2ClientPluginConfigForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
Oauth2ClientPluginConfigForm::testToken	public	function	Additional submit function for saving both config and token.
Oauth2ClientPluginConfigForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class Oauth2ClientPluginConfigForm in OAuth2 Client 8.3

Hierarchy

File

Namespace

Members

API Navigation