You are here

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

class GoogleAuthController in Social Auth Google 8.2

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

Returns responses for Social Auth Google module routes.

Hierarchy

Expanded class hierarchy of GoogleAuthController

File

src/Controller/GoogleAuthController.php, line 18

Namespace

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

  /**
   * GoogleAuthController constructor.
   *
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   * @param \Drupal\social_api\Plugin\NetworkManager $network_manager
   *   Used to get an instance of social_auth_google network plugin.
   * @param \Drupal\social_auth\User\UserAuthenticator $user_authenticator
   *   Used to manage user authentication/registration.
   * @param \Drupal\social_auth_google\GoogleAuthManager $google_manager
   *   Used to manage authentication methods.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request
   *   Used to access GET parameters.
   * @param \Drupal\social_auth\SocialAuthDataHandler $data_handler
   *   The Social Auth data handler.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   Used to handle metadata for redirection to authentication URL.
   */
  public function __construct(MessengerInterface $messenger, NetworkManager $network_manager, UserAuthenticator $user_authenticator, GoogleAuthManager $google_manager, RequestStack $request, SocialAuthDataHandler $data_handler, RendererInterface $renderer) {
    parent::__construct('Social Auth Google', 'social_auth_google', $messenger, $network_manager, $user_authenticator, $google_manager, $request, $data_handler, $renderer);
  }

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

  /**
   * Response for path 'user/login/google/callback'.
   *
   * Google returns the user here after user has authenticated.
   */
  public function callback() {

    // Checks if there was an authentication error.
    $redirect = $this
      ->checkAuthError();
    if ($redirect) {
      return $redirect;
    }

    /** @var \League\OAuth2\Client\Provider\GoogleUser|null $profile */
    $profile = $this
      ->processCallback();

    // If authentication was successful.
    if ($profile !== NULL) {

      // Gets (or not) extra initial data.
      $data = $this->userAuthenticator
        ->checkProviderIsAssociated($profile
        ->getId()) ? NULL : $this->providerManager
        ->getExtraDetails();
      return $this->userAuthenticator
        ->authenticateUser($profile
        ->getName(), $profile
        ->getEmail(), $profile
        ->getId(), $this->providerManager
        ->getAccessToken(), $profile
        ->getAvatar(), $data);
    }
    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::callback public function Response for path 'user/login/google/callback'.
GoogleAuthController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
GoogleAuthController::__construct public function GoogleAuthController constructor. Overrides OAuth2ControllerBase::__construct
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 public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OAuth2ControllerBase::$dataHandler protected property The Social Auth data handler.
OAuth2ControllerBase::$messenger protected property The Messenger service. Overrides MessengerTrait::$messenger
OAuth2ControllerBase::$module protected property The module name.
OAuth2ControllerBase::$networkManager protected property The network plugin manager.
OAuth2ControllerBase::$pluginId protected property The implement plugin id.
OAuth2ControllerBase::$providerManager protected property The provider authentication manager.
OAuth2ControllerBase::$renderer protected property The renderer service.
OAuth2ControllerBase::$request protected property Used to access GET parameters.
OAuth2ControllerBase::$userAuthenticator protected property The Social Auth user authenticator..
OAuth2ControllerBase::checkAuthError protected function Checks if there was an error during authentication with provider.
OAuth2ControllerBase::processCallback public function Process implementer callback path.
OAuth2ControllerBase::redirectToProvider public function Response for implementer authentication url.
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.