Difference between revisions of "Design Document PHP Coding Details"

From BOARD18 Project WIKI
Jump to navigation Jump to search
(Initial version of this page)
 
(→‎changePlayers.php: initial contents)
Line 4: Line 4:
An oveview discussion of these programs is available [[Design_Document_Server_Side_Overview#AJAX_Called_Programs|here]].
An oveview discussion of these programs is available [[Design_Document_Server_Side_Overview#AJAX_Called_Programs|here]].
===changePlayers.php===
===changePlayers.php===
changePlayers.php is the server side code for the
AJAX changePlayers call. This program adds and/or
removes players from existing game sessions.
Inputs:
  mode - A string with a value of '1', '2' or '3'.
          1 - Remove player with login ID in prem.
          2 - Add player with login ID in padd.
          3 - Take both of the above actions.
  game - game_id of current game.
  prem - Login ID of the player to be removed from the game.
  padd - Login ID of the player to be added to the game. 
Output is an echo return status of either "success", "fail" or "dupadd".
===createGame.php===
===createGame.php===
===emailPlayerAdd.php===
===emailPlayerAdd.php===

Revision as of 09:35, 15 December 2013

Design Document edit


This page has details of all of the PHP files that are described in the Server Side Overview. The origional description for each file has been taken from the comments at the top of the file in question. While creating this page I will also be bringing these comments in line with these Standards.

AJAX Called Programs

An oveview discussion of these programs is available here.

changePlayers.php

changePlayers.php is the server side code for the AJAX changePlayers call. This program adds and/or removes players from existing game sessions.

Inputs:

  mode - A string with a value of '1', '2' or '3'.
         1 - Remove player with login ID in prem.
         2 - Add player with login ID in padd.
         3 - Take both of the above actions.
  game - game_id of current game.
  prem - Login ID of the player to be removed from the game.
  padd - Login ID of the player to be added to the game.  

Output is an echo return status of either "success", "fail" or "dupadd".

createGame.php

emailPlayerAdd.php

emailPlayerRem.php

emailPlayerID.php

emailPassword.php

forcePasswd.php

gameBox.php

gameSession.php

logout.php

myGameList.php

newUser.php

updateGame.php

updateUser.php

validateUser.php

Include Modules

An oveview discussion of these modules is available here.

auth.php

configMail.php

config.php

sendEmail.php

makeTables.php


This page is a stub.
The BOARD18 Project will soon be expanding it.