JGoogleAuth

Google authentication class abstract

abstract deprecated
since

3.1.4

deprecated

4.0 Use the joomla/google package via Composer instead

package

Joomla.Platform

Methods

authenticate

Abstract method to authenticate to Google

authenticate() : boolean
abstract
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.

isAuthenticated

Verify if the client has been authenticated

isAuthenticated() : boolean
abstract
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
abstract
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.

since

3.1.4

Type(s)

\Joomla\Registry\Registry