Gps

Extends \Joomla\OpenStreetMap\OpenStreetMapObject

OpenStreetMap API GPS class for the Joomla Framework

deprecated
since

1.0

deprecated

The joomla/openstreetmap package is deprecated

Methods

__construct

Constructor

__construct(array $options = array(), \Joomla\Http\Http $client = null, \Joomla\OpenStreetMap\OAuth $oauth = null) 
inherited
since

1.0

Arguments

$options

arrayOpenStreetMap options object.

$client

\Joomla\Http\HttpThe HTTP client object.

$oauth

\Joomla\OpenStreetMap\OAuthOpenStreetMap OAuth client

downloadTraceMetadata

Method to download Trace data

downloadTraceMetadata(integer $id, string $username, string $password) : array
since

1.0

Arguments

$id

integerTrace identifier

$username

stringUsername

$password

stringPassword

Response

arrayThe XML response

downloadTraceMetadetails

Method to download Trace details

downloadTraceMetadetails(integer $id, string $username, string $password) : array
since

1.0

Arguments

$id

integerTrace identifier

$username

stringUsername

$password

stringPassword

Response

arrayThe XML response

getOption

Get an option from the OpenStreetMapObject instance.

getOption(string $key) : mixed
inherited
since

1.0

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

retrieveGps

Method to retrieve GPS points

retrieveGps(float $left, float $bottom, float $right, float $top, integer $page) : array
since

1.0

Arguments

$left

floatLeft boundary

$bottom

floatBottom boundary

$right

floatRight boundary

$top

floatTop boundary

$page

integerPage number

Response

arrayThe 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
inherited
since

1.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 OpenStreetMapObject instance.

setOption(string $key, mixed $value) : \Joomla\OpenStreetMap\OpenStreetMapObject
inherited
since

1.0

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\Joomla\OpenStreetMap\OpenStreetMapObjectThis 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) : \Joomla\Http\Response
since

1.0

Arguments

$file

stringFile name that contains trace points

$description

stringDescription on trace points

$tags

stringTags for trace

$public

integer1 for public, 0 for private

$visibility

stringOne of the following: private, public, trackable, identifiable

$username

stringUsername

$password

stringPassword

Response

\Joomla\Http\ResponseThe response

Properties

options

Options for the OpenStreetMap object.

inherited
since

1.0

Type(s)

array

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Http\Http

oauth

The OAuth client.

inherited
since

1.0

Type(s)

\Joomla\OpenStreetMap\OAuth