class OpenIDConnectGenericClient in OpenID Connect / OAuth client 8

Generic OpenID Connect client.

Used primarily to login to Drupal sites powered by oauth2_server or PHP sites powered by oauth2-server-php.

Plugin annotation

@OpenIDConnectClient(
  id = "generic",
  label = @Translation("Generic")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\openid_connect\Plugin\OpenIDConnectClientBase implements ContainerFactoryPluginInterface, OpenIDConnectClientInterface uses StringTranslationTrait
    • class \Drupal\openid_connect\Plugin\OpenIDConnectClient\OpenIDConnectGenericClient

File

src/Plugin/OpenIDConnectClient/OpenIDConnectGenericClient.php, line 19

Namespace

Drupal\openid_connect\Plugin\OpenIDConnectClient

class OpenIDConnectGenericClient extends OpenIDConnectClientBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'authorization_endpoint' => '',
      'token_endpoint' => '',
      'userinfo_endpoint' => '',
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['authorization_endpoint'] = [
      '#title' => $this
        ->t('Authorization endpoint'),
      '#type' => 'textfield',
      '#default_value' => $this->configuration['authorization_endpoint'],
    ];
    $form['token_endpoint'] = [
      '#title' => $this
        ->t('Token endpoint'),
      '#type' => 'textfield',
      '#default_value' => $this->configuration['token_endpoint'],
    ];
    $form['userinfo_endpoint'] = [
      '#title' => $this
        ->t('UserInfo endpoint'),
      '#type' => 'textfield',
      '#default_value' => $this->configuration['userinfo_endpoint'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getEndpoints() {
    return [
      'authorization' => $this->configuration['authorization_endpoint'],
      'token' => $this->configuration['token_endpoint'],
      'userinfo' => $this->configuration['userinfo_endpoint'],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
OpenIDConnectClientBase::$clientScopes	protected	property	The minimum set of scopes for this client.
OpenIDConnectClientBase::$dateTime	protected	property	The datetime.time service.
OpenIDConnectClientBase::$httpClient	protected	property	The HTTP client to fetch the feed data with.
OpenIDConnectClientBase::$languageManager	protected	property	The language manager.
OpenIDConnectClientBase::$loggerFactory	protected	property	The logger factory used for logging.
OpenIDConnectClientBase::$pageCacheKillSwitch	protected	property	Page cache kill switch.
OpenIDConnectClientBase::$requestStack	protected	property	The request stack used to access request globals.
OpenIDConnectClientBase::$stateToken	protected	property	The OpenID state token service.
OpenIDConnectClientBase::authorize	public	function	Redirects the user to the authorization endpoint. Overrides OpenIDConnectClientInterface::authorize	3
OpenIDConnectClientBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
OpenIDConnectClientBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
OpenIDConnectClientBase::decodeIdToken	public	function	Decodes ID token to access user data. Overrides OpenIDConnectClientInterface::decodeIdToken	3
OpenIDConnectClientBase::getClientScopes	public	function	Gets an array of of scopes. Overrides OpenIDConnectClientInterface::getClientScopes
OpenIDConnectClientBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
OpenIDConnectClientBase::getRedirectUrl	protected	function	Returns the redirect URL.
OpenIDConnectClientBase::getRequestOptions	protected	function	Helper function for request options.
OpenIDConnectClientBase::getUrlOptions	protected	function	Helper function for URL options.
OpenIDConnectClientBase::retrieveTokens	public	function	Retrieve access token and ID token. Overrides OpenIDConnectClientInterface::retrieveTokens
OpenIDConnectClientBase::retrieveUserInfo	public	function	Retrieves user info: additional user profile data. Overrides OpenIDConnectClientInterface::retrieveUserInfo	4
OpenIDConnectClientBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
OpenIDConnectClientBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
OpenIDConnectClientBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
OpenIDConnectClientBase::__construct	public	function	The constructor. Overrides PluginBase::__construct
OpenIDConnectGenericClient::buildConfigurationForm	public	function	Form constructor. Overrides OpenIDConnectClientBase::buildConfigurationForm
OpenIDConnectGenericClient::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides OpenIDConnectClientBase::defaultConfiguration
OpenIDConnectGenericClient::getEndpoints	public	function	Returns an array of endpoints. Overrides OpenIDConnectClientInterface::getEndpoints
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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.