Public Member Functions | |
| __construct ($template, $userId=null) | |
| display ($request=null, $template=null) | |
| execute (... $functionArgs) | |
| initData () | |
| readInputData () | |
 Public Member Functions inherited from Form | |
| __construct ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null) | |
| _decomposeArray ($name, $value, $stack) | |
| addCheck ($formValidator) | |
| addError ($field, $message) | |
| addErrorField ($field) | |
| addSupportedFormLocale ($supportedLocale) | |
| fetch ($request, $template=null, $display=false) | |
| getData ($key) | |
| getDefaultFormLocale () | |
| getErrorsArray () | |
| getLocaleFieldNames () | |
| getRequiredLocale () | |
| getTemplate () | |
| isValid () | |
| readUserVars ($vars) | |
| setData ($key, $value=null) | |
| setDefaultFormLocale ($defaultLocale) | |
| setTemplate ($template) | |
| validate ($callHooks=true) | |
Data Fields | |
| $userId | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Base class for user forms.
Definition at line 18 of file UserForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| UserForm::__construct | ( | $template, | |
$userId = null |
|||
| ) |
Constructor.
- Parameters
-
$request PKPRequest $userId int optional $author Author optional
Reimplemented in UserRoleForm.
Definition at line 32 of file UserForm.inc.php.
References $userId, and Form\addCheck().
Member Function Documentation
◆ display()
| UserForm::display | ( | $request = null, |
|
$template = null |
|||
| ) |
Display the form.
- Parameters
-
$request PKPRequest $template string the template to be rendered, mandatory if no template has been specified on class instantiation.
Reimplemented from Form.
Reimplemented in UserDetailsForm, and UserRoleForm.
Definition at line 69 of file UserForm.inc.php.
References Form\fetch(), DAORegistry\getDAO(), Form\getData(), and PKPTemplateManager\getManager().
◆ execute()
| UserForm::execute | ( | $functionArgs | ) |
Execute the form's action. (Note that it is assumed that the form has already been validated.)
- Parameters
-
mixed $functionArgs,... Arguments from the caller to be passed to the hook consumer
- Returns
- mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.
Reimplemented from Form.
Reimplemented in UserDetailsForm, and UserRoleForm.
Definition at line 92 of file UserForm.inc.php.
References PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().
◆ initData()
| UserForm::initData | ( | ) |
Initialize form data from current user profile.
Reimplemented from Form.
Reimplemented in UserDetailsForm.
Definition at line 45 of file UserForm.inc.php.
References DAORegistry\getDAO(), and Form\setData().
◆ readInputData()
| UserForm::readInputData | ( | ) |
Assign form data to user-submitted data. Can be overridden from subclasses.
Reimplemented from Form.
Reimplemented in UserDetailsForm.
Definition at line 61 of file UserForm.inc.php.
References Form\readUserVars().
Field Documentation
◆ $userId
| Id UserForm::$userId |
of the user being edited
Definition at line 24 of file UserForm.inc.php.
Referenced by UserRoleForm\__construct(), __construct(), UserDetailsForm\__construct(), and UserDetailsForm\execute().
The documentation for this class was generated from the following file:
