Docs For Class TeamList

Class TeamList

Description

Class TeamList.

TeamList implements a list of teams in the game.

Located in /TeamList.php (line 21)

TList
   |
   --TeamList

Method Summary

void addTeam (Team $team)

Team|bool getTeam (int $index)

Team|bool getTeamByIndex (int $index)

Variables

Inherited Variables

Inherited from TList

TList::$count
TList::$list

Methods

addTeam (line 28)

Adds a team to the list

access: public

void addTeam (Team $team)

Team $team: the team we wish to add

getTeam (line 39)

Returns a team at the specified offset.

return: the team or false if the index is out of the range
access: public

Team|bool getTeam (int $index)

int $index: an index of the team

getTeamByIndex (line 50)

Returns a team with its index equal as the one required.

return: the team or false if no team has been found
access: public

Team|bool getTeamByIndex (int $index)

int $index: team's index

Inherited Methods

Inherited From TList

TList::__construct()
TList::addItem()
TList::clear()
TList::current()
TList::getCount()
TList::getItem()
TList::key()
TList::next()
TList::rewind()
TList::valid()

Documentation generated on Mon, 11 May 2009 16:43:54 +0200 by phpDocumentor 1.4.1