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\RegistryJGoogleAuth options object.- $client
\JOAuth2ClientOAuth client for Google authentication.
authenticate
Abstract method to authenticate to Google
authenticate() : boolean
| since |
3.1.4 |
|---|
Response
booleanTrue on success.
getOption
Get an option from the JGoogleAuth object.
getOption(string $key) : mixed
| since |
3.1.4 |
|---|
Arguments
- $key
stringThe name of the option to get.
Response
mixedThe 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
booleanIs 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
stringThe URL for the request.- $data
mixedThe data to include in the request.- $headers
arrayThe headers to send with the request.- $method
stringThe type of http request to send.
Response
mixedData from Google.
setOption
Set an option for the JGoogleAuth object.
setOption(string $key, mixed $value) : \JGoogleAuth
| since |
3.1.4 |
|---|
Arguments
- $key
stringThe name of the option to set.- $value
mixedThe option value to set.
Response
\JGoogleAuthThis object for method chaining.
Properties
options
Options for the Google authentication object.