Class JOpenstreetmapElements

Openstreetmap API Elements class for the Joomla Platform

JOpenstreetmapElements

Package: Joomla\Platform\Openstreetmap
Deprecated: 4.0 Use the joomla/openstreetmap package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 13.1
Located at joomla/openstreetmap/elements.php

Methods summary

`public array`	# `createNode( integer $changeset, float $latitude, float $longitude, arary $tags )` Method to create a node Method to create a node Parameters `$changeset` `integer` - $changeset Changeset id `$latitude` `float` - $latitude Latitude of the node `$longitude` `float` - $longitude Longitude of the node `$tags` `arary` - $tags Array of tags for a node Returns `array` - The XML response Since 13.1
`public array`	# `createWay( integer $changeset, array $tags, array $nds )` Method to create a way Method to create a way Parameters `$changeset` `integer` - $changeset Changeset id `$tags` `array` - $tags Array of tags for a way `$nds` `array` - $nds Node ids to refer Returns `array` - The XML response Since 13.1
`public array`	# `createRelation( integer $changeset, array $tags, array $members )` Method to create a relation Method to create a relation Parameters `$changeset` `integer` - $changeset Changeset id `$tags` `array` - $tags Array of tags for a relation `$members` `array` - $members Array of members for a relation eg: $members = array(array("type"=>"node", "role"=>"stop", "ref"=>"123"), array("type"=>"way", "ref"=>"123")) Returns `array` - The XML response Since 13.1
`public array`	# `readElement( string $element, integer $id )` Method to read an element [node\|way\|relation] Method to read an element [node\|way\|relation] Parameters `$element` `string` - $element [node\|way\|relation] `$id` `integer` - $id Element identifier Returns `array` - The XML response Throws `DomainException` Since 13.1
`public array`	# `updateElement( string $element, string $xml, integer $id )` Method to update an Element [node\|way\|relation] Method to update an Element [node\|way\|relation] Parameters `$element` `string` - $element [node\|way\|relation] `$xml` `string` - $xml Full reperentation of the element with a version number `$id` `integer` - $id Element identifier Returns `array` - The xml response Throws `DomainException` Since 13.1
`public array`	# `deleteElement( string $element, integer $id, integer $version, integer $changeset, float $latitude = null, float $longitude = null )` Method to delete an element [node\|way\|relation] Method to delete an element [node\|way\|relation] Parameters `$element` `string` - $element [node\|way\|relation] `$id` `integer` - $id Element identifier `$version` `integer` - $version Element version `$changeset` `integer` - $changeset Changeset identifier `$latitude` `float` - $latitude Latitude of the element `$longitude` `float` - $longitude Longitude of the element Returns `array` - The XML response Throws `DomainException` Since 13.1
`public array`	# `historyOfElement( string $element, integer $id )` Method to get history of an element [node\|way\|relation] Method to get history of an element [node\|way\|relation] Parameters `$element` `string` - $element [node\|way\|relation] `$id` `integer` - $id Element identifier Returns `array` - The XML response Throws `DomainException` Since 13.1
`public array`	# `versionOfElement( string $element, integer $id, integer $version )` Method to get details about a version of an element [node\|way\|relation] Method to get details about a version of an element [node\|way\|relation] Parameters `$element` `string` - $element [node\|way\|relation] `$id` `integer` - $id Element identifier `$version` `integer` - $version Element version Returns `array` - The XML response Throws `DomainException` Since 13.1
`public array`	# `multiFetchElements( string $element, string $params )` Method to get data about multiple ids of an element [node\|way\|relation] Method to get data about multiple ids of an element [node\|way\|relation] Parameters `$element` `string` - $element [nodes\|ways\|relations] - use plural word `$params` `string` - $params Comma separated list of ids belonging to type $element Returns `array` - The XML response Throws `DomainException` Since 13.1
`public array`	# `relationsForElement( string $element, integer $id )` Method to get relations for an Element [node\|way\|relation] Method to get relations for an Element [node\|way\|relation] Parameters `$element` `string` - $element [node\|way\|relation] `$id` `integer` - $id Element identifier Returns `array` - The XML response Throws `DomainException` Since 13.1
`public array`	# `waysForNode( integer $id )` Method to get ways for a Node element Method to get ways for a Node element Parameters `$id` `integer` - $id Node identifier Returns `array` - The XML response Since 13.1
`public array`	# `fullElement( string $element, integer $id )` Method to get full information about an element [way\|relation] Method to get full information about an element [way\|relation] Parameters `$element` `string` - $element [way\|relation] `$id` `integer` - $id Identifier Returns `array` - The XML response Throws `DomainException` Since 13.1
`public array`	# `redaction( string $element, integer $id, integer $version, integer $redaction_id )` Method used by the DWG to hide old versions of elements containing data privacy or copyright infringements Method used by the DWG to hide old versions of elements containing data privacy or copyright infringements Parameters `$element` `string` - $element [node\|way\|relation] `$id` `integer` - $id Element identifier `$version` `integer` - $version Element version `$redaction_id` `integer` - $redaction_id Redaction id Returns `array` - The xml response Throws `DomainException` Since 13.1

Methods inherited from JOpenstreetmapObject

__construct(), getOption(), sendRequest(), setOption()

Magic methods summary

Properties summary

Properties inherited from JOpenstreetmapObject

$client, $oauth, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JOpenstreetmapElements

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Methods inherited from JOpenstreetmapObject

Magic methods summary

Properties summary

Properties inherited from JOpenstreetmapObject