PHP Class PKPImportExportDeployment, pkp-lib

Mostrar archivo Open project: pkp/pkp-lib Class Usage Examples

Public Properties

Property	Type	Description
$_context		The current import/export context
$_fileDBIds		Connection between the file and revision IDs from the XML import file and the DB file IDs
$_processedObjectsIds		The processed import objects IDs
$_submission		The current import/export submission
$_user		The current import/export user

Public Methods

Method	Description
__construct ( $context, $user = null )	Constructor
addError ( $assocType, $assocId, $errorMsg )	Add the error message to the processed object ID.
addProcessedObjectId ( $assocType, $assocId )	Add the processed object ID.
getContext ( ) : Context	Get the import/export context.
getFileDBId ( $fileId, $revisionId ) : integer	Get the file DB Id.
getFileDBIds ( ) : array	Get the array of the inserted file DB Ids.
getNamespace ( ) : string	Get the namespace URN
getProcessedObjectsIds ( $assocType ) : array	Get the processed objects IDs.
getRepresentationNodeName ( )	Get the representation node name
getSchemaFilename ( ) : string	Get the schema filename.
getSubmission ( ) : Submission	Get the import/export submission.
getSubmissionNodeName ( ) : string	Get the submission node name
getSubmissionsNodeName ( ) : string	Get the submissions node name
getUser ( ) : User	Get the import/export user.
removeImportedObjects ( $assocType )	Remove the processed objects.
setContext ( $context )	Set the import/export context.
setFileDBId ( $fileId, $revisionId, $DBId )	Set the file DB Id.
setFileDBIds ( $fileDBIds )	Set the array of the inserted file DB Ids.
setSubmission ( $submission )	Set the import/export submission.
setUser ( $user )	Set the import/export user.

Method Details

__construct() public method

Constructor

public __construct ( $context, $user = null )
$context		Context
$user		User optional

addError() public method

Add the error message to the processed object ID.

public addError ( $assocType, $assocId, $errorMsg )
$assocType		integer ASSOC_TYPE_...
$assocId		integer
$errorMsg		string

addProcessedObjectId() public method

Add the processed object ID.

public addProcessedObjectId ( $assocType, $assocId )
$assocType		integer ASSOC_TYPE_...
$assocId		integer

getContext() public method

Get the import/export context.

public getContext ( ) : Context
return	Context

getFileDBId() public method

Get the file DB Id.

public getFileDBId ( $fileId, $revisionId ) : integer
$fileId		integer
$revisionId		integer
return	integer

getFileDBIds() public method

Get the array of the inserted file DB Ids.

public getFileDBIds ( ) : array
return	array

getNamespace() public method

Get the namespace URN

public getNamespace ( ) : string
return	string

getProcessedObjectsIds() public method

Get the processed objects IDs.

public getProcessedObjectsIds ( $assocType ) : array
$assocType		integer ASSOC_TYPE_...
return	array	Associative array (assoc object Id => array of errors)

getRepresentationNodeName() public method

Get the representation node name

public getRepresentationNodeName ( )

getSchemaFilename() public method

Get the schema filename.

public getSchemaFilename ( ) : string
return	string

getSubmission() public method

Get the import/export submission.

public getSubmission ( ) : Submission
return	Submission

getSubmissionNodeName() public method

Get the submission node name

public getSubmissionNodeName ( ) : string
return	string

getSubmissionsNodeName() public method

Get the submissions node name

public getSubmissionsNodeName ( ) : string
return	string

getUser() public method

Get the import/export user.

public getUser ( ) : User
return	User

removeImportedObjects() public method

Remove the processed objects.

public removeImportedObjects ( $assocType )
$assocType		integer ASSOC_TYPE_...

setContext() public method

Set the import/export context.

public setContext ( $context )
$context		Context

setFileDBId() public method

Set the file DB Id.

public setFileDBId ( $fileId, $revisionId, $DBId )
$fileId		integer
$revisionId		integer
$DBId		integer

setFileDBIds() public method

Set the array of the inserted file DB Ids.

public setFileDBIds ( $fileDBIds )
$fileDBIds		array

setSubmission() public method

Set the import/export submission.

public setSubmission ( $submission )
$submission		Submission

setUser() public method

Set the import/export user.

public setUser ( $user )
$user		User

Property Details

$_context public_oe property

The current import/export context

public $_context

$_fileDBIds public_oe property

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

public $_fileDBIds

$_processedObjectsIds public_oe property

The processed import objects IDs

public $_processedObjectsIds

$_submission public_oe property

The current import/export submission

public $_submission

$_user public_oe property

The current import/export user

public $_user