Main Page | Class Hierarchy | Class List | Directories | Class Members | Related Pages | Examples

gameSpyQ Class Reference

Uses the new gameSpy query protcol to communicate with the server. More...

Inheritance diagram for gameSpyQ:

Inheritance graph
Collaboration diagram for gameSpyQ:

Collaboration graph
List of all members.

Public Member Functions

 query_server ($getPlayers=TRUE, $getRules=TRUE)
 Querys the server.
 sortPlayers ($players, $sortkey='name')
 Sorts the given players.
 _processServerData ($serverData)
 Process the given raw data and stores everything.
 _processPlayerData ($playerData, $keys)
 Process raw player data.
 _getClassName ()
 returns the class name of the instance

Detailed Description

Uses the new gameSpy query protcol to communicate with the server.

Author:
Jeremias Reith (jr@terragate.net)
Version:
Id
gameSpyQ.php 197 2004-10-22 05:15:22Z jr


Member Function Documentation

gameSpyQ::_getClassName  ) 
 

returns the class name of the instance

Returns:
the class name of the instance
Override this for mixed case class names and support for PHP <5

Reimplemented from gsQuery.

gameSpyQ::_processPlayerData playerData,
keys
 

Process raw player data.

For internal use only.

Parameters:
playerData array containing player data
keys array of available keys
Returns:
TRUE on success

gameSpyQ::_processServerData serverData  ) 
 

Process the given raw data and stores everything.

For internal use only.

Parameters:
serverData data that has the basic server infos and rules
Returns:
TRUE on success

gameSpyQ::query_server getPlayers = TRUE,
getRules = TRUE
 

Querys the server.

This method is abstract

Parameters:
getPlayers wheather to retrieve player infos
getRules wheather to retrieve rules
Returns:
TRUE on success

Reimplemented from gsQuery.

gameSpyQ::sortPlayers players,
sortkey = 'name'
 

Sorts the given players.

You can sort by name, score, frags, deaths, honor and time

Parameters:
players players to sort
sortkey sort by the given key
Returns:
sorted player hash

Reimplemented from gsQuery.


The documentation for this class was generated from the following file:
Generated on Sat Oct 15 16:51:59 2005 for gsQuery by  doxygen 1.4.4