Design Document For DRAFT1846

From BOARD18 Project WIKI
Revision as of 13:55, 27 October 2020 by Rich (talk | contribs) (DRAFT1846 Logic Flow)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
DraftFlow.png

Introduction

DRAFT1846 has been designed to look and feel as much like BOARD18 as possible.

This means that a couple of the sections of the BOARD18 design document can be applied, for the most part, directly to DRAFT1846.

These sections are:

DRAFT1846 is a multi page email driven application. With two exceptions, emails are always used to pass control between pages.
The exceptions are the DRAFT1846Start page which is directly executed by the index.html page and the DRAFT1846Goodby page which is used as an exit mechanism by most of the other pages.

DRAFT1846 Logic Flow

The diagram to the right shows a simplified version of the control flow between the DRAFT1846 pages.
Note that though many details have been omitted from this diagram, it is still generally correct.

This section contains a link to a WIKI page describing in detail each DRAFT1846 page.
Each such WIKI page list all of the functions contained in that DRAFT1846 page.
The last link below points to a WIKI page describing a repository of common functions.

DRAFT1846 Server Side

The server side processing for DRAFT1846 is done in stand alone PHP programs that are executed from these web pages via AJAX calls.
Below is a link to a WIKI page containing descriptions of each of these PHP programs.

DRAFT1846 Server Side Programs

Database Structure

The DRAFT1846 database is structured as follows:

 
mysql> show columns from draft_table;
+---------------+------------------+------+-----+-------------------+-----------------------------+
| Field         | Type             | Null | Key | Default           | Extra                       |
+---------------+------------------+------+-----+-------------------+-----------------------------+
| draft_id      | int(11) unsigned | NO   | PRI | NULL              | auto_increment              |
| draft         | text             | YES  |     | NULL              |                             |
| activity_date | timestamp        | NO   |     | CURRENT_TIMESTAMP | on update CURRENT_TIMESTAMP |
+---------------+------------------+------+-----+-------------------+-----------------------------+
3 rows in set (0.00 sec)

The draft field is a text string containing the stringafied JSON data object as shown below.

JSON Data Object

This object contains all of the information about a given draft except for the Draft ID.
It is stored in the table as a stringified json object called draft and appears to javascript as nested array.
The sample object below has just been created by logic on the draft1846Start page.

Click here to access a detailed description of this JSON Data Object

 
array (
  'status' => 'Pending',
  'updtCount' => 1,
  'numbPlayers' => 3,
  'curPlayer' => 1,
  'cpd' => 0,
  'deck' => 
  array (
    0 => 'Chicago and W. Indiana',
    1 => 'Blank Card',
    2 => 'Mail Contract',
    3 => 'Michigan Southern',
    4 => 'Ohio and Indiana',
    5 => 'Tunnel Blasting Co.',
    6 => 'Blank Card',
    7 => 'Blank Card',
    8 => 'Big 4',
  ),
  'hand' => 
  array (
  ),
  'players' => 
  array (
    0 => 
    array (
      'name' => 'rich3',
      'email' => 'richpri46@gmail.com',
      'confirmed' => 'No',
      'cash' => 400,
      'privates' => 
      array (
      ),
      'urlKey' => '00271U01D3ZC',
    ),
    1 => 
    array (
      'name' => 'rich2',
      'email' => 'richpri46@gmail.com',
      'confirmed' => 'No',
      'cash' => 400,
      'privates' => 
      array (
      ),
      'urlKey' => '00272X00VJ71',
    ),
    2 => 
    array (
      'name' => 'rich1',
      'email' => 'richpri46@gmail.com',
      'confirmed' => 'No',
      'cash' => 400,
      'privates' => 
      array (
      ),
      'urlKey' => '0027373K05DF',
    ),
  ),
)