XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
XCube_ActionForm Class Reference
Inheritance diagram for XCube_ActionForm:
LegacyRender_BannerAdminDeleteForm LegacyRender_BannerAdminEditForm LegacyRender_BannerclientAdminDeleteForm LegacyRender_BannerclientAdminEditForm LegacyRender_BannerfinishAdminDeleteForm LegacyRender_ThemeSelectForm LegacyRender_TplfileAdminDeleteForm LegacyRender_TplfileEditForm LegacyRender_TplfileUploadForm LegacyRender_TplsetDeleteForm LegacyRender_TplsetEditForm LegacyRender_TplsetSelectForm LegacyRender_TplsetUploadForm Legacy_AbstractCommentAdminEditForm Legacy_ActionForm Legacy_ActionSearchForm Legacy_BlockEditForm Legacy_BlockListForm Legacy_CommentAdminDeleteForm Legacy_CommentEditForm Legacy_CommentListForm Legacy_CustomBlockDeleteForm Legacy_ImageAdminDeleteForm Legacy_ImageListForm Legacy_ImageUploadForm Legacy_ImageUploadForm Legacy_ImagecategoryAdminDeleteForm Legacy_ImagecategoryAdminEditForm Legacy_ImagecategoryListForm Legacy_InstallWizardForm Legacy_MiscFriendForm Legacy_ModuleEditForm Legacy_ModuleInstallForm Legacy_ModuleListForm Legacy_ModuleUninstallForm Legacy_ModuleUpdateForm Legacy_NotifyDeleteForm Legacy_PreferenceEditForm Legacy_SearchResultsForm Legacy_SmilesAdminDeleteForm Legacy_SmilesAdminEditForm Legacy_SmilesListForm Legacy_SmilesUploadForm Legacy_ThemeSelectForm MessageForm MessageSettingsForm Profile_Admin_DefinitionsDeleteForm Profile_Admin_DefinitionsEditForm Profile_DataDeleteForm Profile_DataEditForm User_AbstractUserEditForm User_AvatarAdminDeleteForm User_AvatarAdminEditForm User_AvatarEditForm User_AvatarListForm User_AvatarSelectForm User_AvatarUploadForm User_GroupAdminDeleteForm User_GroupAdminEditForm User_GroupMemberEditForm User_GroupPermEditForm User_LostPassEditForm User_MailjobAdminDeleteForm User_MailjobAdminEditForm User_MailjobAdminSendForm User_Mailjob_linkAdminDeletesForm User_RanksAdminDeleteForm User_RanksAdminEditForm User_RanksListForm User_RecountForm User_UserAdminDeleteForm User_UserAdminEditForm User_UserConfirmForm User_UserDeleteForm User_UserListForm User_UserSearchForm User_UserSearchListForm

Public Member Functions

 __construct ()
 Constructor.
 
 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.
 

Data Fields

 $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 51 of file XCube_ActionForm.class.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Constructor.

Reimplemented in Legacy_ActionForm.

Definition at line 109 of file XCube_ActionForm.class.php.

Member Function Documentation

◆ _validateToken()

_validateToken ( )

Validates the token.

Returns
void

Validates the token. This method is deprecated, because XCube_Action will be changed for multi-layer. So this method is called only by this class.

Todo
This method has to be remove, because it is using session directly.

Reimplemented in User_MailjobServiceEditForm.

Definition at line 293 of file XCube_ActionForm.class.php.

◆ addErrorMessage()

addErrorMessage ( $message)

Adds a message to the form's error message buffer.

Parameters
string$message

Definition at line 386 of file XCube_ActionForm.class.php.

◆ 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 in Legacy_ActionSearchForm, Legacy_NotifyDeleteForm, and Legacy_SearchResultsForm.

Definition at line 267 of file XCube_ActionForm.class.php.

◆ get()

get ( $key,
$index = null )

Gets raw value.

Parameters
string$keyName of form property.
string$indexHint for array.
Returns
mixed
Attention
This method returns raw values. Therefore, if the value is used in templates, it should require an escape.

Definition at line 222 of file XCube_ActionForm.class.php.

◆ getErrorMessages()

getErrorMessages ( )

Gets error messages.

Returns
string[]

Definition at line 395 of file XCube_ActionForm.class.php.

◆ getFormProperties()

& getFormProperties ( )

Gets form properties of this member property.

Returns
XCube_AbstractProperty[]
Attention
This method is Not necessarily essential. It could be renamed in the near future.
Todo
Check whether this method is needed.

Definition at line 245 of file XCube_ActionForm.class.php.

◆ getToken()

getToken ( )

Gets the token value of this actionform's token.

Returns
string

Generates a token value, stores it in sessions, returns it. This member function should be called in templates. A subclass can override it to modify the logic generating the token value.

Definition at line 143 of file XCube_ActionForm.class.php.

◆ getTokenErrorMessage()

getTokenErrorMessage ( )

Gets a message about the failure of the token validation.

Returns
string

Reimplemented in Legacy_BlockListForm, Legacy_CommentListForm, Legacy_ImagecategoryListForm, Legacy_ImageListForm, Legacy_ModuleListForm, Legacy_SmilesListForm, User_AvatarListForm, User_Mailjob_linkAdminDeletesForm, User_RanksListForm, User_UserListForm, and User_UserSearchListForm.

Definition at line 161 of file XCube_ActionForm.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 in Legacy_AbstractCommentAdminEditForm, Legacy_BlockEditForm, Legacy_BlockInstallEditForm, Legacy_BlockListForm, Legacy_BlockUninstallForm, Legacy_CommentAdminDeleteForm, Legacy_CommentEditForm, Legacy_CommentListForm, Legacy_CustomBlockDeleteForm, Legacy_CustomBlockEditForm, Legacy_ImageAdminCreateForm, Legacy_ImageAdminDeleteForm, Legacy_ImagecategoryAdminDeleteForm, Legacy_ImagecategoryAdminEditForm, Legacy_ImagecategoryAdminNewForm, Legacy_ImagecategoryListForm, Legacy_ImageListForm, Legacy_ImageUploadForm, Legacy_ImageUploadForm, Legacy_InstallWizardForm, Legacy_MiscFriendForm, Legacy_ModuleEditForm, Legacy_ModuleInstallForm, Legacy_ModuleListForm, Legacy_ModulePreferenceEditForm, Legacy_ModuleUninstallForm, Legacy_ModuleUpdateForm, Legacy_NotifyDeleteForm, Legacy_PreferenceEditForm, Legacy_SmilesAdminDeleteForm, Legacy_SmilesAdminEditForm, Legacy_SmilesListForm, Legacy_SmilesUploadForm, Legacy_ThemeSelectForm, LegacyRender_BannerAdminDeleteForm, LegacyRender_BannerAdminEditForm, LegacyRender_BannerclientAdminDeleteForm, LegacyRender_BannerclientAdminEditForm, LegacyRender_BannerfinishAdminDeleteForm, LegacyRender_ThemeSelectForm, LegacyRender_TplfileAdminDeleteForm, LegacyRender_TplfileCloneForm, LegacyRender_TplfileEditForm, LegacyRender_TplfileUploadForm, LegacyRender_TplsetCloneForm, LegacyRender_TplsetDeleteForm, LegacyRender_TplsetEditForm, LegacyRender_TplsetSelectForm, LegacyRender_TplsetUploadForm, MessageForm, MessageSettingsForm, Profile_Admin_DefinitionsDeleteForm, Profile_Admin_DefinitionsEditForm, Profile_DataDeleteForm, Profile_DataEditForm, User_AvatarAdminDeleteForm, User_AvatarAdminEditForm, User_AvatarEditForm, User_AvatarListForm, User_AvatarSelectForm, User_AvatarUploadForm, User_EditUserForm, User_GroupAdminDeleteForm, User_GroupAdminEditForm, User_GroupMemberEditForm, User_GroupPermEditForm, User_LostPassEditForm, User_Mailjob_linkAdminDeletesForm, User_MailjobAdminDeleteForm, User_MailjobAdminEditForm, User_MailjobAdminSendForm, User_RanksAdminDeleteForm, User_RanksAdminEditForm, User_RanksListForm, User_RecountForm, User_RegisterEditForm, User_UserAdminDeleteForm, User_UserAdminEditForm, User_UserConfirmForm, User_UserDeleteForm, User_UserListForm, and User_UserSearchListForm.

Definition at line 130 of file XCube_ActionForm.class.php.

◆ getVar()

getVar ( $key,
$index = null )
Parameters
$key
null$index
Returns
mixed
Deprecated

Definition at line 233 of file XCube_ActionForm.class.php.

◆ hasError()

hasError ( )

Gets a value indicating whether this action form keeps error messages or error flag.

Returns
bool - If the action form is error status, returns true.

Definition at line 376 of file XCube_ActionForm.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 in Legacy_AbstractCommentAdminEditForm, Legacy_BlockEditForm, Legacy_CommentAdminDeleteForm, Legacy_CommentEditForm, Legacy_CommentEditForm_Admin, Legacy_CustomBlockDeleteForm, Legacy_CustomBlockEditForm, Legacy_ImageAdminCreateForm, Legacy_ImageAdminDeleteForm, Legacy_ImagecategoryAdminDeleteForm, Legacy_ImagecategoryAdminEditForm, Legacy_ImagecategoryAdminNewForm, Legacy_ImageUploadForm, Legacy_InstallWizardForm, Legacy_MiscFriendForm, Legacy_ModuleEditForm, Legacy_ModuleInstallForm, Legacy_ModuleUninstallForm, Legacy_ModuleUpdateForm, Legacy_SmilesAdminDeleteForm, Legacy_SmilesAdminEditForm, Legacy_ThemeSelectForm, LegacyRender_BannerAdminDeleteForm, LegacyRender_BannerAdminEditForm, LegacyRender_BannerclientAdminDeleteForm, LegacyRender_BannerclientAdminEditForm, LegacyRender_BannerfinishAdminDeleteForm, LegacyRender_ThemeSelectForm, LegacyRender_TplfileAdminDeleteForm, LegacyRender_TplfileCloneForm, LegacyRender_TplfileEditForm, LegacyRender_TplsetCloneForm, LegacyRender_TplsetDeleteForm, LegacyRender_TplsetEditForm, MessageSettingsForm, Profile_Admin_DefinitionsDeleteForm, Profile_Admin_DefinitionsEditForm, Profile_DataDeleteForm, Profile_DataEditForm, User_AvatarAdminDeleteForm, User_AvatarAdminEditForm, User_AvatarEditForm, User_AvatarSelectForm, User_EditUserForm, User_GroupAdminDeleteForm, User_GroupAdminEditForm, User_MailjobAdminDeleteForm, User_MailjobAdminEditForm, User_MailjobAdminSendForm, User_RanksAdminDeleteForm, User_RanksAdminEditForm, User_RecountForm, User_RegisterEditForm, User_UserAdminDeleteForm, and User_UserAdminEditForm.

Definition at line 413 of file XCube_ActionForm.class.php.

◆ prepare()

prepare ( )

[Abstract] Set up form properties and field properties.

Reimplemented in Legacy_AbstractCommentAdminEditForm, Legacy_ActionSearchForm, Legacy_ApprovalCommentAdminEditForm, Legacy_BlockEditForm, Legacy_BlockListForm, Legacy_CommentAdminDeleteForm, Legacy_CommentEditForm, Legacy_CommentEditForm_Admin, Legacy_CommentListForm, Legacy_CustomBlockDeleteForm, Legacy_CustomBlockEditForm, Legacy_ImageAdminCreateForm, Legacy_ImageAdminDeleteForm, Legacy_ImagecategoryAdminDeleteForm, Legacy_ImagecategoryAdminEditForm, Legacy_ImagecategoryAdminNewForm, Legacy_ImagecategoryListForm, Legacy_ImageListForm, Legacy_ImageUploadForm, Legacy_ImageUploadForm, Legacy_InstallWizardForm, Legacy_MiscFriendForm, Legacy_ModuleEditForm, Legacy_ModuleInstallForm, Legacy_ModuleListForm, Legacy_ModuleUninstallForm, Legacy_ModuleUpdateForm, Legacy_PendingCommentAdminEditForm, Legacy_PreferenceEditForm, Legacy_SearchResultsForm, Legacy_SearchShowallbyuserForm, Legacy_SearchShowallForm, Legacy_SmilesAdminDeleteForm, Legacy_SmilesAdminEditForm, Legacy_SmilesListForm, Legacy_SmilesUploadForm, Legacy_ThemeSelectForm, LegacyRender_BannerAdminDeleteForm, LegacyRender_BannerAdminEditForm, LegacyRender_BannerclientAdminDeleteForm, LegacyRender_BannerclientAdminEditForm, LegacyRender_BannerfinishAdminDeleteForm, LegacyRender_ThemeSelectForm, LegacyRender_TplfileAdminDeleteForm, LegacyRender_TplfileCloneForm, LegacyRender_TplfileEditForm, LegacyRender_TplfileUploadForm, LegacyRender_TplsetCloneForm, LegacyRender_TplsetDeleteForm, LegacyRender_TplsetEditForm, LegacyRender_TplsetSelectForm, LegacyRender_TplsetUploadForm, MessageForm, MessageSettingsForm, Profile_Admin_DefinitionsDeleteForm, Profile_Admin_DefinitionsEditForm, Profile_DataDeleteForm, Profile_DataEditForm, User_AvatarAdminDeleteForm, User_AvatarAdminEditForm, User_AvatarListForm, User_AvatarSelectForm, User_AvatarUploadForm, User_EditUserForm, User_GroupAdminDeleteForm, User_GroupAdminEditForm, User_GroupMemberEditForm, User_GroupPermEditForm, User_LostPassEditForm, User_Mailjob_linkAdminDeletesForm, User_MailjobAdminDeleteForm, User_MailjobAdminEditForm, User_MailjobAdminSendForm, User_RanksAdminDeleteForm, User_RanksAdminEditForm, User_RanksListForm, User_RecountForm, User_RegisterAgreeEditForm, User_RegisterEditForm, User_UserAdminDeleteForm, User_UserAdminEditForm, User_UserConfirmForm, User_UserDeleteForm, User_UserListForm, User_UserSearchForm, and User_UserSearchListForm.

Definition at line 119 of file XCube_ActionForm.class.php.

◆ set()

set ( )

Sets the raw value as the value of the form property.

This method is an overloaded function.

XCube_ActionForm::set($name, $value)
Set $value to $name property.
$this->set('name', 'Bob'); // Set 'Bob' to 'name'.
XCube_ActionForm::set($name, $index, $value)
Set $value to $name array property[$index].
$this->set('names', 0, 'Bob'); // Set 'Bob' to 'names[0]'.

Definition at line 183 of file XCube_ActionForm.class.php.

◆ setVar()

setVar ( )
Deprecated

Definition at line 199 of file XCube_ActionForm.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 in Legacy_AbstractCommentAdminEditForm, Legacy_BlockEditForm, Legacy_BlockInstallEditForm, Legacy_BlockUninstallForm, Legacy_CommentAdminDeleteForm, Legacy_CommentEditForm, Legacy_CommentEditForm_Admin, Legacy_CustomBlockDeleteForm, Legacy_CustomBlockEditForm, Legacy_ImageAdminCreateForm, Legacy_ImageAdminDeleteForm, Legacy_ImagecategoryAdminDeleteForm, Legacy_ImagecategoryAdminEditForm, Legacy_ImagecategoryAdminNewForm, Legacy_ImageUploadForm, Legacy_InstallWizardForm, Legacy_MiscFriendForm, Legacy_ModuleEditForm, Legacy_ModuleInstallForm, Legacy_ModuleUninstallForm, Legacy_ModuleUpdateForm, Legacy_PreferenceEditForm, Legacy_SearchResultsForm, Legacy_SearchShowallbyuserForm, Legacy_SearchShowallForm, Legacy_SmilesAdminDeleteForm, Legacy_SmilesAdminEditForm, LegacyRender_BannerAdminDeleteForm, LegacyRender_BannerAdminEditForm, LegacyRender_BannerclientAdminDeleteForm, LegacyRender_BannerclientAdminEditForm, LegacyRender_BannerfinishAdminDeleteForm, LegacyRender_ThemeSelectForm, LegacyRender_TplfileAdminDeleteForm, LegacyRender_TplfileCloneForm, LegacyRender_TplfileEditForm, LegacyRender_TplsetCloneForm, LegacyRender_TplsetDeleteForm, LegacyRender_TplsetEditForm, MessageForm, MessageSettingsForm, Profile_Admin_DefinitionsDeleteForm, Profile_Admin_DefinitionsEditForm, Profile_DataDeleteForm, Profile_DataEditForm, User_AvatarAdminDeleteForm, User_AvatarAdminEditForm, User_AvatarEditForm, User_AvatarSelectForm, User_EditUserForm, User_GroupAdminDeleteForm, User_GroupAdminEditForm, User_MailjobAdminDeleteForm, User_MailjobAdminEditForm, User_RanksAdminDeleteForm, User_RanksAdminEditForm, User_RecountForm, User_RegisterEditForm, User_UserAdminDeleteForm, and User_UserAdminEditForm.

Definition at line 430 of file XCube_ActionForm.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 in Legacy_ImageUploadForm, Legacy_SearchResultsForm, LegacyRender_BannerAdminEditForm, and User_MailjobAdminEditForm.

Definition at line 344 of file XCube_ActionForm.class.php.

Field Documentation

◆ $_mToken

$_mToken

string

Token string as one-time token.

Definition at line 103 of file XCube_ActionForm.class.php.

◆ $mContext

$mContext

[READ ONLY] XCube_HttpContext

The context object. Allows to access the HTTP-request information. Basically, this member property is read only. Initialized in the constructor.

Definition at line 59 of file XCube_ActionForm.class.php.

◆ $mErrorFlag

$mErrorFlag = false

bool

Attention
This is temporary until we decide on the method of error handling.

Definition at line 89 of file XCube_ActionForm.class.php.

◆ $mErrorMessages

$mErrorMessages = []

string[]

Definition at line 95 of file XCube_ActionForm.class.php.

◆ $mFieldProperties

$mFieldProperties = []

XCube_FieldProperty[].

Definition at line 81 of file XCube_ActionForm.class.php.

◆ $mFormProperties

$mFormProperties = []

XCube_FormProperty[].

Definition at line 75 of file XCube_ActionForm.class.php.

◆ $mUser

$mUser

[READ ONLY] XCube_Principal

The object implementing the interface of XCube_Principal. Allows you to check the permissions of the current HTTP-request through principal object. Basically, this member property is read only. Initialized in constructor.

Definition at line 69 of file XCube_ActionForm.class.php.

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