Open Journal Systems  3.3.0
BaseProfileForm Class Reference
Inheritance diagram for BaseProfileForm:
Form APIProfileForm ContactForm IdentityForm PublicProfileForm RolesForm

Public Member Functions

 __construct ($template, $user)
 
 execute (... $functionArgs)
 
 getUser ()
 
- 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)
 
 display ($request=null, $template=null)
 
 fetch ($request, $template=null, $display=false)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isValid ()
 
 readInputData ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

 $_user
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Base form to edit an aspect of user profile.

Definition at line 18 of file BaseProfileForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

BaseProfileForm::__construct (   $template,
  $user 
)

Constructor.

Parameters
$templatestring
$userUser

Definition at line 31 of file BaseProfileForm.inc.php.

References Form\addCheck().

Member Function Documentation

◆ execute()

BaseProfileForm::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 PublicProfileForm, ContactForm, IdentityForm, RolesForm, and APIProfileForm.

Definition at line 51 of file BaseProfileForm.inc.php.

References PKPApplication\get(), and DAORegistry\getDAO().

◆ getUser()

Field Documentation

◆ $_user

User BaseProfileForm::$_user

Definition at line 24 of file BaseProfileForm.inc.php.

Referenced by getUser().


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