Coding Standards AJAX - Revision history

Rich: /* The $.getJSON() Function */ added some comments

2020-07-23T17:20:58Z

The $.getJSON() Function: added some comments

← Older revision		Revision as of 17:20, 23 July 2020
Line 24:		Line 24:
	Special error hadling capabilities are provided by this function. These may		Special error hadling capabilities are provided by this function. These may
	modify the callback function processing that is described below.<br>		modify the callback function processing that is described below.<br>
	~~<span style="color: Fuchsia">~~
	~~Note that further documentation~~ of these ~~differences should eventually be included here~~.		The $.getJSON() function is only used in two JavaScript files, board18Map2.js and board18Market2.js. They are very basic to BOARD18 and were written very early in the development process.
	~~</span>~~
			On the one hand I see no reason to use the $.getJSON() function in any future code. On the other hand I see no reason to modify the code in either of these files.

			Thus I am not going to spend further time on documenting this function.

	== Callback Function Coding Standards ==		== Callback Function Coding Standards ==

2020-07-23T17:16:07Z

The PHP Side Of The $.getJSON() Call

← Older revision		Revision as of 17:16, 23 July 2020
Line 208:		Line 208:

	On the one hand I see no reason to use the $.getJSON() call in any future code.		On the one hand I see no reason to use the $.getJSON() call in any future code.
	On the other hand see no reason to modify the code in either of these files.		On the other hand I see no reason to modify the code in either of these files.

	Thus I am not going to spend further time on documenting this call.		Thus I am not going to spend further time on documenting this call.

2020-07-23T17:14:54Z

The PHP Side Of The $.getJSON() Call: initial content

← Older revision		Revision as of 17:14, 23 July 2020
Line 203:		Line 203:

	=== The PHP Side Of The $.getJSON() Call ===		=== The PHP Side Of The $.getJSON() Call ===
	~~<span style="color: Fuchsia">To be provided at a~~ future ~~date~~.~~</span>~~		The $.getJSON() call is only used in two JavaScript files,
			board18Map2.js and board18Market2.js. They are very basic to
			BOARD18 and were written very early in the development process.

			On the one hand I see no reason to use the $.getJSON() call in any future code.
			On the other hand see no reason to modify the code in either of these files.

			Thus I am not going to spend further time on documenting this call.


	[[Category:Standards]]		[[Category:Standards]]

2020-07-23T17:04:18Z

Data Returns: ====Returns That Pass Data====

← Older revision		Revision as of 17:04, 23 July 2020
Line 166:		Line 166:
	</pre>		</pre>

	====Data ~~Returns~~====		====Returns That Pass Data====
	~~Data returns~~ should always be in the form of a stringified JSON data structure.		Returns that pass data should always be in the form of a stringified JSON data structure.
	This structure should contain a "stat" variable to return the status of the call.		This structure should contain a "stat" variable to return the status of the call.
	The rest of the data structure should be the actual return data. In some cases, for		The rest of the data structure should be the actual return data. In some cases, for

2020-07-23T17:01:38Z

Other Returns: rewrite

← Older revision		Revision as of 17:01, 23 July 2020
Line 195:		Line 195:
	</pre>		</pre>

	====~~Other~~ Returns====		====Non Data Returns====
	~~Other~~ returns will ~~either~~ be successful returns ~~which~~ have no data component.		Non data returns will be from functions whose successful returns have no data component.
	They should simply echo the character string 'success'.		They should simply echo the character string 'success' or 'fail'.
	~~Or they will~~ be edit ~~failure returns.~~		They cold also be simple edit errors
	~~They~~ should echo a short ~~charcter~~ string which describes the error. See the		which should echo a short character string which describes the edit error. See the
	'''Echo Status Return Type''' section above for examples of this.		'''Echo Status Return Type''' section above for examples of this.

2020-07-23T16:56:47Z

Data Returns: initial contents

← Older revision		Revision as of 16:56, 23 July 2020
Line 167:		Line 167:

	====Data Returns====		====Data Returns====
			Data returns should always be in the form of a stringified JSON data structure.
			This structure should contain a "stat" variable to return the status of the call.
			The rest of the data structure should be the actual return data. In some cases, for
			example a failure return, the data structure may consist of only the "stat" variable.

			The data structure should be documented as in this example.
			<pre>
			* Output is the following stringified JSON data structure.
			* {
			* "stat":"success",
			* "games":
			* [
			* {
			* "game_id":"nnnn",
			* "gname":"gggg",
			* "bname":"bbbb",
			* "version":"vvvv",
			* "start_date":"mm/dd/yyyy",
			* "status":"ssss"
			* },
			* . . . . more games . . . . .
			* ]
			* }
			*
			* "stat" can be "success", "fail" or "none".
			* "games" will only be present if "stat" is "success".
			</pre>

	====Other Returns====		====Other Returns====

2020-07-23T16:45:27Z

The PHP Side Of The $.post() Call

← Older revision		Revision as of 16:45, 23 July 2020
Line 160:		Line 160:
	$link = mysqli_connect(DB_HOST, DB_USER, DB_PASSWORD, DB_DATABASE);		$link = mysqli_connect(DB_HOST, DB_USER, DB_PASSWORD, DB_DATABASE);
	if (!$link) {		if (!$link) {
	error_log('Failed to connect to server: ' . mysqli_connect_error());		error_log('FunctionName Failed to connect to server: ' . mysqli_connect_error());
	echo 'fail';		echo 'fail';
	exit;		exit;

2014-10-15T12:56:02Z

AJAX call Coding Standards

← Older revision		Revision as of 12:56, 15 October 2014
Line 16:		Line 16:
	as a [http://en.wikipedia.org/wiki/Query_string URL query string].		as a [http://en.wikipedia.org/wiki/Query_string URL query string].
	The response from emailPlayerID.php will be processed by the callback function		The response from emailPlayerID.php will be processed by the callback function
	specified third parameter of the $.post function (emailPlayerResult() in the		specified in the third parameter of the $.post function (emailPlayerResult() in the
	example above).		example above).

2013-11-29T15:30:25Z

added index

← Older revision		Revision as of 15:30, 29 November 2013
Line 1:		Line 1:
			{{Coding Standards Index}}
	The BOARD18 "JavaScript to PHP interface standard" is defined here.		The BOARD18 "JavaScript to PHP interface standard" is defined here.

2013-11-29T13:51:51Z

added category standards

← Older revision		Revision as of 13:51, 29 November 2013
Line 1:		Line 1:
	~~This coding standards document is very incomplete!~~		The BOARD18 "JavaScript to PHP interface standard" is defined here.

	~~At the present I intend it to cover mostly interface standards.~~

	The JavaScript to PHP interface ~~will be the first thing that I standardize~~ here.

	== AJAX call Coding Standards ==		== AJAX call Coding Standards ==
Line 181:		Line 177:
	=== The PHP Side Of The $.getJSON() Call ===		=== The PHP Side Of The $.getJSON() Call ===
	<span style="color: Fuchsia">To be provided at a future date.</span>		<span style="color: Fuchsia">To be provided at a future date.</span>


			[[Category:Standards]]