Docs For Class JOpenstreetmap

Description

Joomla Platform class for interact with Openstreetmap API.

since: 13.1

Located in /libraries/joomla/openstreetmap/openstreetmap.php (line 19)

Variable Summary

JOpenstreetmapChangesets $changesets

JHttp $client

JOpenstreetmapElements $elements

JOpenstreetmapGps $gps

JOpenstreetmapInfo $info

JOpenstreetmapOauth $oauth

JRegistry $options

JOpenstreetmapUser $user

Method Summary

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

mixed getOption (string $key)

JOpenstreetmap setOption (string $key, mixed $value)

JOpenstreetmapObject __get (string $name)

Variables

JOpenstreetmapChangesets $changesets (line 51)

Openstreetmap API object for changesets.

since: 13.1
access: protected

JHttp $client (line 35)

The HTTP client object to use in sending HTTP requests.

since: 13.1
access: protected

JOpenstreetmapElements $elements (line 59)

Openstreetmap API object for elements.

since: 13.1
access: protected

JOpenstreetmapGps $gps (line 67)

Openstreetmap API object for GPS.

since: 13.1
access: protected

JOpenstreetmapInfo $info (line 75)

Openstreetmap API object for info.

since: 13.1
access: protected

JOpenstreetmapOauth $oauth (line 43)

The OAuth client.

since: 13.1
access: protected

JRegistry $options (line 27)

Options for the Openstreetmap object.

since: 13.1
access: protected

JOpenstreetmapUser $user (line 83)

Openstreetmap API object for user.

since: 13.1
access: protected

Methods

Constructor __construct (line 94)

Constructor.

since: 13.1
access: public

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

JOpenstreetmapOauth $oauth: Openstreetmap oauth client
JRegistry $options: Openstreetmap options object
JHttp $client: The HTTP client object

getOption (line 142)

Get an option from the JOpenstreetmap instance.

return: The option value.
since: 13.1
access: public

mixed getOption (string $key)

string $key: The name of the option to get.

setOption (line 157)

Set an option for the Openstreetmap instance.

return: This object for method chaining.
since: 13.1
access: public

JOpenstreetmap setOption (string $key, mixed $value)

string $key: The name of the option to set.
mixed $value: The option value to set.

__get (line 116)

Method to get object instances

return: Openstreetmap API object
since: 13.1
throws: InvalidArgumentException
access: public

JOpenstreetmapObject __get (string $name)

string $name: Name of property to retrieve