The DRAFT1846Start Page - Revision history

Rich at 14:43, 28 October 2020

2020-10-28T14:43:22Z

← Older revision		Revision as of 14:43, 28 October 2020
Line 88:		Line 88:

	Output is the pseudo random url key based on the input.		Output is the pseudo random url key based on the input.

			[[Category:Design]]

Rich: /* function newDraftOK(response) */

2020-05-27T19:45:06Z

function newDraftOK(response)

← Older revision		Revision as of 19:45, 27 May 2020
Line 58:		Line 58:
	Function newDraftOK is the success callback function for		Function newDraftOK is the success callback function for
	the ajax makeDraft.php call. It checks for a failure		the ajax makeDraft.php call. It checks for a failure
	and then reports the new draft ID to the start page.		and then reports the new draft ID to the start page.<br>
	Finally it adds a psudorandom url key to the array for		Finally it adds a psudorandom url key to the array for
	each player and calls the ~~updatedraft~~.php function.		each player and calls the updatedraftNpi.php function.

	The php/makeDraft.php call returns the numeric draft_id of		The php/makeDraft.php call returns the numeric draft_id of

Rich: /* function updtDraftResult(result) */

2020-05-27T19:43:58Z

function updtDraftResult(result)

← Older revision		Revision as of 19:43, 27 May 2020
Line 67:		Line 67:
	== function updtDraftResult(result) ==		== function updtDraftResult(result) ==
	Function updtDraftResult is the success callback function		Function updtDraftResult is the success callback function
	for the ajax ~~updtDraft~~.php call made by the newDraftOK()		for the ajax updtDraftNpi.php call made by the newDraftOK()
	function. It checks for a failure or a collision		function. It checks for a failure or a collision
	and then it calls the emailConfirmation.php function.		and then it calls the emailConfirmation.php function.

Rich: /* function startupEmailsResult(response) */ add urlKeyGen

2020-05-24T18:24:56Z

function startupEmailsResult(response): add urlKeyGen

← Older revision		Revision as of 18:24, 24 May 2020
Line 80:		Line 80:
	It only needs to check for errors and it only needs to report		It only needs to check for errors and it only needs to report
	the first error.		the first error.

			== function urlKeyGen(draftID, playerID) ==
			The urlKeyGen() function creates a pseudo random url key
			for a given draftID and playerID.

			Input consists of the draftID and the playerID

			Output is the pseudo random url key based on the input.

Rich: /* function newDraftOK(response) */ reflect adition of new function

2020-05-24T18:21:16Z

function newDraftOK(response): reflect adition of new function

← Older revision		Revision as of 18:21, 24 May 2020
Line 57:		Line 57:
	== function newDraftOK(response) ==		== function newDraftOK(response) ==
	Function newDraftOK is the success callback function for		Function newDraftOK is the success callback function for
	the ajax ~~php/~~makeDraft.php call.		the ajax makeDraft.php call. It checks for a failure
			and then reports the new draft ID to the start page.
			Finally it adds a psudorandom url key to the array for
			each player and calls the updatedraft.php function.

	The php/makeDraft.php call returns the numeric draft_id of		The php/makeDraft.php call returns the numeric draft_id of
	the new table row or the ~~integer~~ 0 if a failure ~~occurred~~.		the new table row or the intiger 0 if a failure occured.
	~~The~~ newDraftOK function checks for a failure ~~(0)~~
	and then ~~reports the new draft ID to the start page.~~		== function updtDraftResult(result) ==
	~~Finally~~ it calls the emailConfirmation.php function.		Function updtDraftResult is the success callback function
			for the ajax updtDraft.php call made by the newDraftOK()
			function. It checks for a failure or a collision
			and then it calls the emailConfirmation.php function.

			Output from updateDraft is an echo return status of
			"success", "collision" or "fail".

	== function startupEmailsResult(response) ==		== function startupEmailsResult(response) ==

Rich: added index

2020-05-20T21:45:53Z

added index

← Older revision		Revision as of 21:45, 20 May 2020
Line 1:		Line 1:
	Control is ~~transfered~~ to the draft1846Start page from the		{{Draft1846 Design Document Index}}
			Control is transferred to the draft1846Start page from the
	index page. The index page also supplies the number of		index page. The index page also supplies the number of
	players the draft1846Start page as a URL parameter.<br>		players the draft1846Start page as a URL parameter.<br>

Rich: initial contents of this page

2020-05-19T21:59:55Z

initial contents of this page

New page

Control is transfered to the draft1846Start page from the
index page. The index page also supplies the number of
players the draft1846Start page as a URL parameter.<br>
The draft1846Start page displays a form in to
which the names and email addresses of the players should
be entered. For less than 5 players, it also displays a
selection box which should be used to select the unused
privates.

== function SetupDraft() ==
The SetupDraft function uses the functions below to setup a
new draft by creating a new row in the draft_table and then
sending a confirmation email to each player in the draft.

== function makeDeck() ==
The makeDeck function sets up a D1846.deck array with all
private companies present in the array. It then removes
the privates that will not be used in the game. Then it
adds the required number of blank cards to the array.
And finally it shuffles the array.

== function shuffle(array) ==
Function shuffle is used to shuffle a javascript array.
I found various forms of this function on many web
pages. This particular one is a modified version of
the function shown on the javascript.info page at
https://javascript.info/task/shuffle

The shuffle function accepts an array as input and
shuffles the array in place.

== function purgeitem(array, item) ==
Function purgeitem is used to remove an item from
a javascript array.

The purgeitem function accepts two parameters:
#The first is the array that will be modified.
#The second is the item that will be removed.

The function modifies the array in place.

== function makePinfo() ==
The makePinfo function sets up the D1846.nlist array
and the D1846.elist array by accessing the player
name and email addresse fields from the setup form
on the draft1846Start page. It also checks for
duplicate names.

== function makeDraftRow() ==
Function makeDraftRow creates "D1846.draft",
and then uses JSON.stringify to convert it
to the JSON component of the new draft_table
row for this usage of DRAFT1846.
It then does an ajax call to makeDraft.php.

== function newDraftOK(response) ==
Function newDraftOK is the success callback function for
the ajax php/makeDraft.php call.
The php/makeDraft.php call returns the numeric draft_id of
the new table row or the integer 0 if a failure occurred.
The newDraftOK function checks for a failure (0)
and then reports the new draft ID to the start page.
Finally it calls the emailConfirmation.php function.

== function startupEmailsResult(response) ==
Function startupEmailsResult is the call back function for
the ajax calls to emailConfirmation.php. It will have to
process returns from multiple emails for the same call.
It only needs to check for errors and it only needs to report
the first error.