PHP Class Upgrade, ojs

Inheritance: extends CI_Controller
Show file Open project: pkp/ojs Class Usage Examples

Public Methods

Method Description
__construct ( $params, $installFile = 'upgrade.xml', $isPlugin = false ) Constructor.
_createQuery ( $stageId, $submissionId, $sequence, $title, $dateNotified = null )
clearDataCache ( ) : boolean Clear the data cache files (needed because of direct tinkering with settings tables)
convertEditorDecisionNotes ( ) : boolean Convert editor decision notes to a query.
convertQueries ( ) : boolean Convert signoffs to queries.
convertSupplementaryFiles ( ) : boolean Convert supplementary files to submission files.
fixReviewForms ( ) : boolean Modernize review form storage from OJS 2.x
htmlifyEmailTemplates ( ) : boolean Convert email templates to HTML.
installDefaultGenres ( ) For 3.0.0 upgrade. Genres are required to migrate files.
isUpgrade ( ) : boolean Returns true iff this is an upgrade process.
localizeArticleCoverImages ( ) : boolean Localize article cover images.
localizeCustomBlockSettings ( ) For 2.4.6 upgrade: to enable localization of a CustomBlock, the blockContent values are converted from string to array (key: primary_language)
localizeIssueCoverImages ( ) : boolean Localize issue cover images.
migrateArticleMetadata ( ) : boolean For 3.0.0 upgrade: Convert string-field semi-colon separated metadata to controlled vocabularies.
migrateCounterPluginUsageStatistics ( ) For 2.4 upgrade: migrate COUNTER statistics to the metrics table.
migrateDefaultUsageStatistics ( ) For 2.4 upgrade: migrate OJS default statistics to the metrics table.
migrateFiles ( $upgrade, $params ) : boolean Migrate submission filenames from OJS 2.x
migrateTimedViewsUsageStatistics ( ) For 2.4 upgrade: migrate Timed views statistics to the metrics table.
migrateUserRoles ( ) : boolean For 3.0.0 upgrade: Migrate the static user role structure to user groups and stage assignments.
rebuildSearchIndex ( ) : boolean Rebuild the search index.
setFileName ( ) : boolean Set the missing file names.
setFileUploader ( ) : boolean Set the missing uploader user id and group id to a journal manager.
syncSeriesAssocType ( ) : boolean Synchronize the ASSOC_TYPE_SERIES constant to ASSOC_TYPE_SECTION defined in PKPApplication.

Method Details

__construct() public method

Constructor.
public __construct ( $params, $installFile = 'upgrade.xml', $isPlugin = false )
$params array upgrade parameters

_createQuery() public method

public _createQuery ( $stageId, $submissionId, $sequence, $title, $dateNotified = null )

clearDataCache() public method

Clear the data cache files (needed because of direct tinkering with settings tables)
public clearDataCache ( ) : boolean
return boolean

convertEditorDecisionNotes() public method

Convert editor decision notes to a query.
public convertEditorDecisionNotes ( ) : boolean
return boolean True indicates success.

convertQueries() public method

Convert signoffs to queries.
public convertQueries ( ) : boolean
return boolean True indicates success.

convertSupplementaryFiles() public method

Convert supplementary files to submission files.
public convertSupplementaryFiles ( ) : boolean
return boolean True indicates success.

fixReviewForms() public method

Modernize review form storage from OJS 2.x
public fixReviewForms ( ) : boolean
return boolean

htmlifyEmailTemplates() public method

Convert email templates to HTML.
public htmlifyEmailTemplates ( ) : boolean
return boolean True indicates success.

installDefaultGenres() public method

For 3.0.0 upgrade. Genres are required to migrate files.
public installDefaultGenres ( )

isUpgrade() public method

Returns true iff this is an upgrade process.
public isUpgrade ( ) : boolean
return boolean

localizeArticleCoverImages() public method

Localize article cover images.
public localizeArticleCoverImages ( ) : boolean
return boolean True indicates success.

localizeCustomBlockSettings() public method

For 2.4.6 upgrade: to enable localization of a CustomBlock, the blockContent values are converted from string to array (key: primary_language)
public localizeCustomBlockSettings ( )

localizeIssueCoverImages() public method

Localize issue cover images.
public localizeIssueCoverImages ( ) : boolean
return boolean True indicates success.

migrateArticleMetadata() public method

For 3.0.0 upgrade: Convert string-field semi-colon separated metadata to controlled vocabularies.
public migrateArticleMetadata ( ) : boolean
return boolean

migrateCounterPluginUsageStatistics() public method

For 2.4 upgrade: migrate COUNTER statistics to the metrics table.
public migrateCounterPluginUsageStatistics ( )

migrateDefaultUsageStatistics() public method

For 2.4 upgrade: migrate OJS default statistics to the metrics table.
public migrateDefaultUsageStatistics ( )

migrateFiles() public method

Migrate submission filenames from OJS 2.x
public migrateFiles ( $upgrade, $params ) : boolean
$upgrade Upgrade
$params array
return boolean

migrateTimedViewsUsageStatistics() public method

For 2.4 upgrade: migrate Timed views statistics to the metrics table.
public migrateTimedViewsUsageStatistics ( )

migrateUserRoles() public method

For 3.0.0 upgrade: Migrate the static user role structure to user groups and stage assignments.
public migrateUserRoles ( ) : boolean
return boolean

rebuildSearchIndex() public method

Rebuild the search index.
public rebuildSearchIndex ( ) : boolean
return boolean

setFileName() public method

Set the missing file names.
public setFileName ( ) : boolean
return boolean True indicates success.

setFileUploader() public method

Set the missing uploader user id and group id to a journal manager.
public setFileUploader ( ) : boolean
return boolean True indicates success.

syncSeriesAssocType() public method

Synchronize the ASSOC_TYPE_SERIES constant to ASSOC_TYPE_SECTION defined in PKPApplication.
public syncSeriesAssocType ( ) : boolean
return boolean