Open Monograph Press  3.3.0
NativeXmlPublicationFormatFilter Class Reference
Inheritance diagram for NativeXmlPublicationFormatFilter:
NativeXmlRepresentationFilter NativeImportFilter NativeImportExportFilter PersistableFilter Filter DataObject

Public Member Functions

 __construct ($filterGroup)
 
 _extractAudienceRangeContent ($node, $onixDeployment, &$representation)
 
 _extractExtentContent ($node, $onixDeployment, &$representation)
 
 _extractMeasureContent ($node, $onixDeployment, &$representation)
 
 _extractTextFromNode ($node, $onixDeployment, $nodeName)
 
 _processFileRef ($node, $deployment, &$representation)
 
 _processProductNode ($node, $deployment, &$representation)
 
 getClassName ()
 
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleElement ($node)
 
- Public Member Functions inherited from NativeXmlRepresentationFilter
 parseIdentifier ($element, $representation)
 
- Public Member Functions inherited from NativeImportFilter
 parseLocalizedContent ($element)
 
process (&$document)
 
- 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 publication formats.

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

Constructor & Destructor Documentation

◆ __construct()

NativeXmlPublicationFormatFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeXmlRepresentationFilter.

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

Member Function Documentation

◆ _extractAudienceRangeContent()

NativeXmlPublicationFormatFilter::_extractAudienceRangeContent (   $node,
  $onixDeployment,
$representation 
)

Extracts the AudienceRange elements, which vary depending on whether a submission defines a specific range, or a to/from pair.

Parameters
$nodeDOMElement
$onixDeploymentOnix30ExportDeployment
PublicationFormat$representation

Definition at line 407 of file NativeXmlPublicationFormatFilter.inc.php.

Referenced by _processProductNode().

◆ _extractExtentContent()

NativeXmlPublicationFormatFilter::_extractExtentContent (   $node,
  $onixDeployment,
$representation 
)

Extracts the elements of the Extent nodes.

Parameters
$nodeDOMElement
$onixDeploymentOnix30ExportDeployment
PublicationFormat$representation

Definition at line 342 of file NativeXmlPublicationFormatFilter.inc.php.

References _extractTextFromNode().

Referenced by _processProductNode().

◆ _extractMeasureContent()

NativeXmlPublicationFormatFilter::_extractMeasureContent (   $node,
  $onixDeployment,
$representation 
)

Extracts the elements of the Measure nodes.

Parameters
$nodeDOMElement
$onixDeploymentOnix30ExportDeployment
PublicationFormat$representation

Definition at line 370 of file NativeXmlPublicationFormatFilter.inc.php.

References _extractTextFromNode().

Referenced by _processProductNode().

◆ _extractTextFromNode()

NativeXmlPublicationFormatFilter::_extractTextFromNode (   $node,
  $onixDeployment,
  $nodeName 
)

Extracts the text content from a node.

Parameters
$nodeDOMElement
$onixDeploymentOnix30ExportDeployment
$nodeNameString the name of the node.
Returns
String

Definition at line 327 of file NativeXmlPublicationFormatFilter.inc.php.

Referenced by _extractExtentContent(), _extractMeasureContent(), and _processProductNode().

◆ _processFileRef()

NativeXmlPublicationFormatFilter::_processFileRef (   $node,
  $deployment,
$representation 
)

Process the self_file_ref node found inside the publication_format node.

Parameters
$nodeDOMElement
$deploymentOnix30ExportDeployment
$representationPublicationFormat

Definition at line 99 of file NativeXmlPublicationFormatFilter.inc.php.

References DAORegistry\getDAO().

Referenced by handleElement().

◆ _processProductNode()

NativeXmlPublicationFormatFilter::_processProductNode (   $node,
  $deployment,
$representation 
)

Process the Product node found inside the publication_format node. There may be many of these.

Parameters
$nodeDOMElement
$representationPublicationFormat

Definition at line 118 of file NativeXmlPublicationFormatFilter.inc.php.

References _extractAudienceRangeContent(), _extractExtentContent(), _extractMeasureContent(), _extractTextFromNode(), PKPServices\get(), PKPApplication\get(), and DAORegistry\getDAO().

Referenced by handleElement().

◆ getClassName()

NativeXmlPublicationFormatFilter::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 NativeXmlRepresentationFilter.

Definition at line 52 of file NativeXmlPublicationFormatFilter.inc.php.

◆ getPluralElementName()

NativeXmlPublicationFormatFilter::getPluralElementName ( )

Return the plural element name

Returns
string

Reimplemented from NativeImportFilter.

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

◆ getSingularElementName()

NativeXmlPublicationFormatFilter::getSingularElementName ( )

Get the singular element name

Returns
string

Reimplemented from NativeImportFilter.

Definition at line 42 of file NativeXmlPublicationFormatFilter.inc.php.

◆ handleElement()

NativeXmlPublicationFormatFilter::handleElement (   $node)

Handle a submission element

Parameters
$nodeDOMElement
Returns
array Array of PublicationFormat objects

Reimplemented from NativeXmlRepresentationFilter.

Definition at line 62 of file NativeXmlPublicationFormatFilter.inc.php.

References _processFileRef(), _processProductNode(), NativeImportExportFilter\getDeployment(), and Application\getRepresentationDAO().


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