Upgrade Class Reference
[Install]

Perform system upgrade. More...

Inheritance diagram for Upgrade:

List of all members.

Public Member Functions
	addSubscriptionIPRanges ()
	clearDataCache ()
	correctCurrencies ()
	designateReviewVersions ()
	dropAllIndexes ()
	ensureSupportedLocales ()
	installBlockPlugins ()
	isUpgrade ()
	localizeJournalSettings ()
	migrateIssueLabelAndSettings ()
	migratePublisher ()
	migrateRtSettings ()
	migrateUserSettings ()
	rebuildSearchIndex ()
	renamePayPerViewSettings ()
	setGalleyLocales ()
	setJournalPrimaryLocales ()
	Upgrade ($params)

---

Detailed Description

Perform system upgrade.

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

---

Member Function Documentation

Upgrade.addSubscriptionIPRanges

(

)

For 2.2 upgrade: Add IP ranges for all journal subscriptions.

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.clearDataCache

(

)

Clear the data cache files (needed because of direct tinkering with settings tables)

Returns:

boolean

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

Upgrade.correctCurrencies

(

)

For upgrade to OJS 2.2.0: Migrate the currency settings so the currencies table can be dropped in favour of XML.

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.designateReviewVersions

(

)

For upgrade to 2.1.1: Designate original versions as review versions in all cases where review versions aren't designated. (#2144)

Returns:

boolean

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

References AuthorAction.designateReviewVersion(), and DAORegistry.getDAO().

Upgrade.dropAllIndexes

(

)

For 2.2 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 OJS tables should be dropped prior to the new schema being applied.

Returns:

boolean

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

References DAORegistry.getDAO(), and Config.getVar().

Upgrade.ensureSupportedLocales

(

)

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

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

References DAORegistry.getDAO().

Upgrade.installBlockPlugins

(

)

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

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.isUpgrade

(

)

Returns true iff this is an upgrade process.

Returns:

boolean

Reimplemented from Installer.

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

Upgrade.localizeJournalSettings

(

)

For 2.2 upgrade: add locale data to existing journal settings that were not previously localized.

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.migrateIssueLabelAndSettings

(

)

For upgrade to 2.2.0: Migrate the issue label column and values to the new show volume, show number, etc. columns and values. Migrate the publication format settings for the journal to the new issue label format. (#2291)

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.migratePublisher

(

)

For 2.2 upgrade: Migrate the "publisher" setting from a serialized array into three localized settings: publisherUrl, publisherNote, and publisherInstitution.

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.migrateRtSettings

(

)

For upgrade to 2.1.1: Migrate the RT settings from the rt_settings table to journal settings and drop the rt_settings table.

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.migrateUserSettings

(

)

For 2.2 upgrade: user_settings table has been renamed in order to apply the schema changes for localization. Migrate the settings from user_settings_old to user_settings now that the new schema has been applied.

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

References DAORegistry.getDAO().

Upgrade.rebuildSearchIndex

(

)

Rebuild the search index.

Returns:

boolean

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

References ArticleSearchIndex.rebuildIndex().

Upgrade.renamePayPerViewSettings

(

)

For 2.2.1 upgrade: Replace "payPerView" to "purchaseArticle" in settings.

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.setGalleyLocales

(

)

For 2.2 upgrade: Set locales for galleys.

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.setJournalPrimaryLocales

(

)

For upgrade to 2.2: Move primary_locale from journal settings into dedicated column.

Returns:

boolean

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

References DAORegistry.getDAO().

Upgrade.Upgrade

(

$

params

)

Constructor.

Parameters:

$params

array upgrade parameters

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

---

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

• classes/install/Upgrade.inc.php