Public Member Functions | |
| __construct ($request, $userId=null, $author=null) | |
| display ($request=null, $template=null) | |
| execute (... $functionParams) | |
| getLocaleFieldNames () | |
| initData () | |
| readInputData () | |
 Public Member Functions inherited from UserForm | |
| __construct ($template, $userId=null) | |
| 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 () | |
| getRequiredLocale () | |
| getTemplate () | |
| isValid () | |
| readUserVars ($vars) | |
| setData ($key, $value=null) | |
| setDefaultFormLocale ($defaultLocale) | |
| setTemplate ($template) | |
| validate ($callHooks=true) | |
Data Fields | |
| $author | |
| $user | |
| Data Fields inherited from UserForm | |
| $userId | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Form for editing user profiles.
Definition at line 18 of file UserDetailsForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| UserDetailsForm::__construct | ( | $request, | |
$userId = null, |
|||
$author = null |
|||
| ) |
Constructor.
- Parameters
-
$request PKPRequest $userId int optional $author Author optional
Definition at line 38 of file UserDetailsForm.inc.php.
References $author, UserForm\$userId, Form\addCheck(), Form\addSupportedFormLocale(), DAORegistry\getDAO(), Config\getVar(), and PKPString\strlen().
Member Function Documentation
◆ display()
| UserDetailsForm::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 UserForm.
Definition at line 165 of file UserDetailsForm.inc.php.
References DAORegistry\getDAO(), and PKPTemplateManager\getManager().
◆ execute()
| UserDetailsForm::execute | ( | $functionParams | ) |
Create or update a user.
Reimplemented from UserForm.
Definition at line 252 of file UserDetailsForm.inc.php.
References $user, UserForm\$userId, Validation\encryptCredentials(), Validation\generatePassword(), PKPServices\get(), PKPApplication\get(), Core\getCurrentDate(), DAORegistry\getDAO(), Form\getData(), and PKPLocale\isLocaleValid().
◆ getLocaleFieldNames()
| UserDetailsForm::getLocaleFieldNames | ( | ) |
Get all locale field names
Reimplemented from Form.
Definition at line 244 of file UserDetailsForm.inc.php.
References DAORegistry\getDAO().
◆ initData()
| UserDetailsForm::initData | ( | ) |
Initialize form data from current user profile.
Reimplemented from UserForm.
Definition at line 100 of file UserDetailsForm.inc.php.
References $author, $user, PKPServices\get(), PKPApplication\get(), and Form\setData().
◆ readInputData()
| UserDetailsForm::readInputData | ( | ) |
Assign form data to user-submitted data.
- See also
- Form::readInputData()
Reimplemented from UserForm.
Definition at line 206 of file UserDetailsForm.inc.php.
References Form\getData(), Form\readUserVars(), and Form\setData().
Field Documentation
◆ $author
| An UserDetailsForm::$author |
optional author to base this user on
Definition at line 30 of file UserDetailsForm.inc.php.
Referenced by __construct(), and initData().
◆ $user
| User UserDetailsForm::$user |
Definition at line 24 of file UserDetailsForm.inc.php.
Referenced by execute(), and initData().
The documentation for this class was generated from the following file:
