Open Monograph Press  3.3.0
NativeXmlMonographFilter Class Reference
Inheritance diagram for NativeXmlMonographFilter:
NativeXmlSubmissionFilter NativeImportFilter NativeImportExportFilter PersistableFilter Filter DataObject

Public Member Functions

 __construct ($filterGroup)
 
 getClassName ()
 
 getImportFilter ($elementName)
 
 handleChildElement ($n, $submission)
 
 parsePublication ($n, $submission)
 
 populateObject ($submission, $node)
 
process (&$document)
 
- Public Member Functions inherited from NativeXmlSubmissionFilter
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleElement ($node)
 
 parseIdentifier ($element, $submission)
 
 parseSubmissionFile ($n, $submission)
 
- Public Member Functions inherited from NativeImportFilter
 parseLocalizedContent ($element)
 
- 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)
 
 supports (&$input, &$output)
 
 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 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 Native XML document to a set of monographs.

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

Constructor & Destructor Documentation

◆ __construct()

NativeXmlMonographFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeXmlSubmissionFilter.

Definition at line 23 of file NativeXmlMonographFilter.inc.php.

Member Function Documentation

◆ getClassName()

NativeXmlMonographFilter::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 NativeXmlSubmissionFilter.

Definition at line 34 of file NativeXmlMonographFilter.inc.php.

◆ getImportFilter()

NativeXmlMonographFilter::getImportFilter (   $elementName)

Get the import filter for a given element.

Parameters
$elementNamestring Name of XML element
Returns
Filter

Reimplemented from NativeXmlSubmissionFilter.

Definition at line 97 of file NativeXmlMonographFilter.inc.php.

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

Referenced by parsePublication().

◆ handleChildElement()

NativeXmlMonographFilter::handleChildElement (   $n,
  $submission 
)

Handle an element whose parent is the submission element.

Parameters
$nDOMElement
$submissionSubmission

Reimplemented from NativeXmlSubmissionFilter.

Definition at line 78 of file NativeXmlMonographFilter.inc.php.

References parsePublication(), and NativeXmlSubmissionFilter\parseSubmissionFile().

◆ parsePublication()

NativeXmlMonographFilter::parsePublication (   $n,
  $submission 
)

Parse a publication format and add it to the submission.

Parameters
$nDOMElement
$submissionSubmission

Reimplemented from NativeXmlSubmissionFilter.

Definition at line 130 of file NativeXmlMonographFilter.inc.php.

References PKPApplication\get(), NativeImportExportFilter\getDeployment(), and getImportFilter().

Referenced by handleChildElement().

◆ populateObject()

NativeXmlMonographFilter::populateObject (   $submission,
  $node 
)

Populate the submission object from the node

Parameters
$submissionSubmission
$nodeDOMElement
Returns
Submission

Reimplemented from NativeXmlSubmissionFilter.

Definition at line 64 of file NativeXmlMonographFilter.inc.php.

References NativeImportExportFilter\getDeployment().

◆ process()

& NativeXmlMonographFilter::process ( $document)
See also
Filter::process()
Parameters
$documentDOMDocument|string
Returns
array Array of imported documents

Reimplemented from NativeImportFilter.

Definition at line 43 of file NativeXmlMonographFilter.inc.php.

References Application\getSubmissionSearchIndex().


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