PHP Class PKPImportExportDeployment, pkp-lib

Afficher le fichier Open project: pkp/pkp-lib Class Usage Examples

Méthodes publiques

Свойство 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

Méthodes publiques

Méthode 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 méthode

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

addError() public méthode

Add the error message to the processed object ID.
public addError ( $assocType, $assocId, $errorMsg )
$assocType integer ASSOC_TYPE_...
$assocId integer
$errorMsg string

addProcessedObjectId() public méthode

Add the processed object ID.
public addProcessedObjectId ( $assocType, $assocId )
$assocType integer ASSOC_TYPE_...
$assocId integer

getContext() public méthode

Get the import/export context.
public getContext ( ) : Context
Résultat Context

getFileDBId() public méthode

Get the file DB Id.
public getFileDBId ( $fileId, $revisionId ) : integer
$fileId integer
$revisionId integer
Résultat integer

getFileDBIds() public méthode

Get the array of the inserted file DB Ids.
public getFileDBIds ( ) : array
Résultat array

getNamespace() public méthode

Get the namespace URN
public getNamespace ( ) : string
Résultat string

getProcessedObjectsIds() public méthode

Get the processed objects IDs.
public getProcessedObjectsIds ( $assocType ) : array
$assocType integer ASSOC_TYPE_...
Résultat array Associative array (assoc object Id => array of errors)

getRepresentationNodeName() public méthode

Get the representation node name
public getRepresentationNodeName ( )

getSchemaFilename() public méthode

Get the schema filename.
public getSchemaFilename ( ) : string
Résultat string

getSubmission() public méthode

Get the import/export submission.
public getSubmission ( ) : Submission
Résultat Submission

getSubmissionNodeName() public méthode

Get the submission node name
public getSubmissionNodeName ( ) : string
Résultat string

getSubmissionsNodeName() public méthode

Get the submissions node name
public getSubmissionsNodeName ( ) : string
Résultat string

getUser() public méthode

Get the import/export user.
public getUser ( ) : User
Résultat User

removeImportedObjects() public méthode

Remove the processed objects.
public removeImportedObjects ( $assocType )
$assocType integer ASSOC_TYPE_...

setContext() public méthode

Set the import/export context.
public setContext ( $context )
$context Context

setFileDBId() public méthode

Set the file DB Id.
public setFileDBId ( $fileId, $revisionId, $DBId )
$fileId integer
$revisionId integer
$DBId integer

setFileDBIds() public méthode

Set the array of the inserted file DB Ids.
public setFileDBIds ( $fileDBIds )
$fileDBIds array

setSubmission() public méthode

Set the import/export submission.
public setSubmission ( $submission )
$submission Submission

setUser() public méthode

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