Docs For Class JGoogleAuthOauth2

Description

Google OAuth authentication class

since: 12.3

Located in /libraries/joomla/google/auth/oauth2.php (line 20)

JGoogleAuth
   |
   --JGoogleAuthOauth2

Variable Summary

JOAuth2Client $client

Method Summary

JGoogleAuthOauth2 __construct ([JRegistry $options = null], [JOAuth2Client $client = null])

boolean authenticate ()

JOAuth2Client googlize ()

boolean isAuthenticated ()

mixed query (string $url, [mixed $data = null], [array $headers = null], [string $method = 'get'])

Variables

JOAuth2Client $client (line 26)

var: OAuth client for the Google authentication object.
since: 12.3
access: protected

Inherited Variables

Inherited from JGoogleAuth

JGoogleAuth::$options

Methods

Constructor __construct (line 36)

Constructor.

since: 12.3
access: public

JGoogleAuthOauth2 __construct ([JRegistry $options = null], [JOAuth2Client $client = null])

JRegistry $options: JGoogleAuth options object.
JOAuth2Client $client: OAuth client for Google authentication.

authenticate (line 49)

Method to authenticate to Google

return: True on success.
since: 12.3
access: public

boolean authenticate ()

Redefinition of:

JGoogleAuth::authenticate(): Abstract method to authenticate to Google

googlize (line 94)

Method to fill in Google-specific OAuth settings

return: Google-configured Oauth2 client.
since: 12.3
access: protected

JOAuth2Client googlize ()

isAuthenticated (line 63)

Verify if the client has been authenticated

return: Is authenticated
since: 12.3
access: public

boolean isAuthenticated ()

Redefinition of:

JGoogleAuth::isAuthenticated(): Verify if the client has been authenticated

query (line 80)

Method to retrieve data from Google

return: Data from Google.
since: 12.3
access: public

mixed query (string $url, [mixed $data = null], [array $headers = null], [string $method = 'get'])

string $url: The URL for the request.
mixed $data: The data to include in the request.
array $headers: The headers to send with the request.
string $method: The type of http request to send.

Redefinition of:

JGoogleAuth::query(): Abstract method to retrieve data from Google

Inherited Methods

Inherited From JGoogleAuth

JGoogleAuth::authenticate()
JGoogleAuth::getOption()
JGoogleAuth::isAuthenticated()
JGoogleAuth::query()
JGoogleAuth::setOption()