Docs For Class Services_OpenStreetMap

delete [line 574]

Services_OpenStreetMap_Object delete(
)

Mark the object as deleted.

Access: public

[ Top ]

getAttributes [line 342]

mixed getAttributes(
)

Return the attributes set for this object in question.

Access: public

[ Top ]

getConfig [line 609]

Services_OpenStreetMap_Config getConfig(
)

Get current Config object

Access: public

[ Top ]

getId [line 263]

null|string getId(
)

Retrieve the id of the object in question.

Return: id of the object
Access: public

Overridden in child classes as:

Services_OpenStreetMap_Changeset::getId(): Get changeset Id.

[ Top ]

getOsmChangeXml [line 180]

string|null 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

Overridden in child classes as:

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

[ Top ]

getRelations [line 422]

Services_OpenStreetMap_Relations getRelations(
)

Get all relations referring to the object in question.

Access: public

[ Top ]

getTag [line 370]

string|null getTag(
string
$key)

Return value of specified tag as set against this object.

If tag isn't set, return null.

Access: public

Parameters:

string $key — Key value, For example, 'amenity', 'highway' etc

[ Top ]

getTags [line 356]

array getTags(
)

Return the tags set for this object in question.

Return: tags
Access: public

[ Top ]

getTransport [line 633]

Services_OpenStreetMap_Transport. getTransport(
)

Retrieve the current Transport instance.

Access: public

[ Top ]

getType [line 384]

string getType(
)

Return which type of object this is.

Return: type
Access: public

Overridden in child classes as:

Services_OpenStreetMap_Relation::getType(): Type

[ Top ]

getUid [line 300]

integer getUid(
)

Retrieve the uid of the object in question.

Return: uid of the object
Access: public

[ Top ]

getUser [line 314]

string getUser(
)

Retrieve the user (creator/editor) of the object in question.

Return: user of the object
Access: public

[ Top ]

getVersion [line 328]

integer getVersion(
)

Retrieve the version of the object in question

Return: version of the object
Access: public

[ Top ]

getXml [line 104]

string getXml(
)

Get XML.

Access: public

[ Top ]

history [line 394]

Services_OpenStreetMap_Objects history(
)

Get each distinct version of an object.

Access: public

[ Top ]

isDirty [line 585]

bool isDirty(
)

Indicate whether object has had a tag added, edited or removed.

Access: public

[ Top ]

osmChangeXml [line 253]

string osmChangeXml(
string
$xml)

Amend changeXML with specific updates as appropriate.

See: Services_OpenStreetMap_Object::getOsmChangeXml()
Link: http://wiki.openstreetmap.org/wiki/OsmChange
Access: public

Overridden in child classes as:

Services_OpenStreetMap_Way::osmChangeXml(): Amend osmChangeXml with specific updates pertinent to this Way object.

Parameters:

string $xml — OsmChange XML as generated by getOsmChangeXml

[ Top ]

removeTag [line 527]

Services_OpenStreetMap_Object removeTag(
mixed
$key)

Remove a tag.

 $obj->removeTag("name:en");

Access: public

Parameters:

mixed $key — Name of a tag key to remove.

[ Top ]

removeTags [line 549]

Services_OpenStreetMap_Object removeTags(
array
$keys)

Remove tags.

Remove more than one tag from the object.

 $obj->removeTags(array("name:en", "name:kl"));

Access: public

Parameters:

array $keys — Associate array of keys to remove.

[ Top ]

setAllTags [line 510]

Services_OpenStreetMap_Object setAllTags(
[array
$tags = []])

Set all tags.

This will overwrite all/any tags that are already set.

 $obj->setAllTags(

  array(
   'key' => 'value',
   'key2', 'value2',
  )
 );

Access: public

Parameters:

array $tags — array of tags.

[ Top ]

setChangesetId [line 167]

Services_OpenStreetMap_Object setChangesetId(
string
$id)

Set the Changeset Id for this object.

Access: public

Parameters:

string $id — Changeset Id (numeric)

[ Top ]

setConfig [line 597]

Services_OpenStreetMap_Object setConfig(
Services_OpenStreetMap_Config
$config)

Set Config object

Access: public

Parameters:

Services_OpenStreetMap_Config $config — Config object

[ Top ]

setId [line 289]

Services_OpenStreetMap_Object setId(
string
$value)

Set the id value of the object in question.

Specified id should be numeric.

 $obj->setId($id)->...

Access: public

Parameters:

string $value — new id of the object

[ Top ]

setTag [line 456]

Services_OpenStreetMap_Object setTag(
mixed
$key, mixed
$value)

Set tag to [new] key/value pair.

The object is returned, supporting Fluent coding style.

 $obj->setTag('key', 'value')->setTag(...);

Access: public

Parameters:

mixed	`$key`	—	key
mixed	`$value`	—	value

[ Top ]

setTags [line 484]

Services_OpenStreetMap_Object setTags(
[array
$tags = []])

Set tags.

Set a number of tags at once, using an associative array.

 $obj->setTag(

  array(
   'key' => 'value',
   'key2', 'value2',
  )
 );

Access: public

Parameters:

array $tags — array of tags.

[ Top ]

setTransport [line 621]

Services_OpenStreetMap_Object setTransport(
Services_OpenStreetMap_Transport
$transport)

Set the Transport instance.

Access: public

Parameters:

Services_OpenStreetMap_Transport $transport — Transport instance.

[ Top ]

setVal [line 154]

Services_OpenStreetMap_Object setVal(
string
$value)

Store a specified value.

Access: public

Parameters:

string $value — Most likely an id value, returned from the server.

[ Top ]

setXml [line 133]

Services_OpenStreetMap_Object setXml(
SimpleXMLElement
$xml)

Set XML.

Access: public

Overridden in child classes as:

Services_OpenStreetMap_Relation::setXml(): Set the Xml

Services_OpenStreetMap_Comment::setXml(): Set XML

Services_OpenStreetMap_Note::setXml(): Set XML

Parameters:

SimpleXMLElement $xml — OSM XML

[ Top ]

__toString [line 116]

string __toString(
)

If modified, return the osmChangeXML for the object, otherwise the defining XML.

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

[ Top ]

Class: Services_OpenStreetMap_Object

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$action = null

$changesetId = null

$config = null

$dirty = false

$id = null

$obj = null

$tags = []

$transport = null

$type = null

$xml = null

Method Detail

delete [line 574]

getAttributes [line 342]

getConfig [line 609]

getId [line 263]

getOsmChangeXml [line 180]

getRelations [line 422]

getTag [line 370]

Parameters:

getTags [line 356]

getTransport [line 633]

getType [line 384]

getUid [line 300]

getUser [line 314]

getVersion [line 328]

getXml [line 104]

history [line 394]

isDirty [line 585]

osmChangeXml [line 253]

Parameters:

removeTag [line 527]

Parameters:

removeTags [line 549]

Parameters:

setAllTags [line 510]

Parameters:

setChangesetId [line 167]

Parameters:

setConfig [line 597]

Parameters:

setId [line 289]

Parameters:

setTag [line 456]

Parameters:

setTags [line 484]

Parameters:

setTransport [line 621]

Parameters:

setVal [line 154]

Parameters:

setXml [line 133]

Parameters:

__toString [line 116]