Class JOpenstreetmapGps

Description
Description | Vars | Methods (details)

Openstreetmap API GPS class for the Joomla Platform

  • since: 13.1

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

JOpenstreetmapObject
   |
   --JOpenstreetmapGps
Method Summary
Description | Vars | Methods (details)
array downloadTraceMetadata (integer $id, string $username, string $password)
array downloadTraceMetadetails (integer $id, string $username, string $password)
array retrieveGps (float $left, float $bottom, float $right, float $top, [integer $page = 0])
JHttpResponse uploadTrace (string $file, string $description, string $tags, integer $public, string $visibility, string $username, string $password)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JOpenstreetmapObject

JOpenstreetmapObject::$client
 JOpenstreetmapObject::$oauth
 JOpenstreetmapObject::$options
Methods
Description | Vars Methods (details)
downloadTraceMetadata (line 129)

Method to download Trace data

  • return: The XML response
  • since: 13.1
  • access: public
array downloadTraceMetadata (integer $id, string $username, string $password)
  • integer $id: Trace identifier
  • string $username: Username
  • string $password: Password
downloadTraceMetadetails (line 104)

Method to download Trace details

  • return: The XML response
  • since: 13.1
  • access: public
array downloadTraceMetadetails (integer $id, string $username, string $password)
  • integer $id: Trace identifier
  • string $username: Username
  • string $password: Password
retrieveGps (line 34)

Method to retrieve GPS points

  • return: The XML response containing GPS points
  • since: 13.1
  • access: public
array retrieveGps (float $left, float $bottom, float $right, float $top, [integer $page = 0])
  • float $left: Left boundary
  • float $bottom: Bottom boundary
  • float $right: Right boundary
  • float $top: Top boundary
  • integer $page: Page number
uploadTrace (line 65)

Method to upload GPS Traces

  • return: The response
  • since: 13.1
  • access: public
JHttpResponse uploadTrace (string $file, string $description, string $tags, integer $public, string $visibility, string $username, string $password)
  • string $file: File name that contains trace points
  • string $description: Description on trace points
  • string $tags: Tags for trace
  • integer $public:
    1. for public, 0 for private
  • string $visibility: One of the following: private, public, trackable, identifiable
  • string $username: Username
  • string $password: Password

Inherited Methods

Inherited From JOpenstreetmapObject

JOpenstreetmapObject::__construct()
JOpenstreetmapObject::getOption()
JOpenstreetmapObject::sendRequest()
JOpenstreetmapObject::setOption()

Documentation generated on Tue, 19 Nov 2013 15:04:01 +0100 by phpDocumentor 1.4.3