Référence de la classe JOAuth2Client

Graphe d'héritage de JOAuth2Client:

Fonctions membres publiques
	__construct (Registry $options=null, JHttp $http=null, JInput $input=null, JApplicationWeb $application=null)
	authenticate ()
	isAuthenticated ()
	createUrl ()
	query ($url, $data=null, $headers=array(), $method='get', $timeout=null)
	getOption ($key)
	setOption ($key, $value)
	getToken ()
	setToken ($value)
	refreshToken ($token=null)

Attributs protégés
	$options
	$http
	$input
	$application

Description détaillée

Joomla Platform class for interacting with an OAuth 2.0 server.

Depuis

3.1.4

Obsolète:

4.0 Use the joomla/oauth2 framework package that will be bundled instead

Documentation des constructeurs et destructeur

__construct()

__construct	(	Registry	$options = null,
		JHttp	$http = null,
		JInput	$input = null,
		JApplicationWeb	$application = null
	)

Constructor.

Paramètres

Registry	$options	JOAuth2Client options object
JHttp	$http	The HTTP client object
JInput	$input	The input object
JApplicationWeb	$application	The application object

Depuis

3.1.4

Références $input, et $options.

Documentation des fonctions membres

authenticate()

authenticate

(

)

Get the access token or redict to the authentication URL.

Renvoie

string The access token

Depuis

3.1.4

Exceptions

RuntimeException

Références $data.

createUrl()

createUrl

(

)

Create the URL for authentication.

Renvoie

JHttpResponse The HTTP response

Depuis

3.1.4

Exceptions

InvalidArgumentException

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

getOption()

getOption

(

$key

)

Get an option from the JOAuth2Client instance.

Paramètres

string

$key

The name of the option to get

Renvoie

mixed The option value

Depuis

3.1.4

Références $key.

getToken()

getToken

(

)

Get the access token from the JOAuth2Client instance.

Renvoie

array The access token

Depuis

3.1.4

isAuthenticated()

isAuthenticated

(

)

Verify if the client has been authenticated

Renvoie

boolean Is authenticated

Depuis

3.1.4

Références elseif.

query()

query	(		$url,
			$data = null,
			$headers = array(),
			$method = 'get',
			$timeout = null
	)

Send a signed Oauth request.

Paramètres

string	$url	The URL for the request.
mixed	$data	The data to include in the request
array	$headers	The headers to send with the request
string	$method	The method with which to send the request
int	$timeout	The timeout for the request

Renvoie

string The URL.

Depuis

3.1.4

Exceptions

InvalidArgumentException
RuntimeException

Références $data, $url, et elseif.

refreshToken()

refreshToken

(

$token = null

)

Refresh the access token instance.

Paramètres

string

$token

The refresh token

Renvoie

array The new access token

Depuis

3.1.4

Exceptions

Exception
RuntimeException

Références $data.

setOption()

setOption	(		$key,
			$value
	)

Set an option for the JOAuth2Client instance.

Paramètres

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

Renvoie

JOAuth2Client This object for method chaining

Depuis

3.1.4

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

setToken()

setToken

(

$value

)

Set an option for the JOAuth2Client instance.

Paramètres

array

$value

The access token

Renvoie

JOAuth2Client This object for method chaining

Depuis

3.1.4

Références $value.

Documentation des champs

$application

$application

protected

$http

$http

protected

$input

$input

protected

$options

$options

protected

---

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

• libraries/joomla/oauth2/client.php