Référence de la classe JOpenstreetmapGps

Graphe d'héritage de JOpenstreetmapGps:

Graphe de collaboration de JOpenstreetmapGps:

Liste de tous les membres

Fonctions membres publiques
	retrieveGps ($left, $bottom, $right, $top, $page=0)
	uploadTrace ($file, $description, $tags, $public, $visibility, $username, $password)
	downloadTraceMetadetails ($id, $username, $password)
	downloadTraceMetadata ($id, $username, $password)
Fonctions membres publiques inherited from JOpenstreetmapObject
	__construct (JRegistry &$options=null, JHttp $client=null, JOpenstreetmapOauth $oauth=null)
	getOption ($key)
	setOption ($key, $value)
	sendRequest ($path, $method= 'GET', $headers=array(), $data= '')

Additional Inherited Members
Attributs protégés inherited from JOpenstreetmapObject
	$options
	$client
	$oauth

---

Description détaillée

Définition à la ligne 19 du fichier gps.php.

---

Documentation des fonctions membres

JOpenstreetmapGps::downloadTraceMetadata	(		$id,
			$username,
			$password
	)

Method to download Trace data

Paramètres:

integer	$id	Trace identifier
string	$username	Username
string	$password	Password

Renvoie:

array The XML response

Depuis:

13.1

Définition à la ligne 129 du fichier gps.php.

        {
                // Set the API base
                $base = 'gpx/' . $id . '/data';

                // Build the request path.
                $path = $this->getOption('api.url') . $base;

                // Send the request.
                $xml_string = $this->sendRequest($path, 'GET', array('Authorization' => 'Basic ' . base64_encode($username . ':' . $password)));

                return $xml_string;
        }

JOpenstreetmapGps::downloadTraceMetadetails	(		$id,
			$username,
			$password
	)

Method to download Trace details

Paramètres:

integer	$id	Trace identifier
string	$username	Username
string	$password	Password

Renvoie:

array The XML response

Depuis:

13.1

Définition à la ligne 104 du fichier gps.php.

        {
                // Set the API base
                $base = 'gpx/' . $id . '/details';

                // Build the request path.
                $path = $this->getOption('api.url') . $base;

                // Send the request.
                $xml_string = $this->sendRequest($path, 'GET', array('Authorization' => 'Basic ' . base64_encode($username . ':' . $password)));

                return $xml_string;
        }

JOpenstreetmapGps::retrieveGps	(		$left,
			$bottom,
			$right,
			$top,
			$page = 0
	)

Method to retrieve GPS points

Paramètres:

float	$left	Left boundary
float	$bottom	Bottom boundary
float	$right	Right boundary
float	$top	Top boundary
integer	$page	Page number

Renvoie:

array The XML response containing GPS points

Depuis:

13.1

Définition à la ligne 34 du fichier gps.php.

        {
                // Set the API base
                $base = 'trackpoints?bbox=' . $left . ',' . $bottom . ',' . $right . ',' . $top . '&page=' . $page;

                // Build the request path.
                $path = $this->getOption('api.url') . $base;

                // Send the request.
                $response = $this->oauth->oauthRequest($path, 'GET', array());

                $xml_string = simplexml_load_string($response->body);

                return $xml_string;
        }

JOpenstreetmapGps::uploadTrace	(		$file,
			$description,
			$tags,
			$public,
			$visibility,
			$username,
			$password
	)

Method to upload GPS Traces

Paramètres:

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

Renvoie:

JHttpResponse The response

Depuis:

13.1

Définition à la ligne 65 du fichier gps.php.

        {
                // Set parameters.
                $parameters = array(
                        'file' => $file,
                        'description' => $description,
                        'tags' => $tags,
                        'public' => $public,
                        'visibility' => $visibility
                );

                // Set the API base
                $base = 'gpx/create';

                // Build the request path.
                $path = $this->getOption('api.url') . $base;

                $header['Content-Type'] = 'multipart/form-data';

                $header = array_merge($header, $parameters);
                $header = array_merge($header, array('Authorization' => 'Basic ' . base64_encode($username . ':' . $password)));

                // Send the request.
                $response = $this->sendRequest($path, 'POST', $header, array());

                return $response;
        }

---

La documentation de cette classe a été générée à partir du fichier suivant :

• jplatform-13.1/joomla/openstreetmap/gps.php