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 JOpenstreetmapOauth
+ Graphe d'héritage de JOpenstreetmapOauth:

Fonctions membres publiques

 __construct (Registry $options=null, JHttp $client=null, JInput $input=null)
 
 verifyCredentials ()
 
 validateResponse ($url, $response)
 
- Fonctions membres publiques hérités de JOAuth1Client
 __construct (Registry $options=null, JHttp $client=null, JInput $input=null, JApplicationWeb $application=null, $version=null)
 
 authenticate ()
 
 oauthRequest ($url, $method, $parameters, $data=array(), $headers=array())
 
 validateResponse ($url, $response)
 
 toUrl ($url, $parameters)
 
 safeEncode ($data)
 
 verifyCredentials ()
 
 getOption ($key)
 
 setOption ($key, $value)
 
 getToken ()
 
 setToken ($token)
 

Attributs protégés

 $options
 
- Attributs protégés hérités de JOAuth1Client
 $options
 
 $token = array()
 
 $client
 
 $input
 
 $application
 
 $version
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de JOAuth1Client
static generateNonce ()
 

Description détaillée

Joomla Platform class for generating Openstreetmap API access token.

Depuis
3.2.0
Obsolète:
4.0 Use the joomla/openstreetmap package via Composer instead

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Registry  $options = null,
JHttp  $client = null,
JInput  $input = null 
)

Constructor.

Paramètres
Registry$optionsJOpenstreetmapOauth options object.
JHttp$clientThe HTTP client object.
JInput$inputThe input object
Depuis
3.2.0

Références $client, $input, $options, Registry\def(), et null.

Documentation des fonctions membres

◆ validateResponse()

validateResponse (   $url,
  $response 
)

Method to validate a response.

Paramètres
string$urlThe request URL.
JHttpResponse$responseThe response to validate.
Renvoie
void
Depuis
3.2.0
Exceptions
DomainException

Références ENT_COMPAT, et htmlspecialchars.

◆ verifyCredentials()

verifyCredentials ( )

Method to verify if the access token is valid by making a request to an API endpoint.

Renvoie
boolean Returns true if the access token is valid and false otherwise.
Depuis
3.2.0

Documentation des champs

◆ $options

$options
protected

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