Skip to content
This repository has been archived by the owner on Nov 26, 2017. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
JOpenstreetmap package with tests added
  • Loading branch information
Buddhima authored and buddhima committed Mar 18, 2013
1 parent 8477998 commit 79c63e0
Show file tree
Hide file tree
Showing 17 changed files with 4,627 additions and 0 deletions.
330 changes: 330 additions & 0 deletions libraries/joomla/openstreetmap/changesets.php
@@ -0,0 +1,330 @@
<?php
/**
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/

defined('JPATH_PLATFORM') or die();

/**
* Openstreetmap API Changesets class for the Joomla Platform
*
* @package Joomla.Platform
* @subpackage Openstreetmap
*
* @since 12.3
*/
class JOpenstreetmapChangesets extends JOpenstreetmapObject
{
/**
* Method to create a changeset
*
* @param array $changesets array which contains changeset data
*
* @return array The xml response
*
* @since 12.3
*/
public function createChangeset($changesets=array())
{
$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>';
$tag_list = '';

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;

}

/**
* Method to read a changeset
*
* @param int $id identifier of the changeset
*
* @return array The xml response about a changeset
*
* @since 12.3
*/
public function readChangeset($id)
{

// 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;

}

/**
* Method to update a changeset
*
* @param int $id identifier of the changeset
* @param array $tags array of tags to update
*
* @return array The xml response of updated changeset
*
* @since 12.3
*/
public function updateChangeset($id, $tags=array() )
{
$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;
}

/**
* Method to close a changeset
*
* @param int $id identifier of the changeset
*
* @return No value returns
*
* @since 12.3
*/
public function closeChangeset($id)
{
$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.
$response = $this->oauth->oauthRequest($path, 'PUT', $parameters, $header);

}

/**
* Method to download a changeset
*
* @param int $id identifier of the changeset
*
* @return array The xml response of requested changeset
*
* @since 12.3
*/
public function downloadChangeset($id)
{

// 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;
}

/**
* Method to expand the bounding box of a changeset
*
* @param int $id identifier of the changeset
* @param array $nodes list of lat lon about nodes
*
* @return array The xml response of changed changeset
*
* @since 12.3
*/
public function expandBBoxChangeset($id, $nodes)
{
$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;
}

/**
* Method to Query on changesets
*
* @param string $param parameters for query
*
* @return array The xml response
*
* @since 12.3
*/
public function queryChangeset($param)
{
// 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;
}

/**
* Method to upload a diff to a changeset
*
* @param string $xml diff data to upload
* @param int $id identifier of the changeset
*
* @return array The xml response of result
*
* @since 12.3
*/
public function diffUploadChangeset($xml, $id)
{
$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;
}
}

0 comments on commit 79c63e0

Please sign in to comment.