JOpenstreetmapInfo
Extends \JOpenstreetmapObjectOpenstreetmap API Info class for the Joomla Platform
since |
3.2.0 |
---|---|
deprecated |
4.0 Use the |
package |
Joomla.Platform |
Methods
__construct
Constructor
__construct(\Joomla\Registry\Registry &$options = null, \JHttp $client = null, \JOpenstreetmapOauth $oauth = null)
since |
3.2.0 |
---|
Arguments
- $options
- $client
\JHttp
The HTTP client object.- $oauth
\JOpenstreetmapOauth
Openstreetmap oauth client
getCapabilities
Method to get capabilities of the API
getCapabilities() : array
since |
3.2.0 |
---|
Response
array
The XML response
getOption
Get an option from the JOpenstreetmapObject instance.
getOption(string $key) : mixed
since |
3.2.0 |
---|
Arguments
- $key
string
The name of the option to get.
Response
mixed
The option value.
retrieveMapData
Method to retrieve map data of a bounding box
retrieveMapData(float $left, float $bottom, float $right, float $top) : array
since |
3.2.0 |
---|
Arguments
- $left
float
Left boundary- $bottom
float
Bottom boundary- $right
float
Right boundary- $top
float
Top boundary
Response
array
The XML response
retrievePermissions
Method to retrieve permissions for current user
retrievePermissions() : array
since |
3.2.0 |
---|
Response
array
The XML response
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 |
|
Arguments
- $path
string
The path of the request to make- $method
string
The request method.- $headers
array
The headers passed in the request.- $data
mixed
Either an associative array or a string to be sent with the post request.
Response
\SimpleXMLElement
The XML response
setOption
Set an option for the JOpenstreetmapObject instance.
setOption(string $key, mixed $value) : \JOpenstreetmapObject
since |
3.2.0 |
---|
Arguments
- $key
string
The name of the option to set.- $value
mixed
The option value to set.
Response
\JOpenstreetmapObject
This object for method chaining.
Properties
options
Options for the Openstreetmap object.
client
The HTTP client object to use in sending HTTP requests.
since |
3.2.0 |
---|
Type(s)
\JHttp