Class XFAction

Description

any 'action' inherit XFAction must define at least some common methods/vars.

any 'action' inherit XFAction must define at least some common methods/vars...

  • abstract:

Located in /lb_private/class.root.php (line 2832)


	
			
Direct descendents
Class Constant Summary
 API_VERSION = 0x01
Variable Summary
string $error
array $gpc
array $markgpc
boolean $success
integer $version
Method Summary
void ajax ( $a)
XFAction __construct ()
void execute ()
void get_error ()
void get_GPC ()
void get_mark_GPC ()
void get_success ()
void init ( $a,  $b)
void regular ()
Variables
string $error = '' (line 2848)
  • var: error message storage, useful for ajax requests
  • access: protected

Redefined in descendants as:
array $markgpc = array() (line 2856)
  • var: can mark invalid inputs in forms, useful for ajax requests
  • access: protected

Redefined in descendants as:
boolean $success = false (line 2844)
  • var: flag storing success after execution, useful for ajax requests
  • access: protected

Redefined in descendants as:
integer $version = null (line 2840)
  • var: version number of sibling class
  • access: public

Redefined in descendants as:
Methods
ajax (line 2876)

entry point for ajax requests - called by init()

entry point for ajax requests - called by init()

  • abstract:
  • since: 1.0.0
  • access: protected
void ajax ( $a)
  • $a

Redefined in descendants as:
Constructor __construct (line 2858)
  • access: public
XFAction __construct ()
execute (line 2882)

execute the main 'action' the name of a file says

execute the main 'action' the name of a file says

  • abstract:
  • since: 1.0.0
  • access: public
void execute ()

Redefined in descendants as:
get_error (line 2896)

return error to public

return error to public

  • since: 1.0.0
  • access: public
void get_error ()
get_GPC (line 2904)

return local user input vars to public

return local user input vars to public

  • since: 1.0.0
  • access: public
void get_GPC ()
get_mark_GPC (line 2912)

return 'invalid gpc form mark' to public

return 'invalid gpc form mark' to public

  • since: 1.0.0
  • access: public
void get_mark_GPC ()
get_success (line 2888)

return success to public

return success to public

  • since: 1.0.0
  • access: public
void get_success ()
init (line 2864)

main entry point

main entry point

  • abstract:
  • since: 1.0.0
  • access: public
void init ( $a,  $b)
  • $a
  • $b

Redefined in descendants as:
regular (line 2870)

run an action on regular basis - called by init()

run an action on regular basis - called by init()

  • abstract:
  • since: 1.0.0
  • access: protected
void regular ()

Redefined in descendants as:
Class Constants
API_VERSION = 0x01 (line 2836)
  • var: what version does this base class implement?

Documentation generated on Sun, 20 Jun 2010 11:59:19 +0200 by phpDocumentor 1.4.3