Open Preprint Systems  3.3.0
PreprintCrossrefXmlFilter Class Reference
Inheritance diagram for PreprintCrossrefXmlFilter:
NativeExportFilter NativeImportExportFilter PersistableFilter Filter DataObject

Public Member Functions

 __construct ($filterGroup)
 
 createDOIDataNode ($doc, $doi, $url)
 
 createHeadNode ($doc)
 
 createPostedContentNode ($doc, $publication, $submission)
 
 createPostedDateNode ($doc, $objectPostedDate)
 
 createRelationsDataNode ($doc, $parentDoi)
 
 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 a Preprint to a Crossref XML document.

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

Constructor & Destructor Documentation

◆ __construct()

PreprintCrossrefXmlFilter::__construct (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Reimplemented from NativeExportFilter.

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

References Filter\setDisplayName().

Member Function Documentation

◆ createDOIDataNode()

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

Create and return the DOI data node 'doi_data'.

Parameters
$docDOMDocument
$doistring
$urlstring
Returns
DOMElement

Definition at line 256 of file PreprintCrossrefXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by createPostedContentNode().

◆ createHeadNode()

PreprintCrossrefXmlFilter::createHeadNode (   $doc)

Create and return the head node 'head'.

Parameters
$docDOMDocument
Returns
DOMElement

Definition at line 105 of file PreprintCrossrefXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by process().

◆ createPostedContentNode()

PreprintCrossrefXmlFilter::createPostedContentNode (   $doc,
  $publication,
  $submission 
)

Create and return the posted content node 'posted_content'.

Parameters
$docDOMDocument
Returns
DOMElement

Definition at line 134 of file PreprintCrossrefXmlFilter.inc.php.

References createDOIDataNode(), createPostedDateNode(), createRelationsDataNode(), PKPApplication\get(), NativeImportExportFilter\getDeployment(), and PKPLocale\getIso1FromLocale().

Referenced by process().

◆ createPostedDateNode()

PreprintCrossrefXmlFilter::createPostedDateNode (   $doc,
  $objectPostedDate 
)

Create and return the posted date node 'posted_date'.

Parameters
$docDOMDocument
$objectPostedDatestring
Returns
DOMElement

Definition at line 235 of file PreprintCrossrefXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by createPostedContentNode().

◆ createRelationsDataNode()

PreprintCrossrefXmlFilter::createRelationsDataNode (   $doc,
  $parentDoi 
)

Create and return the 'program' node for DOI relations.

Parameters
$docDOMDocument
$parentDoistring
Returns
DOMElement

Definition at line 270 of file PreprintCrossrefXmlFilter.inc.php.

References NativeImportExportFilter\getDeployment().

Referenced by createPostedContentNode().

◆ createRootNode()

PreprintCrossrefXmlFilter::createRootNode (   $doc)

Create and return the root node 'doi_batch'.

Parameters
$docDOMDocument
Returns
DOMElement

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

References NativeImportExportFilter\getDeployment().

Referenced by process().

◆ getClassName()

PreprintCrossrefXmlFilter::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 PreprintCrossrefXmlFilter.inc.php.

◆ process()

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

Reimplemented from Filter.

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

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


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