Joomla! API

Download
Launch

Client

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

abstract
since

1.0
package

Joomla Framework

Methods

__construct

Constructor.

__construct(array options = array(), \Joomla\Http\Http client, \Joomla\Input\Input input, \Joomla\Application\AbstractWebApplication application, string version = '1.0a') : mixed
since

1.0

Arguments

options

arrayOAuth1 Client options array.

client

\Joomla\Http\HttpThe HTTP client object.

input

\Joomla\Input\InputThe input object

application

\Joomla\Application\AbstractWebApplicationThe application object

version

stringSpecify the OAuth version. By default we are using 1.0a.

Response

mixed

authenticate

Method to form the oauth flow.

authenticate() : string
since

1.0
throws

\DomainException

Response

stringThe access token.

authorise

Method used to authorise the application.

authorise() : void
since

1.1.2

baseString

Prepare the signature base string.

baseString(string url, string method, array parameters) : string
since

1.1.2

Arguments

url

stringThe URL to sign.

method

stringThe request method.

parameters

arrayArray containing request parameters.

Response

stringThe base string.

createHeader

Method used to create the header for the POST request.

createHeader(array parameters) : string
since

1.1.2

Arguments

parameters

arrayArray containing request parameters.

Response

stringThe header.

generateAccessToken

Method used to get an access token.

generateAccessToken() : void
since

1.1.2

generateNonce

Method used to generate the current nonce.

generateNonce() : string
static
since

1.0

Response

stringThe current nonce.

generateRequestToken

Method used to get a request token.

generateRequestToken() : void
since

1.1.2
throws

\DomainException

getOption

Get an option from the OAuth1 Client instance.

getOption(string key) : mixed
since

1.0

Arguments

key

stringThe name of the option to get

Response

mixedThe option value

getToken

Get the oauth token key or secret.

getToken() : array
since

1.0

Response

arrayThe oauth token key and secret.

oauthRequest

Method used to make an OAuth request.

oauthRequest(string url, string method, array parameters, mixed data = array(), array headers = array()) : object
since

1.0
throws

\DomainException

Arguments

url

stringThe request URL.

method

stringThe request method.

parameters

arrayArray containing request parameters.

data

mixedThe POST request data.

headers

arrayAn array of name-value pairs to include in the header of the request

Response

objectThe Response object.

prepareSigningKey

Prepares the OAuth signing key.

prepareSigningKey() : string
since

1.1.2

Response

stringThe prepared signing key.

safeEncode

Encodes the string or array passed in a way compatible with OAuth.

safeEncode(mixed data) : string

If an array is passed each array value will will be encoded.

since

1.0

Arguments

data

mixedThe scalar or array to encode.

Response

string$data encoded in a way compatible with OAuth.

setOption

Set an option for the OAuth1 Client instance.

setOption(string key, mixed value) : \Joomla\Oauth1\Client
since

1.0

Arguments

key

stringThe name of the option to set

value

mixedThe option value to set

Response

\Joomla\Oauth1\ClientThis object for method chaining

setToken

Set the oauth token.

setToken(array token) : \Joomla\Oauth1\Client
since

1.0

Arguments

token

arrayThe access token key and secret.

Response

\Joomla\Oauth1\ClientThis object for method chaining.

signRequest

Method used to sign requests.

signRequest(string url, string method, array parameters) : array
since

1.1.2

Arguments

url

stringThe URL to sign.

method

stringThe request method.

parameters

arrayArray containing request parameters.

Response

arrayThe array containing the request parameters, including signature.

toUrl

Method to create the URL formed string with the parameters.

toUrl(string url, array parameters) : string
since

1.0

Arguments

url

stringThe request URL.

parameters

arrayArray containing request parameters.

Response

stringThe formed URL.

validateResponse

Method to validate a response.

validateResponse(string url, \Joomla\Oauth1\Response response) : void
abstract
since

1.0
throws

\DomainException

Arguments

url

stringThe request URL.

response

\Joomla\Oauth1\ResponseThe response to validate.

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.

verifyCredentials() : array
abstract
since

1.0

Response

arrayThe decoded JSON response

Properties

options

Options for the Client object.

since

1.0

Type(s)

array

token

Contains access token key, secret and verifier.

since

1.0

Type(s)

array

client

The HTTP client object to use in sending HTTP requests.

since

1.0

Type(s)

\Joomla\Http\Http

input

The input object to use in retrieving GET/POST data.

since

1.0

Type(s)

\Joomla\Input\Input

application

The application object to send HTTP headers for redirects.

since

1.0

Type(s)

\Joomla\Application\AbstractWebApplication

version

Selects which version of OAuth to use: 1.0 or 1.0a.

since

1.0

Type(s)

string
  • \ Joomla
  • \ Oauth1
  • \ Client