Upgrade Class Reference

Perform system upgrade. More...

List of all members.

Public Member Functions
	addPluginVersions ()
	changePresenterInUserEmailTemplates ()
	cleanImageAlts ()
	cleanTitles ()
	dropAllIndexes ()
	ensureSupportedLocales ()
	installBlockPlugins ()
	isUpgrade ()
	localizeConferenceSettings ()
	localizeProgramSettings ()
	localizeSchedConfSettings ()
	migratePaperLocations ()
	rebuildSearchIndex ()
	setConferencePrimaryLocales ()
	setGalleyLocales ()
	setReviewMode ()
	updateReviewDeadlineSettings ()
	Upgrade ($params, $installFile= 'upgrade.xml', $isPlugin=false)
	upgradePaperType ()

---

Detailed Description

Perform system upgrade.

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

---

Member Function Documentation

Upgrade.addPluginVersions

(

)

For 2.3 upgrade: Add initial plugin data to versions table

Returns:

boolean

Definition at line 660 of file Upgrade.inc.php.

Upgrade.changePresenterInUserEmailTemplates

(

)

For 2.3 update. Go through all user email templates and change {$presenter to {$author

Definition at line 430 of file Upgrade.inc.php.

Upgrade.cleanImageAlts

(

)

For 2.3 upgrade: Move image alts for Conference Setup Step 2/3 from within the image settings into their own settings. (Improves usability of setup forms and simplifies the code considerably.)

Returns:

boolean

Definition at line 630 of file Upgrade.inc.php.

Upgrade.cleanTitles

(

)

For 2.3 upgrade: Add clean titles for every article title so sorting by title ignores punctuation.

Returns:

boolean

Definition at line 606 of file Upgrade.inc.php.

Upgrade.dropAllIndexes

(

)

For 2.1 upgrade: index handling changed away from using the <KEY> syntax in schema descriptors in cases where AUTONUM columns were not used, in favour of specifically-named indexes using the <index ...> syntax. For this, all indexes (including potentially duplicated indexes from before) on OCS tables should be dropped prior to the new schema being applied.

Returns:

boolean

Definition at line 349 of file Upgrade.inc.php.

Upgrade.ensureSupportedLocales

(

)

The supportedLocales setting may be missing for conferences; ensure that it is properly set.

Definition at line 400 of file Upgrade.inc.php.

Upgrade.installBlockPlugins

(

)

For upgrade to 2.1.0: Install default settings for block plugins.

Returns:

boolean

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

Upgrade.isUpgrade

(

)

Returns true iff this is an upgrade process.

Returns:

boolean

Definition at line 35 of file Upgrade.inc.php.

Upgrade.localizeConferenceSettings

(

)

For 2.1.0 upgrade: add locale data to existing conference settings that were not previously localized.

Returns:

boolean

Definition at line 200 of file Upgrade.inc.php.

Upgrade.localizeProgramSettings

(

)

For 2.1.2 upgrade: add locale data to program settings

Returns:

boolean

Definition at line 550 of file Upgrade.inc.php.

Upgrade.localizeSchedConfSettings

(

)

For 2.1.0 upgrade: add locale data to existing sched conf settings and that were not previously localized.

Returns:

boolean

Definition at line 260 of file Upgrade.inc.php.

Upgrade.migratePaperLocations

(

)

For upgrade to 2.1.0: Migrate paper locations into scheduler

Returns:

boolean

Definition at line 137 of file Upgrade.inc.php.

Upgrade.rebuildSearchIndex

(

)

Rebuild the search index.

Returns:

boolean

Definition at line 47 of file Upgrade.inc.php.

References PaperSearchIndex.rebuildIndex().

Upgrade.setConferencePrimaryLocales

(

)

For upgrade to 2.1.0: Move primary_locale from conference settings into dedicated column.

Returns:

boolean

Definition at line 96 of file Upgrade.inc.php.

Upgrade.setGalleyLocales

(

)

For 2.1.0 upgrade: Set locales for galleys.

Returns:

boolean

Definition at line 306 of file Upgrade.inc.php.

Upgrade.setReviewMode

(

)

For 2.1.0 upgrade: Set review mode for papers.

Returns:

boolean

Definition at line 326 of file Upgrade.inc.php.

Upgrade.updateReviewDeadlineSettings

(

)

For 2.3 upgrade: update default review deadline settings to allow absolute due dates

Returns:

boolean

Definition at line 574 of file Upgrade.inc.php.

Upgrade.Upgrade	(	$	params,
		$	installFile = 'upgrade.xml',
		$	isPlugin = false
	)

Constructor.

Parameters:

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

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

Upgrade.upgradePaperType

(

)

For upgrade to 2.3: remove allowIndividualSubmissions and allowPanelSubmissions settings in favour of controlled vocabulary structure.

Definition at line 474 of file Upgrade.inc.php.

---

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

• classes/install/Upgrade.inc.php

---