Abstract Class JGoogleAuth

Description

Google authentication class abstract

  • abstract:
  • since: 12.3

Located in /libraries/joomla/google/auth.php (line 19)


	
			
Direct descendents
Class Description
 class JGoogleAuthOauth2 Google OAuth authentication class
Variable Summary
Method Summary
 boolean authenticate ()
 mixed getOption (string $key)
 boolean isAuthenticated ()
 mixed query (string $url, [mixed $data = null], [array $headers = null], [string $method = 'get'])
 JGoogleAuth setOption (string $key, mixed $value)
Variables
JRegistry $options (line 25)
  • var: Options for the Google authentication object.
  • since: 12.3
  • access: protected
Methods
authenticate (line 34)

Abstract method to authenticate to Google

  • return: True on success.
  • abstract:
  • since: 12.3
  • access: public
boolean authenticate ()

Redefined in descendants as:
getOption (line 68)

Get an option from the JGoogleAuth object.

  • return: The option value.
  • since: 12.3
  • access: public
mixed getOption (string $key)
  • string $key: The name of the option to get.
isAuthenticated (line 43)

Verify if the client has been authenticated

  • return: Is authenticated
  • abstract:
  • since: 12.3
  • access: public
boolean isAuthenticated ()

Redefined in descendants as:
query (line 57)

Abstract method to retrieve data from Google

  • return: Data from Google.
  • abstract:
  • since: 12.3
  • access: public
mixed query (string $url, [mixed $data = null], [array $headers = null], [string $method = 'get'])
  • 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.

Redefined in descendants as:
setOption (line 83)

Set an option for the JGoogleAuth object.

  • return: This object for method chaining.
  • since: 12.3
  • access: public
JGoogleAuth setOption (string $key, mixed $value)
  • string $key: The name of the option to set.
  • mixed $value: The option value to set.

Documentation generated on Tue, 19 Nov 2013 14:54:09 +0100 by phpDocumentor 1.4.3