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

Public Member Functions

 createRepresentationNode ($doc, $representation)
 
 getClassName ()
 
 getFiles ($representation)
 
process (&$representation)
 
 RepresentationNativeXmlFilter ($filterGroup)
 
- 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)
 

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

Base class that converts a representation to a Native XML document.

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

Member Function Documentation

RepresentationNativeXmlFilter::createRepresentationNode (   $doc,
  $representation 
)

Create and return a representation node.

Parameters
$docDOMDocument
$representationRepresentation
Returns
DOMElement

Definition at line 69 of file RepresentationNativeXmlFilter.inc.php.

References NativeExportFilter\createLocalizedNodes(), NativeImportExportFilter\getDeployment(), and getFiles().

Referenced by process().

RepresentationNativeXmlFilter::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 35 of file RepresentationNativeXmlFilter.inc.php.

RepresentationNativeXmlFilter::getFiles (   $representation)

Get the submission files associated with this representation

Parameters
$representationRepresentation
Returns
array

Definition at line 102 of file RepresentationNativeXmlFilter.inc.php.

Referenced by createRepresentationNode().

& RepresentationNativeXmlFilter::process ( $representation)
See Also
Filter::process()
Parameters
$representationRepresentation
Returns
DOMDocument

Definition at line 48 of file RepresentationNativeXmlFilter.inc.php.

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

RepresentationNativeXmlFilter::RepresentationNativeXmlFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

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

References Filter\setDisplayName().


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