Base
[ class tree: Base ] [ index: Base ] [ all elements ]

Element index for package Base

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ _ ]

_

__construct
in file database.php, method Database::__construct()
    Initialize the database connection
__construct
in file user.php, method User::__construct()
    Initialize a user object
__destruct
in file database.php, method Database::__destruct()
    Close the database connection
__construct
in file unit.php, method Unit::__construct()
    Initialize a unit
__construct
in file territory.php, method Territory::__construct()
    The Territory constructor
__construct
in file order.php, method order::__construct()
    Create the order and initialize objects from a $row
__construct
in file member.php, method Member::__construct()
    Create a Member object from a database Member record row
__construct
in file game.php, method Game::__construct()
top

a

$adminEMail
in file config.sample.php, variable Config::$adminEMail
    The administrators e-mail; if a user experiences a problem they will be invited to contact this e-mail address. It's unlikely bots will experience the sort of problem resulting in your e-mail being displayed, but if your e-mail provider doesn't filter spam well you may want to be careful.
$availablelocales
in file config.sample.php, variable Config::$availablelocales
    Array of available locales
assert_handler
in file error.php, function assert_handler()
authenticate
in file auth.php, method libAuth::authenticate()
    Generate a key code from a username and password. If the username and password do not match a notice will be displayed and the script will be stopped.
auth.php
procedural page auth.php
$aCharSet
in file php-captcha.inc.php, variable PhpCaptcha::$aCharSet
$aFonts
in file php-captcha.inc.php, variable PhpCaptcha::$aFonts
activegames
in file findgames.php, method libFindGames::activegames()
    Games the user could watch
top

b

$bCaseInsensitive
in file php-captcha.inc.php, variable PhpCaptcha::$bCaseInsensitive
$bCharShadow
in file php-captcha.inc.php, variable PhpCaptcha::$bCharShadow
$bUseColour
in file php-captcha.inc.php, variable PhpCaptcha::$bUseColour
$bet
in file member.php, variable Member::$bet
    The amount the user bet into the game
bet
in file game.php, method Game::bet()
    Calculate the worth of a certain country, or the size of the required bet to join. With no args it will calculate the bet size required to join pre-game, with a country specified it will calculate the amount that country is worth, ie how much it would cost to take it over.
top

c

$comment
in file user.php, variable User::$comment
    The user-profile comment
$customFooter
in file config.sample.php, variable Config::$customFooter
    Something to add after everything else has been printed off (except '</body></html>'), useful for things like Google Analytics, or web-rings
CIVILDISORDERID1
in file definitions.php, constant CIVILDISORDERID1
CIVILDISORDERID2
in file definitions.php, constant CIVILDISORDERID2
close
in file header.php, function close()
Config
in file config.sample.php, class Config
    The configuration object. This is the only file that will require modification by end users.
config.sample.php
procedural page config.sample.php
CalculateSpacing
in file php-captcha.inc.php, method PhpCaptcha::CalculateSpacing()
CAPTCHA_AUDIO_PATH
in file php-captcha.inc.php, constant CAPTCHA_AUDIO_PATH
CAPTCHA_BACKGROUND_IMAGES
in file php-captcha.inc.php, constant CAPTCHA_BACKGROUND_IMAGES
CAPTCHA_CASE_INSENSITIVE
in file php-captcha.inc.php, constant CAPTCHA_CASE_INSENSITIVE
CAPTCHA_CHAR_SET
in file php-captcha.inc.php, constant CAPTCHA_CHAR_SET
CAPTCHA_CHAR_SHADOW
in file php-captcha.inc.php, constant CAPTCHA_CHAR_SHADOW
CAPTCHA_FILE_TYPE
in file php-captcha.inc.php, constant CAPTCHA_FILE_TYPE
CAPTCHA_FLITE_PATH
in file php-captcha.inc.php, constant CAPTCHA_FLITE_PATH
CAPTCHA_HEIGHT
in file php-captcha.inc.php, constant CAPTCHA_HEIGHT
CAPTCHA_MAX_FONT_SIZE
in file php-captcha.inc.php, constant CAPTCHA_MAX_FONT_SIZE
CAPTCHA_MIN_FONT_SIZE
in file php-captcha.inc.php, constant CAPTCHA_MIN_FONT_SIZE
CAPTCHA_NUM_CHARS
in file php-captcha.inc.php, constant CAPTCHA_NUM_CHARS
CAPTCHA_NUM_LINES
in file php-captcha.inc.php, constant CAPTCHA_NUM_LINES
CAPTCHA_OWNER_TEXT
in file php-captcha.inc.php, constant CAPTCHA_OWNER_TEXT
CAPTCHA_SESSION_ID
in file php-captcha.inc.php, constant CAPTCHA_SESSION_ID
    ********************** Default Options *********************
CAPTCHA_USE_COLOUR
in file php-captcha.inc.php, constant CAPTCHA_USE_COLOUR
CAPTCHA_WIDTH
in file php-captcha.inc.php, constant CAPTCHA_WIDTH
CaseInsensitive
in file php-captcha.inc.php, method PhpCaptcha::CaseInsensitive()
Create
in file php-captcha.inc.php, method PhpCaptcha::Create()
$coast
in file territory.php, variable Territory::$coast
    Coast type: 'No','Parent','South','North'
$country
in file unit.php, variable Unit::$country
    Country owner
$country
in file territory.php, variable Territory::$country
    The country which initially owns this territory
$country
in file member.php, variable Member::$country
    The country this member is playing as. Will be 'Unassigned' if pre-game.
$country
in file order.php, variable order::$country
    The country corresponding to this order
credits.php
procedural page credits.php
credits.php
procedural page credits.php
top

d

$database_name
in file config.sample.php, variable Config::$database_name
    The database name
$database_password
in file config.sample.php, variable Config::$database_password
    The password of the above user
$database_socket
in file config.sample.php, variable Config::$database_socket
    This is the MySQL socket. It could be a network socket or a UNIX socket.
$database_username
in file config.sample.php, variable Config::$database_username
    The user who will perform all database actions. You should tweak the user's permissions so they can only do the bare minimum they need to be able to do to update the phpDiplomacy tables. Read the administrator documentation for more info.
Database
in file database.php, class Database
    A MySQL DB interaction object.
deCoastCompare
in file database.php, method Database::deCoastCompare()
    Generate the SQL needed to compare a coastal territory column to non-coastal territory column
DYNAMICSRV
in file definitions.php, constant DYNAMICSRV
definitions.php
procedural page definitions.php
database.php
procedural page database.php
DisplayShadow
in file php-captcha.inc.php, method PhpCaptcha::DisplayShadow()
DrawCharacters
in file php-captcha.inc.php, method PhpCaptcha::DrawCharacters()
DrawLines
in file php-captcha.inc.php, method PhpCaptcha::DrawLines()
DrawOwnerText
in file php-captcha.inc.php, method PhpCaptcha::DrawOwnerText()
datetxt
in file game.php, method Game::datetxt()
    Return the in-game turn in text format. 0 = Spring 1901 , 1 = Autumn 1901, etc.
deCoast
in file territory.php, method Territory::deCoast()
    Remove coast info from a territory name
developers.php
procedural page developers.php
developers.php
procedural page developers.php
top

e

$email
in file user.php, variable User::$email
    E-mail address
error
in file html.php, method libHTML::error()
    Print an error message and end the script
error_handler
in file error.php, function error_handler()
escape
in file database.php, method Database::escape()
    Sanitize incoming strings, filtering out all HTML. Suitable for all data.
exception_handler
in file error.php, function exception_handler()
error.php
procedural page error.php
easycaptcha.php
procedural page easycaptcha.php
top

f

$facebookAPIKey
in file config.sample.php, variable Config::$facebookAPIKey
    The Facebook API key. If you're not on Facebook this will be ignored
$facebookAPIPath
in file config.sample.php, variable Config::$facebookAPIPath
    The path to the Facebook API script (facebook.php)
$facebookDebug
in file config.sample.php, variable Config::$facebookDebug
    The Facebook debug value
$facebookNotificationFromUserID
in file config.sample.php, variable Config::$facebookNotificationFromUserID
    The user ID of the Facebook user to send game notification messages from.
$facebookNotificationFromUserSecret
in file config.sample.php, variable Config::$facebookNotificationFromUserSecret
    The authentication secret of the above Facebook user
$facebookSecret
in file config.sample.php, variable Config::$facebookSecret
    The Facebook secret. If you're not on Facebook this will be ignored
$facebookServerURL
in file config.sample.php, variable Config::$facebookServerURL
    The URL of the front end of the server (usually only for Facebook or advanced users)
$facebookStaticURL
in file config.sample.php, variable Config::$facebookStaticURL
    The URL which static data, such as images, are stored at (usually only for Facebook or advanced users)
$fixedPhaseHours
in file config.sample.php, variable Config::$fixedPhaseHours
    If this is set to true all phases will last 24 hours, otherwise the number of hours available will be configurable by the users, from 1 to 72
$formTicket
in file user.php, variable User::$formTicket
    Form-ticket to prevent users from submitting the same form twice
FACEBOOK
in file definitions.php, constant FACEBOOK
footer
in file html.php, method libHTML::footer()
    Output the footer HTML and call the close() function to perform final clean-ups. If $DB and $User are available then the script has ended successfully, and some statistics around outputted.
formTicket
in file user.php, method User::formTicket()
    Checks for a formTicket get/post integer, and checks that it matches the last formTicket given out. If so the form being submitted is valid, otherwise it's invalid.
$finalized
in file member.php, variable Member::$finalized
    Whether or not the user has finalized
$formTicket
in file member.php, variable Member::$formTicket
    The form submission ticket, to prevent submitting the same data twice.
$fromTerr
in file order.php, variable order::$fromTerr
    A territory name from the fromTerr field
$fromTerritory
in file order.php, variable order::$fromTerritory
    The Territory object corresponding to the fromTerr field
finishedgames
in file findgames.php, method libFindGames::finishedgames()
    Games which are finished, but the user is not a member of
findgames.php
procedural page findgames.php
faq.php
procedural page faq.php
faq.php
procedural page faq.php
top

g

$gameMasterSecret
in file config.sample.php, variable Config::$gameMasterSecret
    This is used to authenticate the cron process which will run the gamemaster script.
$getqueries
in file database.php, variable Database::$getqueries
$gmtOffset
in file user.php, variable User::$gmtOffset
    GMT offset, in seconds
GAMEMASTERID
in file definitions.php, constant GAMEMASTERID
gameNotifyBlock
in file html.php, method libHTML::gameNotifyBlock()
    The notification block HTML, containing links to games which need the user's attention.
get_lock
in file database.php, method Database::get_lock()
    Get a MySQL named lock, will stop the script if the lock cannot be obtained
gmtOffsetToText
in file time.php, method libTime::gmtOffsetToText()
    Display a GMT offset in seconds, in text
gmtTextToOffset
in file time.php, method libTime::gmtTextToOffset()
    Convert a GMT text offset to a GMT offset in seconds
GUESTID
in file definitions.php, constant GUESTID
GenerateCode
in file php-captcha.inc.php, method PhpCaptcha::GenerateCode()
gamecreate.php
procedural page gamecreate.php
gamecreate.php
procedural page gamecreate.php
$Game
in file member.php, variable Member::$Game
    A link to the Game object this Member is a member of
$gameID
in file unit.php, variable Unit::$gameID
    Game ID
$gameID
in file member.php, variable Member::$gameID
    The game ID
$gameID
in file order.php, variable order::$gameID
    The game ID corresponding to this order
$gameOver
in file game.php, variable Game::$gameOver
    The conditions under which the game ended; 'Won', 'No', 'Drawn'
Game
in file game.php, class Game
    Prints data on a game, and loads and manages the collections of members which this game contains.
gamelistings.php
procedural page gamelistings.php
gameovertxt
in file game.php, method Game::gameovertxt()
    A textual representation of the game over conditions
gamemessage.php
procedural page gamemessage.php
game.php
procedural page game.php
top

h

$hideEmail
in file user.php, variable User::$hideEmail
    Hide-email? 'Yes'/'No'
$homepage
in file user.php, variable User::$homepage
    User-profile homepage
header.php
procedural page header.php
html.php
procedural page html.php
halloffame.php
procedural page halloffame.php
help.php
procedural page help.php
help.php
procedural page help.php
top

i

$id
in file user.php, variable User::$id
    User ID
$interactiveDATC
in file config.sample.php, variable Config::$interactiveDATC
    If this is set to true datc.php will become interactive, allowing the tests to be run, instead of the results being displayed. However this is CPU intensive and not written with data security in mind
index.php
procedural page index.php
invite.php
procedural page invite.php
is_valid_email_address
in file auth.php, method libAuth::is_valid_email_address()
    ##################################################################################
$iHeight
in file php-captcha.inc.php, variable PhpCaptcha::$iHeight
$iMaxFontSize
in file php-captcha.inc.php, variable PhpCaptcha::$iMaxFontSize
$iMinFontSize
in file php-captcha.inc.php, variable PhpCaptcha::$iMinFontSize
$iNumChars
in file php-captcha.inc.php, variable PhpCaptcha::$iNumChars
$iNumLines
in file php-captcha.inc.php, variable PhpCaptcha::$iNumLines
$iSpacing
in file php-captcha.inc.php, variable PhpCaptcha::$iSpacing
$iWidth
in file php-captcha.inc.php, variable PhpCaptcha::$iWidth
IN_CODE
in file easycaptcha.php, constant IN_CODE
$id
in file unit.php, variable Unit::$id
    Unit ID
$id
in file order.php, variable order::$id
    The order ID
$id
in file member.php, variable Member::$id
    The member ID
$id
in file game.php, variable Game::$id
    The game ID
isComplete
in file order.php, method order::isComplete()
    Return true if the order is complete, false otherwise
isMember
in file game.php, method Game::isMember()
    Determines if the given user ID is registered in the current game. Returns the user's country if so, false if not
intro.php
procedural page intro.php
intro.php
procedural page intro.php
top

j

joinablegames
in file findgames.php, method libFindGames::joinablegames()
    Games the user could join
joinedactivegames
in file findgames.php, method libFindGames::joinedactivegames()
    Active games the user has joined
joinedfinishedgames
in file findgames.php, method libFindGames::joinedfinishedgames()
    Finished games the user has joined
top

k

key_check
in file auth.php, method libAuth::key_check()
    Check a given session key to see if it is valid
key_generate
in file auth.php, method libAuth::key_generate()
    Generate a session key for a given user ID using the config secret
key_logon
in file auth.php, method libAuth::key_logon()
    Logon as a user with a key. Display a notice and terminate if there is a problem, otherwise return a $User object corresponding to the given key.
key_set
in file auth.php, method libAuth::key_set()
    Generate and set an authentication cookie
key_wipe
in file auth.php, method libAuth::key_wipe()
    Wipe the session keys
top

l

$lastMessageIDViewed
in file user.php, variable User::$lastMessageIDViewed
    The last message this user viewed in the public forum
$link
in file database.php, variable Database::$link
    The MySQL resource object used to identify the database connection
$locale
in file user.php, variable User::$locale
    Locale
$localealiases
in file config.sample.php, variable Config::$localealiases
    Different names given to the same locales, to allow automatic recognition of which locale to use.
$logOrders
in file config.sample.php, variable Config::$logOrders
    Should every piece of every order entered be logged as it comes in? This helps solve problems when people think they submitted correct orders but may not have, but it can use up lots of disk space and unnecessary time.
legacy_key_check
in file auth.php, method libAuth::legacy_key_check()
    Check a given key to see if it's just an older key which can still be used and updated
libAuth
in file auth.php, class libAuth
    An class which groups authentication functions
libHTML
in file html.php, class libHTML
    A collection of functions which output HTML and manage the main body and layout of the menu, notification bar, and content.
libTime
in file time.php, class libTime
    This is a collection of functions used to print timezones in a friendly way. It used to translate to/from GMT times, but that's now handled by PHP, so this may be better put into libHTML
load
in file user.php, method User::load()
    Load the User object class fields. It is assumed that username is already escaped.
logon
in file user.php, method User::logon()
    Log-on, create/update a session record, and take information for user access logging for meta-gamers
logon.php
procedural page logon.php
lastLoggedInTxt
in file member.php, method Member::lastLoggedInTxt()
    A textual display of this user's last log-in time
libFindGames
in file findgames.php, class libFindGames
    This class will find games which fit certain criteria
libGameMessage
in file gamemessage.php, class libGameMessage
    Send a message to a member of a country in a game, from another member. Used by GameMaster in processGame, and libChatbox
load
in file game.php, method Game::load()
    Reload the variables which are stored within this object specificially, ie everything
loadMembers
in file game.php, method Game::loadMembers()
    Reload the Members array
loadObject
in file order.php, method order::loadObject()
    Load an object corresponding to an entered class field. Used when inputting new data and when initializing the object (->set() and ->__construct()). If the input doesn't correspond to an object it is ignored.
top

m

$messagesperpage
in file config.sample.php, variable Config::$messagesperpage
    The maximum number of messages displayed on the forum; 50 should be fine.
message.php
procedural page message.php
menu
in file html.php, method libHTML::menu()
    Prints the logo, welcome text and menu.
Message
in file message.php, class Message
    A library used to send messages to the public forum (could be merged with something else)
msg_escape
in file database.php, method Database::msg_escape()
    Sanitize incoming strings, leaving newlines. Suitable for messages.
$mapX
in file territory.php, variable Territory::$mapX
    Large map x coordinate
$mapY
in file territory.php, variable Territory::$mapY
    Large map y coordinate
$Members
in file game.php, variable Game::$Members
    An array of Member(/processMember) objects indexed by country
Member
in file member.php, class Member
    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
modetxt
in file game.php, method Game::modetxt()
    The Game's phase in textual format
member.php
procedural page member.php
top

n

NOLOCK
in file definitions.php, constant NOLOCK
notice
in file html.php, method libHTML::notice()
    Wipe everything done so far, output a notice and end the script. Can be run in the event of errors.
$name
in file game.php, variable Game::$name
    The game's name
$newMessagesFrom
in file member.php, variable Member::$newMessagesFrom
    An array of countries from which this member has new messages. 'Global' may also be within this array.
newCache
in file territory.php, method Territory::newCache()
    Territories are cached so that repeated requests to the database don't need to be made for the same territory. This isn't as much of a problem as it was
notify
in file gamemessage.php, method libGameMessage::notify()
    Notify a country that you sent them a message, uses the global Game
notifyGames
in file findgames.php, method libFindGames::notifyGames()
    Games which the current user needs to have appear in the notify bar
top

o

$online
in file user.php, variable User::$online
    Is this user online?
$oImage
in file php-captcha.inc.php, variable PhpCaptcha::$oImage
$online
in file member.php, variable Member::$online
    Whether this member is online or not
order.php
procedural page order.php
order
in file order.php, class order
    The root order function; mostly just holds information and loads objects for userOrder and processOrder
top

p

$password
in file user.php, variable User::$password
    MD5 (salted) password hex encoded
$points
in file user.php, variable User::$points
    Number of available points
$putqueries
in file database.php, variable Database::$putqueries
packArray
in file database.php, method Database::packArray()
    This is like implode with a wrapper around it, because using implode for this function again and again got messy
pagebreak
in file html.php, method libHTML::pagebreak()
    Print a phpDiplomacy page break, where the content block ends and starts again leaving a gap.
pages
in file html.php, method libHTML::pages()
    Return an array of links, along with their names, who can view them, and whether they appear in the menu.
prebody
in file html.php, method libHTML::prebody()
    The first HTML to be output; the various header tags, before anything is visible
processForm
in file user.php, method User::processForm()
    Filter a registration/user control panel form. An exception is thrown if data can't be filtered. An array of variables usable in SQL are returned.
profile.php
procedural page profile.php
profile_link
in file user.php, method User::profile_link()
    Return a profile link for this user
php-captcha.inc.php
procedural page php-captcha.inc.php
PhpCaptcha
in file php-captcha.inc.php, method PhpCaptcha::PhpCaptcha()
PhpCaptcha
in file php-captcha.inc.php, class PhpCaptcha
    The phpCaptcha class for the registration screen captcha
$password
in file game.php, variable Game::$password
    The MD5 hash of the game's password
$phase
in file game.php, variable Game::$phase
    The game phase: 'Pre-game', 'Diplomacy', 'Retreats', 'Unit-placing', 'Finished'
$phaseHours
in file game.php, variable Game::$phaseHours
    The number of hours per phase, defaults to 24
$phasesMissed
in file member.php, variable Member::$phasesMissed
    The number of phases this Member has missed
$points
in file member.php, variable Member::$points
    The number of points the user currently has available to bet
$pot
in file game.php, variable Game::$pot
    The number of points in the pot
$potType
in file game.php, variable Game::$potType
    Winner-takes-all/Points-per-supply-center
$private
in file game.php, variable Game::$private
    True if the game is private
$processStatus
in file game.php, variable Game::$processStatus
    Not-processing/Processing/Crashed/Paused
$processTime
in file game.php, variable Game::$processTime
    The deadline when the game must next be processed, a UNIX timestamp
pointsPerSupplyCenter
in file game.php, method Game::pointsPerSupplyCenter()
    Calculate the points value of a single supply center in this game
processTimetxt
in file game.php, method Game::processTimetxt()
    Return the next process time in textual format, in terms of time remaining
profile_link
in file member.php, method Member::profile_link()
    Generate a profile link
points.php
procedural page points.php
points.php
procedural page points.php
top

r

remainingText
in file time.php, method libTime::remainingText()
    Print the time remaining
rendertime
in file html.php, method libHTML::rendertime()
    Determine the time it took to run the script
register.php
procedural page register.php
top

s

$salt
in file config.sample.php, variable Config::$salt
    This is used to salt hashes, and the md5 hash of this is appended to the directory that errors are logged to.
$secret
in file config.sample.php, variable Config::$secret
    This is used for session keys, and can be changed from time to time without too much difficulty, but it's even more important that it isn't known!
$sessionCode
in file user.php, variable User::$sessionCode
    Temporary session code (this may now be obsolete)
$statusimg
in file user.php, variable User::$statusimg
    The status green icon, will be present here if this user is online
send
in file message.php, method Message::send()
    Send a message to the public forum. The variables passed are assumed to be already sanitized
SHARE
in file definitions.php, constant SHARE
sql_hash
in file database.php, method Database::sql_hash()
    Run a SQL query and return a single named row $row['foo']
sql_put
in file database.php, method Database::sql_put()
    Run a data insertion SQL query, halting phpDip if there is an error
sql_row
in file database.php, method Database::sql_row()
    Run a SQL query and return a single numbered row $row[0]
sql_tabl
in file database.php, method Database::sql_tabl()
    Query the database and return a MySQL table resource.
starthtml
in file html.php, method libHTML::starthtml()
    Print the HTML which comes before the main content; title, menu, notification bar.
STATICSRV
in file definitions.php, constant STATICSRV
stripslashes_deep
in file header.php, function stripslashes_deep()
$sCode
in file php-captcha.inc.php, variable PhpCaptcha::$sCode
$sFileType
in file php-captcha.inc.php, variable PhpCaptcha::$sFileType
$sOwnerText
in file php-captcha.inc.php, variable PhpCaptcha::$sOwnerText
SetBackgroundImages
in file php-captcha.inc.php, method PhpCaptcha::SetBackgroundImages()
SetCharSet
in file php-captcha.inc.php, method PhpCaptcha::SetCharSet()
SetFileType
in file php-captcha.inc.php, method PhpCaptcha::SetFileType()
SetHeight
in file php-captcha.inc.php, method PhpCaptcha::SetHeight()
SetMaxFontSize
in file php-captcha.inc.php, method PhpCaptcha::SetMaxFontSize()
SetMinFontSize
in file php-captcha.inc.php, method PhpCaptcha::SetMinFontSize()
SetNumChars
in file php-captcha.inc.php, method PhpCaptcha::SetNumChars()
SetNumLines
in file php-captcha.inc.php, method PhpCaptcha::SetNumLines()
SetOwnerText
in file php-captcha.inc.php, method PhpCaptcha::SetOwnerText()
SetWidth
in file php-captcha.inc.php, method PhpCaptcha::SetWidth()
$smallMapX
in file territory.php, variable Territory::$smallMapX
    Small map x coordinate
$smallMapY
in file territory.php, variable Territory::$smallMapY
    Small map y coordinate
$status
in file member.php, variable Member::$status
    The member status; 'Playing','Left','Defeated'
$supply
in file territory.php, variable Territory::$supply
    Supply center present: 'Yes'/'No'
$supplyCenterNo
in file member.php, variable Member::$supplyCenterNo
    The number of supply centers this member owns
send
in file gamemessage.php, method libGameMessage::send()
    Send a game message. Messages are sanitized
static_datetxt
in file game.php, method Game::static_datetxt()
    Return the in-game turn in text format. 0 = Spring 1901 , 1 = Autumn 1901, etc.
summary
in file game.php, method Game::summary()
    Output an HTML summary of the game
summary
in file member.php, method Member::summary()
    Generate a summary of this member's info
top

t

$timeJoined
in file user.php, variable User::$timeJoined
    UNIX timestamp of join-date
$timeLastSessionEnded
in file user.php, variable User::$timeLastSessionEnded
    UNIX timestamp from the time the last session ended
$timezones
in file config.sample.php, variable Config::$timezones
    Array of allowed timezones
$type
in file user.php, variable User::$type
    User type; an array of user-types, each set to true for is-a-member, false for is-not-a-member
time.php
procedural page time.php
tabl_hash
in file database.php, method Database::tabl_hash()
    Take the next named MySQL row from a table resource, or return false if no rows remain $row['foo']
tabl_row
in file database.php, method Database::tabl_row()
    Take the next numbered MySQL row from a table resource, or return false if no rows remain $row[0]
text
in file time.php, method libTime::text()
    Print the time in the viewing $User's timezone
timeJoinedtxt
in file user.php, method User::timeJoinedtxt()
    The time this user joined
$terr
in file territory.php, variable Territory::$terr
    The territory name
$terr
in file unit.php, variable Unit::$terr
    Occupying territory, with coast data
$Territory
in file unit.php, variable Unit::$Territory
    Occupied Territory object
$timeLoggedIn
in file member.php, variable Member::$timeLoggedIn
    The time the player last logged into the game
$toTerr
in file order.php, variable order::$toTerr
    A territory name from the toTerr field
$toTerritory
in file order.php, variable order::$toTerritory
    The Territory object corresponding to the toTerr field
$turn
in file game.php, variable Game::$turn
    The in-game turn, 0 = Spring 1919, 1 = Autumn 1919
$type
in file territory.php, variable Territory::$type
    'Coast','Land','Sea'
$type
in file order.php, variable order::$type
    The type of order e.g. 'Hold', 'Support move', 'Destroy', 'Build Army'
$type
in file unit.php, variable Unit::$type
    Unit type: 'Army'/'Fleet'
territory.php
procedural page territory.php
Territory
in file territory.php, class Territory
    Holds Territory data for orders, and performs other territory/terrstatus related functions such as de-coasting coastal territory names.
translating.php
procedural page translating.php
translating.php
procedural page translating.php
top

u

$username
in file user.php, variable User::$username
    Username
user.php
procedural page user.php
un_msg_escape
in file database.php, method Database::un_msg_escape()
    Un-escape something escaped
UPDATE
in file definitions.php, constant UPDATE
User
in file user.php, class User
    Holds information on a user for display, or to manage certain user related functions such as logging on, and preventing the same data being sent twice. Also processes user registration forms.
UseColour
in file php-captcha.inc.php, method PhpCaptcha::UseColour()
user.php
procedural page user.php
userRegister.php
procedural page userRegister.php
usercp.php
procedural page usercp.php
$Unit
in file order.php, variable order::$Unit
    The Unit object corresponding to the order's unitID field
$unitID
in file order.php, variable order::$unitID
    The ID of the unit in the order; may or may not be fixed
$unitNo
in file member.php, variable Member::$unitNo
    The number of units this member owns
$userID
in file member.php, variable Member::$userID
    The user ID
$username
in file member.php, variable Member::$username
    The username corresponding to this member
unit.php
procedural page unit.php
Unit
in file unit.php, class Unit
    Holds unit data for orders, including the territory which the unit is staying at.
top

v

validate_email
in file auth.php, method libAuth::validate_email()
    Validate an e-mail address by checking its MX records and its format.
VERSION
in file definitions.php, constant VERSION
$vBackgroundImages
in file php-captcha.inc.php, variable PhpCaptcha::$vBackgroundImages
Validate
in file php-captcha.inc.php, method PhpCaptcha::Validate()
$validCountries
in file game.php, variable Game::$validCountries
    An array of valid country names
$validFromCountries
in file gamemessage.php, variable libGameMessage::$validFromCountries
    Valid countries/tabs to receive from
$validToCountries
in file gamemessage.php, variable libGameMessage::$validToCountries
    Valid countries/tabs to send to
$viaConvoy
in file order.php, variable order::$viaConvoy
    Whether or not this unit is moving via convoy (if applicable)
$votes
in file member.php, variable Member::$votes
    An array of vote-flags which this member has voted for
top

w

WriteFile
in file php-captcha.inc.php, method PhpCaptcha::WriteFile()
top

Documentation generated on Thu, 13 Nov 2008 18:14:32 +0900 by phpDocumentor 1.4.1