Open Journal Systems  3.3.0
IssueMedraXmlFilter Class Reference
Inheritance diagram for IssueMedraXmlFilter:
O4DOIXmlFilter NativeExportFilter NativeImportExportFilter PersistableFilter Filter DataObject

Public Member Functions

 __construct ($filterGroup)
 
 createIssueNode ($doc, $pubObject)
 
 createJournalIssueNode ($doc, $issue, $journalLocalePrecedence)
 
 getClassName ()
 
 isWork ($context, $plugin)
 
process (&$pubObjects)
 
- Public Member Functions inherited from O4DOIXmlFilter
 createExtentNode ($doc, $file)
 
 createHeadNode ($doc)
 
 createIdentifierNode ($doc, $workOrProduct, $idType, $id)
 
 createOtherTextNode ($doc, $locale, $description)
 
 createPublisherNode ($doc, $journalLocalePrecedence)
 
 createRelatedNode ($doc, $workOrProduct, $relationCode, $ids)
 
 createRootNode ($doc, $rootNodeName)
 
 createSerialPublicationNode ($doc, $journalLocalePrecedence, $epubFormat=null)
 
 createSerialVersionNode ($doc, $issn, $productForm, $epubFormat=null)
 
 createSerialWorkNode ($doc, $journalLocalePrecedence)
 
 createTitleNode ($doc, $locale, $localizedTitle, $titleType)
 
 getDOIStructuralType ()
 
 getObjectLocalePrecedence ($context, $article, $galley)
 
 getPrimaryTranslation ($localizedData, $localePrecedence)
 
 getRootNodeName ()
 
 getTranslationsByPrecedence ($localizedData, $localePrecedence)
 
 translateLanguageToLocale ($language)
 
- Public Member Functions inherited from NativeExportFilter
 createLocalizedNodes ($doc, $parentNode, $name, $values)
 
 createOptionalNode ($doc, $parentNode, $name, $value)
 
 getNoValidation ()
 
 setNoValidation ($noValidation)
 
 setOpts ($opts)
 
 supports (&$input, &$output)
 
- 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)
 
 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 NativeExportFilter
 $_noValidation = null
 
 $opts = array()
 
- 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 an Issue as work or manifestation to a O4DOI XML document.

Definition at line 19 of file IssueMedraXmlFilter.inc.php.

Constructor & Destructor Documentation

◆ __construct()

IssueMedraXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from O4DOIXmlFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ createIssueNode()

◆ createJournalIssueNode()

IssueMedraXmlFilter::createJournalIssueNode (   $doc,
  $issue,
  $journalLocalePrecedence 
)

Create the journal issue node.

Parameters
$docDOMDocument
$issueIssue
$journalLocalePrecedencearray
Returns
DOMElement

Reimplemented from O4DOIXmlFilter.

Definition at line 173 of file IssueMedraXmlFilter.inc.php.

References O4DOIXmlFilter\createExtentNode(), O4DOIXmlFilter\createTitleNode(), DAORegistry\getDAO(), NativeImportExportFilter\getDeployment(), O4DOIXmlFilter\getTranslationsByPrecedence(), and isWork().

Referenced by createIssueNode().

◆ getClassName()

IssueMedraXmlFilter::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 PersistableFilter.

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

◆ isWork()

IssueMedraXmlFilter::isWork (   $context,
  $plugin 
)

Get whether the object exported is considered as work

Parameters
$contextContext
$pluginDOIPubIdExportPlugin
Returns
boolean

Reimplemented from O4DOIXmlFilter.

Definition at line 32 of file IssueMedraXmlFilter.inc.php.

Referenced by createIssueNode(), createJournalIssueNode(), and process().

◆ process()

& IssueMedraXmlFilter::process ( $pubObjects)
See also
Filter::process()
Parameters
$pubObjectsarray Array of Issues
Returns
DOMDocument

Reimplemented from Filter.

Definition at line 54 of file IssueMedraXmlFilter.inc.php.

References O4DOIXmlFilter\createHeadNode(), createIssueNode(), O4DOIXmlFilter\createRootNode(), NativeImportExportFilter\getDeployment(), and isWork().


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