Open Journal Systems  3.3.0
MaintenanceForm Class Reference
Inheritance diagram for MaintenanceForm:
Form InstallForm UpgradeForm

Public Member Functions

 __construct ($request, $template)
 
 dbInstallError ($errorMsg)
 
 display ($request=null, $template=null)
 
 installError ($errorMsg, $translate=true)
 
- 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)
 
 execute (... $functionArgs)
 
 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

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

Detailed Description

Base form for system maintenance (install/upgrade).

Definition at line 19 of file MaintenanceForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

MaintenanceForm::__construct (   $request,
  $template 
)

Constructor.

Definition at line 29 of file MaintenanceForm.inc.php.

References Form\addCheck().

Member Function Documentation

◆ dbInstallError()

MaintenanceForm::dbInstallError (   $errorMsg)

Fail with a database installation error.

Parameters
$errorMsgstring

Definition at line 59 of file MaintenanceForm.inc.php.

References display(), and PKPTemplateManager\getManager().

Referenced by UpgradeForm\execute(), and InstallForm\execute().

◆ display()

MaintenanceForm::display (   $request = null,
  $template = null 
)

Display the form.

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

Reimplemented from Form.

Reimplemented in InstallForm.

Definition at line 38 of file MaintenanceForm.inc.php.

References VersionCheck\getCurrentCodeVersion(), and PKPTemplateManager\getManager().

Referenced by dbInstallError(), and installError().

◆ installError()

MaintenanceForm::installError (   $errorMsg,
  $translate = true 
)

Fail with a generic installation error.

Parameters
$errorMsgstring
$translateboolean

Definition at line 49 of file MaintenanceForm.inc.php.

References display(), and PKPTemplateManager\getManager().

Referenced by UpgradeForm\execute(), and InstallForm\execute().

Field Documentation

◆ $_request

PKPRequest MaintenanceForm::$_request

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


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