JOpenstreetmapObject

Openstreetmap API object class for the Joomla Platform

abstract deprecated
since

3.2.0

deprecated

4.0 Use the joomla/openstreetmap package via Composer instead

package

Joomla.Platform

Methods

__construct

Constructor

__construct(\Joomla\Registry\Registry &$options = null, \JHttp $client = null, \JOpenstreetmapOauth $oauth = null) 
since

3.2.0

Arguments

$options

\Joomla\Registry\Registry

$client

\JHttpThe HTTP client object.

$oauth

\JOpenstreetmapOauthOpenstreetmap oauth client

getOption

Get an option from the JOpenstreetmapObject instance.

getOption(string $key) : mixed
since

3.2.0

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

sendRequest

Method to send the request which does not require authentication.

sendRequest(string $path, string $method = 'GET', array $headers = array(), mixed $data = '') : \SimpleXMLElement
since

3.2.0

throws

\DomainException

Arguments

$path

stringThe path of the request to make

$method

stringThe request method.

$headers

arrayThe headers passed in the request.

$data

mixedEither an associative array or a string to be sent with the post request.

Response

\SimpleXMLElementThe XML response

setOption

Set an option for the JOpenstreetmapObject instance.

setOption(string $key, mixed $value) : \JOpenstreetmapObject
since

3.2.0

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\JOpenstreetmapObjectThis object for method chaining.

Properties

options

Options for the Openstreetmap object.

since

3.2.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

since

3.2.0

Type(s)

\JHttp

oauth

The OAuth client.

since

3.2.0

Type(s)

\JOpenstreetmapOauth