Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Upgrade Class Reference
Inheritance diagram for Upgrade:
Installer

Public Member Functions

 cleanImageAlts ()
 
 cleanTitles ()
 
 clearDataCache ()
 
 correctCurrencies ()
 
 designateReviewVersions ()
 
 dropAllIndexes ()
 
 ensureSupportedLocales ()
 
 installBlockPlugins ()
 
 isUpgrade ()
 
 localizeJournalSettings ()
 
 localizeMoreJournalSettings ()
 
 migrateCounterPluginUsageStatistics ()
 
 migrateDefaultUsageStatistics ()
 
 migrateIssueLabelAndSettings ()
 
 migrateNotifications ()
 
 migratePublisher ()
 
 migrateReviewingInterests ()
 
 migrateRtSettings ()
 
 migrateTimedViewsUsageStatistics ()
 
 migrateUserSettings ()
 
 rebuildSearchIndex ()
 
 removeAuthorRevisedFilesFromSignoffs ()
 
 renamePayPerViewSettings ()
 
 separateSubscriptions ()
 
 setGalleyLocales ()
 
 setJournalPrimaryLocales ()
 
 Upgrade ($params, $installFile= 'upgrade.xml', $isPlugin=false)
 
- Public Member Functions inherited from Installer
 addInstallAction (&$node)
 
 addPluginVersions ()
 
 clearDataCache ()
 
 columnExists ($tableName, $columnName)
 
 destroy ()
 
 execute ()
 
 executeAction ($action)
 
 executeInstaller ()
 
 fileExists ($filePath)
 
 getConfigContents ()
 
getCurrentVersion ()
 
 getErrorMsg ()
 
 getErrorString ()
 
 getErrorType ()
 
getNewVersion ()
 
 getNotes ()
 
 getParam ($name)
 
 getSQL ()
 
 installEmailTemplate ($installer, $attr)
 
 Installer ($descriptor, $params=array(), $isPlugin=false)
 
 installFilterConfig ($filterConfigFile)
 
 isUpgrade ()
 
 parseInstaller ()
 
 parseInstallNodes (&$installTree)
 
 postInstall ()
 
 preInstall ()
 
 setError ($type, $msg)
 
 tableExists ($tableName)
 
 updateConfig ($configParams)
 
 updateVersion ()
 
 wroteConfig ()
 

Detailed Description

Perform system upgrade.

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

Member Function Documentation

Upgrade::cleanImageAlts ( )

For 2.3 upgrade: Move image alts for Journal Setup Step 5 from within the image settings into their own settings. (Improves usability of page 5 setup form and simplifies the code considerably.)

Returns
boolean

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

References DAORegistry\getDAO().

Upgrade::cleanTitles ( )

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

Returns
boolean

Definition at line 669 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 261 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 127 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 57 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 469 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 525 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 222 of file Upgrade.inc.php.

References DAORegistry\getDAO().

Upgrade::isUpgrade ( )

Returns true iff this is an upgrade process.

Returns
boolean

Definition at line 33 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 273 of file Upgrade.inc.php.

References DAORegistry\getDAO().

Upgrade::localizeMoreJournalSettings ( )

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

Returns
boolean

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

References DAORegistry\getDAO().

Upgrade::migrateCounterPluginUsageStatistics ( )

For 2.4 upgrade: migrate COUNTER statistics to the metrics table.

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

References DAORegistry\getDAO().

Upgrade::migrateDefaultUsageStatistics ( )

For 2.4 upgrade: migrate OJS default statistics to the metrics table.

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

References DAORegistry\getDAO(), and Installer\tableExists().

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 145 of file Upgrade.inc.php.

References DAORegistry\getDAO().

Upgrade::migrateNotifications ( )

For 2.4 Upgrade – Overhaul notification structure

Definition at line 774 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 388 of file Upgrade.inc.php.

References DAORegistry\getDAO().

Upgrade::migrateReviewingInterests ( )

For 2.3.3 upgrade: Migrate reviewing interests from free text to controlled vocab structure

Returns
boolean

Definition at line 722 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 83 of file Upgrade.inc.php.

References DAORegistry\getDAO().

Upgrade::migrateTimedViewsUsageStatistics ( )

For 2.4 upgrade: migrate Timed views statistics to the metrics table.

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

References DAORegistry\getDAO(), PluginRegistry\getPlugin(), and Config\getVar().

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 445 of file Upgrade.inc.php.

References DAORegistry\getDAO().

Upgrade::rebuildSearchIndex ( )

Rebuild the search index.

Returns
boolean

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

Upgrade::removeAuthorRevisedFilesFromSignoffs ( )

For 2.3.7 Upgrade – Remove author revised file upload IDs erroneously added to copyedit signoff

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

References DAORegistry\getDAO().

Upgrade::renamePayPerViewSettings ( )

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

Returns
boolean

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

References DAORegistry\getDAO().

Upgrade::separateSubscriptions ( )

For 2.3 upgrade: Separate out individual and institutional subscriptions. Also pull apart single ip range string into multiple, shorter strings.

Returns
boolean

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

References DAORegistry\getDAO().

Upgrade::setGalleyLocales ( )

For 2.2 upgrade: Set locales for galleys.

Returns
boolean

Definition at line 423 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 203 of file Upgrade.inc.php.

References DAORegistry\getDAO().

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

Constructor.

Parameters
$paramsarray upgrade parameters

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


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