ImportOJS1 Class Reference
[Site]

Class to import data from an OJS 1.x installation. More...

List of all members.

Public Member Functions
	addArticleFile ($articleId, $oldFileId, $fileType)
	copyHTMLGalleyImages ($galley, $prefix)
	copyJournalImage ($oldName, $newName)
	error ($message=null)
	generateRedirects ()
	getConflicts ()
	getRedirects ()
	hasOption ($option)
	import ($journalPath, $importPath, $options=array())
	importArticles ()
	importIssues ()
	importJournal ()
	ImportOJS1 ()
	importReadingTools ()
	importSections ()
	importSubscriptions ()
	importUsers ()
	loadJournalConfig ()
	rebuildSearchIndex ()

---

Detailed Description

Class to import data from an OJS 1.x installation.

Definition at line 52 of file ImportOJS1.inc.php.

---

Member Function Documentation

ImportOJS1.addArticleFile	(	$	articleId,
		$	oldFileId,
		$	fileType
	)

Copy an article file.

Parameters:

	$articleId	int
	$oldFileId	int
	$fileType	string

Definition at line 1480 of file ImportOJS1.inc.php.

References Core.cleanVar(), and DAORegistry.getDAO().

Referenced by importArticles().

ImportOJS1.copyHTMLGalleyImages	(	$	galley,
		$	prefix
	)

Copy all image files for an article's HTML galley.

Parameters:

	$galley	ArticleHTMLGalley
	$prefix	string image file prefix, e.g. "<abbrev>-<year>-<id>"

Definition at line 1536 of file ImportOJS1.inc.php.

References DAORegistry.getDAO(), and String.mime_content_type().

Referenced by importArticles().

ImportOJS1.copyJournalImage	(	$	oldName,
		$	newName
	)

Copy a journal title/logo image.

Parameters:

	$oldName	string old setting name
	$newName	string new setting name

Returns:

array image info

Definition at line 1444 of file ImportOJS1.inc.php.

References Core.cleanVar(), and Core.getCurrentDate().

Referenced by importJournal().

ImportOJS1.error

(

$

message = null

)

Record error message.

Returns:

string;

Definition at line 109 of file ImportOJS1.inc.php.

Referenced by import().

ImportOJS1.generateRedirects

(

)

Create OJS 1 -> OJS 2 URL redirect mapping files

Definition at line 1599 of file ImportOJS1.inc.php.

Referenced by import().

ImportOJS1.getConflicts

(

)

Get the list of conflicting user accounts.

Definition at line 1691 of file ImportOJS1.inc.php.

ImportOJS1.getRedirects

(

)

Get OJS 1 -> OJS 2 file redirects.

Definition at line 1698 of file ImportOJS1.inc.php.

ImportOJS1.hasOption

(

$

option

)

Check if an option is enabled.

Parameters:

$option

string

Returns:

boolean

Definition at line 121 of file ImportOJS1.inc.php.

Referenced by import(), importArticles(), importIssues(), importJournal(), importReadingTools(), importSections(), importSubscriptions(), importUsers(), and rebuildSearchIndex().

ImportOJS1.import	(	$	journalPath,
		$	importPath,
		$	options = array()
	)

Execute import of an OJS 1 journal. If an existing journal path is specified, only content is imported; otherwise, a new journal is created and all journal settings are also imported.

Parameters:

	$journalPath	string journal URL path
	$importPath	string local filesystem path to the base OJS 1 directory
	$options	array supported: 'importSubscriptions'

Returns:

boolean/int false or journal ID

Definition at line 134 of file ImportOJS1.inc.php.

References error(), generateRedirects(), DAORegistry.getDAO(), DBConnection.getInstance(), hasOption(), importArticles(), importIssues(), importJournal(), importReadingTools(), importSections(), importSubscriptions(), importUsers(), loadJournalConfig(), and rebuildSearchIndex().

ImportOJS1.importArticles

(

)

Import articles (including metadata and files).

Definition at line 943 of file ImportOJS1.inc.php.

References addArticleFile(), Core.cleanVar(), copyHTMLGalleyImages(), DAORegistry.getDAO(), Locale.getLocale(), and hasOption().

Referenced by import().

ImportOJS1.importIssues

(

)

Import issues.

Definition at line 792 of file ImportOJS1.inc.php.

References Core.cleanVar(), DAORegistry.getDAO(), Locale.getLocale(), and hasOption().

Referenced by import().

ImportOJS1.importJournal

(

)

Import journal and journal settings.

Definition at line 232 of file ImportOJS1.inc.php.

References Core.cleanVar(), copyJournalImage(), DAORegistry.getDAO(), Locale.getLocale(), JournalSetupStep5Form.getLocaleFieldNames(), JournalSetupStep4Form.getLocaleFieldNames(), JournalSetupStep3Form.getLocaleFieldNames(), JournalSetupStep2Form.getLocaleFieldNames(), JournalSetupStep1Form.getLocaleFieldNames(), hasOption(), and Locale.translate().

Referenced by import().

ImportOJS1.ImportOJS1

(

)

Constructor.

Definition at line 99 of file ImportOJS1.inc.php.

References Request.getIndexUrl().

ImportOJS1.importReadingTools

(

)

Import reading tools (nee RST) settings.

Definition at line 501 of file ImportOJS1.inc.php.

References DAORegistry.getDAO(), and hasOption().

Referenced by import().

ImportOJS1.importSections

(

)

Import sections.

Definition at line 898 of file ImportOJS1.inc.php.

References Core.cleanVar(), DAORegistry.getDAO(), Locale.getLocale(), and hasOption().

Referenced by import().

ImportOJS1.importSubscriptions

(

)

Import subscriptions and subscription types.

Definition at line 719 of file ImportOJS1.inc.php.

References Core.cleanVar(), DAORegistry.getDAO(), Locale.getLocale(), and hasOption().

Referenced by import().

ImportOJS1.importUsers

(

)

Import users and roles.

Definition at line 548 of file ImportOJS1.inc.php.

References Core.cleanVar(), Validation.encryptCredentials(), DAORegistry.getDAO(), Locale.getLocale(), and hasOption().

Referenced by import().

ImportOJS1.loadJournalConfig

(

)

Load OJS 1 journal configuration and settings data.

Returns:

boolean

Definition at line 202 of file ImportOJS1.inc.php.

Referenced by import().

ImportOJS1.rebuildSearchIndex

(

)

Rebuild the article search index. Note: Rebuilds index for _all_ journals (non-optimal, but shouldn't be a problem) Based on code from tools/rebuildSearchIndex.php

Definition at line 1430 of file ImportOJS1.inc.php.

References hasOption(), and ArticleSearchIndex.rebuildIndex().

Referenced by import().

---

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

• classes/site/ImportOJS1.inc.php