PKPInstall Class Reference

Inheritance diagram for PKPInstall:

Public Member Functions
	__construct ($xmlDescriptor, $params, $isPlugin)
	createConfig ()
	createData ()
	createDatabase ()
	createDirectories ()
	getCreateDirectories ()
	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

Definition at line 33 of file PKPInstall.inc.php.

Constructor & Destructor Documentation

__construct()

PKPInstall::__construct	(		$xmlDescriptor,
			$params,
			$isPlugin
	)

Constructor.

See also

install.form.InstallForm for the expected parameters

Parameters

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

Reimplemented from Installer.

Reimplemented in Install.

Definition at line 42 of file PKPInstall.inc.php.

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

Member Function Documentation

createConfig()

PKPInstall::createConfig

(

)

Write the configuration file.

Returns

boolean

Definition at line 227 of file PKPInstall.inc.php.

References PKPApplication\get(), Installer\getParam(), and Installer\updateConfig().

createData()

PKPInstall::createData

(

)

Create initial required data.

Returns

boolean

Definition at line 262 of file PKPInstall.inc.php.

References Installer\$locale, Validation\encryptCredentials(), PKPServices\get(), DAORegistry\getDAO(), Installer\getParam(), AppLocale\requireComponents(), and Installer\setError().

createDatabase()

PKPInstall::createDatabase

(

)

Create a new database if required.

Returns

boolean

Definition at line 183 of file PKPInstall.inc.php.

References Installer\$sql, Installer\executeSQL(), DBConnection\getInstance(), Installer\getParam(), and Installer\setError().

createDirectories()

PKPInstall::createDirectories

(

)

Create required files directories FIXME No longer needed since FileManager will auto-create?

Returns

boolean

Definition at line 132 of file PKPInstall.inc.php.

References getCreateDirectories(), Installer\getParam(), Config\getVar(), and Installer\setError().

getCreateDirectories()

PKPInstall::getCreateDirectories

(

)

Get the names of the directories to create.

Returns

array

Reimplemented in Install.

Definition at line 123 of file PKPInstall.inc.php.

Referenced by createDirectories().

isUpgrade()

PKPInstall::isUpgrade

(

)

Returns true iff this is an upgrade process.

Reimplemented from Installer.

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

preInstall()

PKPInstall::preInstall

(

)

Pre-installation.

Returns

boolean

Reimplemented from Installer.

Definition at line 57 of file PKPInstall.inc.php.

References Version\fromString(), DBConnection\getInstance(), Installer\getParam(), PKPLocale\isLocaleValid(), and Installer\setError().

---

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

• PKPInstall.inc.php