User_AvatarSelectForm Class Reference

Inheritance diagram for User_AvatarSelectForm:

Public Member Functions
	getTokenName ()
	Gets the token name of this actionform's token.
	prepare ()
	[Abstract] Set up form properties and field properties.
	validateAvatar_id ()
	load (&$obj)
	[Abstract] Initializes properties' values from an object.
	update (&$obj)
	[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.

Data Fields
	$mSelectedId = 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 14 of file AvatarSelectForm.class.php.

Member Function Documentation

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.

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

load()

load

(

&

$obj

)

[Abstract] Initializes properties' values from an object.

Parameters

mixed

$obj

Returns

void

Set the initial values of this Action Form from an object. This member function mediates between logic and validation. For example, developers can use this method to load values from 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 56 of file AvatarSelectForm.class.php.

prepare()

prepare

(

)

[Abstract] Set up form properties and field properties.

Reimplemented from XCube_ActionForm.

Definition at line 23 of file AvatarSelectForm.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 61 of file AvatarSelectForm.class.php.

validateAvatar_id()

validateAvatar_id

(

)

Definition at line 29 of file AvatarSelectForm.class.php.

Field Documentation

$mSelectedId

$mSelectedId = null

Definition at line 16 of file AvatarSelectForm.class.php.

---

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

• html/modules/user/forms/AvatarSelectForm.class.php