Class JGoogleAuth

Google authentication class abstract

Direct known subclasses

JGoogleAuthOauth2

Abstract
Package: Joomla\Platform\Google
Deprecated: 4.0 Use the joomla/google package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/google/auth.php

Methods summary

`abstract public boolean`	# `authenticate( )` Abstract method to authenticate to Google Abstract method to authenticate to Google Returns `boolean` - True on success. Since 12.3
`abstract public boolean`	# `isAuthenticated( )` Verify if the client has been authenticated Verify if the client has been authenticated Returns `boolean` - Is authenticated Since 12.3
`abstract public mixed`	# `query( string $url, mixed $data = null, array $headers = null, string $method = 'get' )` Abstract method to retrieve data from Google Abstract method to retrieve data from Google Parameters `$url` `string` - $url The URL for the request. `$data` `mixed` - $data The data to include in the request. `$headers` `array` - $headers The headers to send with the request. `$method` `string` - $method The type of http request to send. Returns `mixed` - Data from Google. Since 12.3
`public mixed`	# `getOption( string $key )` Get an option from the JGoogleAuth object. Get an option from the JGoogleAuth object. Parameters `$key` `string` - $key The name of the option to get. Returns `mixed` - The option value. Since 12.3
`public JGoogleAuth`	# `setOption( string $key, mixed $value )` Set an option for the JGoogleAuth object. Set an option for the JGoogleAuth object. Parameters `$key` `string` - $key The name of the option to set. `$value` `mixed` - $value The option value to set. Returns `JGoogleAuth` - This object for method chaining. Since 12.3

Magic methods summary

Properties summary

`protected Joomla\Registry\Registry`	`$options`	# Options for the Google authentication object. Options for the Google authentication object. Since 12.3

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGoogleAuth

Direct known subclasses

Methods summary

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since