Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
NativeXmlPublicationFormatFilter Class Reference
Inheritance diagram for NativeXmlPublicationFormatFilter:
NativeXmlRepresentationFilter NativeImportFilter NativeImportExportFilter PersistableFilter Filter DataObject

Public Member Functions

 _extractAudienceRangeContent ($node, $onixDeployment, &$representation)
 
 _extractExtentContent ($node, $onixDeployment, &$representation)
 
 _extractMeasureContent ($node, $onixDeployment, &$representation)
 
 _extractTextFromNode ($node, $onixDeployment, $nodeName)
 
 _processProductNode ($node, $deployment, &$representation)
 
 getClassName ()
 
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleElement ($node)
 
 NativeXmlPublicationFormatFilter ($filterGroup)
 
- Public Member Functions inherited from NativeXmlRepresentationFilter
 getClassName ()
 
 handleElement ($node)
 
 NativeXmlRepresentationFilter ($filterGroup)
 
- Public Member Functions inherited from NativeImportFilter
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleElement ($node)
 
 NativeImportFilter ($filterGroup)
 
 parseLocalizedContent ($element)
 
process (&$document)
 
- Public Member Functions inherited from NativeImportExportFilter
 getDeployment ()
 
 NativeImportExportFilter ($filterGroup)
 
 setDeployment ($deployment)
 
- Public Member Functions inherited from PersistableFilter
 addSetting (&$setting)
 
 getClassName ()
 
getFilterGroup ()
 
 getInternalSettings ()
 
 getIsTemplate ()
 
 getLocalizedSettingNames ()
 
 getParentFilterId ()
 
getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 hasSetting ($settingName)
 
 hasSettings ()
 
 PersistableFilter ($filterGroup)
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
- Public Member Functions inherited from Filter
 addError ($message)
 
 clearErrors ()
 
execute (&$input)
 
 Filter ($inputType, $outputType)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSeq ()
 
 hasErrors ()
 
 isCompatibleWithRuntimeEnvironment ()
 
process (&$input)
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSeq ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
 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 ()
 
- Public Attributes inherited from PersistableFilter
 $_settings = array()
 
- Public Attributes inherited from Filter
 $_errors = array()
 
 $_runtimeEnvironment = false
 
- Public Attributes 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.

Member Function Documentation

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 387 of file NativeXmlPublicationFormatFilter.inc.php.

Referenced by _processProductNode().

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

Extracts the elements of the Extent nodes.

Parameters
$nodeDOMElement
$onixDeploymentOnix30ExportDeployment
PublicationFormat$representation

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

References _extractTextFromNode().

Referenced by _processProductNode().

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

Extracts the elements of the Measure nodes.

Parameters
$nodeDOMElement
$onixDeploymentOnix30ExportDeployment
PublicationFormat$representation

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

References _extractTextFromNode().

Referenced by _processProductNode().

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 307 of file NativeXmlPublicationFormatFilter.inc.php.

Referenced by _extractExtentContent(), _extractMeasureContent(), and _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 94 of file NativeXmlPublicationFormatFilter.inc.php.

References _extractAudienceRangeContent(), _extractExtentContent(), _extractMeasureContent(), _extractTextFromNode(), PKPRequest\getContext(), DAORegistry\getDAO(), and PKPRequest\getUser().

Referenced by handleElement().

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.)

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

NativeXmlPublicationFormatFilter::getPluralElementName ( )

Return the plural element name

Returns
string

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

NativeXmlPublicationFormatFilter::getSingularElementName ( )

Get the singular element name

Returns
string

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

NativeXmlPublicationFormatFilter::handleElement (   $node)

Handle a submission element

Parameters
$nodeDOMElement
Returns
array Array of PublicationFormat objects

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

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

NativeXmlPublicationFormatFilter::NativeXmlPublicationFormatFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

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


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