PKPImportExportDeployment.inc.php

<?php
class PKPImportExportDeployment {
   var $_context;
 
   var $_user;
 
   var $_submission;
 
   var $_publication;
 
   var $_processedObjectsIds = array();
 
   var $_processedObjectsErrors = array();
 
   var $_processedObjectsWarnings = array();
 
   var $_fileDBIds;
 
   var $_authorDBIds;
 
   var $_baseImportPath = '';
 
   function __construct($context, $user=null) {
      $this->setContext($context);
      $this->setUser($user);
      $this->setSubmission(null);
      $this->setPublication(null);
      $this->setFileDBIds(array());
      $this->_processedObjectsIds = array();
   }
 
   //
   // Deployment items for subclasses to override
   //
   function getSubmissionNodeName() {
      assert(false);
   }
 
   function getSubmissionsNodeName() {
      assert(false);
   }
 
   function getRepresentationNodeName() {
      assert(false);
   }
 
   function getNamespace() {
      assert(false);
   }
 
   function getSchemaFilename() {
      assert(false);
   }
 
 
   //
   // Getter/setters
   //
   function setContext($context) {
      $this->_context = $context;
   }
 
   function getContext() {
      return $this->_context;
   }
 
   function setSubmission($submission) {
      $this->_submission = $submission;
      if ($submission) $this->addProcessedObjectId(ASSOC_TYPE_SUBMISSION, $submission->getId());
   }
 
   function getSubmission() {
      return $this->_submission;
   }
 
   function setPublication($publication) {
      $this->_publication = $publication;
      if ($publication) $this->addProcessedObjectId(ASSOC_TYPE_PUBLICATION, $publication->getId());
   }
 
   function getPublication() {
      return $this->_publication;
   }
 
   function addProcessedObjectId($assocType, $assocId) {
      $this->_processedObjectsIds[$assocType][] = $assocId;
   }
 
   function addError($assocType, $assocId, $errorMsg) {
      $this->_processedObjectsErrors[$assocType][$assocId][] = $errorMsg;
   }
 
   function addWarning($assocType, $assocId, $warningMsg) {
      $this->_processedObjectsWarnings[$assocType][$assocId][] = $warningMsg;
   }
 
   function getProcessedObjectsIds($assocType) {
      if (array_key_exists($assocType, $this->_processedObjectsIds)) {
         return $this->_processedObjectsIds[$assocType];
      }
      return null;
   }
 
   function getProcessedObjectsErrors($assocType) {
      if (array_key_exists($assocType, $this->_processedObjectsErrors)) {
         return $this->_processedObjectsErrors[$assocType];
      }
      return null;
   }
   function getProcessedObjectsWarnings($assocType) {
      if (array_key_exists($assocType, $this->_processedObjectsWarnings)) {
         return $this->_processedObjectsWarnings[$assocType];
      }
      return null;
   }
 
   function removeImportedObjects($assocType) {
      switch ($assocType) {
         case ASSOC_TYPE_SUBMISSION:
            $processedSubmisssionsIds = $this->getProcessedObjectsIds(ASSOC_TYPE_SUBMISSION);
            if (!empty($processedSubmisssionsIds)) {
               $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
               foreach ($processedSubmisssionsIds as $submissionId) {
                  if ($submissionId) {
                     $submissionDao->deleteById($submissionId);
                  }
               }
            }
            break;
      }
   }
 
   function setUser($user) {
      $this->_user = $user;
   }
 
   function getUser() {
      return $this->_user;
   }
 
   function getFileDBIds() {
      return $this->_fileDBIds;
   }
 
   function setFileDBIds($fileDBIds) {
      return $this->_fileDBIds = $fileDBIds;
   }
 
   function getFileDBId($fileId, $revisionId = null) {
      if (array_key_exists($fileId, $this->_fileDBIds)) {
         // is there already the revisionId?
         if ($revisionId) {
            if (array_key_exists($revisionId, $this->_fileDBIds[$fileId])) {
               return $this->_fileDBIds[$fileId][$revisionId];
            } else {
               return null;
            }
         } else {
            // the revisionId is not important, but the fileId
            // the DB Id is unique for a fileId
            return current($this->_fileDBIds[$fileId]);
         }
      }
      return null;
   }
 
   function setFileDBId($fileId, $revisionId, $DBId) {
      return $this->_fileDBIds[$fileId][$revisionId]= $DBId;
   }
 
   function setAuthorDBIds($authorDBIds) {
      return $this->_authorDBIds = $authorDBIds;
   }
 
   function getAuthorDBIds() {
      return $this->_authorDBIds;
   }
 
   function getAuthorDBId($authorId) {
      if (array_key_exists($authorId, $this->_authorDBIds)) {
         return $this->_authorDBIds[$authorId];
      }
 
      return null;
   }
 
   function setAuthorDBId($authorId, $DBId) {
      return $this->_authorDBIds[$authorId] = $DBId;
   }
 
   function setImportPath($path) {
      $this->_baseImportPath = $path;
   }
 
   function getImportPath() {
      return $this->_baseImportPath;
   }
}