Class: Member

Source Location: /objects/member.php

Class Overview

An object representing a relationship between a user and a game. Mostly contains information used for printing the Game->summary(), when not loaded as userMember or processMember

Variables

Methods

Child classes:

userMember: Handles the functions which a user wants to perform when they view a game they're a member of; logging on, finalizing, etc. Also loads orders ready to be updated.

processMember: This class deals with changing the status of a member of a certain game, including the giving of winnings or refunds.

Class Details

[line 31]
An object representing a relationship between a user and a game. Mostly contains information used for printing the Game->summary(), when not loaded as userMember or processMember

[ Top ]

Class Variables

$bet =

[line 82]

The amount the user bet into the game

Type:

int

[ Top ]

$country =

[line 52]

The country this member is playing as. Will be 'Unassigned' if pre-game.

Type:

string

[ Top ]

$finalized =

[line 62]

Whether or not the user has finalized

Type:

boolean

[ Top ]

$formTicket =

[line 67]

The form submission ticket, to prevent submitting the same data twice.

Type:

integer

[ Top ]

$Game =

[line 103]

A link to the Game object this Member is a member of

Type:

Game

[ Top ]

$gameID =

[line 47]

The game ID

Type:

int

[ Top ]

$id =

[line 37]

The member ID

Type:

int

[ Top ]

$newMessagesFrom =

[line 89]

An array of countries from which this member has new messages. 'Global' may also be within this array.

Type:

string[]

[ Top ]

$online =

[line 129]

Whether this member is online or not

Type:

bool

[ Top ]

$phasesMissed =

[line 110]

The number of phases this Member has missed

Type:

int

[ Top ]

$points =

[line 77]

The number of points the user currently has available to bet

Type:

int

[ Top ]

$status =

[line 57]

The member status; 'Playing','Left','Defeated'

Type:

string

[ Top ]

$supplyCenterNo =

[line 123]

The number of supply centers this member owns

Type:

int

[ Top ]

$timeLoggedIn =

[line 96]

The time the player last logged into the game

Type:

int

[ Top ]

$unitNo =

[line 117]

The number of units this member owns

Type:

int

[ Top ]

$userID =

[line 42]

The user ID

Type:

int

[ Top ]

$username =

[line 72]

The username corresponding to this member

Type:

string

[ Top ]

$votes =

[line 136]

An array of vote-flags which this member has voted for

Type:

string[]

[ Top ]

Class Methods

constructor __construct [line 142]

Member __construct(
array
$row)

Create a Member object from a database Member record row

Parameters:

array

$row

Member record

[ Top ]

method lastLoggedInTxt [line 226]

string lastLoggedInTxt(
)

A textual display of this user's last log-in time

Tags:

return:

Last log-in time

[ Top ]

method profile_link [line 164]

string profile_link(
)

Generate a profile link

[ Top ]

method summary [line 189]

string summary(
[boolean
$ingame = false])

Generate a summary of this member's info

Parameters:

boolean

$ingame

If true the output is tweaked for in-game display

[ Top ]

Documentation generated on Thu, 13 Nov 2008 18:16:12 +0900 by phpDocumentor 1.4.1