RepresentationNativeXmlFilter.inc.php

<?php
 
import('lib.pkp.plugins.importexport.native.filter.NativeExportFilter');
 
class RepresentationNativeXmlFilter extends NativeExportFilter {
   function __construct($filterGroup) {
      $this->setDisplayName('Native XML representation export');
      parent::__construct($filterGroup);
   }
 
 
   //
   // Implement template methods from PersistableFilter
   //
   function getClassName() {
      return 'lib.pkp.plugins.importexport.native.filter.RepresentationNativeXmlFilter';
   }
 
 
   //
   // Implement template methods from Filter
   //
   function &process(&$representation) {
      // Create the XML document
      $doc = new DOMDocument('1.0');
      $doc->preserveWhiteSpace = false;
      $doc->formatOutput = true;
      $deployment = $this->getDeployment();
      $rootNode = $this->createRepresentationNode($doc, $representation);
      $doc->appendChild($rootNode);
      $rootNode->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
      $rootNode->setAttribute('xsi:schemaLocation', $deployment->getNamespace() . ' ' . $deployment->getSchemaFilename());
 
      return $doc;
   }
 
   //
   // Representation conversion functions
   //
   function createRepresentationNode($doc, $representation) {
      $deployment = $this->getDeployment();
      $context = $deployment->getContext();
 
      // Create the representation node
      $representationNode = $doc->createElementNS($deployment->getNamespace(), $deployment->getRepresentationNodeName());
 
      $representationNode->setAttribute('locale', $representation->getData('locale'));
 
      $this->addIdentifiers($doc, $representationNode, $representation);
 
      // Add metadata
      $this->createLocalizedNodes($doc, $representationNode, 'name', $representation->getName(null));
      $sequenceNode = $doc->createElementNS($deployment->getNamespace(), 'seq');
      $sequenceNode->appendChild($doc->createTextNode((int) $representation->getSequence()));
      $representationNode->appendChild($sequenceNode);
 
      $urlRemote = $representation->getData('urlRemote');
      if ($urlRemote) {
         $remoteNode = $doc->createElementNS($deployment->getNamespace(), 'remote');
         $remoteNode->setAttribute('src', $urlRemote);
         $representationNode->appendChild($remoteNode);
      } else {
         // Add files
         foreach ($this->getFiles($representation) as $submissionFile) {
            $fileRefNode = $doc->createElementNS($deployment->getNamespace(), 'submission_file_ref');
            $fileRefNode->setAttribute('id', $submissionFile->getFileId());
            $fileRefNode->setAttribute('revision', $submissionFile->getRevision());
            $representationNode->appendChild($fileRefNode);
         }
      }
 
      return $representationNode;
   }
 
   function addIdentifiers($doc, $representationNode, $representation) {
      $deployment = $this->getDeployment();
 
      // Add internal ID
      $representationNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'id', $representation->getId()));
      $node->setAttribute('type', 'internal');
      $node->setAttribute('advice', 'ignore');
 
      // Add public ID
      if ($pubId = $representation->getStoredPubId('publisher-id')) {
         $representationNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'id', htmlspecialchars($pubId, ENT_COMPAT, 'UTF-8')));
         $node->setAttribute('type', 'public');
         $node->setAttribute('advice', 'update');
      }
 
      // Add pub IDs by plugin
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $deployment->getContext()->getId());
      foreach ($pubIdPlugins as $pubIdPlugin) {
         $this->addPubIdentifier($doc, $representationNode, $representation, $pubIdPlugin);
      }
   }
 
   function addPubIdentifier($doc, $representationNode, $representation, $pubIdPlugin) {
      $pubId = $representation->getStoredPubId($pubIdPlugin->getPubIdType());
      if ($pubId) {
         $deployment = $this->getDeployment();
         $representationNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), 'id', htmlspecialchars($pubId, ENT_COMPAT, 'UTF-8')));
         $node->setAttribute('type', $pubIdPlugin->getPubIdType());
         $node->setAttribute('advice', 'update');
         return $node;
      }
      return null;
   }
 
   //
   // Abstract methods to be implemented by subclasses
   //
   function getFiles($representation) {
      assert(false); // To be overridden by subclasses
   }
}