Players actions: yourgamename.action.php - Versijų istorija

Sourisdudesert: /* Methods to use in action methods */

2013-01-11T15:07:01Z

Methods to use in action methods

← Ankstesnė versija		17:07, 11 sausio 2013 versija
60 eilutė:		60 eilutė:

	It returns "true" or "false" whether "argName" has been specified as an argument of the AJAX request or not.		It returns "true" or "false" whether "argName" has been specified as an argument of the AJAX request or not.

			== Useful tip: retrieve a list of number ==

			If your Javascript send a list of integer separated by ";" (ex: "1;2;3;4") as an argument, you can transform them in a PHP array with the following:

			<pre>
			public function playCards()
			{
			self::setAjaxMode();

			$card_ids_raw = self::getArg( "card_ids", AT_numberlist, true );

			// Removing last ';' if exists
			if( substr( $card_ids_raw, -1 ) == ';' )
			$card_ids_raw = substr( $card_ids_raw, 0, -1 );
			if( $card_ids_raw == '' )
			$card_ids = array();
			else
			$card_ids = explode( ';', $card_ids_raw );

			$this->game->playCards( $card_ids );
			self::ajaxResponse( );
			}
			</pre>

Sourisdudesert: /* Methods to use in action methods */

2013-01-11T15:03:50Z

Methods to use in action methods

← Ankstesnė versija		17:03, 11 sausio 2013 versija
49 eilutė:		49 eilutė:
	'AT_alphanum' for a string with 0-9a-zA-Z_ and space		'AT_alphanum' for a string with 0-9a-zA-Z_ and space
	'AT_numberlist' for a list of several numbers separated with "," or ";" (ex: exemple: 1,4;2,3;-1,2).		'AT_numberlist' for a list of several numbers separated with "," or ";" (ex: exemple: 1,4;2,3;-1,2).
			* mandatory: specify "true" if the argument is mandatory.
			* default: if mandatory=false, you can specify here a default value in case the argument is not present.
	bCanFail ~~means than a validation failure is~~ possible (~~user input~~)		* argTypeDetails: see AT_enum above.
	~~The main argType values are as follows~~.		* bCanFail: if true, specify that it may be possible that the argument won't be of the type specified by argType (and then do not log this as a fatal error in the system, and return a standard exception to the player).



	'''function isArg( $argName )'''		'''function isArg( $argName )'''

	~~Return "true" or "false" whether "argName" has been specified as~~ an argument of the ~~AJAX request or not~~.		This is a useful method when you only want to check if an argument is present or not present in your AJAX request (and don't care of the value.

	~~</pre>~~		It returns "true" or "false" whether "argName" has been specified as an argument of the AJAX request or not.

Sourisdudesert: /* Methods to use in action methods */

2013-01-11T14:58:20Z

Methods to use in action methods

← Ankstesnė versija		16:58, 11 sausio 2013 versija
27 eilutė:		27 eilutė:
	== Methods to use in action methods ==		== Methods to use in action methods ==

	; function setAjaxMode		'''function setAjaxMode'''
	~~: Must be use at the beginning of each action method.~~

	~~; function ajaxResponse~~		Must be use at the beginning of each action method.
	: Must be use at the ~~end~~ of each action method.

	~~; function getArg( $argName, $argType, $mandatory=false, $default=NULL, $argTypeDetails=array(), $bCanFail=false )~~		'''function ajaxResponse'''
	~~: This method must be used to retrieve the arguments sent with your AJAX query.~~
	~~: You must NOT use "_GET", "_POST" or equivalent PHP variables to do this, as it is unsafe.~~
	~~: This method use the following arguments:~~
	~~: * argName: the name of the argument to retrieve.~~
	~~: * argType: the type of the argument. You should use one of the following:~~
	: '~~AT_int~~' ~~for an integer~~
	: '~~AT_posint' for a positive integer~~
	~~: 'AT_float' for a float~~
	~~: 'AT_bool' for 1/0/true/false~~
	~~: 'AT_enum~~' ~~for an enumeration (argTypeDetails list the possible values as an array)~~
	: '~~AT_alphanum~~' ~~for a string with 0-9a-zA-Z_ and space~~

			Must be use at the end of each action method.

			'''function getArg( $argName, $argType, $mandatory=false, $default=NULL, $argTypeDetails=array(), $bCanFail=false )'''

	: ~~bCanFail means than~~ a ~~validation failure is~~ possible ~~(user input~~)		This method must be used to retrieve the arguments sent with your AJAX query.
	: ~~The main argType values are as follows~~.		You must NOT use "_GET", "_POST" or equivalent PHP variables to do this, as it is unsafe.
	~~<pre>~~		This method use the following arguments:
			* argName: the name of the argument to retrieve.
			* argType: the type of the argument. You should use one of the following:
			'AT_int' for an integer
			'AT_posint' for a positive integer
			'AT_float' for a float
			'AT_bool' for 1/0/true/false
			'AT_enum' for an enumeration (argTypeDetails list the possible values as an array)
			'AT_alphanum' for a string with 0-9a-zA-Z_ and space
			'AT_numberlist' for a list of several numbers separated with "," or ";" (ex: exemple: 1,4;2,3;-1,2).


	; function isArg( $argName )		bCanFail means than a validation failure is possible (user input)
	: Return "true" or "false" whether "argName" has been specified as an argument of the AJAX request or not.		The main argType values are as follows.



			'''function isArg( $argName )'''

			Return "true" or "false" whether "argName" has been specified as an argument of the AJAX request or not.

	</pre>		</pre>

Sourisdudesert 14:56, 11 sausio 2013

2013-01-11T14:56:04Z

@@ 1 eilutė: / 1 eilutė: @@
-; function isArg( $argName )
+== Purpose of this file ==
-: Is this argument filled ?
 ; function getArg( $argName, $argType, $mandatory=false, $default=NULL, $argTypeDetails=array(), $bCanFail=false  )
-: Get script argument with the correct type
+: This method must be used to retrieve the arguments sent with your AJAX query.
 : bCanFail means than a validation failure is possible (user input)
 : The main argType values are as follows.
 <pre>
-define( 'AT_int', 0 );        //  an integer
-define( 'AT_posint', 1 );     //  a positive integer
-define( 'AT_float', 2 );      //  a float
+; function isArg( $argName )
-define( 'AT_email', 3 );      //  an email
+: Return "true" or "false" whether "argName" has been specified as an argument of the AJAX request or not.
-define( 'AT_url', 4 );        //  a URL
 </pre>

Sourisdudesert: Created page with "=== APP_GameAction class (.action.php) === ; function isArg( $argName ) : Is this argument filled ? ; function getArg( $argName, $argType, $mandatory=false, $defaul..."

2013-01-05T10:14:07Z

Created page with "=== APP_GameAction class (<gamename>.action.php) === ; function isArg( $argName ) : Is this argument filled ? ; function getArg( $argName, $argType, $mandatory=false, $defaul..."

Naujas puslapis

=== APP_GameAction class (<gamename>.action.php) ===

; function isArg( $argName )
: Is this argument filled ?
; function getArg( $argName, $argType, $mandatory=false, $default=NULL, $argTypeDetails=array(), $bCanFail=false )
: Get script argument with the correct type
: bCanFail means than a validation failure is possible (user input)
: The main argType values are as follows.
<pre>
define( 'AT_int', 0 ); // an integer
define( 'AT_posint', 1 ); // a positive integer
define( 'AT_float', 2 ); // a float
define( 'AT_email', 3 ); // an email
define( 'AT_url', 4 ); // a URL
define( 'AT_bool', 5 ); // 1/0/true/false
define( 'AT_enum', 6 ); // argTypeDetails list the possible values
define( 'AT_alphanum', 7 ); // only 0-9a-zA-Z_ and space
</pre>