Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Install Class Reference

Inherits PKPInstall.

Public Member Functions

 createData ()
 
 getCreateDirectories ()
 
 Install ($params, $descriptor= 'install.xml', $isPlugin=false)
 
- Public Member Functions inherited from PKPInstall
 createConfig ()
 
 createData ()
 
 createDatabase ()
 
 createDirectories ()
 
 getCreateDirectories ()
 
 isUpgrade ()
 
 PKPInstall ($xmlDescriptor, $params, $isPlugin)
 
 preInstall ()
 
- Public Member Functions inherited from Installer
 abort ($installer, $attr)
 
 addInstallAction ($node)
 
 addPluginVersions ()
 
 clearDataCache ()
 
 columnExists ($tableName, $columnName)
 
 destroy ()
 
 execute ()
 
 executeAction ($action)
 
 executeInstaller ()
 
 executeSQL ($sql)
 
 getConfigContents ()
 
 getCurrentVersion ()
 
 getErrorMsg ()
 
 getErrorString ()
 
 getErrorType ()
 
 getNewVersion ()
 
 getNotes ()
 
 getParam ($name)
 
 getSQL ()
 
 installEmailTemplate ($installer, $attr)
 
 Installer ($descriptor, $params=array(), $isPlugin=false)
 
 installFilterConfig ($filterConfigFile)
 
 isUpgrade ()
 
 log ($message)
 
 parseInstaller ()
 
 parseInstallNodes ($installTree)
 
 postInstall ()
 
 preInstall ()
 
 setCurrentVersion ($version)
 
 setError ($type, $msg)
 
 setLogger ($logger)
 
 tableExists ($tableName)
 
 updateConfig ($configParams)
 
 updateVersion ()
 
 wroteConfig ()
 

Additional Inherited Members

- Public Attributes inherited from Installer
 $actions
 
 $configContents
 
 $currentVersion
 
 $dataXMLParser
 
 $dbconn
 
 $descriptor
 
 $errorMsg
 
 $errorType
 
 $installedLocales
 
 $isPlugin
 
 $locale
 
 $logger
 
 $newVersion
 
 $notes
 
 $params
 
 $sql
 
 $wroteConfig
 

Detailed Description

Perform system installation.

See Also
Installer, InstallForm

This script will:

  • Create the database (optionally), and install the database tables and initial data.
  • Update the config file with installation parameters.

Definition at line 28 of file Install.inc.php.

Member Function Documentation

Install::createData ( )

Create initial required data.

Returns
boolean

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

Install::getCreateDirectories ( )

Get the names of the directories to create.

Returns
array

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

Install::Install (   $params,
  $descriptor = 'install.xml',
  $isPlugin = false 
)

Constructor.

See Also
install.form.InstallForm for the expected parameters
Parameters
$paramsarray installer parameters
$descriptorstring descriptor path
$isPluginboolean true iff a plugin is being installed

Definition at line 37 of file Install.inc.php.

References Installer\$descriptor, Installer\$isPlugin, and Installer\$params.


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