Legacy_ActionForm Class Reference

Provides a base actionForm class for module developers. More...

Inheritance diagram for Legacy_ActionForm:

Public Member Functions
	__construct ()
	Constructor.
Public Member Functions inherited from XCube_ActionForm
	prepare ()
	[Abstract] Set up form properties and field properties.
	getTokenName ()
	Gets the token name of this actionform's token.
	getToken ()
	Gets the token value of this actionform's token.
	getTokenErrorMessage ()
	Gets a message about the failure of the token validation.
	set ()
	Sets the raw value as the value of the form property.
	setVar ()
	get ( $key, $index=null)
	Gets raw value.
	getVar ( $key, $index=null)
&	getFormProperties ()
	Gets form properties of this member property.
	fetch ()
	Fetches values through the request object.
	_validateToken ()
	Validates the token.
	validate ()
	Validates fetched values.
	hasError ()
	Gets a value indicating whether this action form keeps error messages or error flag.
	addErrorMessage ( $message)
	Adds a message to the form's error message buffer.
	getErrorMessages ()
	Gets error messages.
	load (&$obj)
	[Abstract] Initializes properties' values from an object.
	update (&$obj)
	[Abstract] Updates an object with properties values.

Additional Inherited Members
Data Fields inherited from XCube_ActionForm
	$mContext
	[READ ONLY] XCube_HttpContext
	$mUser
	[READ ONLY] XCube_Principal
	$mFormProperties = []
	XCube_FormProperty[].
	$mFieldProperties = []
	XCube_FieldProperty[].
	$mErrorFlag = false
	bool
	$mErrorMessages = []
	string[]
	$_mToken
	string

Detailed Description

Provides a base actionForm class for module developers.

This class retains the specification defined in the Legacy 2.1 release. XCube_ActionForm will be changed. This class will change to adapt the base class and will provide uniform specifications for developers.

Todo

All actionForms from Package_Legacy must inherit from this class.

Definition at line 28 of file Legacy_ActionForm.class.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructor.

Reimplemented from XCube_ActionForm.

Definition at line 34 of file Legacy_ActionForm.class.php.

---

The documentation for this class was generated from the following file:

• html/modules/legacy/kernel/Legacy_ActionForm.class.php