PKPImportExportDeployment Class Reference

Inheritance diagram for PKPImportExportDeployment:

Public Member Functions
	__construct ($context, $user=null)
	addError ($assocType, $assocId, $errorMsg)
	addProcessedObjectId ($assocType, $assocId)
	addWarning ($assocType, $assocId, $warningMsg)
	getAuthorDBId ($authorId)
	getAuthorDBIds ()
	getContext ()
	getFileDBId ($fileId, $revisionId=null)
	getFileDBIds ()
	getImportPath ()
	getNamespace ()
	getProcessedObjectsErrors ($assocType)
	getProcessedObjectsIds ($assocType)
	getProcessedObjectsWarnings ($assocType)
	getPublication ()
	getRepresentationNodeName ()
	getSchemaFilename ()
	getSubmission ()
	getSubmissionNodeName ()
	getSubmissionsNodeName ()
	getUser ()
	removeImportedObjects ($assocType)
	setAuthorDBId ($authorId, $DBId)
	setAuthorDBIds ($authorDBIds)
	setContext ($context)
	setFileDBId ($fileId, $revisionId, $DBId)
	setFileDBIds ($fileDBIds)
	setImportPath ($path)
	setPublication ($publication)
	setSubmission ($submission)
	setUser ($user)

Data Fields
	$_authorDBIds
	$_baseImportPath = ''
	$_context
	$_fileDBIds
	$_processedObjectsErrors = array()
	$_processedObjectsIds = array()
	$_processedObjectsWarnings = array()
	$_publication
	$_submission
	$_user

Detailed Description

Base class configuring the import/export process to an application's specifics.

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

Constructor & Destructor Documentation

__construct()

PKPImportExportDeployment::__construct	(		$context,
			$user = null
	)

Constructor

Parameters

$context	Context
$user	User optional

Reimplemented in PKPUserImportExportDeployment, PKPNativeImportExportDeployment, and NativeImportExportDeployment.

Definition at line 86 of file PKPImportExportDeployment.inc.php.

References setContext(), setFileDBIds(), setPublication(), setSubmission(), and setUser().

Member Function Documentation

addError()

PKPImportExportDeployment::addError	(		$assocType,
			$assocId,
			$errorMsg
	)

Add the error message to the processed object ID.

Parameters

$assocType	integer ASSOC_TYPE_...
$assocId	integer
$errorMsg	string

Definition at line 206 of file PKPImportExportDeployment.inc.php.

addProcessedObjectId()

PKPImportExportDeployment::addProcessedObjectId	(		$assocType,
			$assocId
	)

Add the processed object ID.

Parameters

$assocType	integer ASSOC_TYPE_...
$assocId	integer

Definition at line 196 of file PKPImportExportDeployment.inc.php.

Referenced by setPublication(), and setSubmission().

addWarning()

PKPImportExportDeployment::addWarning	(		$assocType,
			$assocId,
			$warningMsg
	)

Add the warning message to the processed object ID.

Parameters

$assocType	integer ASSOC_TYPE_...
$assocId	integer
$warningMsg	string

Definition at line 216 of file PKPImportExportDeployment.inc.php.

getAuthorDBId()

PKPImportExportDeployment::getAuthorDBId

(

$authorId

)

Get the author DB Id.

Parameters

$authorId

integer

Returns

integer?

Definition at line 363 of file PKPImportExportDeployment.inc.php.

getAuthorDBIds()

PKPImportExportDeployment::getAuthorDBIds

(

)

Get the array of the inserted author DB Ids.

Returns

array

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

References $_authorDBIds.

getContext()

PKPImportExportDeployment::getContext

(

)

Get the import/export context.

Returns

Context

Definition at line 153 of file PKPImportExportDeployment.inc.php.

References $_context.

getFileDBId()

PKPImportExportDeployment::getFileDBId	(		$fileId,
			$revisionId = null
	)

Get the file DB Id.

Parameters

$fileId	integer
$revisionId	integer

Returns

integer

Definition at line 314 of file PKPImportExportDeployment.inc.php.

getFileDBIds()

PKPImportExportDeployment::getFileDBIds

(

)

Get the array of the inserted file DB Ids.

Returns

array

Definition at line 296 of file PKPImportExportDeployment.inc.php.

References $_fileDBIds.

getImportPath()

PKPImportExportDeployment::getImportPath

(

)

Get the directory location for the import source

Returns

string

Definition at line 392 of file PKPImportExportDeployment.inc.php.

References $_baseImportPath.

getNamespace()

PKPImportExportDeployment::getNamespace

(

)

Get the namespace URN

Returns

string

Reimplemented in PKPUserImportExportDeployment, and PKPNativeImportExportDeployment.

Definition at line 125 of file PKPImportExportDeployment.inc.php.

getProcessedObjectsErrors()

PKPImportExportDeployment::getProcessedObjectsErrors

(

$assocType

)

Get the processed objects errors.

Parameters

$assocType

integer ASSOC_TYPE_...

Returns

array

Definition at line 237 of file PKPImportExportDeployment.inc.php.

getProcessedObjectsIds()

PKPImportExportDeployment::getProcessedObjectsIds

(

$assocType

)

Get the processed objects IDs.

Parameters

$assocType

integer ASSOC_TYPE_...

Returns

array

Definition at line 225 of file PKPImportExportDeployment.inc.php.

Referenced by NativeImportExportDeployment\removeImportedObjects(), and removeImportedObjects().

getProcessedObjectsWarnings()

PKPImportExportDeployment::getProcessedObjectsWarnings

(

$assocType

)

Get the processed objects errors.

Parameters

$assocType

integer ASSOC_TYPE_...

Returns

array

Definition at line 249 of file PKPImportExportDeployment.inc.php.

getPublication()

PKPImportExportDeployment::getPublication

(

)

Get the import/export publication.

Returns

PKPPublication

Definition at line 187 of file PKPImportExportDeployment.inc.php.

References $_publication.

getRepresentationNodeName()

PKPImportExportDeployment::getRepresentationNodeName

(

)

Get the representation node name

Reimplemented in NativeImportExportDeployment.

Definition at line 117 of file PKPImportExportDeployment.inc.php.

getSchemaFilename()

PKPImportExportDeployment::getSchemaFilename

(

)

Get the schema filename.

Returns

string

Reimplemented in PKPNativeImportExportDeployment, NativeImportExportDeployment, and PKPUserImportExportDeployment.

Definition at line 133 of file PKPImportExportDeployment.inc.php.

getSubmission()

PKPImportExportDeployment::getSubmission

(

)

Get the import/export submission.

Returns

Submission

Definition at line 170 of file PKPImportExportDeployment.inc.php.

References $_submission.

getSubmissionNodeName()

PKPImportExportDeployment::getSubmissionNodeName

(

)

Get the submission node name

Returns

string

Reimplemented in PKPNativeImportExportDeployment, and NativeImportExportDeployment.

Definition at line 102 of file PKPImportExportDeployment.inc.php.

getSubmissionsNodeName()

PKPImportExportDeployment::getSubmissionsNodeName

(

)

Get the submissions node name

Returns

string

Reimplemented in PKPNativeImportExportDeployment, and NativeImportExportDeployment.

Definition at line 110 of file PKPImportExportDeployment.inc.php.

getUser()

PKPImportExportDeployment::getUser

(

)

Get the import/export user.

Returns

User

Definition at line 288 of file PKPImportExportDeployment.inc.php.

References $_user.

removeImportedObjects()

PKPImportExportDeployment::removeImportedObjects

(

$assocType

)

Remove the processed objects.

Parameters

$assocType

integer ASSOC_TYPE_...

Reimplemented in NativeImportExportDeployment.

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

References DAORegistry\getDAO(), and getProcessedObjectsIds().

setAuthorDBId()

PKPImportExportDeployment::setAuthorDBId	(		$authorId,
			$DBId
	)

Set the author DB Id.

Parameters

$authorId	integer
$DBId	integer

Definition at line 376 of file PKPImportExportDeployment.inc.php.

setAuthorDBIds()

PKPImportExportDeployment::setAuthorDBIds

(

$authorDBIds

)

Set the array of the inserted author DB Ids.

Parameters

$authorDBIds

array

Definition at line 346 of file PKPImportExportDeployment.inc.php.

setContext()

PKPImportExportDeployment::setContext

(

$context

)

Set the import/export context.

Parameters

$context

Context

Definition at line 145 of file PKPImportExportDeployment.inc.php.

Referenced by __construct().

setFileDBId()

PKPImportExportDeployment::setFileDBId	(		$fileId,
			$revisionId,
			$DBId
	)

Set the file DB Id.

Parameters

$fileId	integer
$revisionId	integer
$DBId	integer

Definition at line 338 of file PKPImportExportDeployment.inc.php.

setFileDBIds()

PKPImportExportDeployment::setFileDBIds

(

$fileDBIds

)

Set the array of the inserted file DB Ids.

Parameters

$fileDBIds

array

Definition at line 304 of file PKPImportExportDeployment.inc.php.

Referenced by __construct().

setImportPath()

PKPImportExportDeployment::setImportPath

(

$path

)

Set the directory location for the import source

Parameters

$path

string

Definition at line 384 of file PKPImportExportDeployment.inc.php.

setPublication()

PKPImportExportDeployment::setPublication

(

$publication

)

Set the import/export publication.

Parameters

$publication

PKPPublication

Definition at line 178 of file PKPImportExportDeployment.inc.php.

References addProcessedObjectId().

Referenced by __construct().

setSubmission()

PKPImportExportDeployment::setSubmission

(

$submission

)

Set the import/export submission.

Parameters

$submission

Submission

Definition at line 161 of file PKPImportExportDeployment.inc.php.

References addProcessedObjectId().

Referenced by __construct().

setUser()

PKPImportExportDeployment::setUser

(

$user

)

Set the import/export user.

Parameters

$user

User

Definition at line 280 of file PKPImportExportDeployment.inc.php.

Referenced by __construct().

Field Documentation

$_authorDBIds

array PKPImportExportDeployment::$_authorDBIds

Connection between the author id from the XML import file and the DB file IDs

Definition at line 73 of file PKPImportExportDeployment.inc.php.

Referenced by getAuthorDBIds().

$_baseImportPath

string PKPImportExportDeployment::$_baseImportPath = ''

Base path for the import source

Definition at line 79 of file PKPImportExportDeployment.inc.php.

Referenced by getImportPath().

$_context

Context PKPImportExportDeployment::$_context

The current import/export context

Definition at line 25 of file PKPImportExportDeployment.inc.php.

Referenced by getContext().

$_fileDBIds

array PKPImportExportDeployment::$_fileDBIds

Connection between the file and revision IDs from the XML import file and the DB file IDs

Definition at line 67 of file PKPImportExportDeployment.inc.php.

Referenced by getFileDBIds().

$_processedObjectsErrors

array PKPImportExportDeployment::$_processedObjectsErrors = array()

Warnings keyed by object IDs

Definition at line 55 of file PKPImportExportDeployment.inc.php.

$_processedObjectsIds

array PKPImportExportDeployment::$_processedObjectsIds = array()

The processed import objects IDs

Definition at line 49 of file PKPImportExportDeployment.inc.php.

$_processedObjectsWarnings

array PKPImportExportDeployment::$_processedObjectsWarnings = array()

Errors keyed by object IDs

Definition at line 61 of file PKPImportExportDeployment.inc.php.

$_publication

PKPPublication PKPImportExportDeployment::$_publication

The current import/export publication

Definition at line 43 of file PKPImportExportDeployment.inc.php.

Referenced by getPublication().

$_submission

Submission PKPImportExportDeployment::$_submission

The current import/export submission

Definition at line 37 of file PKPImportExportDeployment.inc.php.

Referenced by getSubmission().

$_user

User PKPImportExportDeployment::$_user

The current import/export user

Definition at line 31 of file PKPImportExportDeployment.inc.php.

Referenced by getUser().

---

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

• PKPImportExportDeployment.inc.php