Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
TemplateBasedReferencesListFilter Class Reference
Inheritance diagram for TemplateBasedReferencesListFilter:
TemplateBasedFilter PersistableFilter Filter DataObject PKPSubmissionNlm30XmlFilter PlainTextReferencesListFilter

Public Member Functions

 addTemplateVars ($templateMgr, $submission, $request, &$locale)
 getCitationOutputFilterInstance ()
 getCitationOutputFilterTypeDescriptions ()
getMetadataSchema ()
 TemplateBasedReferencesListFilter ($filterGroup)
- Public Member Functions inherited from TemplateBasedFilter
 addTemplateVars ($templateMgr, &$input, $request, &$locale)
 getBasePath ()
 getTemplateName ()
process (&$input)
 TemplateBasedFilter ($filterGroup)
- 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 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

Abstract base class for filters that create a references list for a submission.

Definition at line 20 of file

Member Function Documentation

TemplateBasedReferencesListFilter::addTemplateVars (   $templateMgr,
TemplateBasedReferencesListFilter::getCitationOutputFilterInstance ( )

Retrieve the citation output filter that will be used to transform citations.


Definition at line 55 of file

References getCitationOutputFilterTypeDescriptions(), DataObject\getData(), and PersistableFilter\tempGroup().

Referenced by addTemplateVars().

TemplateBasedReferencesListFilter::getCitationOutputFilterTypeDescriptions ( )

Return an input and output type description that describes the transformation implemented by the citation output filter.


Definition at line 73 of file

Referenced by getCitationOutputFilterInstance().

& TemplateBasedReferencesListFilter::getMetadataSchema ( )

Get the metadata schema being used to extract data from the citations.


Definition at line 43 of file

References DataObject\getData().

Referenced by addTemplateVars().

TemplateBasedReferencesListFilter::TemplateBasedReferencesListFilter (   $filterGroup)



Definition at line 25 of file

References PersistableFilter\addSetting().

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