Services_OpenStreetMap
[ class tree: Services_OpenStreetMap ] [ index: Services_OpenStreetMap ] [ all elements ]

Class: Services_OpenStreetMap_Objects

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

Class Overview


Services_OpenStreetMap_Objects


Author(s):

Variables

Methods


Child classes:

Services_OpenStreetMap_Comments
Services_OpenStreetMap_Comments
Services_OpenStreetMap_Relations
Services_OpenStreetMap_Relations
Services_OpenStreetMap_Changesets
Services_OpenStreetMap_Nodes
Services_OpenStreetMap_Notes
Services_OpenStreetMap_Notes
Services_OpenStreetMap_Ways
Services_OpenStreetMap_Ways
Services_OpenStreetMap_Nodes
Services_OpenStreetMap_Nodes

Inherited Variables

Inherited Methods


Class Details

[line 26]
Services_OpenStreetMap_Objects


[ Top ]


Class Variables

$config =  null

[line 62]

Config object, contains setting on how to interact with API Endpoint.
  • Access: protected



[ Top ]

$objects =  null

[line 41]

Array of Services_OpenStreetMap_Object instances
  • Access: protected

Type:   array


[ Top ]

$position =  0

[line 48]

Position/pointer for navigating objects array
  • Access: protected

Type:   int


[ Top ]

$transport =  null

[line 55]

Transport object
  • Access: protected



[ Top ]

$xml =  null

[line 34]

XML representation of the objects
  • Access: protected

Type:   string


[ Top ]



Method Detail

count   [line 132]

int count( )

Return the number of objects
  • Access: public

[ Top ]

current   [line 152]

Services_OpenStreetMap_Object current( )

Return the current object
  • Access: public

[ Top ]

getConfig   [line 292]

Services_OpenStreetMap_Config getConfig( )

Get current Config object
  • Access: public

[ Top ]

getTransport   [line 316]

Services_OpenStreetMap_Transport. getTransport( )

Retrieve the current Transport instance.
  • Access: public

[ Top ]

getType   [line 81]


getXml   [line 91]

string getXml( )

Get Xml of the object.
  • Access: public

[ Top ]

key   [line 186]

int key( )

Return the key of the current internal iterator pointer
  • Access: public

[ Top ]

next   [line 176]

void next( )

Advance the internal iterator pointer
  • Access: public

[ Top ]

offsetExists   [line 209]

bool offsetExists( int $offset)

Check if the specified offset exists.
  • Access: public

Parameters:

int   $offset   —  N/A.

[ Top ]

offsetGet   [line 221]

Services_OpenStreetMap_Object offsetGet( int $offset)

Get object from the specified offset.
  • Access: public

Parameters:

int   $offset   —  N/A.

[ Top ]

offsetSet   [line 253]

void offsetSet( int $offset, Services_OpenStreetMap_Object $value)

Does nothing as collection is read-only: required for ArrayAccess.
  • Throws: LogicException
  • Access: public

Parameters:

int   $offset   —  N/A
Services_OpenStreetMap_Object   $value   —  N/A

[ Top ]

offsetUnset   [line 268]

void offsetUnset( int $offset)

Does nothing as collection is read-only: required for ArrayAccess.
  • Throws: LogicException
  • Access: public

Parameters:

int   $offset   —  N/A.

[ Top ]

rewind   [line 142]

void rewind( )

Resets the internal iterator pointer
  • Access: public

[ Top ]

setConfig   [line 280]

Services_OpenStreetMap_Objects setConfig( Services_OpenStreetMap_Config $config)

Set Config object
  • Access: public

Parameters:

Services_OpenStreetMap_Config   $config   —  Config object

[ Top ]

setTransport   [line 304]

Services_OpenStreetMap_Objects setTransport( Services_OpenStreetMap_Transport $transport)

Set the Transport instance.
  • Access: public

Parameters:

Services_OpenStreetMap_Transport   $transport   —  Transport instance.

[ Top ]

setVal   [line 120]

Services_OpenStreetMap_Objects setVal( string $value)

Store a specified value.
  • Access: public

Parameters:

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

[ Top ]

setXml   [line 103]

Services_OpenStreetMap_Objects setXml( SimpleXMLElement $xml)

Set Xml for the object.
  • Access: public

Parameters:

SimpleXMLElement   $xml   —  OSM XML

[ Top ]

valid   [line 197]

bool valid( )

Returns whether the current internal iterator pointer is pointing to an existing/valid value.
  • Access: public

[ Top ]

__toString   [line 71]

string __toString( )

Return textual [xml] represention of this collection.

Return getXml output.

  • Access: public

[ Top ]


Documentation generated on Tue, 28 May 2019 19:19:08 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.