class OauthInteractions in FormAssembly 8

Utility class for interacting with FormAssembly for authorization.

@author Shawn P. Duncan <[e-mail]>

Copyright 2018 by Shawn P. Duncan. This code is released under the GNU General Public License. Which means that it is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. http://www.gnu.org/licenses/gpl.html @package Drupal\formassembly

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\formassembly\Controller\OauthInteractions

File

src/Controller/OauthInteractions.php, line 26

Namespace

Drupal\formassembly\Controller

class OauthInteractions extends ControllerBase {

  /**
   * Injected service.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $currentRequest;

  /**
   * Injected service.
   *
   * @var \Drupal\formassembly\ApiAuthorize
   */
  protected $apiAuthorize;

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

  /**
   * Service to obtain oauth credentials.
   *
   * @var \Drupal\formassembly\FormAssemblyKeyService
   */
  protected $keyService;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $requestStack = $container
      ->get('request_stack');
    $instance->currentRequest = $requestStack
      ->getCurrentRequest();
    $instance->apiAuthorize = $container
      ->get('formassembly.authorize');
    $instance->messenger = $container
      ->get('messenger');
    $instance->keyService = $container
      ->get('formassembly.key');
    return $instance;
  }

  /**
   * Assemble the authorization url and redirect to it.
   */
  public function authorize() {

    /** @var \Drupal\Core\Config\ImmutableConfig $formassembly_config */
    $credentials = $this->keyService
      ->getOauthKeys();
    $provider = new OauthProvider([
      'clientId' => $credentials['cid'],
      'clientSecret' => $credentials['secret'],
      'redirectUri' => Url::fromRoute('fa_form.authorize.store', [], [
        'absolute' => TRUE,
      ])
        ->toString(TRUE)
        ->getGeneratedUrl(),
      'baseUrl' => $this->apiAuthorize
        ->getUrl('base')
        ->toString(TRUE)
        ->getGeneratedUrl(),
    ]);
    $url = $provider
      ->getAuthorizationUrl();
    $response = new TrustedRedirectResponse($url);
    $response
      ->addCacheableDependency($url);
    return $response;
  }

  /**
   * Capture the authorization code and trigger token request.
   *
   * @throws \Exception
   *   Re-throws any caught exception after sending a message to the user.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   Redirect to the settings form.
   */
  public function code() {
    try {
      $code = $this->currentRequest->query
        ->get('code');
      if (empty($code)) {
        throw new \UnexpectedValueException("The authorization_code query parameter is missing.");
      }
      $this->apiAuthorize
        ->authorize($code);
      $this->messenger
        ->addMessage($this
        ->t('FormAssembly successfully authorized.'));
      $url = Url::fromRoute('fa_form.settings');
      return new RedirectResponse($url
        ->toString());
    } catch (\Exception $exception) {
      $this->messenger
        ->addMessage($this
        ->t('FormAssembly module failed to authorize. Reason: @message', [
        '@message' => $exception
          ->getMessage(),
      ]), 'error');
      throw $exception;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
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.
OauthInteractions::$apiAuthorize	protected	property	Injected service.
OauthInteractions::$currentRequest	protected	property	Injected service.
OauthInteractions::$keyService	protected	property	Service to obtain oauth credentials.
OauthInteractions::$messenger	protected	property	Injected service. Overrides MessengerTrait::$messenger
OauthInteractions::authorize	public	function	Assemble the authorization url and redirect to it.
OauthInteractions::code	public	function	Capture the authorization code and trigger token request.
OauthInteractions::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
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.