Class: Services_OpenStreetMap_Note

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

Class Overview

Services_OpenStreetMap_Object
   |
   --Services_OpenStreetMap_Note

Services_OpenStreetMap_Note

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_Note

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

[ Top ]

Class Variables

$comments =

[line 41]

Comments object

Access: protected

Type:

Services_OpenStreetMap_Comments

[ Top ]

$type = 'note'

[line 34]

What type of object this is.

Access: protected

Type:	string
Overrides:	Array

[ Top ]

Method Detail

getCloseUrl [line 108]

string getCloseUrl(
)

URL for closing note.

Access: public

[ Top ]

getComments [line 118]

Services_OpenStreetMap_Comments getComments(
)

Get Comments against this note.

Access: public

[ Top ]

getCommentUrl [line 98]

string getCommentUrl(
)

URL for adding comment to note.

Access: public

[ Top ]

getDateCreated [line 78]

int getDateCreated(
)

Retrieve time-stamp of when note was created.

Access: public

[ Top ]

getLat [line 48]

float getLat(
)

Latitude of note

Access: public

[ Top ]

getLon [line 58]

float getLon(
)

Longitude of note

Access: public

[ Top ]

getStatus [line 68]

string getStatus(
)

Retrieve the status of the note ('open' etc)

Access: public

[ Top ]

getUrl [line 88]

string getUrl(
)

URL for this note.

Access: public

[ Top ]

setLat [line 137]

Services_OpenStreetMap_Note setLat(
float
$value)

Set the Latitude of the note

Latitude may range from -180 to 180 degrees.

 $note->setLat($lat)->setLon($lon);

Throws: Services_OpenStreetMap_InvalidArgumentException
Access: public

Parameters:

float $value — Latitude (-180 < y < 180)

[ Top ]

setLon [line 171]

Services_OpenStreetMap_Note setLon(
float
$value)

Set the Longitude of the note

Longitude may range from -90 to 90 degrees.

 $note->setLat($lat)->setLon($lon);

Throws: Services_OpenStreetMap_InvalidArgumentException
Access: public

Parameters:

float $value — Longitude (-90 < x < 90)

[ Top ]

setXml [line 198]

Services_OpenStreetMap_Note setXml(
SimpleXMLElement
$xml)

Set XML

Access: public

Overrides Services_OpenStreetMap_Object::setXml() (Set XML.)

Parameters:

SimpleXMLElement $xml — OSM XML

[ Top ]