Auth

Google authentication class abstract

abstract deprecated
since

1.0

deprecated

The joomla/google package is deprecated

Methods

authenticate

Abstract method to authenticate to Google

authenticate() : boolean
abstract
since

1.0

Response

booleanTrue on success.

getOption

Get an option from the Auth object.

getOption(string $key) : mixed
since

1.0

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

1.0

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

1.0

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 Auth object.

setOption(string $key, mixed $value) : \Joomla\Google\Auth
since

1.0

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\Joomla\Google\AuthThis object for method chaining.

Properties

options

Options for the Google authentication object.

since

1.0

Type(s)

array|\ArrayAccess