Open Journal Systems  3.3.0
ArticlePubMedXmlFilter Class Reference
Inheritance diagram for ArticlePubMedXmlFilter:
PersistableFilter Filter DataObject

Public Member Functions

 __construct ($filterGroup)
 
 createJournalNode ($doc, $journal, $issue, $submission)
 
 generateAuthorNode ($doc, $journal, $issue, $submission, $author)
 
 generatePubDateDom ($doc, $pubDate, $pubStatus)
 
 getClassName ()
 
 getRepresentationExportFilterGroupName ()
 
process (&$submissions)
 
- 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)
 
 supports (&$input, &$output)
 
 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 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 a Article to a PubMed XML document.

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

Constructor & Destructor Documentation

◆ __construct()

ArticlePubMedXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from PersistableFilter.

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

Member Function Documentation

◆ createJournalNode()

ArticlePubMedXmlFilter::createJournalNode (   $doc,
  $journal,
  $issue,
  $submission 
)

Construct and return a Journal element.

Parameters
$docDOMDocument
$journalJournal
$issueIssue
$submissionSubmission

Definition at line 156 of file ArticlePubMedXmlFilter.inc.php.

References generatePubDateDom().

Referenced by process().

◆ generateAuthorNode()

ArticlePubMedXmlFilter::generateAuthorNode (   $doc,
  $journal,
  $issue,
  $submission,
  $author 
)

Generate and return an author node representing the supplied author.

Parameters
$docDOMDocument
$journalJournal
$issueIssue
$submissionSubmission
$authorAuthor
Returns
DOMElement

Definition at line 196 of file ArticlePubMedXmlFilter.inc.php.

Referenced by process().

◆ generatePubDateDom()

ArticlePubMedXmlFilter::generatePubDateDom (   $doc,
  $pubDate,
  $pubStatus 
)

Generate and return a date element per the PubMed standard.

Parameters
$docDOMDocument
$pubDatestring
$pubStatusstring
Returns
DOMElement

Definition at line 219 of file ArticlePubMedXmlFilter.inc.php.

Referenced by createJournalNode(), and process().

◆ getClassName()

ArticlePubMedXmlFilter::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 34 of file ArticlePubMedXmlFilter.inc.php.

◆ getRepresentationExportFilterGroupName()

ArticlePubMedXmlFilter::getRepresentationExportFilterGroupName ( )

Get the representation export filter group name

Returns
string

Definition at line 46 of file ArticlePubMedXmlFilter.inc.php.

◆ process()

& ArticlePubMedXmlFilter::process ( $submissions)
See also
Filter::process()
Parameters
$submissionsarray Array of submissions
Returns
DOMDocument

Reimplemented from Filter.

Definition at line 58 of file ArticlePubMedXmlFilter.inc.php.

References createJournalNode(), generateAuthorNode(), generatePubDateDom(), PKPLocale\get3LetterFrom2LetterIsoLanguage(), DAORegistry\getDAO(), and PKPString\html2text().


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