Index of all elements

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

a

$aCharSet: in file php-captcha.inc.php, variable PhpCaptcha::$aCharSet
$actions: in file adminActionsForms.php, variable adminActionsForms::$actions
An array of admin/moderator task details; the friendly name, the description, a sub-array of friendly parameter names indexed by parameter code-names, all indexed by the task/action's code-name.
$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.
$aFonts: in file php-captcha.inc.php, variable PhpCaptcha::$aFonts
$aLogsData: in file adminMultiFinder.php, variable adminMultiCheck::$aLogsData
Data from the user being checked which is used repeatedly
$army: in file drawMap.php, variable drawMap::$army
An array containing the army icon image resource, and its width and height.
$attackers: in file hold.php, variable adjHold::$attackers
The attackers which are attempting to dislodge this unit
$aUser: in file adminMultiFinder.php, variable adminMultiCheck::$aUser
The user being checked
$aUserID: in file adminMultiFinder.php, variable adminMultiCheck::$aUserID
The user ID being checked
$availablelocales: in file config.sample.php, variable Config::$availablelocales
Array of available locales
absolutePosition: in file drawMap.php, method drawMap::absolutePosition()
Convert a co-ordinate that points to where the center of an image should be placed, to a co-ordinate that points to where the top-left of an image should be placed.
activegames: in file findgames.php, method libFindGames::activegames()
Games the user could watch
addDependency: in file paradox.php, method adjParadoxException::addDependency()
Add a dependencyNode to the paradox chain. Will set $this->complete to true if the node is already contained in the paradox
addTerritoryNames: in file drawMap.php, method drawMap::addTerritoryNames()
Add the territory names, either with GD FreeType or with the small-map overlay
addUnit: in file drawMap.php, method drawMap::addUnit()
Draw a unit icon on the map
addWinnings: in file member.php, method processMember::addWinnings()
Add winnings to this member's user account. If the number of winnings is less than the amount bet the member may need to be refunded some points
adjConvoyChains: in file loadConvoyChains.php, class adjConvoyChains
Creates an array of convoy chains, starting with the starting unit and ending with the finishing coasts, with multiple routes if available etc. Will also remove broken convoys and set their units to having no path
adjConvoyMove: in file convoyMove.php, class adjConvoyMove
An army which is moving via convoy. Needs extra code to determine the path decision; must be able to traverse convoy chain, making sure not to throw a paradox exception until all routes are tried and failed (in the event of a paradox)
adjDependencyNode: in file dependencyNode.php, class adjDependencyNode
The main class behind paradox detection and the non-trivial stuff in the adjudicator.
adjHeadToHeadMove: in file move.php, class adjHeadToHeadMove
A unit engaging in a head to head move; only difference is its defense strength
adjHold: in file hold.php, class adjHold
A root class for adjudication; all units must defend, but only holding units use this class alone, others extend this
adjLoadUnits: in file diplomacy.php, function adjLoadUnits()
Load units into the units array, which is indexed by ID. Intended to make it easy to load each type of unit into the other units which need to be aware of them (loading units support holding someone into the unit being held). It is hacked together and not designed, but it does work
adjMove: in file move.php, class adjMove
A moving unit class
adjParadoxException: in file paradox.php, class adjParadoxException
A paradox exception; has to collect decisions at each point that it's thrown,
adjSupport: in file support.php, class adjSupport
A supporting unit; support hold and move have many similarities
adjSupportHold: in file support.php, class adjSupportHold
Support holding unit
adjSupportMove: in file support.php, class adjSupportMove
Support moving unit
adjudicate: in file game.php, method processGame::adjudicate()
Adjudicate; taking entered orders, converting them to moves, processing the moves, applying the results of the rules.
adjudicateDiplomacy: in file diplomacy.php, function adjudicateDiplomacy()
Adjudicate the diplomacy phase. Assumes moves have been loaded into the moves table. Requires nothing outside of the moves table.
adjudicatePreGame: in file pregame.php, function adjudicatePreGame()
Initialize the game (more of a phase change than adjudication). Will throw an exception if the game doesn't have enough players, which will be caught in gamemaster.php and result in the game's deletion
adjudicateRetreats: in file retreats.php, function adjudicateRetreats()
Adjudicate retreats orders: Fail retreats to the same place, everything else is fine
adjudicateUnitPlacing: in file unitplacing.php, function adjudicateUnitPlacing()
Adjudicate unit placing orders
adminActions.php: procedural page adminActions.php
adminActionsForms.php: procedural page adminActionsForms.php
adminActionsRestricted.php: procedural page adminActionsRestricted.php
adminLog.php: procedural page adminLog.php
adminMultiFinder.php: procedural page adminMultiFinder.php
adminStatusLists.php: procedural page adminStatusLists.php
adminActions: in file adminActions.php, class adminActions
This class gives the static information for moderator tasks, and the code which runs each task. The adminActionsForms class can use the static data to present forms for each task, and correctly pass the submitted form data to the right task code here.
adminActionsForms: in file adminActionsForms.php, class adminActionsForms
This class uses data about admin tasks, provided by child classes, to present a form for each task, send task parameters to the right task-code, and save the results in the admin log table.
adminActionsRestricted: in file adminActionsRestricted.php, class adminActionsRestricted
This class will enable adminActions moderator tasks to be performed, but also allow tasks which only admins should be able to perform.
admincp.php: procedural page admincp.php
adminMultiCheck: in file adminMultiFinder.php, class adminMultiCheck
This class manages a certain user's often used multi-account comparison data, as well as a list of users which are being compared to. $aUser is the first user, $bUser is the second, of which there will likely be several
adminStatusList: in file adminStatusLists.php, function adminStatusList()
Fill a named table from a single column query
aLogsDataCollect: in file adminMultiFinder.php, method adminMultiCheck::aLogsDataCollect()
Collect data aboue aUser from the AccessLogs which is useful for checking for multi-accounts, so that it can be saved in aLogsData and re-used for each bUserID checked against.
apply: in file diplomacy.php, method processOrderDiplomacy::apply()
Apply the adjudicated moves; move the actual units around and change the ownerships of territories etc
apply: in file unitplacing.php, method processOrderUnitPlacing::apply()
Apply the adjudicated moves; retreat/disband units as decided
apply: in file retreats.php, method processOrderRetreats::apply()
Apply the adjudicated moves; delete/create units as decided
archiveMoves: in file order.php, method processOrder::archiveMoves()
Save the current orders as the archive for the Game's current turn
archiveTerrStatus: in file game.php, method processGame::archiveTerrStatus()
Archive the TerrStatus data into the TerrStatusArchive table
assert_handler: in file error.php, function assert_handler()
attacked: in file support.php, method adjSupportHold::attacked()
attacked: in file support.php, method adjSupportMove::attacked()
attacked: in file support.php, method adjSupport::attacked()
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

top

b

$bCaseInsensitive: in file php-captcha.inc.php, variable PhpCaptcha::$bCaseInsensitive
$bCharShadow: in file php-captcha.inc.php, variable PhpCaptcha::$bCharShadow
$bet: in file member.php, variable Member::$bet
The amount the user bet into the game
$borderNodes: in file loadConvoyChains.php, variable adjConvoyChains::$borderNodes
$bUseColour: in file php-captcha.inc.php, variable PhpCaptcha::$bUseColour
$bUserIDs: in file adminMultiFinder.php, variable adminMultiCheck::$bUserIDs
The user IDs which the aUser is being checked against
banUser: in file adminActions.php, method adminActions::banUser()
begin: in file unitplacing.php, method userOrderUnitPlacing::begin()
begin: in file retreats.php, method userOrderRetreats::begin()
begin: in file order.php, method userOrder::begin()
A function which starts the textual order output
begin: in file diplomacy.php, method userOrderDiplomacy::begin()
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.
board.php: procedural page board.php

top

c

$cache

in file dependencyNode.php, variable adjDependencyNode::$cache
A cache; once a value is determined once it does not have to be determined again

$cacheRefresh

in file order.php, variable userOrder::$cacheRefresh
Set to true when new options are retrieved which need to be cached

$chainStart

in file convoyQuery.php, variable convoyQueryGame::$chainStart
The territory which this chain starts from

$coast

in file territory.php, variable Territory::$coast
Coast type: 'No','Parent','South','North'

$colors

in file drawMap.php, variable drawMap::$colors
Widely used colors

$commands

in file chatbox.php, variable libChatbox::$commands
A list of commands which players can run, e.g. /pause

$comment

in file user.php, variable User::$comment
The user-profile comment

$complete

in file paradox.php, variable adjParadoxException::$complete
true if the paradox is a full loop, ready to be resolved, false otherwise

$convoyChain

in file convoyMove.php, variable adjConvoyMove::$convoyChain
A convoy chain of dependency nodes. See the comments within checkChain() for the structure of convoyChain.

$convoys

in file loadConvoyChains.php, variable adjConvoyChains::$convoys

$convoyTerr

in file convoyQuery.php, variable convoyQueryConvoyTo::$convoyTerr
The territory where the convoying fleet is

$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

$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 hold.php, variable adjHold::$country
The country name of the unit

$countryColors

in file drawMap.php, variable drawMap::$countryColors
An array of colors for different countries, indexed by country name

$currentTurn

in file displayMap.php, variable displayMap::$currentTurn
The current turn in the game

$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

chatbox.php

procedural page chatbox.php

convoyQuery.php

procedural page convoyQuery.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

caption

in file drawMap.php, method drawMap::caption()
Write a caption; a large piece of text centered in the map

CaseInsensitive

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

changePhase

in file game.php, method processGame::changePhase()
Change the game's phase, by checking to see which phase this game should change to and calling setChange to do so. Game-overs are also checked for and responded to.

checkChain

in file convoyMove.php, method adjConvoyMove::checkChain()
A recursive function to check whether the convoy chain is a valid path. Returns true if the sub-chain does have a valid path to the destination, false if the sub-chain does not

checkGameOver

in file game.php, method processGame::checkGameOver()
Check to see if there's only one player left, or one player has all 18 supply centers. If so the game is declared game-over and points are distributed

checkInvalidOrders

in file datcGame.php, method datcGame::checkInvalidOrders()
Check whether any orders should have failed but didn't, or did fail but shouldn't have.

checkMembers

in file game.php, method processGame::checkMembers()
Check members to see if anyone has won, or if only one person remains, and to make people defeated/left where appropriate.

checkResults

in file datcGame.php, method datcGame::checkResults()
Check the Moves table to check that the right units Moved/Held/Got Dislodged

CIVILDISORDERID1

in file definitions.php, constant CIVILDISORDERID1

CIVILDISORDERID2

in file definitions.php, constant CIVILDISORDERID2

cleanRemaining

in file order.php, method userOrder::cleanRemaining()
If a requirement is updated which comes before other requirements which are already filled in the

cleanTerrStatus

in file game.php, method processGame::cleanTerrStatus()
Clean the active TerrStatus records to make room for the next turn

clearAccessLogs

in file adminActionsRestricted.php, method adminActionsRestricted::clearAccessLogs()

clearAdminLogs

in file adminActionsRestricted.php, method adminActionsRestricted::clearAdminLogs()

clearErrorLogs

in file adminActionsRestricted.php, method adminActionsRestricted::clearErrorLogs()

clearOrderLogs

in file adminActionsRestricted.php, method adminActionsRestricted::clearOrderLogs()

close

in file header.php, function close()

color

in file drawMap.php, method drawMap::color()
Create a color resource using an RGB array

colorTerritory

in file drawMap.php, method drawMap::colorTerritory()
Color a territory the color of a given country. This must be done before anything else is written to the image

compare

in file adminMultiFinder.php, method adminMultiCheck::compare()
Compares this class' aUser with one of its bUsers, and the data returned from the comparison makes it easy to tell if the two users are being played by the same player.

compareCookieCodeData

in file adminMultiFinder.php, method adminMultiCheck::compareCookieCodeData()

compareGames

in file adminMultiFinder.php, method adminMultiCheck::compareGames()

compareIPData

in file adminMultiFinder.php, method adminMultiCheck::compareIPData()

compareUserAgentData

in file adminMultiFinder.php, method adminMultiCheck::compareUserAgentData()

completeAll

in file retreats.php, method processOrderRetreats::completeAll()
Wipe all the incomplete orders.

completeAll

in file unitplacing.php, method processOrderUnitPlacing::completeAll()
Wipe all the incomplete orders.

completeAll

in file diplomacy.php, method processOrderDiplomacy::completeAll()
Wipe all the incomplete orders.

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

convoyFromTerrOptions

in file diplomacy.php, method userOrderDiplomacy::convoyFromTerrOptions()
Army occupied coasts which are linked by a convoy chain

convoyQuery

in file convoyQuery.php, class convoyQuery
This class tries to provide an internal interface to the child classes to let them easily string together queries which can find all matching convoy routes in one go using modifications to SQL instead of probably larger modifications to graph traversal algorithms in PHP.

convoyQueryConvoyFrom

in file convoyQuery.php, class convoyQueryConvoyFrom
Convoy

convoyQueryConvoyTo

in file convoyQuery.php, class convoyQueryConvoyTo
- Which Coasts Can I Convoy To

convoyQueryGame

in file convoyQuery.php, class convoyQueryGame
convoyQuery was previously intended for use in the adjudicator too, with another

convoyQueryMove

in file convoyQuery.php, class convoyQueryMove
Move

Start is a certain coast (with an army)
End is a coast

convoyQuerySupportMove

in file convoyQuery.php, class convoyQuerySupportMove
Support Move From

convoyToTerrOptions

in file diplomacy.php, method userOrderDiplomacy::convoyToTerrOptions()
Coasts which are convoy-accessible by the army we are convoying from, and which go through us

countMemberUnitsSCs

in file game.php, method processGame::countMemberUnitsSCs()
Count the units and supply centers of the members in this game.

countryFlag

in file drawMap.php, method drawMap::countryFlag()
Add a small square to a territory, colored according to a country's name.

create

in file diplomacy.php, method processOrderDiplomacy::create()
Create Diplomacy orders for the current game

create

in file unitplacing.php, method processOrderUnitPlacing::create()
Create Unit placing orders for the current game

create

in file game.php, method processGame::create()
Create a new game, insert it into the database, return the Game object.

Create

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

create

in file retreats.php, method processOrderRetreats::create()
Create Retreats orders for the current game

credits.php

procedural page credits.php

convoyMove.php

procedural page convoyMove.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.
$defender: in file move.php, variable adjMove::$defender
$dependencyChain: in file paradox.php, variable adjParadoxException::$dependencyChain
An array of 2 part arrays: array(array(dependencyNode, decisionName),array(dependencyNode, decisionName), [...])
$depth: in file convoyQuery.php, variable convoyQuery::$depth
The maximum number of tables in the query; the number of convoys + 2.
$dislodged: in file loadConvoyChains.php, variable adjConvoyChains::$dislodged
diplomacy.php: procedural page diplomacy.php
Database: in file database.php, class Database
A MySQL DB interaction object.
DATC: in file map.php, constant DATC
datcGame.php: procedural page datcGame.php
datc.php: procedural page datc.php
datcGame: in file datcGame.php, class datcGame
This is the DATC test game class, which sets the game up, gets it ready for the orders to be entered via OrderInterface, then checks the orders and adjudicates and checks the game.
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
deCoastCompare: in file database.php, method Database::deCoastCompare()
Generate the SQL needed to compare a coastal territory column to non-coastal territory column
defenderMoving: in file move.php, method adjMove::defenderMoving()
dependencyChainToUnitChain: in file paradox.php, method adjParadoxException::dependencyChainToUnitChain()
Convert the chain of array(dependencyNode, decision) to a simple array of dependencyNodes involved in the paradox, and return it
detectParadox: in file dependencyNode.php, method adjDependencyNode::detectParadox()
Check whether we are already evaluating this decision, and have come full circle.
developers.php: procedural page developers.php
displayMap: in file displayMap.php, class displayMap
A class to handle the mapstore map cache; map sure it's up to date, show the current map lists to
DisplayShadow: in file php-captcha.inc.php, method PhpCaptcha::DisplayShadow()
distributeWinnings: in file game.php, method processGame::distributeWinnings()
Distribute winnings among players, in the context of having a winner just won the game. There may be players who deserve a slice of the pot, or there may be players who left but weren't taken over and now deserve a refund.
downSizeTo: in file paradox.php, method adjParadoxException::downSizeTo()
If the paradoxException given is smaller than this one then this one will clone the paradoxException given. If this is greater than or equal to the paradoxException given then nothing will happen
draw: in file game.php, method processGame::draw()
Draw the game; archive the terrstatus and moves, delete active data, set members to drawn
DrawCharacters: in file php-captcha.inc.php, method PhpCaptcha::DrawCharacters()
drawConvoy: in file drawMap.php, method drawMap::drawConvoy()
Draw a convoy arrow
drawCreatedUnit: in file drawMap.php, method drawMap::drawCreatedUnit()
Draws a small star where a unit has been created, drawn to the upper right of the new unit
drawCross: in file drawMap.php, method drawMap::drawCross()
Draw a cross
drawDestroyedUnit: in file drawMap.php, method drawMap::drawDestroyedUnit()
Draws an orange explosion where a unit has been destroyed, intended to be drawn on-top of the unit
drawDislodgedUnit: in file drawMap.php, method drawMap::drawDislodgedUnit()
Draws a small orange explosion where a unit has been dislodged, drawn to the upper right of the unit which took the place of the dislodged unit
drawFailure: in file drawMap.php, method drawMap::drawFailure()
Draw an arrow marker indicating that an order failed
drawGame: in file adminActions.php, method adminActions::drawGame()
DrawLines: in file php-captcha.inc.php, method PhpCaptcha::DrawLines()
drawMap: in file drawMap.php, class drawMap
Draws a map based on the instructions it recieves. Typically takes arguments like orders, territory names and country, and draws that onto the map image. Will write to a given filename once finished
drawMove: in file drawMap.php, method drawMap::drawMove()
Draw a move arrow
drawOrderArrow: in file drawMap.php, method drawMap::drawOrderArrow()
Draw an order's arrow, given the stand and end coordinates and the type of order
DrawOwnerText: in file php-captcha.inc.php, method PhpCaptcha::DrawOwnerText()
drawPolygon: in file drawMap.php, method drawMap::drawPolygon()
Draw a polygon to a certain color
drawRetreat: in file drawMap.php, method drawMap::drawRetreat()
Draw a retreat arrow
drawStandoff: in file drawMap.php, method drawMap::drawStandoff()
Draw a standoff icon on the map
drawSupportHold: in file drawMap.php, method drawMap::drawSupportHold()
Draw a support hold arrow
drawSupportMove: in file drawMap.php, method drawMap::drawSupportMove()
Draw a support move arrow
drawText: in file drawMap.php, method drawMap::drawText()
Draw text on the map
DYNAMICSRV: in file definitions.php, constant DYNAMICSRV
dependencyNode.php: procedural page dependencyNode.php
diplomacy.php: procedural page diplomacy.php
diplomacy.php: procedural page diplomacy.php
definitions.php: procedural page definitions.php
developers.php: procedural page developers.php
displayMap.php: procedural page displayMap.php
drawMap.php: procedural page drawMap.php
database.php: procedural page database.php

top

e

$email: in file user.php, variable User::$email
E-mail address
easycaptcha.php: procedural page easycaptcha.php
endNodeHaving: in file convoyQuery.php, method convoyQuery::endNodeHaving()
Adds a HAVING expression which targets the end-node.
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()
execute: in file convoyQuery.php, method convoyQuery::execute()
Run the query, collect the results from the chain table
error.php: procedural page error.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)
$finalized: in file member.php, variable Member::$finalized
Whether or not the user has finalized
$fixed: in file order.php, variable userOrder::$fixed
An array of requirements/attributes which are fixed for the given phase type.
$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
$fleet: in file drawMap.php, variable drawMap::$fleet
An array containing the fleet icon image resource, and its width and height.
$font: in file drawMap.php, variable drawMap::$font
['path']=>path to font file, ['size']=>font point size, ['color']=>font color
$formTicket: in file user.php, variable User::$formTicket
Form-ticket to prevent users from submitting the same form twice
$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
FACEBOOK: in file definitions.php, constant FACEBOOK
fakeUserMembers: in file datcGame.php, method datcGame::fakeUserMembers()
Create fake userMember objects, so that OrderInterface can be used to mass-set orders
fakeUserOrderSubmission: in file datcGame.php, method datcGame::fakeUserOrderSubmission()
Create an $orderForm array and set it to $_REQUEST, so userOrder thinks the users are
faq.php: procedural page faq.php
findbUserIDs: in file adminMultiFinder.php, method adminMultiCheck::findbUserIDs()
If no bUserIDs were given on construction some users to be checked against have to be found. This is done by finding cookie-code and IP matches, resulting in bUserIDs being set.
finishedgames: in file findgames.php, method libFindGames::finishedgames()
Games which are finished, but the user is not a member of
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.
form: in file adminMultiFinder.php, method adminMultiCheck::form()
Print a form for selecting which user to check, and which users to check against
form: in file adminActionsForms.php, method adminActionsForms::form()
Create a new AdminLog entry so the admin/moderator action just performed can be viewed by others.
form: in file order.php, method userOrder::form()
Return a segment of a form allowing a user to input an order. This function also validates and stores new input as it goes.
formOptionsHTML: in file order.php, method userOrder::formOptionsHTML()
This function creates a drop down HTML menu containing a list of available options.
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.
formTicket: in file member.php, method userMember::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.
fromTerrOptions: in file diplomacy.php, method userOrderDiplomacy::fromTerrOptions()
fromTerrText: in file diplomacy.php, method userOrderDiplomacy::fromTerrText()
findgames.php: procedural page findgames.php
faq.php: procedural page faq.php

top

g

$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 displayMap.php, variable displayMap::$gameID
The game ID of the game who's map is being displayed
$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
$gameID: in file convoyQuery.php, variable convoyQueryGame::$gameID
The game ID
$gameMasterSecret: in file config.sample.php, variable Config::$gameMasterSecret
This is used to authenticate the cron process which will run the gamemaster script.
$gameOver: in file game.php, variable Game::$gameOver
The conditions under which the game ended; 'Won', 'No', 'Drawn'
$getqueries: in file database.php, variable Database::$getqueries
$gmtOffset: in file user.php, variable User::$gmtOffset
GMT offset, in seconds
Game: in file game.php, class Game
Prints data on a game, and loads and manages the collections of members which this game contains.
gamecreate.php: procedural page gamecreate.php
gamelistings.php: procedural page gamelistings.php
game.php: procedural page game.php
gamemaster.php: procedural page gamemaster.php
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.
gameovertxt: in file game.php, method Game::gameovertxt()
A textual representation of the game over conditions
GenerateCode: in file php-captcha.inc.php, method PhpCaptcha::GenerateCode()
getChain: in file loadConvoyChains.php, method adjConvoyChains::getChain()
getConvoyChains: in file loadConvoyChains.php, method adjConvoyChains::getConvoyChains()
getConvoys: in file loadConvoyChains.php, method adjConvoyChains::getConvoys()
getMessages: in file chatbox.php, method libChatbox::getMessages()
Retrieve and parse the messages which have been sent via this tab into an HTML table
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
giveModerator: in file adminActionsRestricted.php, method adminActionsRestricted::giveModerator()
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
gamemessage.php: procedural page gamemessage.php
gamecreate.php: procedural page gamecreate.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
hold.php: procedural page hold.php
halloffame.php: procedural page halloffame.php
having: in file convoyQuery.php, method convoyQuery::having()
A having clause, usually used to add restrictions to all nodes, or specifically the end node.
having: in file convoyQuery.php, method convoyQuerySupportMove::having()
At the end is the army which we are supporting
having: in file convoyQuery.php, method convoyQueryConvoyTo::having()
Basically it's the same as moving from the territory where the unit being convoyed, except it has to have the desired fleet within the path
having: in file convoyQuery.php, method convoyQueryMove::having()
The end has to be a coast, but other than that it's no different from a normal chain
header.php: procedural page header.php
help.php: procedural page help.php
html: in file displayMap.php, method displayMap::html()
Returns the HTML for the map, history scroll arrows, large-map maximization button, and history scroll JS It will also create the map list if it doesn't exist
html: in file order.php, method userOrder::html()
Return the object's HTML for either a form() or text() request. This function also covers most of the procedure followed by userOrder; moving from type requirement to more specific requirements, and organizing the caching once the updates have finished coming.
html.php: procedural page html.php
help.php: procedural page help.php

top

i

$id: in file loadConvoyChains.php, variable adjConvoyChains::$id
$id: in file order.php, variable order::$id
The order ID
$id: in file unit.php, variable Unit::$id
Unit ID
$id: in file user.php, variable User::$id
User ID
$id: in file hold.php, variable adjHold::$id
The unit ID
$id: in file member.php, variable Member::$id
The member ID
$id: in file game.php, variable Game::$id
The game ID
$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
$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
$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
imagelinethick: in file drawMap.php, method drawMap::imagelinethick()
Draw a line
index.php: procedural page index.php
initialize: in file datcGame.php, method datcGame::initialize()
Initialize the test; load units, load map, create orders, load orders
intro.php: procedural page intro.php
invite.php: procedural page invite.php
IN_CODE: in file easycaptcha.php, constant IN_CODE
isComplete: in file order.php, method order::isComplete()
Return true if the order is complete, false otherwise
isConvoyParadox: in file paradox.php, method adjParadoxException::isConvoyParadox()
Determine whether the array of dependencyNodes passed to this function constitures a convoy paradox
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
isMoveChain: in file paradox.php, method adjParadoxException::isMoveChain()
Determine whether the array of dependencyNodes passed to this function consititutes a move chain paradox.
is_valid_email_address: in file auth.php, method libAuth::is_valid_email_address()
##################################################################################
intro.php: procedural page intro.php

top

j

join: in file game.php, method processGame::join()
Allow the user to join a game. The User must have enough points, the Game must be
join: in file convoyQuery.php, method convoyQuery::join()
Joins the node() and link() elements via a series of LEFT JOINs, and tracks the nodes used so far in an array, to create the SQL for defining and linking all of the nodes.
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
$length: in file paradox.php, variable adjParadoxException::$length
How many decisions are contained in this dependency chain? This is important because when considering paradoxes the shortest dependency chain is the one which must be considered.
$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.
loadConvoyChains.php: procedural page loadConvoyChains.php
lastLoggedInTxt: in file member.php, method Member::lastLoggedInTxt()
A textual display of this user's last log-in 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
libChatbox: in file chatbox.php, class libChatbox
The chat-box for the board. From the tabs to the messages to the send-box, also takes responsibility for sending any messages it recieves.
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
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
lineAngle: in file drawMap.php, method drawMap::lineAngle()
Convert two X,Y coordinates representing an arrow into an angle in radians, to allow use of the rotate function which requires radians are measured based on facing right being 0 Rad. Clockwise is positive
link: in file convoyQuery.php, method convoyQuery::link()
The SQL to add per "link" between nodes. Has to link each node to the next one
link: in file convoyQuery.php, method convoyQuerySupportMove::link()
link: in file convoyQuery.php, method convoyQueryGame::link()
load: in file order.php, method userOrder::load()
Load different orders depending on the current phase
load: in file user.php, method User::load()
Load the User object class fields. It is assumed that username is already escaped.
load: in file game.php, method Game::load()
Reload the variables which are stored within this object specificially, ie everything
loadColors: in file drawMap.php, method drawMap::loadColors()
Initialize the RGB color arrays into proper GD color resources
loadFont: in file drawMap.php, method drawMap::loadFont()
Load the $this->font array
loadImage: in file drawMap.php, method drawMap::loadImage()
Load a particular image resource and measure its width and length
loadImages: in file drawMap.php, method drawMap::loadImages()
Load all the image resources required, and measure their width and length
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.
loadOptions: in file order.php, method userOrder::loadOptions()
Because the order option generating queries are quite large, and run very frequently, the order options are cached into session vars. This can save a lot of redundant complex queries.
loadOrderArrows: in file drawMap.php, method drawMap::loadOrderArrows()
Set up colors, filter out settings for a different smallmap setting:
loadOrders: in file datcGame.php, method datcGame::loadOrders()
Load the clean orders into an orders array, so that it can be used to fake order submission
loadOrders: in file member.php, method userMember::loadOrders()
Reload $this->Orders[] from the database
loadTerritories: in file drawMap.php, method drawMap::loadTerritories()
Load the $this->territoryPositions array
loadUnits: in file datcGame.php, method datcGame::loadUnits()
Load units into the game from the DATC tables. The only data that's directly loaded from
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
logRawOrders: in file orderinterface.php, method OrderInterface::logRawOrders()
Log $_REQUEST['orderLog'], to resolve complaints about potentially mistaken orders being entered

top

m

$map: in file drawMap.php, variable drawMap::$map
An array containing the map image resource, and its width and height.
$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
$messagesperpage: in file config.sample.php, variable Config::$messagesperpage
The maximum number of messages displayed on the forum; 50 should be fine.
member.php: procedural page member.php
move.php: procedural page move.php
member.php: procedural page member.php
message.php: procedural page message.php
makeBet: in file game.php, method processGame::makeBet()
Makes a user deposit a certain number of points into this game. Throws an exception if the user doesn't have enough Uses an UPDATE lock on the users column to prevent simultaneous bets
makeDonator: in file adminActions.php, method adminActions::makeDonator()
map.php: procedural page map.php
mapFilename: in file displayMap.php, method displayMap::mapFilename()
Returns the filename of the game's map for the given turn
mapFolder: in file displayMap.php, method displayMap::mapFolder()
Will return the location of this game's map folder relative to the current directory, and create it if it doesn't exist
mapListLocation: in file displayMap.php, method displayMap::mapListLocation()
Get the location of the map list for this game
mapLocation: in file displayMap.php, method displayMap::mapLocation()
Returns the URL of the map for the current game and the given turn. If the map file doesn't exist the map.php link will be given which will generate the map file
mapPrepare: in file datcGame.php, method datcGame::mapPrepare()
Prepare the database for a map to be drawn; archive the moves, save the standoffs, update owners and archive them,
maximumConvoys: in file convoyQuery.php, method convoyQueryGame::maximumConvoys()
This function will determine the maximum possible length of a convoy chain in this game, so that only the required number of tables are joined
measureLength: in file paradox.php, method adjParadoxException::measureLength()
Count upwards through the decision stack to find how many decisions were traversed down to reach this potential paradox
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
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)
message: in file game.php, method processGame::message()
Send a message regarding the game, eg "You win, you lose, draw, not enough players." Messages sent to the forum as a bulletin
modetxt: in file game.php, method Game::modetxt()
The Game's phase in textual format
moveToTerrOptions: in file diplomacy.php, method userOrderDiplomacy::moveToTerrOptions()
Movable territories, and if Unit is an army also include adjacent fleets in the sea
msg_escape: in file database.php, method Database::msg_escape()
Sanitize incoming strings, leaving newlines. Suitable for messages.
member.php: procedural page member.php

top

n

$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.
$nodeNames: in file convoyQuery.php, variable convoyQuery::$nodeNames
An array of node names for all the possible convoys which could be in a chain. Needed to each can be referred to
$nodesSoFar: in file convoyQuery.php, variable convoyQuery::$nodesSoFar
The node names of the nodes which have been done so far.
$numericCalls: in file dependencyNode.php, variable adjDependencyNode::$numericCalls
An array of decisions which are numeric
nonInteractive.php: procedural page nonInteractive.php
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
node: in file convoyQuery.php, method convoyQueryGame::node()
node: in file convoyQuery.php, method convoyQuery::node()
The SQL to add per "node", because each node will link 3 or so tables
nodeSelect: in file convoyQuery.php, method convoyQueryGame::nodeSelect()
Node-column columns
nodeSelect: in file convoyQuery.php, method convoyQuery::nodeSelect()
The SELECT columns for each node. Each node may choose multiple columns to allow it to filter using the HAVING clause, but only the first column that each node specifies will be returned in the final results.
nodeSelect: in file convoyQuery.php, method convoyQuerySupportMove::nodeSelect()
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.
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

$oImage: in file php-captcha.inc.php, variable PhpCaptcha::$oImage
$online: in file user.php, variable User::$online
Is this user online?
$online: in file member.php, variable Member::$online
Whether this member is online or not
$options: in file order.php, variable userOrder::$options
This array saves the options for each requirement encountered in the order so far via $_SESSION variables, to cut down the number of costly queries required. This means options are usually only generated once, instead of every time they're seen.
$orderArrows: in file drawMap.php, variable drawMap::$orderArrows
An array of different arrow parameters; colors, thicknesses etc, for arrows representing different orders
$Orders: in file datcGame.php, variable datcGame::$Orders
Storage space for the order objects for each of the members
$Orders: in file member.php, variable userMember::$Orders
An aggregate array of userOrders to be used by OrderInterface
order.php: procedural page order.php
orderinterface.php: procedural page orderinterface.php
orderText.php: procedural page orderText.php
order.php: procedural page order.php
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
OrderInterface: in file orderinterface.php, class OrderInterface
Prints the table of orders, and finalizes users as necessary. As orders are printed they are entered and validated
ordersForm: in file orderinterface.php, method OrderInterface::ordersForm()
Display the board users form, for updating, finalizing, and reading current orders.
ordersTable: in file orderinterface.php, method OrderInterface::ordersTable()
Print a table of the current Member's orders. If finalized print text, if not finalized print drop-down lists where available
output: in file chatbox.php, method libChatbox::output()
Output the chatbox HTML; output the tabs, then the information about the player we're talking to, then the correspondance we have with the current msgCountry at the moment, then the post-box for new messages we want to send
outputTabs: in file chatbox.php, method libChatbox::outputTabs()
Output the tabs which go on top of the chat-box, along with online notifications and message notifications
outputTest: in file datcGame.php, method datcGame::outputTest()
Output the test orders and success criteria

top

p

$password: in file user.php, variable User::$password
MD5 (salted) password hex encoded
$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
$points: in file user.php, variable User::$points
Number of available points
$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
$preventers: in file move.php, variable adjMove::$preventers
$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
$putqueries: in file database.php, variable Database::$putqueries
php-captcha.inc.php: procedural page php-captcha.inc.php
paradox.php: procedural page paradox.php
pregame.php: procedural page pregame.php
points.php: procedural page points.php
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.
paradoxForce: in file dependencyNode.php, method adjDependencyNode::paradoxForce()
An interface to allow adjParadoxException to force a decision by editing the cache, so that paradoxes can be resolved
pauseGame: in file adminActions.php, method adminActions::pauseGame()
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
points.php: procedural page points.php
pointsPerSupplyCenter: in file game.php, method Game::pointsPerSupplyCenter()
Calculate the points value of a single supply center in this game
polygonMap: in file drawMap.php, method drawMap::polygonMap()
Return an array of coordinates for an n sided symmetrical polygon, which has 0,0 at its center.
prebody: in file html.php, method libHTML::prebody()
The first HTML to be output; the various header tags, before anything is visible
preGameMap: in file displayMap.php, method displayMap::preGameMap()
Returns an <img> link to the pre-game start map with logo
prepare: in file convoyQuery.php, method convoyQuery::prepare()
Prepare the query
prepare: in file chatbox.php, method libChatbox::prepare()
Prepare the chat-box; Update the tab we're looking at, set messages from the current user to seen if there were any unseen previously, and send any messenges which we sent
printCheckSummary: in file adminMultiFinder.php, method adminMultiCheck::printCheckSummary()
Print a summary of the check which is about to be performed
printDataComparison: in file adminMultiFinder.php, method adminMultiCheck::printDataComparison()
Check a single data-type from aUser with the same data-type from one of the bUsers.
printTimeDataRow: in file adminMultiFinder.php, method adminMultiCheck::printTimeDataRow()
process: in file adminActionsForms.php, method adminActionsForms::process()
For the given task display the form, and run the task if data entered from the corresponding form
process: in file game.php, method processGame::process()
Process; the main gamemaster function for managing games; processes orders, adjudicates them,
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.
processGame: in file game.php, class processGame
This class creates games, joins players up to games, manages the passing of games from phase to phase, decides when they're over and allocates points when they are, etc. It is the most general part of the gamemaster, just about all game manipulation occurs within this class.
processMember: in file member.php, class processMember
This class deals with changing the status of a member of a certain game, including the giving of winnings or refunds.
processOrder: in file order.php, class processOrder
Performs a few game processing order related tasks. Mainly just a wrapper for SQL to process orders
processOrderDiplomacy: in file diplomacy.php, class processOrderDiplomacy
Converts & sanitizes orders to moves for processing, then performs the actions based on the results of the processed moves, and also creates new moves
processOrderRetreats: in file retreats.php, class processOrderRetreats
Converts & sanitizes orders to moves for processing, then performs the actions based on the results of the processed moves, and also creates new moves
processOrderUnitPlacing: in file unitplacing.php, class processOrderUnitPlacing
Converts & sanitizes orders to moves for processing, then performs the actions based on the results of the processed moves, and also creates new moves
processRequirement: in file order.php, method userOrder::processRequirement()
Generate options for, check for updates for, update, and return the text/HTML for, a specific requirement. If new options are retrieved $this->cacheRefresh is set to true
processTimetxt: in file game.php, method Game::processTimetxt()
Return the next process time in textual format, in terms of time remaining
profile.php: procedural page profile.php
profile_link: in file member.php, method Member::profile_link()
Generate a profile link
profile_link: in file user.php, method User::profile_link()
Return a profile link for this user
putImage: in file drawMap.php, method drawMap::putImage()
Put the given image array into the given position

top

q

$query: in file convoyQuery.php, variable convoyQuery::$query
The query, ready to be executed after running prepare

top

r

$requirements: in file order.php, variable userOrder::$requirements
An array of requirements; Type is chosen, and this selects the sub-array of further requirements which need to be filled to complete the order.
retreats.php: procedural page retreats.php
retreats.php: procedural page retreats.php
retreats.php: procedural page retreats.php
register.php: procedural page register.php
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
reprocessGame: in file adminActionsRestricted.php, method adminActionsRestricted::reprocessGame()
resetPass: in file adminActions.php, method adminActions::resetPass()
resolve: in file paradox.php, method adjParadoxException::resolve()
Resolve the paradox, by applying special logic. Move chains all result in a successful move, convoy paradoxes are resolved using the Szykman rule, which states that the unit being convoyed is unsuccessful, and has no influence over the territory it is being convoyed to.
rotate: in file drawMap.php, method drawMap::rotate()
Rotate an array of coordinates around a central point. The array of coordinates
runCommand: in file chatbox.php, method libChatbox::runCommand()
Run a chatbox command, e.g. /pause. Even if all votes for e.g. a pause go through the gamemaster will process the pause, it won't happen here.

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.
$sCode: in file php-captcha.inc.php, variable PhpCaptcha::$sCode
$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)
$sFileType: in file php-captcha.inc.php, variable PhpCaptcha::$sFileType
$smallmap: in file drawMap.php, variable drawMap::$smallmap
True if we are displaying a small map, false otherwise
$smallMapNames: in file drawMap.php, variable drawMap::$smallMapNames
An array containing the smallmap territory names overlay image resource, and its width and height.
$smallMapX: in file territory.php, variable Territory::$smallMapX
Small map x coordinate
$smallMapY: in file territory.php, variable Territory::$smallMapY
Small map y coordinate
$sOwnerText: in file php-captcha.inc.php, variable PhpCaptcha::$sOwnerText
$standoff: in file drawMap.php, variable drawMap::$standoff
An array containing the standoff icon image resource, and its width and height.
$status: in file member.php, variable Member::$status
The member status; 'Playing','Left','Defeated'
$statusimg: in file user.php, variable User::$statusimg
The status green icon, will be present here if this user is online
$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
$supporters: in file hold.php, variable adjHold::$supporters
The units which are potentially supporting this unit
$supporting: in file support.php, variable adjSupportMove::$supporting
$supportingFrom: in file convoyQuery.php, variable convoyQuerySupportMove::$supportingFrom
The territory which the unit is SUPPORTING from.
support.php: procedural page support.php
save: in file adminActionsForms.php, method adminActionsForms::save()
Create a new AdminLog entry so the admin/moderator action just performed can be viewed by others.
saveOptions: in file order.php, method userOrder::saveOptions()
Save the options in $this->options into the session var
seen: in file member.php, method userMember::seen()
Register that you have viewed the messages from a certain country and no longer need notification of them
select: in file convoyQuery.php, method convoyQuery::select()
The select clause; the required info is specified by children with nodeSelect()
send: in file gamemessage.php, method libGameMessage::send()
Send a game message. Messages are sanitized
send: in file message.php, method Message::send()
Send a message to the public forum. The variables passed are assumed to be already sanitized
serve: in file displayMap.php, method displayMap::serve()
Output the map for the current game and turn directly to the browser from the disk. The script ends here
set: in file order.php, method userOrder::set()
Set an order variable, both in the object and in the database. Load up a new object corresponding to the input if required. If value doesn't evaluate to true the order variable is wiped, as is the corresponding object.
SetBackgroundImages: in file php-captcha.inc.php, method PhpCaptcha::SetBackgroundImages()
SetCharSet: in file php-captcha.inc.php, method PhpCaptcha::SetCharSet()
setDefeated: in file member.php, method processMember::setDefeated()
Set the player as defeated, give a refund if necessary.
setDrawn: in file member.php, method processMember::setDrawn()
Set the player's status to Drawn, give them their equal share of the winnings, if they survived
setDrawn: in file game.php, method processGame::setDrawn()
Set this game as drawn, split the pot evenly among the survivors and send them a message
SetFileType: in file php-captcha.inc.php, method PhpCaptcha::SetFileType()
SetHeight: in file php-captcha.inc.php, method PhpCaptcha::SetHeight()
setLeft: in file member.php, method processMember::setLeft()
The user has left the game and can be taken over by other players, however he hasn't completely left, so he can't yet be refunded.
setLeftAndFinished: in file member.php, method processMember::setLeftAndFinished()
A player survived, but had left, so they don't get a share of the pot, but they do get their refund now if they are due one.
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()
setPhase: in file game.php, method processGame::setPhase()
Set the next phase for this game, update the phase and turn forward where applicable
setStatus: in file member.php, method processMember::setStatus()
Update the player's status
setSurvived: in file member.php, method processMember::setSurvived()
The player didn't win, but survived. Maybe they got nothing in a WTA game, maybe they won.
setTakenOver: in file member.php, method processMember::setTakenOver()
A user which left has been taken over, and should be refunded now if necessary
setTransparancies: in file drawMap.php, method drawMap::setTransparancies()
Make various images have transparent areas
setTransparancy: in file drawMap.php, method drawMap::setTransparancy()
Make a particular image transparent
setUnits: in file convoyMove.php, method adjConvoyMove::setUnits()
A recursive function to import the unit objects into the chain array which is otherwise full of IDs
setUnits: in file hold.php, method adjHold::setUnits()
Import supporter and attacker units
setUnits: in file support.php, method adjSupportMove::setUnits()
setUnits: in file move.php, method