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

Class: Services_OpenStreetMap_User

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

Class Overview


Services_OpenStreetMap_User


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 25]
Services_OpenStreetMap_User


[ Top ]


Class Variables

$config =  null

[line 47]

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



[ Top ]

$obj =

[line 61]

Object based on xml for user
  • Access: protected

Type:   object|false


[ Top ]

$preferences =  []

[line 33]

User preferences
  • Access: protected

Type:   array


[ Top ]

$prefObj =

[line 75]

Preferences object
  • Access: protected

Type:   object|false


[ Top ]

$prefXml =

[line 68]

Preferences XML
  • Access: protected

Type:   string


[ Top ]

$transport =  null

[line 40]

Transport object.
  • Access: protected



[ Top ]

$xml =  null

[line 54]

XML represention of the User
  • Access: protected

Type:   string


[ Top ]



Method Detail

getAccountCreated   [line 130]

string getAccountCreated( )

Retrieve date, as a string, representing when the user's account was created.
  • Access: public

[ Top ]

getActiveBlocksIssued   [line 315]

integer|null getActiveBlocksIssued( )

The number of active blocks issued by the user.
  • Access: public

[ Top ]

getActiveBlocksReceived   [line 285]

integer|null getActiveBlocksReceived( )

The number of active blocks received by the user.
  • Access: public

[ Top ]

getAttributes   [line 109]

mixed getAttributes( )

Return the attributes set for this user instance.
  • Access: public

[ Top ]

getBlocksIssued   [line 300]

integer|null getBlocksIssued( )

The [total] number of blocks issued by the user.
  • Access: public

[ Top ]

getBlocksReceived   [line 270]

integer|null getBlocksReceived( )

The [total] number of blocks received by the user.
  • Access: public

[ Top ]

getChangesets   [line 240]

integer|null getChangesets( )

The number of changesets opened by the user.
  • Access: public

[ Top ]

getConfig   [line 440]

Services_OpenStreetMap_Config getConfig( )

Get current Config object
  • Access: public

[ Top ]

getDescription   [line 140]

string getDescription( )

Return the description set for the user.
  • Access: public

[ Top ]

getDisplayName   [line 119]

string getDisplayName( )

Return the display name of the user.
  • Return: display name of user.
  • Access: public

[ Top ]

getId   [line 151]

string getId( )

Retrieve the id of the user.
  • Return: id of the object
  • Access: public

[ Top ]

getImage   [line 161]

string|null getImage( )

Return href to user's profile image, null if not set.
  • Access: public

[ Top ]

getLanguages   [line 175]

array|null getLanguages( )

Return an array of the user's preferred languages.
  • Access: public

[ Top ]

getLat   [line 196]

float|null getLat( )

Latitude of 'home' setting for user.
  • Access: public

[ Top ]

getLon   [line 210]

float|null getLon( )

Longitude of 'home' setting for user.
  • Access: public

[ Top ]

getPreferences   [line 349]

array getPreferences( )

Return an array of the user's preferences.
  • Access: public

[ Top ]

getRoles   [line 330]

array getRoles( )

Array of names of roles associated with the user.
  • Access: public

[ Top ]

getTraces   [line 255]

integer|null getTraces( )

The number of traces uploaded by the user.
  • Access: public

[ Top ]

getTransport   [line 430]

Services_OpenStreetMap_Transport. getTransport( )

Retrieve the current Transport instance.
  • Access: public

[ Top ]

getZoom   [line 225]

integer|null getZoom( )

Zoom level of 'home' setting for user.
  • Access: public

[ Top ]

setConfig   [line 452]

Services_OpenStreetMap_User setConfig( Services_OpenStreetMap_Config $config)

Set Config object
  • Access: public

Parameters:

Services_OpenStreetMap_Config   $config   —  Config object

[ Top ]

setPreferences   [line 373]

Services_OpenStreetMap_User setPreferences( array $preferences)

Set user preferences, updating the values on the server automatically.

To update a single preference, use an array with just one entry.

  • Access: public

Parameters:

array   $preferences   —  Key/Value pairs in associative array

[ Top ]

setPreferencesXml   [line 98]

void setPreferencesXml( mixed $xml)

Set the XML for preferences.
  • Access: public

Parameters:

mixed   $xml   —  XML describing a user's preferences.

[ Top ]

setTransport   [line 418]

Services_OpenStreetMap_User setTransport( Services_OpenStreetMap_Transport $transport)

Set the Transport instance.
  • Access: public

Parameters:

Services_OpenStreetMap_Transport   $transport   —  Transport instance.

[ Top ]

setXml   [line 84]

Services_OpenStreetMap_User setXml( SimpleXMLElement $xml)

Set the XML representing this user.
  • Access: public

Parameters:

SimpleXMLElement   $xml   —  XML describing a user.

[ Top ]


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