Design Document For DRAFT1846 - Revision history

Rich: /* DRAFT1846 Logic Flow */

2020-10-27T21:55:52Z

DRAFT1846 Logic Flow

← Older revision		Revision as of 21:55, 27 October 2020
Line 14:		Line 14:
	== DRAFT1846 Logic Flow ==		== DRAFT1846 Logic Flow ==
	The diagram to the right shows a simplified version of the control flow between the DRAFT1846 pages. <br>		The diagram to the right shows a simplified version of the control flow between the DRAFT1846 pages. <br>
	Note that though many details ~~(and one page)~~ have been omitted from this diagram, it is still generally correct.		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. <br>		This section contains a link to a WIKI page describing in detail each DRAFT1846 page. <br>

Rich: removed key/value stuff to a separate page

2020-05-24T17:29:41Z

removed key/value stuff to a separate page

← Older revision		Revision as of 17:29, 24 May 2020
Line 116:		Line 116:
	)		)
	</pre>		</pre>

	~~== draft key/value pairs ==~~
	~~The "draft" database table column is a stringified JSON structure.<br>~~
	~~This structure contains key/value pairs that are each explained here.<br>~~

	~~=== The status key/value pair ===~~
	~~The status value is a text string used to track the progress of the draft.<br>~~
	~~It can have any one of these 5 values:~~
	~~#Pending: Still waiting for at least one player to confirm.~~
	~~#Confirmed: All players have confirmed their email addresses.~~
	~~#Active: The draft is active and more than one card is left.~~
	~~#Last: The last remaining private is being processed.~~
	~~#Done: The draft is completed.~~

	~~=== The updtCount key/value pair ===~~
	~~The updtCount value is an integer used to support a week version of optimistic database locking.~~

	~~=== The numbPlayers key/value pair ===~~
	~~The numbPlayers value is the number of players in the draft.~~

	~~=== The curPlayer key/value pair ===~~
	~~The curPlayer value is the player ID of the player currently taking his/her turn.~~

	~~=== The cpd key/value pair ===~~
	~~The cpd value is an integer used to keep track of the discount being applied to a private.<br>~~
	~~It is only used by the draft1846Last page.~~

	~~=== The deck key/value pair ===~~
	~~The deck value is an array that currently contains a list of the nine cards being used in this draft.~~

	~~=== The hand key/value pair ===~~
	~~The hand value is an empty array. It will contain the hand being delt to a player during his turn in the draft.~~

	~~=== The players key/value pair ===~~
	~~The players value is an array that contains a sub array for each player in the draft.~~




	~~=== The return key/value pair ===~~
	~~The return value is a text string used to return the success or failure status of a call to a php module.<br>~~
	~~The actual value of the string is dependent on the php module in question and is documented there.~~

	[[Category:Design]]		[[Category:Design]]

Rich: /* JSON Data Object */

2020-05-24T16:51:26Z

JSON Data Object

← Older revision		Revision as of 16:51, 24 May 2020
Line 53:		Line 53:
	It is stored in the table as a stringified json object called '''draft''' and appears to javascript as nested array.<br>		It is stored in the table as a stringified json object called '''draft''' and appears to javascript as nested array.<br>
	The sample object below has just been created by logic on the draft1846Start page.		The sample object below has just been created by logic on the draft1846Start page.

			'''[[JSON Data Object Key/Value Pairs\|<span style="color: Green">Click here to access a detailed description of this JSON Data Object </span>]]'''

	<pre>		<pre>
	array (		array (

Rich: /* Some Fields of Note */ complete rewrite - partially done.

2020-05-24T15:16:59Z

Some Fields of Note: complete rewrite - partially done.

← Older revision		Revision as of 15:16, 24 May 2020
Line 114:		Line 114:
	</pre>		</pre>

	== ~~Some Fields of Note~~ ==		== draft key/value pairs ==
	The "draft" database table ~~field~~ is a stringified JSON structure.<br>		The "draft" database table column is a stringified JSON structure.<br>
	This structure contains ~~some~~ key/value pairs that ~~could use some explanation as to their use~~.<br>		This structure contains key/value pairs that are each explained here.<br>
	~~A number of these key/value pairs are mentioned here.~~

	=== The status key/value pair ===		=== The status key/value pair ===
Line 129:		Line 128:

	=== The updtCount key/value pair ===		=== The updtCount key/value pair ===
	The updtCount value is an integer used to support a week version of optimistic database locking.~~<br>~~		The updtCount value is an integer used to support a week version of optimistic database locking.

			=== The numbPlayers key/value pair ===
			The numbPlayers value is the number of players in the draft.

			=== The curPlayer key/value pair ===
			The curPlayer value is the player ID of the player currently taking his/her turn.

	=== The cpd key/value pair ===		=== The cpd key/value pair ===
	The cpd value is an integer used to keep track of the discount being applied to a private.<br>		The cpd value is an integer used to keep track of the discount being applied to a private.<br>
	It is only used by the draft1846Last page.		It is only used by the draft1846Last page.

			=== The deck key/value pair ===
			The deck value is an array that currently contains a list of the nine cards being used in this draft.

			=== The hand key/value pair ===
			The hand value is an empty array. It will contain the hand being delt to a player during his turn in the draft.

			=== The players key/value pair ===
			The players value is an array that contains a sub array for each player in the draft.




	=== The return key/value pair ===		=== The return key/value pair ===

Rich: /* JSON Data Object */

2020-05-24T14:59:52Z

JSON Data Object

← Older revision		Revision as of 14:59, 24 May 2020
Line 51:		Line 51:
	== JSON Data Object ==		== JSON Data Object ==
	This object contains all of the information about a given draft except for the Draft ID.<br>		This object contains all of the information about a given draft except for the Draft ID.<br>
	It is stored in the table as a stringified json object and appears to javascript as nested array.<br>		It is stored in the table as a stringified json object called '''draft''' and appears to javascript as nested array.<br>
	The sample object below has just been created by logic on the draft1846Start page.		The sample object below has just been created by logic on the draft1846Start page.
	<pre>		<pre>

Rich: /* JASON Data Object */ total rewrite

2020-05-24T14:57:35Z

JASON Data Object: total rewrite

← Older revision		Revision as of 14:57, 24 May 2020
Line 49:		Line 49:
	The draft field is a text string containing the stringafied JSON data object as shown below.		The draft field is a text string containing the stringafied JSON data object as shown below.

	== ~~JASON~~ Data Object ==		== JSON Data Object ==
	This ~~Object~~ contains all of the information about a given draft except for the Draft ID.		This object contains all of the information about a given draft except for the Draft ID.<br>
			It is stored in the table as a stringified json object and appears to javascript as nested array.<br>
			The sample object below has just been created by logic on the draft1846Start page.
	<pre>		<pre>
	array (		array (
	'status' => '~~Last~~',		'status' => 'Pending',
	'updtCount' => 10,		'updtCount' => 1,
	'numbPlayers' => 3,		'numbPlayers' => 3,
	'curPlayer' => 2,		'curPlayer' => 1,
	'cpd' => 20,		'cpd' => 0,
	'deck' =>		'deck' =>
	array (		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' =>		'hand' =>
	array (		array (
	~~0 => 'Mail Contract',~~
	),		),
	'players' =>		'players' =>
Line 71:		Line 81:
	'name' => 'rich3',		'name' => 'rich3',
	'email' => 'richpri46@gmail.com',		'email' => 'richpri46@gmail.com',
	'confirmed' => '~~Yes~~',		'confirmed' => 'No',
	'cash' => ~~200~~,		'cash' => 400,
	'privates' =>		'privates' =>
	array (		array (
	~~0 => 'Tunnel Blasting Co.',~~
	~~1 => 'Blank Card',~~
	~~2 => 'Michigan Southern',~~
	),		),
			'urlKey' => '00271U01D3ZC',
	),		),
	1 =>		1 =>
Line 84:		Line 92:
	'name' => 'rich2',		'name' => 'rich2',
	'email' => 'richpri46@gmail.com',		'email' => 'richpri46@gmail.com',
	'confirmed' => '~~Yes~~',		'confirmed' => 'No',
	'cash' => ~~240~~,		'cash' => 400,
	'privates' =>		'privates' =>
	array (		array (
	~~0 => 'Big 4',~~
	~~1 => 'Chicago and W. Indiana',~~
	~~2 => 'Blank Card',~~
	),		),
			'urlKey' => '00272X00VJ71',
	),		),
	2 =>		2 =>
Line 97:		Line 103:
	'name' => 'rich1',		'name' => 'rich1',
	'email' => 'richpri46@gmail.com',		'email' => 'richpri46@gmail.com',
	'confirmed' => '~~Yes~~',		'confirmed' => 'No',
	'cash' => ~~360~~,		'cash' => 400,
	'privates' =>		'privates' =>
	array (		array (
	~~0 => 'Ohio and Indiana',~~
	~~1 => 'Blank Card',~~
	),		),
			'urlKey' => '0027373K05DF',
	),		),
	),		),
	~~'return' => 'success',~~
	)		)
	</pre>		</pre>

Rich: /* DRAFT1846 Server Side */

2020-05-21T23:11:17Z

DRAFT1846 Server Side

← Older revision		Revision as of 23:11, 21 May 2020
Line 29:		Line 29:

	== DRAFT1846 Server Side ==		== DRAFT1846 Server Side ==
	The server side processing for DRAFT1846 is done in stand alone PHP programs that are executed from ~~the~~ web pages via AJAX calls. <br>		The server side processing for DRAFT1846 is done in stand alone PHP programs that are executed from these web pages via AJAX calls. <br>
	Below is a link to a WIKI page ~~with~~ descriptions of each of these PHP programs.		Below is a link to a WIKI page containing descriptions of each of these PHP programs.

	[[DRAFT1846 Server Side Programs]]		[[DRAFT1846 Server Side Programs]]

Rich: /* DRAFT1846 Server Functions */ replaced contents of this section

2020-05-21T23:10:19Z

DRAFT1846 Server Functions: replaced contents of this section

← Older revision		Revision as of 23:10, 21 May 2020
Line 28:		Line 28:
	*[[The DRAFT1846Com File]]		*[[The DRAFT1846Com File]]

	== DRAFT1846 Server ~~Functions~~ ==		== DRAFT1846 Server Side ==
	The server side processing for DRAFT1846 is done in stand alone PHP programs that are executed from the web pages via AJAX calls. <br>		The server side processing for DRAFT1846 is done in stand alone PHP programs that are executed from the web pages via AJAX calls. <br>
	~~This section contains~~ a link to a WIKI page ~~section describing~~		Below is a link to a WIKI page with descriptions of each of these PHP programs.
	~~in detail~~ each of these PHP ~~functions~~.
			[[DRAFT1846 Server Side Programs]]

	== Database Structure ==		== Database Structure ==

Rich: /* DRAFT1846 Server Functions */

2020-05-21T22:58:34Z

DRAFT1846 Server Functions

← Older revision		Revision as of 22:58, 21 May 2020
Line 29:		Line 29:

	== DRAFT1846 Server Functions ==		== DRAFT1846 Server Functions ==
			The server side processing for DRAFT1846 is done in stand alone PHP programs that are executed from the web pages via AJAX calls. <br>
			This section contains a link to a WIKI page section describing
			in detail each of these PHP functions.

	== Database Structure ==		== Database Structure ==

Rich: /* DRAFT1846 Logic Flow */ added Server Functions section

2020-05-21T22:36:45Z

DRAFT1846 Logic Flow: added Server Functions section

← Older revision		Revision as of 22:36, 21 May 2020
Line 27:		Line 27:
	*[[The DRAFT1846Goodby Page]]		*[[The DRAFT1846Goodby Page]]
	*[[The DRAFT1846Com File]]		*[[The DRAFT1846Com File]]

			== DRAFT1846 Server Functions ==

	== Database Structure ==		== Database Structure ==