class SalesforceController in Salesforce Suite 8.3

OAuth callback handler.

Hierarchy

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

1 file declares its use of SalesforceController

SalesforceControllerTest.php in tests/src/Unit/SalesforceControllerTest.php

File

src/Controller/SalesforceController.php, line 17

Namespace

Drupal\salesforce\Controller

class SalesforceController extends ControllerBase {
  protected $client;
  protected $httpClient;
  protected $url_generator;

  /**
   * {@inheritdoc}
   */
  public function __construct(RestClientInterface $rest, Client $httpClient, MetadataBubblingUrlGenerator $url_generator) {
    $this->client = $rest;
    $this->httpClient = $httpClient;
    $this->url_generator = $url_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('salesforce.client'), $container
      ->get('http_client'), $container
      ->get('url_generator'));
  }

  /**
   * Wrapper for \Drupal::request().
   *
   * @return \Symfony\Component\HttpFoundation\Request
   *   The currently active request object.
   */
  protected function request() {
    return \Drupal::request();
  }

  /**
   * Display a success message on successful oauth.
   */
  protected function successMessage() {
    drupal_set_message(t('Successfully connected to %endpoint', [
      '%endpoint' => $this->client
        ->getInstanceUrl(),
    ]));
  }

  /**
   * OAuth step 2: Callback for the oauth redirect URI.
   *
   * Complete OAuth handshake by exchanging an authorization code for an access
   * token.
   */
  public function oauthCallback() {

    // If no code is provided, return access denied.
    if (empty($this
      ->request()
      ->get('code'))) {
      throw new AccessDeniedHttpException();
    }
    $data = urldecode(UrlHelper::buildQuery([
      'code' => $this
        ->request()
        ->get('code'),
      'grant_type' => 'authorization_code',
      'client_id' => $this->client
        ->getConsumerKey(),
      'client_secret' => $this->client
        ->getConsumerSecret(),
      'redirect_uri' => $this->client
        ->getAuthCallbackUrl(),
    ]));
    $url = $this->client
      ->getAuthTokenUrl();
    $headers = [
      // This is an undocumented requirement on SF's end.
      'Content-Type' => 'application/x-www-form-urlencoded',
    ];
    $response = $this->httpClient
      ->post($url, [
      'headers' => $headers,
      'body' => $data,
    ]);
    $this->client
      ->handleAuthResponse($response);
    $this
      ->successMessage();
    return new RedirectResponse($this->url_generator
      ->generateFromRoute('salesforce.authorize', [], [
      "absolute" => TRUE,
    ], FALSE));
  }

}

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	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
SalesforceController::$client	protected	property
SalesforceController::$httpClient	protected	property
SalesforceController::$url_generator	protected	property
SalesforceController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
SalesforceController::oauthCallback	public	function	OAuth step 2: Callback for the oauth redirect URI.
SalesforceController::request	protected	function	Wrapper for \Drupal::request().
SalesforceController::successMessage	protected	function	Display a success message on successful oauth.
SalesforceController::__construct	public	function
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.