JOpenstreetmapGps
Extends \JOpenstreetmapObjectOpenstreetmap API GPS 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
downloadTraceMetadata
Method to download Trace data
downloadTraceMetadata(integer $id, string $username, string $password) : array
since |
3.2.0 |
---|
Arguments
- $id
integer
Trace identifier- $username
string
Username- $password
string
Password
Response
array
The XML response
downloadTraceMetadetails
Method to download Trace details
downloadTraceMetadetails(integer $id, string $username, string $password) : array
since |
3.2.0 |
---|
Arguments
- $id
integer
Trace identifier- $username
string
Username- $password
string
Password
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.
retrieveGps
Method to retrieve GPS points
retrieveGps(float $left, float $bottom, float $right, float $top, integer $page) : array
since |
3.2.0 |
---|
Arguments
- $left
float
Left boundary- $bottom
float
Bottom boundary- $right
float
Right boundary- $top
float
Top boundary- $page
integer
Page number
Response
array
The XML response containing GPS points
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.
uploadTrace
Method to upload GPS Traces
uploadTrace(string $file, string $description, string $tags, integer $public, string $visibility, string $username, string $password) : \JHttpResponse
since |
3.2.0 |
---|
Arguments
- $file
string
File name that contains trace points- $description
string
Description on trace points- $tags
string
Tags for trace- $public
integer
1 for public, 0 for private- $visibility
string
One of the following: private, public, trackable, identifiable- $username
string
Username- $password
string
Password
Response
\JHttpResponse
The response
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