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

Public Member Functions

 getCitationModule ()
 
 getClassName ()
 
process (&$input)
 
- 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)
 

Static Public Member Functions

static getSupportedCitationModules ()
 
- 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 ()
 

Additional Inherited Members

- 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

Paracite parsing filter implementation.

The paracite parsing filter has one parameter: the citation module to be used. This can be one of "Standard", "Citebase" or "Jiao".

If you want to use various modules at the same time then you have to instantiate this parser filter several times with different configuration and chain all instances.

NB: This filter requires perl and CPAN's Biblio::Citation::Parser and Text::Unidecode packages to be installed on the server. It also requires the PHP shell_exec() function to be available which is often disabled in shared hosting environments.

Definition at line 40 of file ParaciteRawCitationNlm30CitationSchemaFilter.inc.php.

Member Function Documentation

ParaciteRawCitationNlm30CitationSchemaFilter::getCitationModule ( )

get the citation module

Returns
string

Definition at line 65 of file ParaciteRawCitationNlm30CitationSchemaFilter.inc.php.

References DataObject\getData().

Referenced by process().

ParaciteRawCitationNlm30CitationSchemaFilter::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 76 of file ParaciteRawCitationNlm30CitationSchemaFilter.inc.php.

static ParaciteRawCitationNlm30CitationSchemaFilter::getSupportedCitationModules ( )
static

Return supported paracite citation parser modules

Returns
array supported citation modules

Definition at line 287 of file ParaciteRawCitationNlm30CitationSchemaFilter.inc.php.

Referenced by ParaciteRawCitationNlm30CitationSchemaFilterTest\testAllCitationsWithThisParser(), and ParaciteRawCitationNlm30CitationSchemaFilterTest\testExecute().

& ParaciteRawCitationNlm30CitationSchemaFilter::process ( $input)

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
$inputstring
Returns
MetadataDescription

Definition at line 89 of file ParaciteRawCitationNlm30CitationSchemaFilter.inc.php.

References getCitationModule(), Filter\getDisplayName(), Filter\getSeq(), Config\getVar(), String\iterativeExplode(), String\titleCase(), String\trimPunctuation(), String\utf8_compliant(), String\utf8_normalize(), and String\utf8_to_ascii().


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