Docs For Class TList

Description

Implements interfaces:

Iterator (internal interface)

Class TList.

TList implements a list.

Located in /TList.php (line 21)

Direct descendents

Class	Description
PlayerList	Class PlayerList.
TeamList	Class TeamList.

Variable Summary

int $count

array $list

Method Summary

TList __construct ()

void addItem (mixed $item)

void clear ()

mixed current ()

int getCount ()

mixed|bool getItem (int $index)

int key ()

mixed next ()

void rewind ()

bool valid ()

Variables

int $count (line 35)

Number of items in the list.

access: protected

array $list (line 28)

Internal list of items.

access: protected

Methods

Constructor __construct (line 41)

Class constructor.

access: public

TList __construct ()

Redefined in descendants as:

Team::__construct() : Constructor.

addItem (line 52)

Adds an item to the list.

access: protected

void addItem (mixed $item)

mixed $item: the item we wish to add

clear (line 84)

Clears the list.

access: public

void clear ()

current (line 109)

Returns the current array item.

This method is required by the interface Iterator.

return: the current array item
access: public

mixed current ()

Implementation of:

Iterator::current

getCount (line 74)

Returns the number of items in the list.

return: the number of items
access: public

int getCount ()

getItem (line 64)

Returns an item at the specified offset.

return: the item or false if index is out of the range
access: protected

mixed|bool getItem (int $index)

int $index: the index of item

key (line 124)

Returns the key of the current array item.

This method is required by the interface Iterator.

return: the key of the current array item
access: public

int key ()

Implementation of:

Iterator::key

next (line 136)

Moves the internal pointer to the next array item.

This method is required by the interface Iterator.

return: the next array item
access: public

mixed next ()

Implementation of:

Iterator::next

rewind (line 95)

Rewinds internal array pointer.

This method is required by the interface Iterator.

access: public

void rewind ()

Implementation of:

Iterator::rewind

valid (line 148)

Returns whether there is an item at current position.

This method is required by the interface Iterator.

access: public

bool valid ()

Implementation of:

Iterator::valid