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

armyGame Class Reference

Extends the gameSpy protocol to support America's Army. More...

Inheritance diagram for armyGame:

Inheritance graph
Collaboration diagram for armyGame:

Collaboration graph
List of all members.

Public Member Functions

 query_server ($getPlayers=TRUE, $getRules=TRUE)
 Querys the server.
 _processPlayers ($rawPlayerData)
 Extracts the players out of the given data.
 _processServerInfo ($rawdata)
 Process the given raw data and stores everything.
 sortPlayers ($players, $sortkey='name')
 Sorts the given players.
 _getClassName ()
 returns the class name of the instance

Detailed Description

Extends the gameSpy protocol to support America's Army.

Author:
Jeremias Reith (jr@terragate.net)
Version:
Id
armyGame.php 190 2004-09-25 15:48:06Z jr
This is a quick hack to support the changed America's Army protocol. It is slow, incomplete and ugly. Does anyone have the protocol specs?
Todo:
Add rules & clean up
Examples:

example_usage.php.


Member Function Documentation

armyGame::_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 gameSpy.

armyGame::_processPlayers rawPlayerData  ) 
 

Extracts the players out of the given data.

For internal use only.

Parameters:
rawPlayerData data with players
Returns:
TRUE on success

Reimplemented from gameSpy.

armyGame::_processServerInfo rawdata  ) 
 

Process the given raw data and stores everything.

For internal use only.

Parameters:
rawdata data that has the basic server infos
Returns:
TRUE on success

Reimplemented from gameSpy.

armyGame::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 gameSpy.

armyGame::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:57 2005 for gsQuery by  doxygen 1.4.4