Class JOAuth2Client

Joomla Platform class for interacting with an OAuth 2.0 server.

Direct known subclasses

JFacebookOAuth

Package: Joomla\Platform\OAuth2
Deprecated: 4.0 Use the joomla/oauth2 framework package that will be bundled 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/oauth2/client.php

Methods summary

`public`	# `__construct( Joomla\Registry\Registry $options = null, JHttp $http = null, JInput $input = null, JApplicationWeb $application = null )` Constructor. Constructor. Parameters `$options` `Joomla\Registry\Registry` - $options JOAuth2Client options object `$http` `JHttp` - $http The HTTP client object `$input` `JInput` - $input The input object `$application` `JApplicationWeb` - $application The application object Since 12.3
`public string`	# `authenticate( )` Get the access token or redict to the authentication URL. Get the access token or redict to the authentication URL. Returns `string` - The access token Throws `RuntimeException` Since 12.3
`public boolean`	# `isAuthenticated( )` Verify if the client has been authenticated Verify if the client has been authenticated Returns `boolean` - Is authenticated Since 12.3
`public JHttpResponse`	# `createUrl( )` Create the URL for authentication. Create the URL for authentication. Returns `JHttpResponse` - The HTTP response Throws `InvalidArgumentException` Since 12.3
`public string`	# `query( string $url, mixed $data = null, array $headers = array(), string $method = 'get', integer $timeout = null )` Send a signed Oauth request. Send a signed Oauth request. 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 method with which to send the request `$timeout` `integer` - $timeout The timeout for the request Returns `string` - The URL. Throws `InvalidArgumentException` `RuntimeException` Since 12.3
`public mixed`	# `getOption( string $key )` Get an option from the JOAuth2Client instance. Get an option from the JOAuth2Client instance. Parameters `$key` `string` - $key The name of the option to get Returns `mixed` - The option value Since 12.3
`public JOAuth2Client`	# `setOption( string $key, mixed $value )` Set an option for the JOAuth2Client instance. Set an option for the JOAuth2Client instance. Parameters `$key` `string` - $key The name of the option to set `$value` `mixed` - $value The option value to set Returns `JOAuth2Client` - This object for method chaining Since 12.3
`public array`	# `getToken( )` Get the access token from the JOAuth2Client instance. Get the access token from the JOAuth2Client instance. Returns `array` - The access token Since 12.3
`public JOAuth2Client`	# `setToken( array $value )` Set an option for the JOAuth2Client instance. Set an option for the JOAuth2Client instance. Parameters `$value` `array` - $value The access token Returns `JOAuth2Client` - This object for method chaining Since 12.3
`public array`	# `refreshToken( string $token = null )` Refresh the access token instance. Refresh the access token instance. Parameters `$token` `string` - $token The refresh token Returns `array` - The new access token Throws `Exception` `RuntimeException` Since 12.3

Magic methods summary

Properties summary

`protected Joomla\Registry\Registry`	`$options`	# Options for the JOAuth2Client object. Options for the JOAuth2Client object. Since 12.3
`protected JHttp`	`$http`	# The HTTP client object to use in sending HTTP requests. The HTTP client object to use in sending HTTP requests. Since 12.3
`protected JInput`	`$input`	# The input object to use in retrieving GET/POST data. The input object to use in retrieving GET/POST data. Since 12.3
`protected JApplicationWeb`	`$application`	# The application object to send HTTP headers for redirects. The application object to send HTTP headers for redirects. Since 12.3

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JOAuth2Client

Direct known subclasses

Methods summary

Parameters

Since

Returns

Throws

Since

Returns

Since

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Magic methods summary

Properties summary

Since

Since

Since

Since