You are here

Home » API reference » Social Auth Google 8 » GoogleAuthController.php

class GoogleAuthController in Social Auth Google 8

Same name and namespace in other branches
  1. 8.2 src/Controller/GoogleAuthController.php \Drupal\social_auth_google\Controller\GoogleAuthController
  2. 3.x src/Controller/GoogleAuthController.php \Drupal\social_auth_google\Controller\GoogleAuthController

Manages requests to Google API.

Hierarchy

Expanded class hierarchy of GoogleAuthController

File

src/Controller/GoogleAuthController.php, line 16

Namespace

Drupal\social_auth_google\Controller
View source 
class GoogleAuthController extends ControllerBase {

  /**
   * The network plugin manager.
   *
   * @var \Drupal\social_api\Plugin\NetworkManager
   */
  protected $networkManager;

  /**
   * The Google authentication manager.
   *
   * @var \Drupal\social_auth_google\GoogleAuthManager
   */
  protected $googleManager;

  /**
   * The user manager.
   *
   * @var \Drupal\social_auth\SocialAuthUserManager
   */
  protected $userManager;

  /**
   * The session manager.
   *
   * @var \Symfony\Component\HttpFoundation\Session\SessionInterface
   */
  protected $session;

  /**
   * GoogleLoginController constructor.
   *
   * @param \Drupal\social_api\Plugin\NetworkManager $network_manager
   *   Used to get an instance of social_auth_google network plugin.
   * @param \Drupal\social_auth\SocialAuthUserManager $user_manager
   *   Manages user login/registration.
   * @param \Drupal\social_auth_google\GoogleAuthManager $google_manager
   *   Used to manage authentication methods.
   * @param \Symfony\Component\HttpFoundation\Session\SessionInterface $session
   *   Used to store the access token into a session variable.
   */
  public function __construct(NetworkManager $network_manager, SocialAuthUserManager $user_manager, GoogleAuthManager $google_manager, SessionInterface $session) {
    $this->networkManager = $network_manager;
    $this->userManager = $user_manager;
    $this->googleManager = $google_manager;
    $this->session = $session;

    // Sets the plugin id.
    $this->userManager
      ->setPluginId('social_auth_google');

    // Sets the session keys to nullify if user could not logged in.
    $this->userManager
      ->setSessionKeysToNullify([
      'social_auth_google_access_token',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.network.manager'), $container
      ->get('social_auth.user_manager'), $container
      ->get('social_auth_google.manager'), $container
      ->get('session'));
  }

  /**
   * Redirect to Google Services Authentication page.
   *
   * @return \Zend\Diactoros\Response\RedirectResponse
   *   Redirection to Google Accounts.
   */
  public function redirectToGoogle() {

    /* @var \Google_Client $client */
    $client = $this->networkManager
      ->createInstance('social_auth_google')
      ->getSdk();
    $client
      ->setScopes([
      'email',
      'profile',
    ]);
    return new RedirectResponse($client
      ->createAuthUrl());
  }

  /**
   * Callback function to login user.
   */
  public function callback() {

    /* @var \Google_Client $client */
    $client = $this->networkManager
      ->createInstance('social_auth_google')
      ->getSdk();
    $this->googleManager
      ->setClient($client)
      ->authenticate();

    // Saves access token so that event subscribers can call Google API.
    $this->session
      ->set('social_auth_google_access_token', $this->googleManager
      ->getAccessToken());

    // Gets user information.
    $user = $this->googleManager
      ->getUserInfo();

    // If user information could be retrieved.
    if ($user) {
      return $this->userManager
        ->authenticateUser($user
        ->getEmail(), $user
        ->getName(), $user
        ->getId(), $user
        ->getPicture());
    }
    drupal_set_message($this
      ->t('You could not be authenticated, please contact the administrator'), 'error');
    return $this
      ->redirect('user.login');
  }

}

Members

Namesort descending 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.
GoogleAuthController::$googleManager protected property The Google authentication manager.
GoogleAuthController::$networkManager protected property The network plugin manager.
GoogleAuthController::$session protected property The session manager.
GoogleAuthController::$userManager protected property The user manager.
GoogleAuthController::callback public function Callback function to login user.
GoogleAuthController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
GoogleAuthController::redirectToGoogle public function Redirect to Google Services Authentication page.
GoogleAuthController::__construct public function GoogleLoginController constructor.
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.
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.