Class: Services_OpenStreetMap_Way

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

Class Overview

Services_OpenStreetMap_Object
   |
   --Services_OpenStreetMap_Way

Services_OpenStreetMap_Way

Author(s):

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::$id
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 27]
Services_OpenStreetMap_Way

Author: Ken Guest <kguest@php.net>
Link: Way.php
License: BSD

[ Top ]

Class Variables

$dirtyNodes = false

[line 56]

Indicate whether nodes have been changed/added/deleted.

Access: protected

Type:

boolean

[ Top ]

$nodes = []

[line 42]

A way is a collection of nodes.

Access: protected

Type:

Services_OpenStreetMap_Node[]|string[]

[ Top ]

$nodesNew = []

[line 49]

Nodes to the way

Access: protected

Type:

array

[ Top ]

$type = 'way'

[line 34]

What type of object this is

Access: protected

Type:	mixed
Overrides:	Array

[ Top ]

Method Detail

addNode [line 107]

Services_OpenStreetMap_Way addNode(
Services_OpenStreetMap_Node
$node)

Add a node to the way.

Access: public

Parameters:

Services_OpenStreetMap_Node $node — Node to add to the way.

[ Top ]

getAddress [line 208]

array|null getAddress(
)

Return address [tags], as an array, if set on a closed way.

Access: public

[ Top ]

getNodes [line 86]

array getNodes(
)

Return an array containing the IDs of all nodes in the way.

Access: public

[ Top ]

isClosed [line 63]

boolean isClosed(
)

Return true if the way can be considered 'closed'.

Access: public

[ Top ]

osmChangeXml [line 165]

string osmChangeXml(
string
$xml)

Amend osmChangeXml with specific updates pertinent to this Way object.

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

Overrides Services_OpenStreetMap_Object::osmChangeXml() (Amend changeXML with specific updates as appropriate.)

Parameters:

string $xml — OSM Change XML as generated by getOsmChangeXml

[ Top ]

removeNode [line 130]

Services_OpenStreetMap_Way removeNode(
mixed
$node)

Remove a node from the way.

Throws: Services_OpenStreetMap_InvalidArgumentException
Access: public

Parameters:

mixed $node — Either a Node object or an id/ref of such an object.

[ Top ]