POT
POT
POT
Main menu

Download

Forum

SVN

Class: OTS_InfoRespond

Source Location: /classes/OTS_InfoRespond.php

Class OTS_InfoRespond

Class Overview

Wrapper for 'info' respond's DOMDocument.

Wrapper for 'info' respond's DOMDocument. Note: as this class extends DOMDocument class and contains exacly respond XML tree you can work on it as on normal DOM tree.

Located in /classes/OTS_InfoRespond.php [line 47]

DOMDocument
   |
   --OTS_InfoRespond
Author(s):
API Tags:
Property-read:  string $tspqVersion: Root element version.
Property-read:  int $uptime: Uptime.
Property-read:  string $ip: IP number.
Property-read:  string $name: Server name.
Property-read:  int $port: Server port.
Property-read:  string $location: Server physical location.
Property-read:  string $url: Website URL.
Property-read:  string $server: What the hell...?
Property-read:  string $serverVersion: Server version.
Property-read:  string $clientVersion: Client version.
Property-read:  string $owner: Owner name.
Property-read:  string $eMail: Owner's e-mail.
Property-read:  int $onlinePlayers: Players online count.
Property-read:  int $maxPlayers: Maximum allowed players count.
Property-read:  int $playersPeak: Record of players online.
Property-read:  int $monstersCount: Number of monsters on map.
Property-read:  string $mapName: Map name.
Property-read:  string $mapAuthor: Map author.
Property-read:  int $mapWidth: Map width.
Property-read:  int $mapHeight: Map height.
Property-read:  string $motd: Message Of The Day.

Information Tags:
Version:  0.1.0
Version:  0.0.2
Since:  0.0.2

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From DOMDocument (Internal Class)

constructor __construct ( [$version = ], [$encoding = ] )
adoptNode ( $source )
appendChild ( $newChild )
C14N ( [$exclusive = ], [$with_comments = ], [$xpath = ], [$ns_prefixes = ] )
C14NFile ( $uri, [$exclusive = ], [$with_comments = ], [$xpath = ], [$ns_prefixes = ] )
cloneNode ( $deep )
compareDocumentPosition ( $other )
createAttribute ( $name )
createAttributeNS ( $namespaceURI, $qualifiedName )
createCDATASection ( $data )
createComment ( $data )
createDocumentFragment ( )
createElement ( $tagName, [$value = ] )
createElementNS ( $namespaceURI, $qualifiedName, [$value = ] )
createEntityReference ( $name )
createProcessingInstruction ( $target, $data )
createTextNode ( $data )
getElementById ( $elementId )
getElementsByTagName ( $tagName )
getElementsByTagNameNS ( $namespaceURI, $localName )
getFeature ( $feature, $version )
getNodePath ( )
getUserData ( $key )
hasAttributes ( )
hasChildNodes ( )
importNode ( $importedNode, $deep )
insertBefore ( $newChild, [$refChild = ] )
isDefaultNamespace ( $namespaceURI )
isEqualNode ( $arg )
isSameNode ( $other )
isSupported ( $feature, $version )
load ( $source, [$options = ] )
loadHTML ( $source )
loadHTMLFile ( $source )
loadXML ( $source, [$options = ] )
lookupNamespaceUri ( $prefix )
lookupPrefix ( $namespaceURI )
normalize ( )
normalizeDocument ( )
registerNodeClass ( $baseClass, $extendedClass )
relaxNGValidate ( $filename )
relaxNGValidateSource ( $source )
removeChild ( $oldChild )
renameNode ( $node, $namespaceURI, $qualifiedName )
replaceChild ( $newChild, $oldChild )
save ( $file )
saveHTML ( )
saveHTMLFile ( $file )
saveXML ( [$node = ] )
schemaValidate ( $filename )
schemaValidateSource ( $source )
setUserData ( $key, $data, $handler )
validate ( )
xinclude ( [$options = ] )

[ Top ]
Method Summary
string   getClientVersion()   Returns dedicated version of client.
string   getEMail()   Returns owner e-mail.
string   getIP()   Returns server IP.
string   getLocation()   Returns server location.
string   getMapAuthor()   Returns map author.
int   getMapHeight()   Returns map height.
string   getMapName()   Returns map name.
int   getMapWidth()   Returns map width.
int   getMaxPlayers()   Returns maximum amount of players online.
int   getMonstersCount()   Returns number of all monsters on map.
string   getMOTD()   Returns server's Message Of The Day
string   getName()   Returns server name.
int   getOnlinePlayers()   Returns current amount of players online.
string   getOwner()   Returns owner name.
int   getPlayersPeak()   Returns record of online players.
int   getPort()   Returns server port.
string   getServer()   Returns server attribute.
string   getServerVersion()   Returns server version.
string   getTSPQVersion()   Returns version of root element.
int   getUptime()   Returns server uptime.
string   getURL()   Returns server website.
mixed   __get()   Magic PHP5 method.
string   __toString()   Returns string representation of XML.

[ Top ]
Methods
getClientVersion  [line 156]

  string getClientVersion( )

Returns dedicated version of client.

Returns dedicated version of client.


API Tags:
Return:  Version.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getEMail  [line 178]

  string getEMail( )

Returns owner e-mail.

Returns owner e-mail.


API Tags:
Return:  Owner e-mail.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getIP  [line 77]

  string getIP( )

Returns server IP.

Returns server IP.


API Tags:
Return:  IP.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getLocation  [line 110]

  string getLocation( )

Returns server location.

Returns server location.


API Tags:
Return:  Location.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getMapAuthor  [line 244]

  string getMapAuthor( )

Returns map author.

Returns map author.


API Tags:
Return:  Mapper name.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getMapHeight  [line 266]

  int getMapHeight( )

Returns map height.

Returns map height.


API Tags:
Return:  Map height.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getMapName  [line 233]

  string getMapName( )

Returns map name.

Returns map name.


API Tags:
Return:  Map name.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getMapWidth  [line 255]

  int getMapWidth( )

Returns map width.

Returns map width.


API Tags:
Return:  Map width.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getMaxPlayers  [line 200]

  int getMaxPlayers( )

Returns maximum amount of players online.

Returns maximum amount of players online.


API Tags:
Return:  Maximum allowed count of players.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getMonstersCount  [line 222]

  int getMonstersCount( )

Returns number of all monsters on map.

Returns number of all monsters on map.


API Tags:
Return:  Count of monsters.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getMOTD  [line 278]

  string getMOTD( )

Returns server's Message Of The Day

Returns server's Message Of The Day


API Tags:
Return:  Server MOTD.
Access:  public

Information Tags:
Version:  0.1.0
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getName  [line 88]

  string getName( )

Returns server name.

Returns server name.


API Tags:
Return:  Name.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getOnlinePlayers  [line 189]

  int getOnlinePlayers( )

Returns current amount of players online.

Returns current amount of players online.


API Tags:
Return:  Count of players.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getOwner  [line 167]

  string getOwner( )

Returns owner name.

Returns owner name.


API Tags:
Return:  Owner name.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getPlayersPeak  [line 211]

  int getPlayersPeak( )

Returns record of online players.

Returns record of online players.


API Tags:
Return:  Players online record.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getPort  [line 99]

  int getPort( )

Returns server port.

Returns server port.


API Tags:
Return:  Port.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getServer  [line 134]

  string getServer( )

Returns server attribute.

Returns server attribute. I have no idea what the hell is it representing :P.


API Tags:
Return:  Attribute value.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getServerVersion  [line 145]

  string getServerVersion( )

Returns server version.

Returns server version.


API Tags:
Return:  Version.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getTSPQVersion  [line 55]

  string getTSPQVersion( )

Returns version of root element.

Returns version of root element.


API Tags:
Return:  TSPQ version.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getUptime  [line 66]

  int getUptime( )

Returns server uptime.

Returns server uptime.


API Tags:
Return:  Uptime.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
getURL  [line 121]

  string getURL( )

Returns server website.

Returns server website.


API Tags:
Return:  Website URL.
Access:  public

Information Tags:
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Since:  0.0.2

[ Top ]
__get  [line 304]

  mixed __get( string $name  )

Magic PHP5 method.

Magic PHP5 method.

Parameters:
string   $name:  Property name.

API Tags:
Return:  Property value.
Access:  public

Information Tags:
Version:  0.1.0
Version:  0.0.2
Throws:  DOMException On DOM operation error.
Throws:  OutOfBoundsException For non-supported properties.
Since:  0.0.2
Since:  0.1.0

[ Top ]
__toString  [line 383]

  string __toString( )

Returns string representation of XML.

Returns string representation of XML.


API Tags:
Return:  String representation of object.
Access:  public

Information Tags:
Version:  0.1.0
Version:  0.0.2
Since:  0.0.2
Since:  0.1.0

[ Top ]