Inheritance diagram for Legacy_ActionSearchForm:

Public Member Functions
	prepare ()
	[Abstract] Set up form properties and field properties.

	fetch ()
	Fetches values through the request object.

Public Member Functions inherited from XCube_ActionForm
	__construct ()
	Constructor.

	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.

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

Data Fields
	$mState = null

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

Definition at line 18 of file ActionSearchForm.class.php.

Member Function Documentation

◆ fetch()

fetch ( )

Fetches values through the request object.

Returns: void

See also: getFromRequest

Fetch the input value, set it and form properties. These values can be retrieved by the get() method. The subclass can define its own member function to fetch the values. Define member functions with name "fetch" + "form name". For example, to fetch the "message", define the function "fetchMessage()". The subclass function assigns a value to this action form.

function fetchModifytime()
{
  $this->set('modifytime', time());
}

Reimplemented from XCube_ActionForm.

Definition at line 32 of file ActionSearchForm.class.php.

◆ prepare()

prepare ( )

[Abstract] Set up form properties and field properties.

Reimplemented from XCube_ActionForm.

Definition at line 22 of file ActionSearchForm.class.php.

Field Documentation

◆ $mState

$mState = null

Definition at line 20 of file ActionSearchForm.class.php.

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

html/modules/legacy/admin/forms/ActionSearchForm.class.php