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

Public Member Functions

 __construct ($filterGroup)
 
 createArticleNode ($doc, $pubObject)
 
 createContentItemNode ($doc, $issue, $article, $galley, $objectLocalePrecedence)
 
 createContributorNode ($doc, $author, $objectLocalePrecedence)
 
 createSubjectNode ($doc, $subjectSchemeId, $subjectHeadingOrCode, $subjectSchemeName=null)
 
 getClassName ()
 
 getRootNodeName ()
 
 isWork ($context, $plugin)
 
process (&$pubObjects)
 
- Public Member Functions inherited from O4DOIXmlFilter
 createExtentNode ($doc, $file)
 
 createHeadNode ($doc)
 
 createIdentifierNode ($doc, $workOrProduct, $idType, $id)
 
 createJournalIssueNode ($doc, $issue, $journalLocalePrecedence)
 
 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)
 
 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 Article as work to a O4DOI XML document.

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

Constructor & Destructor Documentation

◆ __construct()

ArticleMedraXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from O4DOIXmlFilter.

Reimplemented in GalleyMedraXmlFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ createArticleNode()

ArticleMedraXmlFilter::createArticleNode (   $doc,
  $pubObject 
)

◆ createContentItemNode()

ArticleMedraXmlFilter::createContentItemNode (   $doc,
  $issue,
  $article,
  $galley,
  $objectLocalePrecedence 
)

◆ createContributorNode()

ArticleMedraXmlFilter::createContributorNode (   $doc,
  $author,
  $objectLocalePrecedence 
)

Create a contributor node.

Parameters
$docDOMDocument
$authorAuthor
$objectLocalePrecedencearray
Returns
DOMElement

Definition at line 340 of file ArticleMedraXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment(), O4DOIXmlFilter\getPrimaryTranslation(), and PKPString\html2text().

Referenced by createContentItemNode().

◆ createSubjectNode()

ArticleMedraXmlFilter::createSubjectNode (   $doc,
  $subjectSchemeId,
  $subjectHeadingOrCode,
  $subjectSchemeName = null 
)

Create a subject node.

Parameters
$docDOMDocument
$subjectSchemeIdstring One of the O4DOI_SUBJECT_SCHEME_* constants.
$subjectHeadingOrCodestring The subject.
$subjectSchemeNamestring|null A subject scheme name.
Returns
DOMElement

Definition at line 380 of file ArticleMedraXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by createContentItemNode().

◆ getClassName()

ArticleMedraXmlFilter::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.

Reimplemented in GalleyMedraXmlFilter.

Definition at line 49 of file ArticleMedraXmlFilter.inc.php.

◆ getRootNodeName()

ArticleMedraXmlFilter::getRootNodeName ( )

Get root node name

Returns
string

Reimplemented from O4DOIXmlFilter.

Reimplemented in GalleyMedraXmlFilter.

Definition at line 39 of file ArticleMedraXmlFilter.inc.php.

Referenced by process().

◆ isWork()

ArticleMedraXmlFilter::isWork (   $context,
  $plugin 
)

Get whether the object exported is considered as work

Parameters
$contextContext
$pluginDOIPubIdExportPlugin
Returns
boolean

Reimplemented from O4DOIXmlFilter.

Reimplemented in GalleyMedraXmlFilter.

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

Referenced by createArticleNode().

◆ process()

& ArticleMedraXmlFilter::process ( $pubObjects)
See also
Filter::process()
Parameters
$pubObjectsarray Array of Submissions or ArticleGalleys
Returns
DOMDocument

Reimplemented from Filter.

Definition at line 61 of file ArticleMedraXmlFilter.inc.php.

References createArticleNode(), O4DOIXmlFilter\createHeadNode(), O4DOIXmlFilter\createRootNode(), NativeImportExportFilter\getDeployment(), and getRootNodeName().


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