Joomla! API

Constructor.

__construct(\Joomla\Application\SessionAwareWebApplicationInterface application, \Joomla\Http\Http client = null, \Joomla\Input\Input input = null, array|\ArrayAccess options = [],  version = '1.0a') :

since	1.0

Arguments

application: SessionAwareWebApplicationInterfaceThe application object
client: Http|nullThe HTTP client object.
input: Input|nullThe input object
options: array<string|int, mixed>|ArrayAccessOAuth1 Client options.
version: stringSpecify the OAuth version. By default we are using 1.0a.

Response

mixed

Method to form the oauth flow.

authenticate() : mixed||string|int

since	1.0
throws	`DomainException`

Response

array<string|int, mixed>The access token.

Method used to authorise the application.

authorise() :

since	1.1.2

Response

void

Prepare the signature base string.

baseString( url,  method, mixed||string|int parameters) :

since	1.1.2

Arguments

url: stringThe URL to sign.
method: stringThe request method.
parameters: array<string|int, mixed>Array containing request parameters.

Response

stringThe base string.

Method used to create the header for the POST request.

createHeader(mixed||string|int parameters) :

since	1.1.2

Arguments

parameters: array<string|int, mixed>Array containing request parameters.

Response

stringThe header.

Method used to get an access token.

generateAccessToken() :

since	1.1.2

Response

void

Method used to generate the current nonce.

generateNonce() :

static

since	1.0

Response

stringThe current nonce.

Method used to get a request token.

generateRequestToken() :

since	1.1.2
throws	`DomainException`

Response

void

Get an option from the OAuth1 Client instance.

getOption( key,  default = null) :

since	1.0

Arguments

key: stringThe name of the option to get
default: mixedOptional default value if the option does not exist

Response

mixedThe option value

Get the oauth token key or secret.

getToken() : mixed||string|int

since	1.0

Response

array<string|int, mixed>The oauth token key and secret.

Method used to make an OAuth request.

oauthRequest( url,  method, mixed||string|int parameters,  data = [], mixed||string|int headers = []) : \Joomla\Http\Response

since	1.0
throws	`DomainException`

Arguments

url: stringThe request URL.
method: stringThe request method.
parameters: array<string|int, mixed>Array containing request parameters.
data: mixedThe POST request data.
headers: array<string|int, mixed>An array of name-value pairs to include in the header of the request

Response

Response

Prepares the OAuth signing key.

prepareSigningKey() :

since	1.1.2

Response

stringThe prepared signing key.

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

safeEncode(string|string[] data) : string|string[]

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

since	1.0

Arguments

data: string|array<string|int, string>The scalar or array to encode.

Response

string|array<string|int, string>$data encoded in a way compatible with OAuth.

Set an option for the OAuth1 Client instance.

setOption( key,  value) :

since	1.0

Arguments

key: stringThe name of the option to set
value: mixedThe option value to set

Response

$this

Set the oauth token.

setToken(mixed||string|int token) :

since	1.0

Arguments

token: array<string|int, mixed>The access token key and secret.

Response

$this

Method used to sign requests.

signRequest( url,  method, mixed||string|int parameters) : mixed||string|int

since	1.1.2

Arguments

url: stringThe URL to sign.
method: stringThe request method.
parameters: array<string|int, mixed>Array containing request parameters.

Response

array<string|int, mixed>The array containing the request parameters, including signature.

Method to create the URL formed string with the parameters.

toUrl( url, mixed||string|int parameters) :

since	1.0

Arguments

url: stringThe request URL.
parameters: array<string|int, mixed>Array containing request parameters.

Response

stringThe formed URL.

Method to validate a response.

validateResponse( url, \Joomla\Http\Response response) :

abstract

since	1.0
throws	`DomainException`

Arguments

url: stringThe request URL.
response: ResponseThe response to validate.

Response

void

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() : mixed||string|int

abstract

since	1.0

Response

array<string|int, mixed>The decoded JSON response

Options for the Client object.

since	1.0

Type(s)

array<string|int, mixed>|ArrayAccess

Contains access token key, secret and verifier.

since	1.0

Type(s)

array<string|int, mixed>

The HTTP client object to use in sending HTTP requests.

since	1.0

Type(s)

Http

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

since	1.0

Type(s)

Input

The application object to send HTTP headers for redirects.

since	1.0

Type(s)

SessionAwareWebApplicationInterface

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

since	1.0

Type(s)

string

since	1.0
package	Joomla Framework

Client

Methods

__construct

Arguments

Response

authenticate

Response

authorise

Response

baseString

Arguments

Response

createHeader

Arguments

Response

generateAccessToken

Response

generateNonce

Response

generateRequestToken

Response

getOption

Arguments

Response

getToken

Response

oauthRequest

Arguments

Response

prepareSigningKey

Response

safeEncode

Arguments

Response

setOption

Arguments

Response

setToken

Arguments

Response

signRequest

Arguments

Response

toUrl

Arguments

Response

validateResponse

Arguments

Response

verifyCredentials

Response

Properties

options

Type(s)

token

Type(s)

client

Type(s)

input

Type(s)

application

Type(s)

version

Type(s)