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

Public Member Functions

_getSearchTemplates ()
 
_lookupWorldcat ($oclcId)
 
_lookupXIsbn ($isbn)
 
 _oclcToIsbns ($oclcId)
 
 getApiKey ()
 
 getClassName ()
 
process (&$citationDescription)
 
 WorldcatNlm30CitationSchemaFilter ($filterGroup)
 
- 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

Citation lookup filter that uses the OCLC Worldcat Search API and xISBN services to search for book citation metadata.

See Also
CitationManager

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

Member Function Documentation

& WorldcatNlm30CitationSchemaFilter::_getSearchTemplates ( )

Return an array of search templates.

Returns
array

Definition at line 226 of file WorldcatNlm30CitationSchemaFilter.inc.php.

Referenced by process().

& WorldcatNlm30CitationSchemaFilter::_lookupWorldcat (   $oclcId)
& WorldcatNlm30CitationSchemaFilter::_lookupXIsbn (   $isbn)

Fills the given citation object with meta-data retrieved from xISBN

Parameters
$isbnstring
Returns
Citation

Definition at line 191 of file WorldcatNlm30CitationSchemaFilter.inc.php.

References Nlm30CitationSchemaFilter\callWebService(), Nlm30CitationSchemaFilter\getNlm30CitationDescriptionFromMetadataArray(), and Nlm30CitationSchemaFilter\postProcessMetadataArray().

Referenced by process().

WorldcatNlm30CitationSchemaFilter::_oclcToIsbns (   $oclcId)

Take an OCLC number and return the associated ISBNs as an array

Parameters
$oclcIdstring
Returns
array an array of ISBNs or an empty array if none found

Definition at line 138 of file WorldcatNlm30CitationSchemaFilter.inc.php.

References Nlm30CitationSchemaFilter\callWebService().

Referenced by process().

WorldcatNlm30CitationSchemaFilter::getApiKey ( )

Get the apiKey

Returns
string

Definition at line 59 of file WorldcatNlm30CitationSchemaFilter.inc.php.

References DataObject\getData().

Referenced by _lookupWorldcat(), and process().

WorldcatNlm30CitationSchemaFilter::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 70 of file WorldcatNlm30CitationSchemaFilter.inc.php.

& WorldcatNlm30CitationSchemaFilter::process ( $citationDescription)
WorldcatNlm30CitationSchemaFilter::WorldcatNlm30CitationSchemaFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

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

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


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