Open Journal Systems  3.3.0
ContactForm Class Reference
Inheritance diagram for ContactForm:
BaseProfileForm Form

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

Form to edit user's contact information.

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

Constructor & Destructor Documentation

◆ __construct()

ContactForm::__construct (   $user)

Constructor.

Parameters
$userUser

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

References Form\addCheck(), and DAORegistry\getDAO().

Member Function Documentation

◆ execute()

ContactForm::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 BaseProfileForm.

Definition at line 89 of file ContactForm.inc.php.

References PKPApplication\get(), Form\getData(), BaseProfileForm\getUser(), and PKPLocale\isLocaleValid().

◆ fetch()

ContactForm::fetch (   $request,
  $template = null,
  $display = false 
)

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Reimplemented from Form.

Definition at line 36 of file ContactForm.inc.php.

References PKPTemplateManager\getManager().

◆ initData()

ContactForm::initData ( )

Initialize form data for a new form.

Reimplemented from Form.

Definition at line 56 of file ContactForm.inc.php.

References BaseProfileForm\getUser().

◆ readInputData()

ContactForm::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 73 of file ContactForm.inc.php.

References Form\getData(), Form\readUserVars(), and Form\setData().


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