This is a documentation for Board Game Arena: play board games online !

„Studio function reference” változatai közötti eltérés

Innen: Board Game Arena
Ugrás a navigációhoz Ugrás a kereséshez
(Created page with "This page references useful server side and client side functions, so that nobody needs to reinvent the wheel (unless he wants to). == Server side (PHP functions) == ; todo ...")
 
Nincs szerkesztési összefoglaló
3. sor: 3. sor:
== Server side (PHP functions) ==
== Server side (PHP functions) ==


; todo : todo
=== 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>
=== Table class (<gamename>.game.php) ===


== Client side (Javascript functions) ==
== Client side (Javascript functions) ==


; todo : todo
; todo : todo

A lap 2012. november 25., 19:37-kori változata

This page references useful server side and client side functions, so that nobody needs to reinvent the wheel (unless he wants to).

Server side (PHP functions)

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.
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

Table class (<gamename>.game.php)

Client side (Javascript functions)

todo
todo