Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JOpenstreetmapObject
+ Graphe d'héritage de JOpenstreetmapObject:

Fonctions membres publiques

 __construct (Registry &$options=null, JHttp $client=null, JOpenstreetmapOauth $oauth=null)
 
 getOption ($key)
 
 setOption ($key, $value)
 
 sendRequest ($path, $method='GET', $headers=array(), $data='')
 

Attributs protégés

 $options
 
 $client
 
 $oauth
 

Description détaillée

Openstreetmap API object class for the Joomla Platform

Depuis
13.1
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,
JOpenstreetmapOauth  $oauth = null 
)

Constructor

Paramètres
Registry&$optionsOpenstreetmap options object.
JHttp$clientThe HTTP client object.
JOpenstreetmapOauth$oauthOpenstreetmap oauth client
Depuis
13.1

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

Documentation des fonctions membres

◆ getOption()

getOption (   $key)

Get an option from the JOpenstreetmapObject instance.

Paramètres
string$keyThe name of the option to get.
Renvoie
mixed The option value.
Depuis
13.1

Références $key.

◆ sendRequest()

sendRequest (   $path,
  $method = 'GET',
  $headers = array(),
  $data = '' 
)

Method to send the request which does not require authentication.

Paramètres
string$pathThe path of the request to make
string$methodThe request method.
array$headersThe headers passed in the request.
mixed$dataEither an associative array or a string to be sent with the post request.
Renvoie
SimpleXMLElement The XML response
Depuis
13.1
Exceptions
DomainException

Références $data, $path, et ENT_COMPAT.

◆ setOption()

setOption (   $key,
  $value 
)

Set an option for the JOpenstreetmapObject instance.

Paramètres
string$keyThe name of the option to set.
mixed$valueThe option value to set.
Renvoie
JOpenstreetmapObject This object for method chaining.
Depuis
13.1

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

Documentation des champs

◆ $client

$client
protected

◆ $oauth

$oauth
protected

◆ $options

$options
protected

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