JGoogleAuth

class JGoogleAuth

Google authentication class abstract

Methods

boolean
authenticate()

Abstract method to authenticate to Google

boolean
isAuthenticated()

Verify if the client has been authenticated

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

Abstract method to retrieve data from Google

mixed
getOption( string $key)

Get an option from the JGoogleAuth object.

JGoogleAuth
setOption( string $key, mixed $value)

Set an option for the JGoogleAuth object.

Details

abstract boolean authenticate()

Abstract method to authenticate to Google

Return Value

boolean True on success.

abstract boolean isAuthenticated()

Verify if the client has been authenticated

Return Value

boolean Is authenticated

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

Abstract method to retrieve data from Google

Parameters

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.

Return Value

mixed Data from Google.

mixed getOption( string $key)

Get an option from the JGoogleAuth object.

Parameters

string $key The name of the option to get.

Return Value

mixed The option value.

JGoogleAuth setOption( string $key, mixed $value)

Set an option for the JGoogleAuth object.

Parameters

string $key The name of the option to set.
mixed $value The option value to set.

Return Value

JGoogleAuth This object for method chaining.