class OAuthCredentials in Salesforce Suite 8.3

Salesforce credentials extension, for drupalisms.

Hierarchy

• class \Drupal\salesforce\Consumer\SalesforceCredentials extends \OAuth\Common\Consumer\Credentials implements SalesforceCredentialsInterface
  • class \Drupal\salesforce\Consumer\OAuthCredentials

1 file declares its use of OAuthCredentials

SalesforceOAuthPlugin.php in src/Plugin/SalesforceAuthProvider/SalesforceOAuthPlugin.php

File

src/Consumer/OAuthCredentials.php, line 10

Namespace

Drupal\salesforce\Consumer

class OAuthCredentials extends SalesforceCredentials {

  /**
   * {@inheritdoc}
   */
  public function __construct($consumerKey, $consumerSecret, $loginUrl) {
    parent::__construct($consumerKey, $consumerSecret, self::callbackUrl());
    $this->consumerKey = $consumerKey;
    $this->loginUrl = $loginUrl;
  }

  /**
   * Constructor helper.
   *
   * @param array $configuration
   *   Plugin configuration.
   *
   * @return \Drupal\salesforce\Consumer\OAuthCredentials
   *   Credentials, valid or not.
   */
  public static function create(array $configuration) {
    return new static($configuration['consumer_key'], $configuration['consumer_secret'], $configuration['login_url']);
  }

  /**
   * {@inheritdoc}
   */
  public function getCallbackUrl() {
    return self::callbackUrl();
  }

  /**
   * Static wrapper to generate the callback url from the callback route.
   *
   * @return string
   *   The callback URL.
   */
  public static function callbackUrl() {
    return Url::fromRoute('salesforce.oauth_callback', [], [
      'absolute' => TRUE,
      'https' => TRUE,
    ])
      ->toString();
  }

  /**
   * {@inheritdoc}
   */
  public function isValid() {
    return !empty($this->loginUrl) && !empty($this->consumerSecret) && !empty($this->consumerId);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
OAuthCredentials::callbackUrl	public static	function	Static wrapper to generate the callback url from the callback route.
OAuthCredentials::create	public static	function	Constructor helper. Overrides SalesforceCredentials::create
OAuthCredentials::getCallbackUrl	public	function	Overrides SalesforceCredentials::getCallbackUrl
OAuthCredentials::isValid	public	function	Overrides SalesforceCredentials::isValid
OAuthCredentials::__construct	public	function
SalesforceCredentials::$consumerKey	protected	property	Consumer key for the Salesforce connected OAuth app.
SalesforceCredentials::$loginUrl	protected	property	Login URL e.g. https://test.salesforce.com or https://login.salesforce.com.
SalesforceCredentials::getConsumerKey	public	function	Get the consumer key for these credentials. Overrides SalesforceCredentialsInterface::getConsumerKey
SalesforceCredentials::getLoginUrl	public	function	Get the login URL for these credentials. Overrides SalesforceCredentialsInterface::getLoginUrl