Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques
Référence de la classe JOpenstreetmapChangesets
+ Graphe d'héritage de JOpenstreetmapChangesets:
+ Graphe de collaboration de JOpenstreetmapChangesets:

Liste de tous les membres

Fonctions membres publiques

 createChangeset ($changesets=array())
 readChangeset ($id)
 updateChangeset ($id, $tags=array())
 closeChangeset ($id)
 downloadChangeset ($id)
 expandBBoxChangeset ($id, $nodes)
 queryChangeset ($param)
 diffUploadChangeset ($xml, $id)
- 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 changesets.php.

Documentation des fonctions membres

JOpenstreetmapChangesets::closeChangeset (   $id)

Method to close a changeset

Paramètres:
integer$ididentifier of the changeset
Renvoie:
void
Depuis:
13.1

Définition à la ligne 164 du fichier changesets.php.

{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key']
);
// Set the API base
$base = 'changeset/' . $id . '/close';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['format'] = 'text/xml';
// Send the request.
$this->oauth->oauthRequest($path, 'PUT', $parameters, $header);
}
JOpenstreetmapChangesets::createChangeset (   $changesets = array())

Method to create a changeset

Paramètres:
array$changesetsArray which contains changeset data
Renvoie:
array The XML response
Depuis:
13.1

Définition à la ligne 30 du fichier changesets.php.

{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key'],
'oauth_token_secret' => $token['secret']
);
// Set the API base
$base = 'changeset/create';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$xml = '<?xml version="1.0" encoding="UTF-8"?>
<osm version="0.6" generator="JOpenstreetmap">';
if (!empty($changesets))
{
// Create Changeset element for every changeset
foreach ($changesets as $tags)
{
$xml .= '<changeset>';
if (!empty($tags))
{
// Create a list of tags for each changeset
foreach ($tags as $key => $value)
{
$xml .= '<tag k="' . $key . '" v="' . $value . '"/>';
}
}
$xml .= '</changeset>';
}
}
$xml .= '</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT', $parameters, $xml, $header);
return $response->body;
}
JOpenstreetmapChangesets::diffUploadChangeset (   $xml,
  $id 
)

Method to upload a diff to a changeset

Paramètres:
string$xmlDiff data to upload
integer$idIdentifier of the changeset
Renvoie:
array The XML response of result
Depuis:
13.1

Définition à la ligne 294 du fichier changesets.php.

{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key']
);
// Set the API base
$base = 'changeset/' . $id . '/upload';
// Build the request path.
$path = $this->getOption('api.url') . $base;
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST', $parameters, $xml, $header);
$xml_string = simplexml_load_string($response->body);
return $xml_string->diffResult;
}
JOpenstreetmapChangesets::downloadChangeset (   $id)

Method to download a changeset

Paramètres:
integer$idIdentifier of the changeset
Renvoie:
array The XML response of requested changeset
Depuis:
13.1

Définition à la ligne 194 du fichier changesets.php.

{
// Set the API base
$base = 'changeset/' . $id . '/download';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->create;
}
JOpenstreetmapChangesets::expandBBoxChangeset (   $id,
  $nodes 
)

Method to expand the bounding box of a changeset

Paramètres:
integer$idIdentifier of the changeset
array$nodesList of lat lon about nodes
Renvoie:
array The XML response of changed changeset
Depuis:
13.1

Définition à la ligne 218 du fichier changesets.php.

{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key']
);
// Set the API base
$base = 'changeset/' . $id . '/expand_bbox';
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Create a list of tags to update changeset
$node_list = '';
if (!empty($nodes))
{
foreach ($nodes as $node)
{
$node_list .= '<node lat="' . $node[0] . '" lon="' . $node[1] . '"/>';
}
}
$xml = '<?xml version="1.0" encoding="UTF-8"?>
<osm version="0.6" generator="JOpenstreetmap">
<changeset>'
. $node_list .
'</changeset>
</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'POST', $parameters, $xml, $header);
$xml_string = simplexml_load_string($response->body);
return $xml_string->changeset;
}
JOpenstreetmapChangesets::queryChangeset (   $param)

Method to query on changesets

Paramètres:
string$paramParameters for query
Renvoie:
array The XML response
Depuis:
13.1

Définition à la ligne 270 du fichier changesets.php.

{
// Set the API base
$base = 'changesets/' . $param;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->osm;
}
JOpenstreetmapChangesets::readChangeset (   $id)

Method to read a changeset

Paramètres:
integer$ididentifier of the changeset
Renvoie:
array The XML response about a changeset
Depuis:
13.1

Définition à la ligne 88 du fichier changesets.php.

{
// Set the API base
$base = 'changeset/' . $id;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Send the request.
$xml_string = $this->sendRequest($path);
return $xml_string->changeset;
}
JOpenstreetmapChangesets::updateChangeset (   $id,
  $tags = array() 
)

Method to update a changeset

Paramètres:
integer$idIdentifier of the changeset
array$tagsArray of tags to update
Renvoie:
array The XML response of updated changeset
Depuis:
13.1

Définition à la ligne 112 du fichier changesets.php.

{
$token = $this->oauth->getToken();
// Set parameters.
$parameters = array(
'oauth_token' => $token['key']
);
// Set the API base
$base = 'changeset/' . $id;
// Build the request path.
$path = $this->getOption('api.url') . $base;
// Create a list of tags to update changeset
$tag_list = '';
if (!empty($tags))
{
foreach ($tags as $key => $value)
{
$tag_list .= '<tag k="' . $key . '" v="' . $value . '"/>';
}
}
$xml = '<?xml version="1.0" encoding="UTF-8"?>
<osm version="0.6" generator="JOpenstreetmap">
<changeset>'
. $tag_list .
'</changeset>
</osm>';
$header['Content-Type'] = 'text/xml';
// Send the request.
$response = $this->oauth->oauthRequest($path, 'PUT', $parameters, $xml, $header);
$xml_string = simplexml_load_string($response->body);
return $xml_string->changeset;
}
La documentation de cette classe a été générée à partir du fichier suivant :