PHP Класс PKPImportExportDeployment, pkp-lib

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$_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

Открытые методы

Метод Описание
__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.

Описание методов

__construct() публичный метод

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

addError() публичный метод

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

addProcessedObjectId() публичный метод

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

getContext() публичный метод

Get the import/export context.
public getContext ( ) : Context
Результат Context

getFileDBId() публичный метод

Get the file DB Id.
public getFileDBId ( $fileId, $revisionId ) : integer
$fileId integer
$revisionId integer
Результат integer

getFileDBIds() публичный метод

Get the array of the inserted file DB Ids.
public getFileDBIds ( ) : array
Результат array

getNamespace() публичный метод

Get the namespace URN
public getNamespace ( ) : string
Результат string

getProcessedObjectsIds() публичный метод

Get the processed objects IDs.
public getProcessedObjectsIds ( $assocType ) : array
$assocType integer ASSOC_TYPE_...
Результат array Associative array (assoc object Id => array of errors)

getRepresentationNodeName() публичный метод

Get the representation node name

getSchemaFilename() публичный метод

Get the schema filename.
public getSchemaFilename ( ) : string
Результат string

getSubmission() публичный метод

Get the import/export submission.
public getSubmission ( ) : Submission
Результат Submission

getSubmissionNodeName() публичный метод

Get the submission node name
public getSubmissionNodeName ( ) : string
Результат string

getSubmissionsNodeName() публичный метод

Get the submissions node name
public getSubmissionsNodeName ( ) : string
Результат string

getUser() публичный метод

Get the import/export user.
public getUser ( ) : User
Результат User

removeImportedObjects() публичный метод

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

setContext() публичный метод

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

setFileDBId() публичный метод

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

setFileDBIds() публичный метод

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

setSubmission() публичный метод

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

setUser() публичный метод

Set the import/export user.
public setUser ( $user )
$user User

Описание свойств

$_context публичное свойство

The current import/export context
public $_context

$_fileDBIds публичное свойство

Connection between the file and revision IDs from the XML import file and the DB file IDs
public $_fileDBIds

$_processedObjectsIds публичное свойство

The processed import objects IDs
public $_processedObjectsIds

$_submission публичное свойство

The current import/export submission
public $_submission

$_user публичное свойство

The current import/export user
public $_user