Référence de la classe Client

Fonctions membres publiques
	__construct (SessionAwareWebApplicationInterface $application, Http $client=null, Input $input=null, $options=[], $version='1.0a')
	authenticate ()
	oauthRequest ($url, $method, $parameters, $data=[], $headers=[])
	validateResponse ($url, $response)
	toUrl ($url, $parameters)
	safeEncode ($data)
	verifyCredentials ()
	getOption ($key, $default=null)
	setOption ($key, $value)
	getToken ()
	setToken ($token)

Fonctions membres publiques statiques
static	generateNonce ()

Attributs protégés
	$options
	$token = []
	$client
	$input
	$application
	$version

Fonctions membres privées
	generateRequestToken ()
	authorise ()
	generateAccessToken ()
	createHeader (array $parameters)
	signRequest (string $url, string $method, array $parameters)
	baseString (string $url, string $method, array $parameters)
	prepareSigningKey ()

Description détaillée

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

Depuis

1.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	SessionAwareWebApplicationInterface	$application,
		Http	$client = null,
		Input	$input = null,
			$options = [],
			$version = '1.0a'
	)

Constructor.

Paramètres

SessionAwareWebApplicationInterface	$application	The application object
Http	$client	The HTTP client object.
Input	$input	The input object
array | \ArrayAccess	$options	OAuth1 Client options.
string	$version	Specify the OAuth version. By default we are using 1.0a.

Depuis

1.0

Références Client\$application, Client\$client, Client\$input, Client\$options, Client\$version, et HttpFactory\getHttp().

Documentation des fonctions membres

authenticate()

authenticate

(

)

Method to form the oauth flow.

Renvoie

array|null The access token.

Depuis

1.0

Exceptions

Références Client\$token, Client\authorise(), Client\generateAccessToken(), Client\generateRequestToken(), null, et Client\verifyCredentials().

authorise()

authorise ( )

private

Method used to authorise the application.

Renvoie

void

Depuis

1.1.2

Références $scope, $url, et Client\getOption().

Référencé par Client\authenticate().

baseString()

baseString ( string  $url, string  $method, array  $parameters  )

private

Prepare the signature base string.

Paramètres

string	$url	The URL to sign.
string	$method	The request method.
array	$parameters	Array containing request parameters.

Renvoie

string The base string.

Depuis

1.1.2

Références $base, $key, $method, $parameters, $params, $url, $value, et Client\safeEncode().

Référencé par Client\signRequest().

createHeader()

createHeader ( array  $parameters )

private

Method used to create the header for the POST request.

Paramètres

array

$parameters

Array containing request parameters.

Renvoie

string The header.

Depuis

1.1.2

Références $header, $key, $parameters, $value, et Client\safeEncode().

Référencé par Client\oauthRequest().

generateAccessToken()

generateAccessToken ( )

private

Method used to get an access token.

Renvoie

void

Depuis

1.1.2

Références $parameters, $params, Client\getOption(), et Client\oauthRequest().

Référencé par Client\authenticate().

generateNonce()

static generateNonce ( )

static

Method used to generate the current nonce.

Renvoie

string The current nonce.

Depuis

1.0

Référencé par Client\oauthRequest().

generateRequestToken()

generateRequestToken ( )

private

Method used to get a request token.

Renvoie

void

Depuis

1.1.2

Exceptions

Références $parameters, $params, Client\getOption(), et Client\oauthRequest().

Référencé par Client\authenticate().

getOption()

getOption	(		$key,
			$default = null
	)

Get an option from the OAuth1 Client instance.

Paramètres

string	$key	The name of the option to get
mixed	$default	Optional default value if the option does not exist

Renvoie

mixed The option value

Depuis

1.0

Références $default, et $key.

Référencé par Client\authorise(), Client\generateAccessToken(), Client\generateRequestToken(), Client\oauthRequest(), et Client\prepareSigningKey().

getToken()

getToken

(

)

Get the oauth token key or secret.

Renvoie

array The oauth token key and secret.

Depuis

1.0

Références Client\$token.

oauthRequest()

oauthRequest	(		$url,
			$method,
			$parameters,
			$data = [],
			$headers = []
	)

Method used to make an OAuth request.

Paramètres

string	$url	The request URL.
string	$method	The request method.
array	$parameters	Array containing request parameters.
mixed	$data	The POST request data.
array	$headers	An array of name-value pairs to include in the header of the request

Renvoie

Depuis

1.0

Exceptions

Références $data, $method, $parameters, $url, Client\createHeader(), Client\generateNonce(), Client\getOption(), Client\signRequest(), Client\toUrl(), et Client\validateResponse().

Référencé par Client\generateAccessToken(), et Client\generateRequestToken().

prepareSigningKey()

prepareSigningKey ( )

private

Prepares the OAuth signing key.

Renvoie

string The prepared signing key.

Depuis

1.1.2

Références Client\getOption(), et Client\safeEncode().

Référencé par Client\signRequest().

safeEncode()

safeEncode

(

$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.

Paramètres

mixed

$data

The scalar or array to encode.

Renvoie

string $data encoded in a way compatible with OAuth.

Depuis

1.0

Références $data, et $this.

Référencé par Client\baseString(), Client\createHeader(), Client\prepareSigningKey(), et Client\signRequest().

setOption()

setOption	(		$key,
			$value
	)

Set an option for the OAuth1 Client instance.

Paramètres

string	$key	The name of the option to set
mixed	$value	The option value to set

Renvoie

$this

Depuis

1.0

Références $key, $this, et $value.

setToken()

setToken

(

$token

)

Set the oauth token.

Paramètres

array

$token

The access token key and secret.

Renvoie

$this

Depuis

1.0

Références $this, et Client\$token.

signRequest()

signRequest ( string  $url, string  $method, array  $parameters  )

private

Method used to sign requests.

Paramètres

string	$url	The URL to sign.
string	$method	The request method.
array	$parameters	Array containing request parameters.

Renvoie

array The array containing the request parameters, including signature.

Depuis

1.1.2

Références $base, $method, $parameters, Client\baseString(), Client\prepareSigningKey(), et Client\safeEncode().

Référencé par Client\oauthRequest().

toUrl()

toUrl	(		$url,
			$parameters
	)

Method to create the URL formed string with the parameters.

Paramètres

string	$url	The request URL.
array	$parameters	Array containing request parameters.

Renvoie

string The formed URL.

Depuis

1.0

Références $parameters, $uri, et $url.

Référencé par Client\oauthRequest().

validateResponse()

validateResponse (   $url,   $response  )

abstract

Method to validate a response.

Paramètres

string	$url	The request URL.
Response	$response	The response to validate.

Renvoie

void

Depuis

1.0

Exceptions

Référencé par Client\oauthRequest().

verifyCredentials()

verifyCredentials ( )

abstract

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.

Renvoie

array The decoded JSON response

Depuis

1.0

Référencé par Client\authenticate().

Documentation des champs

$application

$application

protected

Référencé par Client\__construct().

$client

$client

protected

Référencé par Client\__construct().

$input

$input

protected

Référencé par Client\__construct().

$options

$options

protected

Référencé par Client\__construct().

$token

$token = []

protected

Référencé par Client\authenticate(), Client\getToken(), et Client\setToken().

$version

$version

protected

Référencé par Client\__construct().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• oauth1/src/Client.php