Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Mods34DescriptionXmlFilter Class Reference
Inheritance diagram for Mods34DescriptionXmlFilter:
PersistableFilter Filter DataObject

Public Member Functions

_buildDocumentHierarchy (&$doc, &$root, &$mods34Description)
 
_createNode ($doc, $nodePath, $value=null)
 
_joinNodes (&$documentHierarchy)
 
_processCompositeProperty (&$doc, $elementName, &$metadataDescription)
 
 getClassName ()
 
 Mods34DescriptionXmlFilter (&$filterGroup)
 
process (&$input)
 
- 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)
 
 tempGroup ($inputType, $outputType)
 
- 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)
 
 supportedRuntimeEnvironmentSettings ()
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
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

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Class that converts a meta-data description to a MODS 3.4 XML document.

Definition at line 24 of file Mods34DescriptionXmlFilter.inc.php.

Member Function Documentation

& Mods34DescriptionXmlFilter::_buildDocumentHierarchy ( $doc,
$root,
$mods34Description 
)

Create a hierarchical array that represents the MODS DOM from the meta-data description.

Parameters
$docXMLNode|DOMDocument the MODS document node.
$rootXMLNode|DOMDocument the root node of the MODS document.
$mods34DescriptionMetadataDescription
Returns
array a hierarchical array of XMLNode|DOMDocument objects representing the MODS document.

Definition at line 111 of file Mods34DescriptionXmlFilter.inc.php.

References _createNode(), _processCompositeProperty(), and PKPLocale\get3LetterIsoFromLocale().

Referenced by _processCompositeProperty(), and process().

& Mods34DescriptionXmlFilter::_createNode (   $doc,
  $nodePath,
  $value = null 
)

Create a new XML node.

Parameters
$docXMLNode|DOMImplementation
$nodePathstring an XPath-like string that describes the node to be created.
$valuestring the value to be added as a text node (if any)
Returns
XMLNode|DOMDocument

Definition at line 303 of file Mods34DescriptionXmlFilter.inc.php.

Referenced by _buildDocumentHierarchy().

& Mods34DescriptionXmlFilter::_joinNodes ( $documentHierarchy)

Recursively join the document hierarchy into a single document.

Parameters
$documentHierarchy
Returns
array an array of joined nodes

Definition at line 338 of file Mods34DescriptionXmlFilter.inc.php.

Referenced by _processCompositeProperty(), and process().

& Mods34DescriptionXmlFilter::_processCompositeProperty ( $doc,
  $elementName,
$metadataDescription 
)

Process a MODS composite property into an XML node.

Parameters
$docXMLNode|DOMDocument the MODS document node.
$elementNamestring the name of the root element of the composite
$metadataDescriptionMetadataDescription
Returns
XMLNode|DOMDocument

Definition at line 88 of file Mods34DescriptionXmlFilter.inc.php.

References _buildDocumentHierarchy(), and _joinNodes().

Referenced by _buildDocumentHierarchy().

Mods34DescriptionXmlFilter::getClassName ( )
Mods34DescriptionXmlFilter::Mods34DescriptionXmlFilter ( $filterGroup)

Constructor $filterGroup FilterGroup

Definition at line 29 of file Mods34DescriptionXmlFilter.inc.php.

References Filter\setDisplayName().

& Mods34DescriptionXmlFilter::process ( $input)

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