Class JOAuth1Client

Joomla Platform class for interacting with an OAuth 1.0 and 1.0a server.

Direct known subclasses

JLinkedinOauth, JOpenstreetmapOauth, JTwitterOAuth

Abstract
Package: Joomla\Platform\OAuth1
Deprecated: 4.0 Use the joomla/oauth1 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: 13.1
Located at joomla/oauth1/client.php

Methods summary

`public`	# `__construct( Joomla\Registry\Registry $options = null, JHttp $client = null, JInput $input = null, JApplicationWeb $application = null, string $version = null )` Constructor. Constructor. Parameters `$options` `Joomla\Registry\Registry` - $options OAuth1Client options object. `$client` `JHttp` - $client The HTTP client object. `$input` `JInput` - $input The input object `$application` `JApplicationWeb` - $application The application object `$version` `string` - $version Specify the OAuth version. By default we are using 1.0a. Since 13.1
`public array`	# `authenticate( )` Method to for the oauth flow. Method to for the oauth flow. Returns `array` - Contains access token key, secret and verifier. Throws `DomainException` Since 13.1
`public JHttpResponse`	# `oauthRequest( string $url, string $method, array $parameters, mixed $data = array(), array $headers = array() )` Method used to make an OAuth request. Method used to make an OAuth request. Parameters `$url` `string` - $url The request URL. `$method` `string` - $method The request method. `$parameters` `array` - $parameters Array containing request parameters. `$data` `mixed` - $data The POST request data. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request Returns `JHttpResponse` Throws `DomainException` Since 13.1
`abstract public`	# `validateResponse( string $url, JHttpResponse $response )` Method to validate a response. Method to validate a response. Parameters `$url` `string` - $url The request URL. `$response` `JHttpResponse` - $response The response to validate. Throws `DomainException` Since 13.1
`public string`	# `toUrl( string $url, array $parameters )` Method to create the URL formed string with the parameters. Method to create the URL formed string with the parameters. Parameters `$url` `string` - $url The request URL. `$parameters` `array` - $parameters Array containing request parameters. Returns `string` - The formed URL. Since 13.1
`public string`	# `safeEncode( mixed $data )` Encodes the string or array passed in a way compatible with OAuth. If an array is passed each array value will will be encoded. Encodes the string or array passed in a way compatible with OAuth. If an array is passed each array value will will be encoded. Parameters `$data` `mixed` - $data The scalar or array to encode. Returns `string` - $data encoded in a way compatible with OAuth. Since 13.1
`public static string`	# `generateNonce( )` Method used to generate the current nonce. Method used to generate the current nonce. Returns `string` - The current nonce. Since 13.1
`abstract public array`	# `verifyCredentials( )` Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Returns `array` - The decoded JSON response Since 13.1
`public mixed`	# `getOption( string $key )` Get an option from the JOauth1aClient instance. Get an option from the JOauth1aClient instance. Parameters `$key` `string` - $key The name of the option to get Returns `mixed` - The option value Since 13.1
`public JOAuth1Client`	# `setOption( string $key, mixed $value )` Set an option for the JOauth1aClient instance. Set an option for the JOauth1aClient instance. Parameters `$key` `string` - $key The name of the option to set `$value` `mixed` - $value The option value to set Returns `JOAuth1Client` - This object for method chaining Since 13.1
`public array`	# `getToken( )` Get the oauth token key or secret. Get the oauth token key or secret. Returns `array` - The oauth token key and secret. Since 13.1
`public JOAuth1Client`	# `setToken( array $token )` Set the oauth token. Set the oauth token. Parameters `$token` `array` - $token The access token key and secret. Returns `JOAuth1Client` - This object for method chaining. Since 13.1

Magic methods summary

Properties summary

`protected Joomla\Registry\Registry`	`$options`	# Options for the JOAuth1Client object. Options for the JOAuth1Client object. Since 13.1
`protected array`	`$token`	# Contains access token key, secret and verifier. Contains access token key, secret and verifier. Since 13.1
`protected JHttp`	`$client`	# The HTTP client object to use in sending HTTP requests. The HTTP client object to use in sending HTTP requests. Since 13.1
`protected JInput`	`$input`	# The input object to use in retrieving GET/POST data. The input object to use in retrieving GET/POST data. Since 13.1
`protected JApplicationWeb`	`$application`	# The application object to send HTTP headers for redirects. The application object to send HTTP headers for redirects. Since 13.1
`protected string`	`$version`	# Selects which version of OAuth to use: 1.0 or 1.0a. Selects which version of OAuth to use: 1.0 or 1.0a. Since 13.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JOAuth1Client

Direct known subclasses

Methods summary

Parameters

Since

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since