Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
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$optionsJOAuth2Client options object
JHttp$httpThe HTTP client object
JInput$inputThe input object
JApplicationWeb$applicationThe 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$keyThe 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$urlThe URL for the request.
mixed$dataThe data to include in the request
array$headersThe headers to send with the request
string$methodThe method with which to send the request
int$timeoutThe 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$tokenThe 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$keyThe name of the option to set
mixed$valueThe 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$valueThe 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 :