You are here

Home » API reference » OpenID Connect / OAuth client 8 » OpenIDConnectLinkedinClient.php

class OpenIDConnectLinkedinClient in OpenID Connect / OAuth client 8

Same name and namespace in other branches
  1. 2.x src/Plugin/OpenIDConnectClient/OpenIDConnectLinkedinClient.php \Drupal\openid_connect\Plugin\OpenIDConnectClient\OpenIDConnectLinkedinClient

LinkedIn OpenID Connect client.

Implements OpenID Connect Client plugin for LinkedIn.

Plugin annotation


@OpenIDConnectClient(
  id = "linkedin",
  label = @Translation("LinkedIn")
)

Hierarchy

Expanded class hierarchy of OpenIDConnectLinkedinClient

File

src/Plugin/OpenIDConnectClient/OpenIDConnectLinkedinClient.php, line 18

Namespace

Drupal\openid_connect\Plugin\OpenIDConnectClient
View source 
class OpenIDConnectLinkedinClient extends OpenIDConnectClientBase {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $url = 'https://www.linkedin.com/developer/apps';
    $form['description'] = [
      '#markup' => '<div class="description">' . $this
        ->t('Set up your app in <a href="@url" target="_blank">my apps</a> on LinkedIn.', [
        '@url' => $url,
      ]) . '</div>',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getEndpoints() {
    return [
      'authorization' => 'https://www.linkedin.com/oauth/v2/authorization',
      'token' => 'https://www.linkedin.com/oauth/v2/accessToken',
      'userinfo' => 'https://api.linkedin.com/v2/me?projection=(id,localizedFirstName,localizedLastName,profilePicture(displayImage~:playableStreams))',
      'useremail' => 'https://api.linkedin.com/v2/emailAddress?q=members&projection=(elements*(handle~))',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function authorize($scope = 'openid email') {

    // Use LinkedIn specific authorisations.
    return parent::authorize('r_liteprofile r_emailaddress');
  }

  /**
   * {@inheritdoc}
   */
  public function decodeIdToken($id_token) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function retrieveUserInfo($access_token) {
    $userinfo = [];
    $info = parent::retrieveUserInfo($access_token);
    if ($info) {
      $userinfo['sub'] = isset($info['id']) ? $info['id'] : '';
      $userinfo['first_name'] = isset($info['localizedFirstName']) ? $info['localizedFirstName'] : '';
      $userinfo['last_name'] = isset($info['localizedLastName']) ? $info['localizedLastName'] : '';
      $userinfo['name'] = $userinfo['first_name'] . ' ' . $userinfo['last_name'];
      if (isset($info['profilePicture']['displayImage~']['elements'])) {

        // The picture was provided.
        $pictures = $info['profilePicture']['displayImage~']['elements'];

        // The last picture should have the largest picture of size 800x800 px.
        $last_picture = end($pictures);
        if (isset($last_picture['identifiers'][0]['identifier'])) {
          $userinfo['picture'] = $last_picture['identifiers'][0]['identifier'];
        }
      }
      else {

        // The picture was not provided.
        $userinfo['picture'] = '';
      }
    }

    // Get the email. It should always be provided.
    if ($email = $this
      ->retrieveUserEmail($access_token)) {
      $userinfo['email'] = $email;
    }
    return $userinfo;
  }

  /**
   * Get user email.
   *
   * @param string $access_token
   *   An access token string.
   *
   * @return string|bool
   *   An email or false.
   */
  protected function retrieveUserEmail($access_token) {
    $request_options = [
      'headers' => [
        'Authorization' => 'Bearer ' . $access_token,
        'Accept' => 'application/json',
      ],
    ];
    $endpoints = $this
      ->getEndpoints();
    try {
      $response = $this->httpClient
        ->get($endpoints['useremail'], $request_options);
      $object = json_decode((string) $response
        ->getBody(), TRUE);
      if (isset($object['elements'])) {
        foreach ($object['elements'] as $element) {
          if (isset($element['handle~']['emailAddress'])) {

            // The email address was found.
            return $element['handle~']['emailAddress'];
          }
        }
      }
    } catch (\Exception $e) {
      $variables = [
        '@message' => 'Could not retrieve user email information',
        '@error_message' => $e
          ->getMessage(),
      ];
      $this->loggerFactory
        ->get('openid_connect_' . $this->pluginId)
        ->error('@message. Details: @error_message', $variables);
    }

    // No email address was provided.
    return FALSE;
  }

}

Members

Namesort descending 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::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::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 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::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
OpenIDConnectLinkedinClient::authorize public function Redirects the user to the authorization endpoint. Overrides OpenIDConnectClientBase::authorize
OpenIDConnectLinkedinClient::buildConfigurationForm public function Form constructor. Overrides OpenIDConnectClientBase::buildConfigurationForm
OpenIDConnectLinkedinClient::decodeIdToken public function Decodes ID token to access user data. Overrides OpenIDConnectClientBase::decodeIdToken
OpenIDConnectLinkedinClient::getEndpoints public function Returns an array of endpoints. Overrides OpenIDConnectClientInterface::getEndpoints
OpenIDConnectLinkedinClient::retrieveUserEmail protected function Get user email.
OpenIDConnectLinkedinClient::retrieveUserInfo public function Retrieves user info: additional user profile data. Overrides OpenIDConnectClientBase::retrieveUserInfo
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.