Class: Services_OpenStreetMap_Changeset

Source Location: /Services_OpenStreetMap-1.0.0RC2/Services/OpenStreetMap/Changeset.php

Class Overview

Services_OpenStreetMap_Object
   |
   --Services_OpenStreetMap_Changeset

Services_OpenStreetMap_Changeset

Author(s):

Valery Khvalov <khvalov at tut.by>
Ken Guest <kguest at php.net>

Variables

Methods

Inherited Variables

Class: Services_OpenStreetMap_Object

Services_OpenStreetMap_Object::$action
Services_OpenStreetMap_Object::$changesetId
Services_OpenStreetMap_Object::$config
Services_OpenStreetMap_Object::$dirty
Services_OpenStreetMap_Object::$obj
Services_OpenStreetMap_Object::$tags
Services_OpenStreetMap_Object::$transport
Services_OpenStreetMap_Object::$xml

Inherited Methods

Class: Services_OpenStreetMap_Object

Services_OpenStreetMap_Object::delete(): Mark the object as deleted.
Services_OpenStreetMap_Object::getAttributes(): Return the attributes set for this object in question.
Services_OpenStreetMap_Object::getConfig(): Get current Config object
Services_OpenStreetMap_Object::getId(): Retrieve the id of the object in question.
Services_OpenStreetMap_Object::getOsmChangeXml(): Generate and return the OsmChange XML required to record the changes made to the object in question.
Services_OpenStreetMap_Object::getRelations(): Get all relations referring to the object in question.
Services_OpenStreetMap_Object::getTag(): Return value of specified tag as set against this object.
Services_OpenStreetMap_Object::getTags(): Return the tags set for this object in question.
Services_OpenStreetMap_Object::getTransport(): Retrieve the current Transport instance.
Services_OpenStreetMap_Object::getType(): Return which type of object this is.
Services_OpenStreetMap_Object::getUid(): Retrieve the uid of the object in question.
Services_OpenStreetMap_Object::getUser(): Retrieve the user (creator/editor) of the object in question.
Services_OpenStreetMap_Object::getVersion(): Retrieve the version of the object in question
Services_OpenStreetMap_Object::getXml(): Get XML.
Services_OpenStreetMap_Object::history(): Get each distinct version of an object.
Services_OpenStreetMap_Object::isDirty(): Indicate whether object has had a tag added, edited or removed.
Services_OpenStreetMap_Object::osmChangeXml(): Amend changeXML with specific updates as appropriate.
Services_OpenStreetMap_Object::removeTag(): Remove a tag.
Services_OpenStreetMap_Object::removeTags(): Remove tags.
Services_OpenStreetMap_Object::setAllTags(): Set all tags.
Services_OpenStreetMap_Object::setChangesetId(): Set the Changeset Id for this object.
Services_OpenStreetMap_Object::setConfig(): Set Config object
Services_OpenStreetMap_Object::setId(): Set the id value of the object in question.
Services_OpenStreetMap_Object::setTag(): Set tag to [new] key/value pair.
Services_OpenStreetMap_Object::setTags(): Set tags.
Services_OpenStreetMap_Object::setTransport(): Set the Transport instance.
Services_OpenStreetMap_Object::setVal(): Store a specified value.
Services_OpenStreetMap_Object::setXml(): Set XML.
Services_OpenStreetMap_Object::__toString(): If modified, return the osmChangeXML for the object, otherwise the defining XML.

Class Details

[line 28]
Services_OpenStreetMap_Changeset

Author: Valery Khvalov <khvalov@tut.by>
Author: Ken Guest <kguest@php.net>
Link: Changeset.php
License: BSD

[ Top ]

Class Variables

$atomic =

[line 85]

Atomic?

Access: protected

Type:

bool

[ Top ]

$id = null

[line 63]

The Id of this changeset.

Access: protected

Type:	string\|null
Overrides:	Array

[ Top ]

$members = []

[line 42]

Array containing members of what this changeset represents.

Access: protected

Type:

array

[ Top ]

$membersIds = []

[line 49]

Array of the Ids of the members of what this changeset represents.

Access: protected

Type:

array

[ Top ]

$open = false

[line 56]

Whether the changeset is open.

Access: protected

Type:

bool

[ Top ]

$osmChangeXml = null

[line 70]

The OsmChange XML for this changeset.

Access: protected

Type:

string|null

[ Top ]

$type = 'changeset'

[line 35]

What type object this is.

Access: protected

Type:	string
Overrides:	Array

[ Top ]

$updateMap = []

[line 78]

Used to keep track of Id updates.

Access: protected

Type:

array

[ Top ]

Method Detail

__construct (Constructor) [line 94]

Services_OpenStreetMap_Changeset __construct(
[bool
$atomic = true])

Constructor

Access: public

Parameters:

bool $atomic — Whether changeset is atomic or not.

[ Top ]

add [line 227]

void add(
Services_OpenStreetMap_Object
$object)

Add object to the changeset so changes can be transmitted to the server.

Throws: Services_OpenStreetMap_RuntimeException If an object has already been added to the changeset or has been added to a closed changeset.
Access: public

Parameters:

Services_OpenStreetMap_Object $object — OSM object

[ Top ]

begin [line 108]

void begin(
string
$message)

Begin changeset transaction.

Throws: Services_OpenStreetMap_RuntimeException If either user or password are not set.
Access: public

Parameters:

string $message — The changeset log message.

[ Top ]

commit [line 259]

void commit(
)

Commit changeset, posting to server.

Generate osmChange document and post it to the server, when successful close the changeset.

Link: http://wiki.openstreetmap.org/wiki/OsmChange
Throws: Services_OpenStreetMap_RuntimeException If changeset Id is not numeric.
Throws: Services_OpenStreetMap_Transport If changeset is already closed.
Access: public

[ Top ]

getClosedAt [line 504]

string getClosedAt(
)

Get ClosedAt time.

Access: public

[ Top ]

getCreatedAt [line 494]

string getCreatedAt(
)

Get CreatedAt time.

Access: public

[ Top ]

getId [line 570]

null|string getId(
)

Get changeset Id.

Return: value or null if none set
Access: public

Overrides Services_OpenStreetMap_Object::getId() (Retrieve the id of the object in question.)

[ Top ]

getMaxLat [line 560]

float getMaxLat(
)

Return max latitude value.

Access: public

[ Top ]

getMaxLon [line 550]

float getMaxLon(
)

Return max longitude value.

Access: public

[ Top ]

getMinLat [line 539]

float getMinLat(
)

Return min latitude value.

Access: public

[ Top ]

getMinLon [line 529]

float getMinLon(
)

Return min longitude.

Access: public

[ Top ]

getOsmChangeXml [line 459]

string getOsmChangeXml(
)

Generate and return the OsmChange XML required to record the changes made to the object in question.

Link: http://wiki.openstreetmap.org/wiki/OsmChange
Access: public

Overrides Services_OpenStreetMap_Object::getOsmChangeXml() (Generate and return the OsmChange XML required to record the changes made to the object in question.)

[ Top ]

getUpdateMap [line 636]

array getUpdateMap(
)

Get update map.

Access: public

[ Top ]

isOpen [line 514]

boolean isOpen(
)

Is the changeset open?

Access: public

[ Top ]

setOsmChangeXml [line 483]

Services_OpenStreetMap_Changeset setOsmChangeXml(
string
$xml)

Set Change XML.

Access: public

Parameters:

string $xml — OsmChange XML

[ Top ]

updateObjectId [line 616]

void updateObjectId(
string
$type, string
$oldId, string
$newId)

Update id of some type of object.

Access: public

Parameters:

string	`$type`	—	Object type
string	`$oldId`	—	Old id
string	`$newId`	—	New id

[ Top ]

updateObjectIds [line 589]

void updateObjectIds(
string
$body)

Given diffResult xml, update Ids of objects that are members of the current changeset.

Throws: Services_OpenStreetMap_Exception If diffResult xml is invalid.
Access: public

Parameters:

string $body — diffResult xml

[ Top ]