Open Monograph Press  3.3.0
PublicationNativeXmlFilter Class Reference
Inheritance diagram for PublicationNativeXmlFilter:
PKPPublicationNativeXmlFilter NativeExportFilter NativeImportExportFilter PersistableFilter Filter DataObject

Public Member Functions

 addChapters ($doc, $entityNode, $entity)
 
 createEntityNode ($doc, $entity)
 
 createPublicationCoversNode ($filter, $doc, $object)
 
 getClassName ()
 
 getRepresentationExportFilterGroupName ()
 
 parseCovers ($filter, $node, $object, $assocType)
 
- Public Member Functions inherited from PKPPublicationNativeXmlFilter
 __construct ($filterGroup)
 
 _getControlledVocabulariesMappings ()
 
 addAuthors ($doc, $entityNode, $entity)
 
 addControlledVocabulary ($doc, $entityNode, $controlledVocabulariesNodeName, $controlledVocabularyNodeName, $controlledVocabulary)
 
 addIdentifiers ($doc, $entityNode, $entity)
 
 addMetadata ($doc, $entityNode, $entity)
 
 addPubIdentifier ($doc, $entityNode, $entity, $pubIdPlugin)
 
 addRepresentations ($doc, $entityNode, $entity)
 
 getFiles ($representation)
 
process (&$entity)
 
- Public Member Functions inherited from NativeExportFilter
 createLocalizedNodes ($doc, $parentNode, $name, $values)
 
 createOptionalNode ($doc, $parentNode, $name, $value)
 
 getNoValidation ()
 
 setNoValidation ($noValidation)
 
 setOpts ($opts)
 
 supports (&$input, &$output)
 
- Public Member Functions inherited from NativeImportExportFilter
 getDeployment ()
 
 setDeployment ($deployment)
 
- Public Member Functions inherited from PersistableFilter
 addSetting ($setting)
 
 getFilterGroup ()
 
 getInternalSettings ()
 
 getIsTemplate ()
 
 getLocalizedSettingNames ()
 
 getParentFilterId ()
 
 getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 hasSetting ($settingName)
 
 hasSettings ()
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
- Public Member Functions inherited from Filter
 __construct ($inputType, $outputType)
 
 addError ($message)
 
 clearErrors ()
 
execute (&$input, $returnErrors=false)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSequence ()
 
 hasErrors ()
 
 isCompatibleWithRuntimeEnvironment ()
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSequence ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Static Public Member Functions inherited from PersistableFilter
static tempGroup ($inputType, $outputType)
 
- Static Public Member Functions inherited from Filter
static supportedRuntimeEnvironmentSettings ()
 
- Data Fields inherited from NativeExportFilter
 $_noValidation = null
 
 $opts = array()
 
- Data Fields inherited from NativeImportExportFilter
 $_deployment
 
- Data Fields inherited from PersistableFilter
 $_filterGroup
 
 $_settings = array()
 
- Data Fields inherited from Filter
 $_errors = array()
 
 $_input
 
 $_inputType
 
 $_output
 
 $_outputType
 
 $_runtimeEnvironment = false
 
- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Class that converts a Article to a Native XML document.

Definition at line 18 of file PublicationNativeXmlFilter.inc.php.

Member Function Documentation

◆ addChapters()

PublicationNativeXmlFilter::addChapters (   $doc,
  $entityNode,
  $entity 
)

Add the chapter metadata for a publication to its DOM element.

Parameters
$docDOMDocument
$entityNodeDOMElement
$entityPublication

Definition at line 83 of file PublicationNativeXmlFilter.inc.php.

References DAORegistry\getDAO(), and NativeImportExportFilter\getDeployment().

Referenced by createEntityNode().

◆ createEntityNode()

PublicationNativeXmlFilter::createEntityNode (   $doc,
  $entity 
)

Create and return a submission node.

Parameters
$docDOMDocument
$entityPublication
Returns
DOMElement

Reimplemented from PKPPublicationNativeXmlFilter.

Definition at line 46 of file PublicationNativeXmlFilter.inc.php.

References addChapters(), createPublicationCoversNode(), DAORegistry\getDAO(), and NativeImportExportFilter\getDeployment().

◆ createPublicationCoversNode()

PublicationNativeXmlFilter::createPublicationCoversNode (   $filter,
  $doc,
  $object 
)

Create and return an object covers node.

Parameters
$filterNativeExportFilter
$docDOMDocument
$objectPublication
Returns
DOMElement

Definition at line 105 of file PublicationNativeXmlFilter.inc.php.

Referenced by createEntityNode().

◆ getClassName()

PublicationNativeXmlFilter::getClassName ( )

Return the fully qualified class name of the filter class. This information must be persisted when saving a filter so that the filter can later be reconstructed from the information in the database.

(This must be hard coded by sub-classes for PHP4 compatibility. PHP4 always returns class names lowercase which we cannot tolerate as we need this path to find the class on case sensitive file systems.)

Reimplemented from PKPPublicationNativeXmlFilter.

Definition at line 25 of file PublicationNativeXmlFilter.inc.php.

◆ getRepresentationExportFilterGroupName()

PublicationNativeXmlFilter::getRepresentationExportFilterGroupName ( )

Get the representation export filter group name

Returns
string

Definition at line 33 of file PublicationNativeXmlFilter.inc.php.

◆ parseCovers()

PublicationNativeXmlFilter::parseCovers (   $filter,
  $node,
  $object,
  $assocType 
)

Parse out the object covers.

Parameters
$filterNativeExportFilter
$nodeDOMElement
$objectPublication
$assocTypeASSOC_TYPE_PUBLICATION

Definition at line 144 of file PublicationNativeXmlFilter.inc.php.


The documentation for this class was generated from the following file: