Legacy_PreferenceEditForm Class Reference

Inheritance diagram for Legacy_PreferenceEditForm:

Public Member Functions
	Legacy_PreferenceEditForm ($category)
	__construct ($category)
	getTokenName ()
	Gets the token name of this actionform's token.
	getCategoryId ()
	getModuleId ()
	prepare ()
	[Abstract] Set up form properties and field properties.
	getImploadValue ($key)
	update (&$configArr)
	[Abstract] Updates an object with properties values.
Public Member Functions inherited from XCube_ActionForm
	__construct ()
	Constructor.
	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.

Data Fields
	$mKeyName = 'confcat_id'
	$mKeyValue = 0
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 PreferenceEditForm.class.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$category

)

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

Member Function Documentation

getCategoryId()

getCategoryId

(

)

Definition at line 43 of file PreferenceEditForm.class.php.

getImploadValue()

getImploadValue

(

$key

)

Definition at line 123 of file PreferenceEditForm.class.php.

getModuleId()

getModuleId

(

)

Definition at line 48 of file PreferenceEditForm.class.php.

getTokenName()

getTokenName

(

)

Gets the token name of this actionform's token.

Returns

string

Return token name. If the sub-class doesn't override this member function, features about one-time tokens aren't used.

Reimplemented from XCube_ActionForm.

Reimplemented in Legacy_ModulePreferenceEditForm.

Definition at line 38 of file PreferenceEditForm.class.php.

Legacy_PreferenceEditForm()

Legacy_PreferenceEditForm

(

$category

)

Definition at line 23 of file PreferenceEditForm.class.php.

prepare()

prepare

(

)

[Abstract] Set up form properties and field properties.

Reimplemented from XCube_ActionForm.

Definition at line 53 of file PreferenceEditForm.class.php.

update()

update

(

&

$obj

)

[Abstract] Updates an object with properties values.

Parameters

mixed

$obj

Returns

void

Set input values to a object from this action form. This member function mediates between logic and the result of validations. For example, developers can use this method to set values to XoopsSimpleObject.

This member function is abstract. But, the subclass of this class does not have to implement it.

Reimplemented from XCube_ActionForm.

Definition at line 129 of file PreferenceEditForm.class.php.

Field Documentation

$mKeyName

$mKeyName = 'confcat_id'

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

$mKeyValue

$mKeyValue = 0

Definition at line 21 of file PreferenceEditForm.class.php.

---

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

• html/modules/legacy/admin/forms/PreferenceEditForm.class.php