Open Journal Systems  3.3.0
IssueCrossrefXmlFilter Class Reference
Inheritance diagram for IssueCrossrefXmlFilter:
NativeExportFilter NativeImportExportFilter PersistableFilter Filter DataObject ArticleCrossrefXmlFilter

Public Member Functions

 __construct ($filterGroup)
 
 createDOIDataNode ($doc, $doi, $url)
 
 createHeadNode ($doc)
 
 createJournalIssueNode ($doc, $issue)
 
 createJournalMetadataNode ($doc)
 
 createJournalNode ($doc, $pubObject)
 
 createPublicationDateNode ($doc, $objectPublicationDate)
 
 createRootNode ($doc)
 
 getClassName ()
 
process (&$pubObjects)
 
- 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 to a Crossref XML document.

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

Constructor & Destructor Documentation

◆ __construct()

IssueCrossrefXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeExportFilter.

Reimplemented in ArticleCrossrefXmlFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ createDOIDataNode()

IssueCrossrefXmlFilter::createDOIDataNode (   $doc,
  $doi,
  $url 
)

Create and return the DOI date node 'doi_data'.

Parameters
$docDOMDocument
$doistring
$urlstring
Returns
DOMElement

Definition at line 229 of file IssueCrossrefXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by ArticleCrossrefXmlFilter\createComponentListNode(), ArticleCrossrefXmlFilter\createJournalArticleNode(), and createJournalIssueNode().

◆ createHeadNode()

IssueCrossrefXmlFilter::createHeadNode (   $doc)

Create and return the head node 'head'.

Parameters
$docDOMDocument
Returns
DOMElement

Definition at line 97 of file IssueCrossrefXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by process().

◆ createJournalIssueNode()

IssueCrossrefXmlFilter::createJournalIssueNode (   $doc,
  $issue 
)

Create and return the journal issue node 'journal_issue'.

Parameters
$docDOMDocument
$issueIssue
Returns
DOMElement

Reimplemented in ArticleCrossrefXmlFilter.

Definition at line 177 of file IssueCrossrefXmlFilter.inc.php.

References createDOIDataNode(), createPublicationDateNode(), PKPApplication\get(), and NativeImportExportFilter\getDeployment().

Referenced by createJournalNode().

◆ createJournalMetadataNode()

IssueCrossrefXmlFilter::createJournalMetadataNode (   $doc)

Create and return the journal metadata node 'journal_metadata'.

Parameters
$docDOMDocument
Returns
DOMElement

Definition at line 140 of file IssueCrossrefXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by createJournalNode().

◆ createJournalNode()

IssueCrossrefXmlFilter::createJournalNode (   $doc,
  $pubObject 
)

Create and return the journal node 'journal'.

Parameters
$docDOMDocument
$pubObjectobject Issue or Submission
Returns
DOMElement

Reimplemented in ArticleCrossrefXmlFilter.

Definition at line 127 of file IssueCrossrefXmlFilter.inc.php.

References createJournalIssueNode(), createJournalMetadataNode(), and NativeImportExportFilter\getDeployment().

Referenced by process().

◆ createPublicationDateNode()

IssueCrossrefXmlFilter::createPublicationDateNode (   $doc,
  $objectPublicationDate 
)

Create and return the publication date node 'publication_date'.

Parameters
$docDOMDocument
$objectPublicationDatestring
Returns
DOMElement

Definition at line 207 of file IssueCrossrefXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by ArticleCrossrefXmlFilter\createJournalArticleNode(), and createJournalIssueNode().

◆ createRootNode()

IssueCrossrefXmlFilter::createRootNode (   $doc)

Create and return the root node 'doi_batch'.

Parameters
$docDOMDocument
Returns
DOMElement

Definition at line 81 of file IssueCrossrefXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by process().

◆ getClassName()

IssueCrossrefXmlFilter::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 ArticleCrossrefXmlFilter.

Definition at line 34 of file IssueCrossrefXmlFilter.inc.php.

◆ process()

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

Reimplemented from Filter.

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

References createHeadNode(), createJournalNode(), createRootNode(), and NativeImportExportFilter\getDeployment().


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