LegacyRender_BannerAdminEditForm Class Reference

Inheritance diagram for LegacyRender_BannerAdminEditForm:

Public Member Functions
	getTokenName ()
	Gets the token name of this actionform's token.
	prepare ()
	[Abstract] Set up form properties and field properties.
	validate ()
	Validates fetched values.
	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.
	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.

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

Definition at line 18 of file BannerAdminEditForm.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 20 of file BannerAdminEditForm.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 88 of file BannerAdminEditForm.class.php.

prepare()

prepare

(

)

[Abstract] Set up form properties and field properties.

Reimplemented from XCube_ActionForm.

Definition at line 25 of file BannerAdminEditForm.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 99 of file BannerAdminEditForm.class.php.

validate()

validate

(

)

Validates fetched values.

Returns

void

Performs validation, so that if an input value is wrong, error messages are added to the error message buffer. The validation procedure is as follows:

• 1. If this object has a token name, validate the unique one-time token.
• 2. Call the member function to validate all the properties of the field.
• 3. Call the member function that is defined in the subclass.

For a database, validations are performed by functions of the properties of each field. But, the subclass can define its own validation logic. Define member function with name "validate" + "form name". For example, to validate "message", define the function "validateMessage()".

Reimplemented from XCube_ActionForm.

Definition at line 67 of file BannerAdminEditForm.class.php.

---

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

• html/modules/legacyRender/admin/forms/BannerAdminEditForm.class.php