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

Public Member Functions

 __construct ($request)
 
 checkDBDrivers ()
 
 display ($request=null, $template=null)
 
 execute (... $functionArgs)
 
 initData ()
 
 readInputData ()
 
- Public Member Functions inherited from MaintenanceForm
 __construct ($request, $template)
 
 dbInstallError ($errorMsg)
 
 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)
 
 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

 $localesComplete
 
 $supportedClientCharsets
 
 $supportedConnectionCharsets
 
 $supportedDatabaseCharsets
 
 $supportedDatabaseDrivers
 
 $supportedLocales
 
- Data Fields inherited from MaintenanceForm
 $_request
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for system installation.

See also
Install

Definition at line 20 of file InstallForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

InstallForm::__construct (   $request)

Constructor.

Parameters
$requestPKPRequest

Definition at line 62 of file InstallForm.inc.php.

References Form\addCheck(), PKPLocale\getAllLocales(), and PKPLocale\isLocaleComplete().

Member Function Documentation

◆ checkDBDrivers()

InstallForm::checkDBDrivers ( )

Check if database drivers have the required PHP module loaded. The names of drivers that appear to be unavailable are bracketed.

Returns
array

Definition at line 241 of file InstallForm.inc.php.

Referenced by display().

◆ display()

InstallForm::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 MaintenanceForm.

Definition at line 122 of file InstallForm.inc.php.

References checkDBDrivers(), XSLTransformer\checkSupport(), PKPTemplateManager\getManager(), and PKPString\hasMBString().

◆ execute()

InstallForm::execute (   $functionArgs)

Perform installation.

Parameters
...$functionArgsFunction arguments
Returns
mixed

Reimplemented from Form.

Definition at line 208 of file InstallForm.inc.php.

References MaintenanceForm\dbInstallError(), PKPTemplateManager\getManager(), and MaintenanceForm\installError().

◆ initData()

InstallForm::initData ( )

Initialize form data for a new form.

Reimplemented from Form.

Definition at line 147 of file InstallForm.inc.php.

References AppLocale\getLocale(), Application\getName(), and Core\isWindows().

◆ readInputData()

InstallForm::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 177 of file InstallForm.inc.php.

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

Field Documentation

◆ $localesComplete

array InstallForm::$localesComplete

locale completeness booleans

Definition at line 32 of file InstallForm.inc.php.

◆ $supportedClientCharsets

array InstallForm::$supportedClientCharsets

client character sets supported by this system

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

◆ $supportedConnectionCharsets

array InstallForm::$supportedConnectionCharsets

connection character sets supported by this system

Definition at line 44 of file InstallForm.inc.php.

◆ $supportedDatabaseCharsets

array InstallForm::$supportedDatabaseCharsets

database character sets supported by this system

Definition at line 50 of file InstallForm.inc.php.

◆ $supportedDatabaseDrivers

array InstallForm::$supportedDatabaseDrivers

database drivers supported by this system

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

◆ $supportedLocales

array InstallForm::$supportedLocales

locales supported by this system

Definition at line 26 of file InstallForm.inc.php.


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