JGoogleAuthOauth2
Extends \JGoogleAuthGoogle OAuth authentication class
since |
3.1.4 |
---|---|
deprecated |
4.0 Use the |
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JOAuth2Client $client = null)
since |
3.1.4 |
---|
Arguments
- $options
\Joomla\Registry\Registry
JGoogleAuth options object.- $client
\JOAuth2Client
OAuth client for Google authentication.
authenticate
Abstract method to authenticate to Google
authenticate() : boolean
since |
3.1.4 |
---|
Response
boolean
True on success.
getOption
Get an option from the JGoogleAuth object.
getOption(string $key) : mixed
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to get.
Response
mixed
The option value.
googlize
Method to fill in Google-specific OAuth settings
googlize() : \JOAuth2Client
isAuthenticated
Verify if the client has been authenticated
isAuthenticated() : boolean
since |
3.1.4 |
---|
Response
boolean
Is authenticated
query
Abstract method to retrieve data from Google
query(string $url, mixed $data = null, array $headers = null, string $method = 'get') : mixed
since |
3.1.4 |
---|
Arguments
- $url
string
The URL for the request.- $data
mixed
The data to include in the request.- $headers
array
The headers to send with the request.- $method
string
The type of http request to send.
Response
mixed
Data from Google.
setOption
Set an option for the JGoogleAuth object.
setOption(string $key, mixed $value) : \JGoogleAuth
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to set.- $value
mixed
The option value to set.
Response
\JGoogleAuth
This object for method chaining.
Properties
options
Options for the Google authentication object.