0 follower

Class Yiisoft\Yii\AuthClient\Client\Google

InheritanceYiisoft\Yii\AuthClient\Client\Google » Yiisoft\Yii\AuthClient\OAuth2 » Yiisoft\Yii\AuthClient\OAuth » Yiisoft\Yii\AuthClient\AuthClient
ImplementsYiisoft\Yii\AuthClient\AuthClientInterface

Google allows authentication via Google OAuth2 using HTTP client. Here we are NOT using the alternative Client Libraries namely @see https://developers.google.com/people/v1/libraries#php In order to use Google OAuth2 you must create a project at https://console.cloud.google.com/cloud-resource-manager and setup its credentials at https://console.cloud.google.com/apis/credentials?project=[yourProjectId].

Create an Oauth2 Web Application and record the resultant Client Id and Client Secret in e.g a .env file and insert your website's returnUrl e.g. https:\example.com\callbackGoogle

See also:

Protected Properties

Hide inherited properties

Property Type Description Defined By
$accessToken array|Yiisoft\Yii\AuthClient\OAuthToken|null Access token instance or its array configuration. Yiisoft\Yii\AuthClient\OAuth
$authUrl string Yiisoft\Yii\AuthClient\Client\Google
$autoRefreshAccessToken boolean Whether to automatically perform 'refresh access token' request on expired access token. Yiisoft\Yii\AuthClient\OAuth
$clientId string OAuth client ID. Yiisoft\Yii\AuthClient\OAuth2
$clientSecret string OAuth client secret. Yiisoft\Yii\AuthClient\OAuth2
$endPoint string Yiisoft\Yii\AuthClient\Client\Google
$endpoint string API base URL. Yiisoft\Yii\AuthClient\OAuth
$factory \Yiisoft\Factory\Factory Yiisoft\Yii\AuthClient\OAuth2
$httpClient \Psr\Http\Client\ClientInterface Yiisoft\Yii\AuthClient\AuthClient
$normalizeUserAttributeMap array Map used to normalize user attributes fetched from external auth service in format: normalizedAttributeName => sourceSpecification 'sourceSpecification' can be: - string, raw attribute name - array, pass to raw attribute value - callable, PHP callback, which should accept array of raw attributes and return normalized value. Yiisoft\Yii\AuthClient\AuthClient
$requestFactory \Psr\Http\Message\RequestFactoryInterface Yiisoft\Yii\AuthClient\AuthClient
$returnUrl string Yiisoft\Yii\AuthClient\OAuth2
$scope string String auth request scope. Yiisoft\Yii\AuthClient\OAuth
$session \Yiisoft\Session\SessionInterface Yiisoft\Yii\AuthClient\OAuth2
$tokenUrl string Yiisoft\Yii\AuthClient\Client\Google
$validateAuthState boolean Whether to use and validate auth 'state' parameter in authentication flow. Yiisoft\Yii\AuthClient\OAuth2
$version string Yiisoft\Yii\AuthClient\Client\Google
$viewOptions array View options in format: optionName => optionValue Yiisoft\Yii\AuthClient\AuthClient

Public Methods

Hide inherited methods

Method Description Defined By
__construct() BaseOAuth constructor. Yiisoft\Yii\AuthClient\OAuth2
api() Performs request to the OAuth API returning response data. Yiisoft\Yii\AuthClient\OAuth
applyAccessTokenToRequest() Yiisoft\Yii\AuthClient\OAuth2
beforeApiRequestSend() Yiisoft\Yii\AuthClient\OAuth
buildAuthUrl() Composes user authorization URL. Yiisoft\Yii\AuthClient\OAuth2
createApiRequest() Creates an HTTP request for the API call. Yiisoft\Yii\AuthClient\OAuth
createRequest() Yiisoft\Yii\AuthClient\AuthClient
fetchAccessToken() Fetches access token from authorization code. Yiisoft\Yii\AuthClient\OAuth2
fetchAccessTokenWithCodeVerifier() Note: This function will be adapted later to accomodate the 'confidential client'. Yiisoft\Yii\AuthClient\OAuth2
getAccessToken() Yiisoft\Yii\AuthClient\OAuth
getButtonClass() Yiisoft\Yii\AuthClient\Client\Google
getClientId() Yiisoft\Yii\AuthClient\OAuth2
getClientSecret() Yiisoft\Yii\AuthClient\OAuth2
getCurrentUserJsonArray() Yiisoft\Yii\AuthClient\Client\Google
getName() Yiisoft\Yii\AuthClient\Client\Google
getNormalizeUserAttributeMap() Yiisoft\Yii\AuthClient\AuthClient
getOauth2ReturnUrl() Yiisoft\Yii\AuthClient\OAuth2
getRequestFactory() Yiisoft\Yii\AuthClient\AuthClient
getReturnUrl() Yiisoft\Yii\AuthClient\OAuth
getScope() Yiisoft\Yii\AuthClient\OAuth
getSessionAuthState() Compare a callback query parameter 'state' with the saved Auth Client's 'authState' parameter in order to prevent CSRF attacks Yiisoft\Yii\AuthClient\OAuth2
getTitle() Yiisoft\Yii\AuthClient\Client\Google
getTokenUrl() Yiisoft\Yii\AuthClient\OAuth2
getViewOptions() Yiisoft\Yii\AuthClient\AuthClient
getYiisoftFactory() Yiisoft\Yii\AuthClient\OAuth
refreshAccessToken() Gets new auth token to replace expired one. Yiisoft\Yii\AuthClient\OAuth2
setAccessToken() Sets access token to be used. Yiisoft\Yii\AuthClient\OAuth
setAuthUrl() Yiisoft\Yii\AuthClient\OAuth
setClientId() Yiisoft\Yii\AuthClient\OAuth2
setClientSecret() Yiisoft\Yii\AuthClient\OAuth2
setOauth2ReturnUrl() Yiisoft\Yii\AuthClient\OAuth2
setRequestFactory() Yiisoft\Yii\AuthClient\AuthClient
setReturnUrl() Yiisoft\Yii\AuthClient\OAuth
setTokenUrl() Yiisoft\Yii\AuthClient\OAuth2
setYiisoftFactory() Yiisoft\Yii\AuthClient\OAuth
withValidateAuthState() Yiisoft\Yii\AuthClient\OAuth2
withoutValidateAuthState() Yiisoft\Yii\AuthClient\OAuth2

Property Details

Hide inherited properties

$authUrl protected property
protected string $authUrl 'https://accounts.google.com/o/oauth2/v2/auth'
$endPoint protected property
protected string $endPoint 'https://www.googleapis.com/oauth2/v2/userinfo'
$tokenUrl protected property
protected string $tokenUrl 'https://oauth2.googleapis.com/token'
$version protected property
protected string $version 'v2'

Method Details

Hide inherited methods

__construct() public method

Defined in: Yiisoft\Yii\AuthClient\OAuth2::__construct()

BaseOAuth constructor.

public __construct( \Psr\Http\Client\ClientInterface $httpClient, \Psr\Http\Message\RequestFactoryInterface $requestFactory, Yiisoft\Yii\AuthClient\StateStorage\StateStorageInterface $stateStorage, \Yiisoft\Factory\Factory $factory, \Yiisoft\Session\SessionInterface $session ): mixed
$httpClient \Psr\Http\Client\ClientInterface
$requestFactory \Psr\Http\Message\RequestFactoryInterface
$stateStorage Yiisoft\Yii\AuthClient\StateStorage\StateStorageInterface
$factory \Yiisoft\Factory\Factory
$session \Yiisoft\Session\SessionInterface

                public function __construct(
    ClientInterface $httpClient,
    RequestFactoryInterface $requestFactory,
    StateStorageInterface $stateStorage,
    protected YiisoftFactory $factory,
    protected SessionInterface $session,
) {
    parent::__construct($httpClient, $requestFactory, $stateStorage, $this->factory);
}

            
api() public method

Defined in: Yiisoft\Yii\AuthClient\OAuth::api()

Performs request to the OAuth API returning response data.

You may use createApiRequest() method instead, gaining more control over request execution.

See also createApiRequest().

public api( string $apiSubUrl, string $method 'GET', array|string $data = [], array $headers = [] ): array
$apiSubUrl string

API sub URL, which will be append to \Yiisoft\Yii\AuthClient\apiBaseUrl, or absolute API URL.

$method string

Request method.

$data array|string

Request data or content.

$headers array

Additional request headers.

return array

API response data.

throws Exception

                public function api($apiSubUrl, $method = 'GET', $data = [], $headers = []): array
{
    $request = $this->createApiRequest($method, $apiSubUrl);
    $request = RequestUtil::addHeaders($request, $headers);
    if (!empty($data)) {
        if (is_array($data)) {
            $request = RequestUtil::addParams($request, $data);
        } else {
            $request->getBody()->write($data);
        }
    }
    $request = $this->beforeApiRequestSend($request);
    $response = $this->sendRequest($request);
    if ($response->getStatusCode() !== 200) {
        throw new InvalidResponseException(
            $response,
            'Request failed with code: ' . $response->getStatusCode() . ', message: ' . (string)$response->getBody()
        );
    }
    return (array)Json::decode($response->getBody()->getContents());
}

            
applyAccessTokenToRequest() public method
public applyAccessTokenToRequest( \Psr\Http\Message\RequestInterface $request, Yiisoft\Yii\AuthClient\OAuthToken $accessToken ): \Psr\Http\Message\RequestInterface
$request \Psr\Http\Message\RequestInterface
$accessToken Yiisoft\Yii\AuthClient\OAuthToken

                #[\Override]
public function applyAccessTokenToRequest(RequestInterface $request, OAuthToken $accessToken): RequestInterface
{
    return RequestUtil::addParams(
        $request,
        [
            'access_token' => $accessToken->getToken(),
        ]
    );
}

            
applyClientCredentialsToRequest() protected method

Defined in: Yiisoft\Yii\AuthClient\OAuth2::applyClientCredentialsToRequest()

Applies client credentials (e.g. $clientId and $clientSecret) to the HTTP request instance.

This method should be invoked before sending any HTTP request, which requires client credentials.

protected applyClientCredentialsToRequest( \Psr\Http\Message\RequestInterface $request ): \Psr\Http\Message\RequestInterface
$request \Psr\Http\Message\RequestInterface

HTTP request instance.

                protected function applyClientCredentialsToRequest(RequestInterface $request): RequestInterface
{
    return RequestUtil::addParams(
        $request,
        [
            'client_id' => $this->clientId,
            'client_secret' => $this->clientSecret,
        ]
    );
}

            
beforeApiRequestSend() public method
public beforeApiRequestSend( \Psr\Http\Message\RequestInterface $request ): \Psr\Http\Message\RequestInterface
$request \Psr\Http\Message\RequestInterface

                public function beforeApiRequestSend(RequestInterface $request): RequestInterface
{
    $accessToken = $this->getAccessToken();
    if (!is_object($accessToken) || !$accessToken->getIsValid()) {
        throw new Exception('Invalid access token.');
    }
    return $this->applyAccessTokenToRequest($request, $accessToken);
}

            
buildAuthUrl() public method

Defined in: Yiisoft\Yii\AuthClient\OAuth2::buildAuthUrl()

Composes user authorization URL.

public buildAuthUrl( \Psr\Http\Message\ServerRequestInterface $incomingRequest, array $params = [] ): string
$incomingRequest \Psr\Http\Message\ServerRequestInterface
$params array

Additional auth GET params.

return string

Authorization URL.

                #[\Override]
public function buildAuthUrl(
    ServerRequestInterface $incomingRequest,
    array $params = []
): string {
    $defaultParams = [
        'client_id' => $this->clientId,
        'response_type' => 'code',
        'redirect_uri' => $this->getOauth2ReturnUrl(),
        'xoauth_displayname' => $incomingRequest->getAttribute(AuthAction::AUTH_NAME),
    ];
    if (!empty($this->getScope())) {
        $defaultParams['scope'] = $this->getScope();
    }
    if ($this->validateAuthState) {
        $authState = $this->generateAuthState();
        $this->setState('authState', $authState);
        $defaultParams['state'] = $authState;
    }
    return RequestUtil::composeUrl($this->authUrl, array_merge($defaultParams, $params));
}

            
createApiRequest() public method

Defined in: Yiisoft\Yii\AuthClient\OAuth::createApiRequest()

Creates an HTTP request for the API call.

The created request will be automatically processed adding access token parameters and signature before sending. You may use createRequest() to gain full control over request composition and execution.

See also createRequest().

public createApiRequest( string $method, string $uri ): \Psr\Http\Message\RequestInterface
$method string
$uri string
return \Psr\Http\Message\RequestInterface

HTTP request instance.

                public function createApiRequest(string $method, string $uri): RequestInterface
{
    return $this->createRequest($method, $this->endpoint . $uri);
}

            
createRequest() public method
public createRequest( string $method, string $uri ): \Psr\Http\Message\RequestInterface
$method string
$uri string

                public function createRequest(string $method, string $uri): RequestInterface
{
    return $this->requestFactory->createRequest($method, $uri);
}

            
createToken() protected method

Defined in: Yiisoft\Yii\AuthClient\OAuth2::createToken()

Creates token from its configuration.

protected createToken( array $tokenConfig = [] ): Yiisoft\Yii\AuthClient\OAuthToken
$tokenConfig array

Token configuration.

return Yiisoft\Yii\AuthClient\OAuthToken

Token instance.

                #[\Override]
protected function createToken(array $tokenConfig = []): OAuthToken
{
    $tokenConfig['tokenParamKey'] = 'access_token';
    return parent::createToken($tokenConfig);
}

            
defaultNormalizeUserAttributeMap() protected method

Defined in: Yiisoft\Yii\AuthClient\AuthClient::defaultNormalizeUserAttributeMap()

Returns the default $normalizeUserAttributeMap value.

Particular client may override this method in order to provide specific default map.

protected defaultNormalizeUserAttributeMap( ): array
return array

Normalize attribute map.

                protected function defaultNormalizeUserAttributeMap(): array
{
    return [];
}

            
defaultReturnUrl() protected method
protected defaultReturnUrl( \Psr\Http\Message\ServerRequestInterface $request ): string
$request \Psr\Http\Message\ServerRequestInterface
return string

Return URL.

                #[\Override]
protected function defaultReturnUrl(ServerRequestInterface $request): string
{
    $params = $request->getQueryParams();
    unset($params['code'], $params['state']);
    return (string)$request->getUri()->withQuery(http_build_query($params, '', '&', PHP_QUERY_RFC3986));
}

            
defaultViewOptions() protected method

protected defaultViewOptions( ): integer[]

                #[\Override]
protected function defaultViewOptions(): array
{
    return [
        'popupWidth' => 860,
        'popupHeight' => 480,
    ];
}

            
fetchAccessToken() public method

Defined in: Yiisoft\Yii\AuthClient\OAuth2::fetchAccessToken()

Fetches access token from authorization code.

public fetchAccessToken( \Psr\Http\Message\ServerRequestInterface $incomingRequest, string $authCode, array $params = [] ): Yiisoft\Yii\AuthClient\OAuthToken
$incomingRequest \Psr\Http\Message\ServerRequestInterface
$authCode string

Authorization code, usually comes at GET parameter 'code'.

$params array

Additional request params.

return Yiisoft\Yii\AuthClient\OAuthToken

Access token.

                public function fetchAccessToken(
    ServerRequestInterface $incomingRequest,
    string $authCode,
    array $params = []
): OAuthToken {
    if ($this->validateAuthState) {
        /**
         * @psalm-suppress MixedAssignment
         */
        $authState = $this->getState('authState');
        $queryParams = $incomingRequest->getQueryParams();
        $bodyParams = $incomingRequest->getParsedBody();
        /**
         * @psalm-suppress MixedAssignment
         */
        $incomingState = $queryParams['state'] ?? ($bodyParams['state'] ?? null);
        if (is_string($incomingState)) {
            if (strcmp($incomingState, (string)$authState) !== 0) {
                throw new InvalidArgumentException('Invalid auth state parameter.');
            }
        }
        if ($incomingState === null) {
            throw new InvalidArgumentException('Invalid auth state parameter.');
        }
        if (empty($authState)) {
            throw new InvalidArgumentException('Invalid auth state parameter.');
        }
        $this->removeState('authState');
    }
    $defaultParams = [
        'code' => $authCode,
        'redirect_uri' => $this->getOauth2ReturnUrl(),
    ];
    $request = $this->createRequest('POST', $this->tokenUrl);
    $request = RequestUtil::addParams($request, array_merge($defaultParams, $params));
    $request = $this->applyClientCredentialsToRequest($request);
    $response = $this->sendRequest($request);
    $contents = $response->getBody()->getContents();
    $output = $this->parse_str_clean($contents);
    $token = new OAuthToken();
    /**
     * @var string $key
     * @var string $value
     */
    foreach ($output as $key => $value) {
        $token->setParam($key, $value);
    }
    return $token;
}

            
fetchAccessTokenWithCodeVerifier() public method

Defined in: Yiisoft\Yii\AuthClient\OAuth2::fetchAccessTokenWithCodeVerifier()

Note: This function will be adapted later to accomodate the 'confidential client'.

See also https://docs.x.com/resources/fundamentals/authentication/oauth-2-0/authorization-code Used specifically for the X i.e. Twitter OAuth2.0 Authorization code with PKCE and public client i.e. client id included in request body; and NOT Confidential Client i.e. Client id not included in the request body.

public fetchAccessTokenWithCodeVerifier( \Psr\Http\Message\ServerRequestInterface $incomingRequest, string $authCode, array $params = [] ): Yiisoft\Yii\AuthClient\OAuthToken
$incomingRequest \Psr\Http\Message\ServerRequestInterface
$authCode string
$params array
throws InvalidArgumentException

                public function fetchAccessTokenWithCodeVerifier(
    ServerRequestInterface $incomingRequest,
    string $authCode,
    array $params = [],
): OAuthToken {
    if ($this->validateAuthState) {
        /**
         * @psalm-suppress MixedAssignment
         */
        $authState = $this->getState('authState');
        $queryParams = $incomingRequest->getQueryParams();
        $bodyParams = $incomingRequest->getParsedBody();
        /**
         * @psalm-suppress MixedAssignment
         */
        $incomingState = $queryParams['state'] ?? ($bodyParams['state'] ?? null);
        if (is_string($incomingState)) {
            if (strcmp($incomingState, (string)$authState) !== 0) {
                throw new InvalidArgumentException('Invalid auth state parameter.');
            }
        }
        if ($incomingState === null) {
            throw new InvalidArgumentException('Invalid auth state parameter.');
        }
        if (empty($authState)) {
            throw new InvalidArgumentException('Invalid auth state parameter.');
        }
        $this->removeState('authState');
    }
    $requestBody = [
        'code' => $authCode,
        'grant_type' => 'authorization_code',
        'client_id' => $this->clientId,
        'client_secret' => $this->clientSecret,
        'redirect_uri' => $params['redirect_uri'] ?? '',
        'code_verifier' => $params['code_verifier'] ?? '',
    ];
    $request = $this->requestFactory
        ->createRequest('POST', $this->tokenUrl)
        ->withHeader('Content-Type', 'application/x-www-form-urlencoded');
    $request->getBody()->write(http_build_query($requestBody));
    try {
        $response = $this->httpClient->sendRequest($request);
        $body = $response->getBody()->getContents();
        if (strlen($body) > 0) {
            $output = (array) json_decode($body, true);
        } else {
            $output = [];
        }
    } catch (\Throwable $e) {
        $output = [];
    }
    $token = new OAuthToken();
    /**
     * @var string $key
     * @var string $value
     */
    foreach ($output as $key => $value) {
        $token->setParam($key, $value);
    }
    return $token;
}

            
generateAuthState() protected method

Defined in: Yiisoft\Yii\AuthClient\OAuth2::generateAuthState()

Generates the auth state value.

protected generateAuthState( ): string
return string

Auth state value.

                protected function generateAuthState(): string
{
    $baseString = static::class . '-' . time();
    $sessionId = $this->session->getId();
    if (null !== $sessionId) {
        if ($this->session->isActive()) {
            $baseString .= '-' . $sessionId;
        }
    }
    return hash('sha256', uniqid($baseString, true));
}

            
getAccessToken() public method
public getAccessToken( ): Yiisoft\Yii\AuthClient\OAuthToken|null
return Yiisoft\Yii\AuthClient\OAuthToken|null

Auth token instance.

                public function getAccessToken(): ?OAuthToken
{
    if (!is_object($this->accessToken)) {
        $this->accessToken = $this->restoreAccessToken();
    }
    return $this->accessToken;
}

            
getButtonClass() public method

public getButtonClass( ): string

                #[\Override]
public function getButtonClass(): string
{
    return 'btn btn-primary bi bi-google';
}

            
getClientId() public method
public getClientId( ): string

                #[\Override]
public function getClientId(): string
{
    return $this->clientId;
}

            
getClientSecret() public method
public getClientSecret( ): string

                public function getClientSecret(): string
{
    return $this->clientSecret;
}

            
getCurrentUserJsonArray() public method

public getCurrentUserJsonArray( Yiisoft\Yii\AuthClient\OAuthToken $token ): array
$token Yiisoft\Yii\AuthClient\OAuthToken

                public function getCurrentUserJsonArray(OAuthToken $token): array
{
    /**
     * e.g. '{all the params}' => ''
     * @var array $params
     */
    $tokenParams = $token->getParams();
    /**
     * e.g. convert the above key, namely '{all the params}', into an array
     * @var array $tokenArray
     */
    $tokenArray = array_keys($tokenParams);
    /**
     * @var string $jsonString
     */
    $jsonString = $tokenArray[0];
    /**
     * @var array $finalArray
     */
    $finalArray = json_decode($jsonString, true);
    /**
     * @var string $tokenString
     */
    $tokenString = $finalArray['access_token'] ?? '';
    if ($tokenString !== '') {
        $url = sprintf(
            'https://www.googleapis.com/oauth2/%s/userinfo',
            $this->version
        );
        $request = $this->createRequest('GET', $url);
        $request = RequestUtil::addHeaders(
            $request,
            [
                'Authorization' => 'Bearer ' . $tokenString,
                'Host' => 'www.googleapis.com',
                'Content-length' => 0,
            ]
        );
        $response = $this->sendRequest($request);
        return (array)json_decode($response->getBody()->getContents(), true);
    }
    return [];
}

            
getDefaultScope() protected method

See also:

protected getDefaultScope( ): string

                #[\Override]
protected function getDefaultScope(): string
{
    return 'https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email';
}

            
getName() public method

public getName( ): string

                #[\Override]
public function getName(): string
{
    return 'google';
}

            
getNormalizeUserAttributeMap() public method
public getNormalizeUserAttributeMap( ): array
return array

Normalize user attribute map.

                public function getNormalizeUserAttributeMap(): array
{
    if (empty($this->normalizeUserAttributeMap)) {
        $this->normalizeUserAttributeMap = $this->defaultNormalizeUserAttributeMap();
    }
    return $this->normalizeUserAttributeMap;
}

            
getOauth2ReturnUrl() public method
public getOauth2ReturnUrl( ): string

                public function getOauth2ReturnUrl(): string
{
    return $this->returnUrl;
}

            
getRequestFactory() public method
public getRequestFactory( ): \Psr\Http\Message\RequestFactoryInterface

                public function getRequestFactory(): RequestFactoryInterface
{
    return $this->requestFactory;
}

            
getReturnUrl() public method
public getReturnUrl( \Psr\Http\Message\ServerRequestInterface $request ): string
$request \Psr\Http\Message\ServerRequestInterface
return string

Return URL.

                public function getReturnUrl(ServerRequestInterface $request): string
{
    if ($this->returnUrl === '') {
        $this->returnUrl = $this->defaultReturnUrl($request);
    }
    return $this->returnUrl;
}

            
getScope() public method
public getScope( ): string

                public function getScope(): string
{
    if ($this->scope === null) {
        return $this->getDefaultScope();
    }
    return $this->scope;
}

            
getSessionAuthState() public method

Defined in: Yiisoft\Yii\AuthClient\OAuth2::getSessionAuthState()

Compare a callback query parameter 'state' with the saved Auth Client's 'authState' parameter in order to prevent CSRF attacks

Use: Typically used in a AuthController's callback function specifically for an Identity Provider e.g. Facebook

public getSessionAuthState( ): mixed

                public function getSessionAuthState(): mixed
{
    /**
     * @see src\AuthClient protected function getState('authState')
     */
    return $this->getState('authState');
}

            
getState() protected method

Defined in: Yiisoft\Yii\AuthClient\AuthClient::getState()

Returns persistent state value.

protected getState( string $key ): mixed
$key string

State key.

return mixed

State value.

                protected function getState(string $key): mixed
{
    return $this->stateStorage->get($this->getStateKeyPrefix() . $key);
}

            
getStateKeyPrefix() protected method

Defined in: Yiisoft\Yii\AuthClient\AuthClient::getStateKeyPrefix()

Returns session key prefix, which is used to store internal states.

protected getStateKeyPrefix( ): string
return string

Session key prefix.

                protected function getStateKeyPrefix(): string
{
    return static::class . '_' . $this->getName() . '_';
}

            
getTitle() public method

public getTitle( ): string

                #[\Override]
public function getTitle(): string
{
    return 'Google';
}

            
getTokenUrl() public method
public getTokenUrl( ): string

                public function getTokenUrl(): string
{
    return $this->tokenUrl;
}

            
getViewOptions() public method
public getViewOptions( ): array
return array

View options in format: optionName => optionValue

                #[\Override]
public function getViewOptions(): array
{
    if (empty($this->viewOptions)) {
        $this->viewOptions = $this->defaultViewOptions();
    }
    return $this->viewOptions;
}

            
getYiisoftFactory() public method
public getYiisoftFactory( ): \Yiisoft\Factory\Factory

                public function getYiisoftFactory(): YiisoftFactory
{
    return $this->factory;
}

            
initUserAttributes() protected method

protected initUserAttributes( ): array

                protected function initUserAttributes(): array
{
    $token = $this->getAccessToken();
    if ($token instanceof OAuthToken) {
        return $this->getCurrentUserJsonArray($token);
    }
    return [];
}

            
refreshAccessToken() public method

Defined in: Yiisoft\Yii\AuthClient\OAuth2::refreshAccessToken()

Gets new auth token to replace expired one.

See also https://developers.google.com/oauthplayground.

public refreshAccessToken( Yiisoft\Yii\AuthClient\OAuthToken $token ): Yiisoft\Yii\AuthClient\OAuthToken
$token Yiisoft\Yii\AuthClient\OAuthToken

Expired auth token.

return Yiisoft\Yii\AuthClient\OAuthToken

New auth token.

                #[\Override]
public function refreshAccessToken(OAuthToken $token): OAuthToken
{
    $params = [
        'grant_type' => 'refresh_token',
    ];
    $params = array_merge($token->getParams(), $params);
    $request = $this->createRequest('POST', $this->tokenUrl);
    $request = RequestUtil::addParams($request, $params);
    $request = $this->applyClientCredentialsToRequest($request);
    $response = $this->sendRequest($request);
    $contents = $response->getBody()->getContents();
    $output = $this->parse_str_clean($contents);
    $token = new OAuthToken();
    /**
     * @var string $key
     * @var string $value
     */
    foreach ($output as $key => $value) {
        $token->setParam($key, $value);
    }
    return $token;
}

            
removeState() protected method

Defined in: Yiisoft\Yii\AuthClient\AuthClient::removeState()

Removes persistent state value.

protected removeState( string $key ): void
$key string

State key.

                protected function removeState(string $key): void
{
    $this->stateStorage->remove($this->getStateKeyPrefix() . $key);
}

            
restoreAccessToken() protected method

Defined in: Yiisoft\Yii\AuthClient\OAuth::restoreAccessToken()

Restores access token.

protected restoreAccessToken( ): Yiisoft\Yii\AuthClient\OAuthToken|null

                protected function restoreAccessToken(): ?OAuthToken
{
    /**
     * @psalm-suppress MixedAssignment $token
     */
    if (($token = $this->getState('token')) instanceof OAuthToken) {
        if ($token->getIsExpired() && $this->autoRefreshAccessToken) {
            return $this->refreshAccessToken($token);
        }
        return $token;
    }
    return null;
}

            
saveAccessToken() protected method

Defined in: Yiisoft\Yii\AuthClient\OAuth::saveAccessToken()

Saves token as persistent state.

protected saveAccessToken( Yiisoft\Yii\AuthClient\OAuthToken|null $token null ): $this
$token Yiisoft\Yii\AuthClient\OAuthToken|null

Auth token to be saved.

return $this

The object itself.

                protected function saveAccessToken(OAuthToken $token = null): self
{
    return $this->setState('token', $token);
}

            
sendRequest() protected method
protected sendRequest( \Psr\Http\Message\RequestInterface $request ): \Psr\Http\Message\ResponseInterface
$request \Psr\Http\Message\RequestInterface

                protected function sendRequest(RequestInterface $request): ResponseInterface
{
    return $this->httpClient->sendRequest($request);
}

            
setAccessToken() public method

Defined in: Yiisoft\Yii\AuthClient\OAuth::setAccessToken()

Sets access token to be used.

public setAccessToken( array|Yiisoft\Yii\AuthClient\OAuthToken $token ): void
$token array|Yiisoft\Yii\AuthClient\OAuthToken

Access token or its configuration.

                public function setAccessToken(array|OAuthToken $token): void
{
    if (is_array($token) && !empty($token)) {
        /**
         * @psalm-suppress MixedAssignment $newToken
         */
        $newToken = $this->createToken($token);
        /**
         * @psalm-suppress MixedAssignment $this->accessToken
         */
        $this->accessToken = $newToken;
        /**
         * @psalm-suppress MixedArgument $newToken
         */
        $this->saveAccessToken($newToken);
    }
    if ($token instanceof OAuthToken) {
        $this->accessToken = $token;
        $this->saveAccessToken($token);
    }
}

            
setAuthUrl() public method
public setAuthUrl( string $authUrl ): void
$authUrl string

                public function setAuthUrl(string $authUrl): void
{
    $this->authUrl = $authUrl;
}

            
setClientId() public method
public setClientId( string $clientId ): void
$clientId string

                public function setClientId(string $clientId): void
{
    $this->clientId = $clientId;
}

            
setClientSecret() public method
public setClientSecret( string $clientSecret ): void
$clientSecret string

                public function setClientSecret(string $clientSecret): void
{
    $this->clientSecret = $clientSecret;
}

            
setOauth2ReturnUrl() public method
public setOauth2ReturnUrl( string $returnUrl ): void
$returnUrl string

                public function setOauth2ReturnUrl(string $returnUrl): void
{
    $this->returnUrl = $returnUrl;
}

            
setRequestFactory() public method
public setRequestFactory( \Psr\Http\Message\RequestFactoryInterface $requestFactory ): void
$requestFactory \Psr\Http\Message\RequestFactoryInterface

                public function setRequestFactory(RequestFactoryInterface $requestFactory): void
{
    $this->requestFactory = $requestFactory;
}

            
setReturnUrl() public method
public setReturnUrl( string $returnUrl ): void
$returnUrl string

Return URL

                public function setReturnUrl(string $returnUrl): void
{
    $this->returnUrl = $returnUrl;
}

            
setState() protected method

Defined in: Yiisoft\Yii\AuthClient\AuthClient::setState()

Sets persistent state.

protected setState( string $key, mixed $value ): $this
$key string

State key.

$value mixed

State value

return $this

The object itself

                protected function setState(string $key, $value): self
{
    $this->stateStorage->set($this->getStateKeyPrefix() . $key, $value);
    return $this;
}

            
setTokenUrl() public method
public setTokenUrl( string $tokenUrl ): void
$tokenUrl string

                public function setTokenUrl(string $tokenUrl): void
{
    $this->tokenUrl = $tokenUrl;
}

            
setYiisoftFactory() public method
public setYiisoftFactory( \Yiisoft\Factory\Factory $factory ): void
$factory \Yiisoft\Factory\Factory

                public function setYiisoftFactory(YiisoftFactory $factory): void
{
    $this->factory = $factory;
}

            
withValidateAuthState() public method
public withValidateAuthState( ): self

                public function withValidateAuthState(): self
{
    $new = clone $this;
    $new->validateAuthState = true;
    return $new;
}

            
withoutValidateAuthState() public method
public withoutValidateAuthState( ): self

                public function withoutValidateAuthState(): self
{
    $new = clone $this;
    $new->validateAuthState = false;
    return $new;
}