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

Public Member Functions

 _buildTextNode ($doc, $nodeName, $textContent)
 
 _createExtentNode ($doc, $deployment, $type, $extentValue, $extentUnit)
 
 _createMeasurementNode ($doc, $deployment, $type, $measurement, $unitCode)
 
 createHeaderNode ($doc, $submission)
 
 createProductNode ($doc, $submission, $publicationFormat)
 
 getClassName ()
 
 MonographONIX30XmlFilter ($filterGroup)
 
process (&$monograph)
 
- Public Member Functions inherited from NativeExportFilter
 createLocalizedNodes ($doc, $parentNode, $name, $values)
 
 createOptionalNode ($doc, $parentNode, $name, $value)
 
 NativeExportFilter ($filterGroup)
 
- 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)
 

Public Attributes

 $_doc
 
- 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()
 

Additional Inherited Members

- Static Public Member Functions inherited from PersistableFilter
static tempGroup ($inputType, $outputType)
 
- Static Public Member Functions inherited from Filter
static supportedRuntimeEnvironmentSettings ()
 

Detailed Description

Base class that converts a monograph to an ONIX 3.0 document.

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

Member Function Documentation

MonographONIX30XmlFilter::_buildTextNode (   $doc,
  $nodeName,
  $textContent 
)

Convenience method for building a node with text content.

Parameters
DOMDocument$doc
string$nodeName
string$textContent
Returns
DOMElement

Definition at line 781 of file MonographONIX30XmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by createHeaderNode(), and createProductNode().

MonographONIX30XmlFilter::_createExtentNode (   $doc,
  $deployment,
  $type,
  $extentValue,
  $extentUnit 
)

Convenience method for building an Extent node.

Parameters
DOMDocument$doc
ONIX30ExportDeployment$deployment
string$type
string$measurement
string$unitCode
Returns
DOMElement

Definition at line 755 of file MonographONIX30XmlFilter.inc.php.

Referenced by createProductNode().

MonographONIX30XmlFilter::_createMeasurementNode (   $doc,
  $deployment,
  $type,
  $measurement,
  $unitCode 
)

Convenience method for building a Measure node.

Parameters
DOMDocument$doc
ONIX30ExportDeployment$deployment
string$type
string$measurement
string$unitCode
Returns
DOMElement

Definition at line 727 of file MonographONIX30XmlFilter.inc.php.

Referenced by createProductNode().

MonographONIX30XmlFilter::createHeaderNode (   $doc,
  $submission 
)

Create and return a node representing the ONIX Header metadata for this submission.

Parameters
$docDOMDocument
$submissionSubmission
Returns
DOMElement

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

References _buildTextNode(), and NativeImportExportFilter\getDeployment().

Referenced by process().

MonographONIX30XmlFilter::createProductNode (   $doc,
  $submission,
  $publicationFormat 
)

Create and return a node representing the ONIX Product metadata for this submission.

Parameters
$docDOMDocument
$submissionSubmission
$publicationFormatPublicationFormat
Returns
DOMElement

Definition at line 133 of file MonographONIX30XmlFilter.inc.php.

References _buildTextNode(), _createExtentNode(), _createMeasurementNode(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), AppLocale\getSupportedFormLocales(), PluginRegistry\loadCategory(), and Request\url().

Referenced by process().

MonographONIX30XmlFilter::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 39 of file MonographONIX30XmlFilter.inc.php.

MonographONIX30XmlFilter::MonographONIX30XmlFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Definition at line 27 of file MonographONIX30XmlFilter.inc.php.

References Filter\setDisplayName().

& MonographONIX30XmlFilter::process ( $monograph)
See Also
Filter::process()
Parameters
$monographMonograph the monograph to export
Returns
DOMDocument

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

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

Member Data Documentation

MonographONIX30XmlFilter::$_doc

var $_doc DOMDocument

Definition at line 21 of file MonographONIX30XmlFilter.inc.php.


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