Docs For Class JOpenstreetmapObject

Description

Openstreetmap API object class for the Joomla Platform

Direct descendents

Class	Description
JOpenstreetmapChangesets	Openstreetmap API Changesets class for the Joomla Platform
JOpenstreetmapElements	Openstreetmap API Elements class for the Joomla Platform
JOpenstreetmapGps	Openstreetmap API GPS class for the Joomla Platform
JOpenstreetmapInfo	Openstreetmap API Info class for the Joomla Platform
JOpenstreetmapUser	Openstreetmap API User class for the Joomla Platform

Variable Summary

JHttp $client

Method Summary

JOpenstreetmapObject __construct ([JRegistry &$options = null], [JHttp $client = null], [JOpenstreetmapOauth $oauth = null])

mixed getOption (string $key)

SimpleXMLElement sendRequest (string $path, [string $method = 'GET'], [array $headers = array()], [mixed $data = ''])

JOpenstreetmapObject setOption (string $key, mixed $value)

Variables

JHttp $client (line 35)

The HTTP client object to use in sending HTTP requests.

JOpenstreetmapOauth $oauth (line 43)

The OAuth client.

JRegistry $options (line 27)

Options for the Openstreetmap object.

Methods

Constructor __construct (line 54)

Constructor

JOpenstreetmapObject __construct ([JRegistry &$options = null], [JHttp $client = null], [JOpenstreetmapOauth $oauth = null])

getOption (line 70)

Get an option from the JOpenstreetmapObject instance.

mixed getOption (string $key)

sendRequest (line 105)

Method to send the request which does not require authentication.

SimpleXMLElement sendRequest (string $path, [string $method = 'GET'], [array $headers = array()], [mixed $data = ''])

string $path: The path of the request to make
string $method: The request method.
array $headers: The headers passed in the request.
mixed $data: Either an associative array or a string to be sent with the post request.

setOption (line 85)

Set an option for the JOpenstreetmapObject instance.

JOpenstreetmapObject setOption (string $key, mixed $value)