Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
CrossrefNlm30CitationSchemaFilter Class Reference
Inheritance diagram for CrossrefNlm30CitationSchemaFilter:
Nlm30CitationSchemaFilter PersistableFilter Filter DataObject

Public Member Functions

_prepareOpenurl10Search (&$citationDescription)
 
 CrossrefNlm30CitationSchemaFilter ($filterGroup)
 
 getClassName ()
 
 getEmail ()
 
process (&$citationDescription)
 
 setEmail ($email)
 
- Public Member Functions inherited from Nlm30CitationSchemaFilter
 _guessPublicationType (&$metadataArray)
 
_recursivelyTrimPunctuation (&$metadataArray)
 
callWebService ($url, &$params, $returnType=XSL_TRANSFORMER_DOCTYPE_DOM, $method= 'GET')
 
 constructSearchStrings (&$searchTemplates, &$citationDescription)
 
fixPublisherNameAndLocation (&$metadata)
 
 getIsOptional ()
 
getNlm30CitationDescriptionFromMetadataArray (&$metadataArray)
 
 getSupportedPublicationTypes ()
 
 Nlm30CitationSchemaFilter (&$filterGroup, $supportedPublicationTypes=array())
 
postProcessMetadataArray (&$preliminaryNlm30Array)
 
 supports (&$input, &$output)
 
transformWebServiceResults (&$xmlResult, $xslFileName)
 
- Public Member Functions inherited from PersistableFilter
 addSetting (&$setting)
 
 getClassName ()
 
getFilterGroup ()
 
 getInternalSettings ()
 
 getIsTemplate ()
 
 getLocalizedSettingNames ()
 
 getParentFilterId ()
 
getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 hasSetting ($settingName)
 
 hasSettings ()
 
 PersistableFilter ($filterGroup)
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
- Public Member Functions inherited from Filter
 addError ($message)
 
 clearErrors ()
 
execute (&$input)
 
 Filter ($inputType, $outputType)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSeq ()
 
 hasErrors ()
 
 isCompatibleWithRuntimeEnvironment ()
 
process (&$input)
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSeq ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Static Public Member Functions inherited from Nlm30CitationSchemaFilter
static _allowedPublicationTypes ()
 
- Static Public Member Functions inherited from PersistableFilter
static tempGroup ($inputType, $outputType)
 
- Static Public Member Functions inherited from Filter
static supportedRuntimeEnvironmentSettings ()
 
- Public Attributes inherited from PersistableFilter
 $_settings = array()
 
- Public Attributes inherited from Filter
 $_errors = array()
 
 $_runtimeEnvironment = false
 
- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Filter that uses the Crossref web service to identify a DOI and corresponding meta-data for a given NLM citation.

Definition at line 28 of file CrossrefNlm30CitationSchemaFilter.inc.php.

Member Function Documentation

& CrossrefNlm30CitationSchemaFilter::_prepareOpenurl10Search ( $citationDescription)

Prepare a search with the CrossRef OpenURL resolver

Parameters
$citationDescriptionMetadataDescription
Returns
array an array of search parameters

Definition at line 136 of file CrossrefNlm30CitationSchemaFilter.inc.php.

Referenced by process().

CrossrefNlm30CitationSchemaFilter::CrossrefNlm30CitationSchemaFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Definition at line 33 of file CrossrefNlm30CitationSchemaFilter.inc.php.

References PersistableFilter\addSetting(), and Filter\setDisplayName().

CrossrefNlm30CitationSchemaFilter::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.)

Definition at line 80 of file CrossrefNlm30CitationSchemaFilter.inc.php.

CrossrefNlm30CitationSchemaFilter::getEmail ( )

Get the CrossRef registered access email

Returns
string

Definition at line 69 of file CrossrefNlm30CitationSchemaFilter.inc.php.

References DataObject\getData().

Referenced by process().

& CrossrefNlm30CitationSchemaFilter::process ( $citationDescription)

This method performs the actual data processing. NB: sub-classes must implement this method.

Parameters
$inputmixed validated filter input data
Returns
mixed non-validated filter output or null if processing was not successful.
Parameters
$citationDescriptionMetadataDescription
Returns
MetadataDescription

Definition at line 93 of file CrossrefNlm30CitationSchemaFilter.inc.php.

References _prepareOpenurl10Search(), Nlm30CitationSchemaFilter\callWebService(), getEmail(), Nlm30CitationSchemaFilter\getNlm30CitationDescriptionFromMetadataArray(), String\regexp_replace(), String\substr(), and Nlm30CitationSchemaFilter\transformWebServiceResults().

CrossrefNlm30CitationSchemaFilter::setEmail (   $email)

Get the CrossRef registered access email

Parameters
$emailstring

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

References DataObject\setData().


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