Class: Services_Openstreetmap_Way

Source Location: /Openstreetmap/Way.php

Class Overview

Services_Openstreetmap_Object
   |
   --Services_Openstreetmap_Way

Services_Openstreetmap_Way

Author(s):

Ken Guest <kguest@php.net>

Variables

Methods

Inherited Variables

Class: Services_Openstreetmap_Object

Services_Openstreetmap_Object::$action
Services_Openstreetmap_Object::$changeset_id
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 OSM Change 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(): getXml
Services_Openstreetmap_Object::history(): Get each distinct version of an object.
Services_Openstreetmap_Object::osmChangeXML(): Amend changeXML with specific updates as appropriate.
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(): setTag
Services_Openstreetmap_Object::setTransport(): Set the Transport instance.
Services_Openstreetmap_Object::setVal(): Store a specified value.
Services_Openstreetmap_Object::setXml(): setXml
Services_Openstreetmap_Object::__toString(): If modified, return the changeXML for the object, otherwise the defining XML.

Class Details

[line 25]
Services_Openstreetmap_Way

Tags:

author:	Ken Guest <kguest@php.net>
link:	Way.php
license:	BSD

[ Top ]

Class Variables

$dirty_nodes = false

[line 30]

Tags:

access:

protected

Type:

mixed

[ Top ]

$nodes = array()

[line 28]

Tags:

access:

protected

Type:

mixed

[ Top ]

$nodes_new = array()

[line 29]

Tags:

access:

protected

Type:

mixed

[ Top ]

$type = 'way'

[line 27]

Tags:

access:

protected

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

method addNode [line 83]

Services_Openstreetmap_Way addNode(
Services_Openstreetmap_Node
$node)

Add a node to the way.

Tags:

access:

public

Parameters:

node

$node

An Services_Openstreetmap_Node object.

[ Top ]

method getAddress [line 182]

array getAddress(
)

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

Tags:

access:

public

[ Top ]

method getNodes [line 61]

array getNodes(
)

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

Tags:

access:

public

[ Top ]

method isClosed [line 38]

boolean isClosed(
)

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

Tags:

access:

public

[ Top ]

method osmChangeXML [line 139]

string osmChangeXML(
string
$xml)

Amend changeXML with specific updates pertinent to this Way object.

Tags:

see:	Services_Openstreetmap_Object::getOsmChangeXML()
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 ]

method removeNode [line 105]

Services_Openstreetmap_Way removeNode(
node
$node)

Remove a node from the way.

Tags:

access:

public

Parameters:

node

$node

Either a Node object or an id/ref of such an object.

[ Top ]

Documentation generated on Wed, 11 Jan 2012 00:37:15 +0000 by phpDocumentor 1.4.4