Class XFAction

Description

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

  • abstract:

Located in /class.root.php (line 2490)


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

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

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

Redefined in descendants as:
Methods
Constructor __construct (line 2516)
  • access: public
XFAction __construct ()
ajax (line 2534)

entry point for ajax requests - called by init()

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

Redefined in descendants as:
execute (line 2540)

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 2554)

return error to public

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

return local user input vars to public

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

return 'invalid gpc form mark' to public

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

return success to public

  • since: 1.0.0
  • access: public
void get_success ()
regular (line 2528)

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 2494)
  • var: what version does this base class implement?

Documentation generated on Tue, 03 Mar 2009 17:58:08 +0100 by phpDocumentor 1.4.1