Install Class Reference

Inheritance diagram for Install:

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

Additional Inherited Members
Data Fields inherited from Installer
	$actions
	$configContents
	$currentVersion
	$dataXMLParser
	$dbconn
	$descriptor
	$errorMsg
	$errorType
	$installedLocales
	$isPlugin
	$locale
	$logger
	$migrations = []
	$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.

Constructor & Destructor Documentation

__construct()

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

Constructor.

See also

install.form.InstallForm for the expected parameters

Parameters

$params	array installer parameters
$descriptor	string descriptor path
$isPlugin	boolean true iff a plugin is being installed

Reimplemented from PKPInstall.

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

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

Member Function Documentation

createData()

Install::createData

(

)

Create initial required data.

Returns

boolean

Reimplemented from PKPInstall.

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

getCreateDirectories()

Install::getCreateDirectories

(

)

Get the names of the directories to create.

Returns

array

Reimplemented from PKPInstall.

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

---

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

• Install.inc.php