XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
Loading...
Searching...
No Matches
User_AvatarEditForm Class Reference
Inheritance diagram for User_AvatarEditForm:
XCube_ActionForm

Public Member Functions

 getTokenName ()
 Gets the token name of this actionform's token.
 
 prepare ($width=null, $height=null, $maxfilesize=null)
 
 validateUploadavatar ()
 
 load (&$obj)
 [Abstract] Initializes properties' values from an object.
 
 update (&$obj)
 [Abstract] Updates an object with properties values.
 
 createAvatar ()
 
- Public Member Functions inherited from XCube_ActionForm
 __construct ()
 Constructor.
 
 prepare ()
 [Abstract] Set up form properties and field properties.
 
 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

 $mOldAvatarFilename = null
 
 $mFormFile = null
 
 $mWidth = 0
 
 $mHeight = 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 14 of file AvatarEditForm.class.php.

Member Function Documentation

◆ createAvatar()

createAvatar ( )
Returns
UserAvatarObject

Definition at line 94 of file AvatarEditForm.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.

Definition at line 22 of file AvatarEditForm.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 69 of file AvatarEditForm.class.php.

◆ prepare()

prepare ( $width = null,
$height = null,
$maxfilesize = null )

Definition at line 27 of file AvatarEditForm.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 75 of file AvatarEditForm.class.php.

◆ validateUploadavatar()

validateUploadavatar ( )

Definition at line 54 of file AvatarEditForm.class.php.

Field Documentation

◆ $mFormFile

$mFormFile = null

Definition at line 17 of file AvatarEditForm.class.php.

◆ $mHeight

$mHeight = 0

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

◆ $mOldAvatarFilename

$mOldAvatarFilename = null

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

◆ $mWidth

$mWidth = 0

Definition at line 19 of file AvatarEditForm.class.php.


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