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

Public Member Functions

 addTemplateVars ($templateMgr, &$input, $request, &$locale)
 
 getBasePath ()
 
 getClassName ()
 
 Nlm30CitationSchemaNlm30XmlFilter ($filterGroup)
 
- Public Member Functions inherited from Nlm30CitationSchemaCitationOutputFormatFilter
 addTemplateVars ($templateMgr, &$input, $request, &$locale)
 
 getSupportedPublicationTypes ()
 
 getTemplateName ()
 
 Nlm30CitationSchemaCitationOutputFormatFilter ($filterGroup)
 
process (&$input)
 
 setSupportedPublicationTypes ($supportedPublicationTypes)
 
- 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

Filter that transforms NLM citation metadata descriptions into NLM 3.0 XML citation output.

Definition at line 20 of file Nlm30CitationSchemaNlm30XmlFilter.inc.php.

Member Function Documentation

Nlm30CitationSchemaNlm30XmlFilter::addTemplateVars (   $templateMgr,
$input,
  $request,
$locale 
)

Sub-classes must implement this method to add template variables to the template.

Parameters
$templateMgrTemplateManager
$inputmixed the filter input
$requestRequest
$localeAppLocale

Definition at line 49 of file Nlm30CitationSchemaNlm30XmlFilter.inc.php.

Nlm30CitationSchemaNlm30XmlFilter::getBasePath ( )

Return the base path of the filter so that we can find the filter templates.

Returns
string

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

Nlm30CitationSchemaNlm30XmlFilter::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 38 of file Nlm30CitationSchemaNlm30XmlFilter.inc.php.

Nlm30CitationSchemaNlm30XmlFilter::Nlm30CitationSchemaNlm30XmlFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Definition at line 25 of file Nlm30CitationSchemaNlm30XmlFilter.inc.php.

References Filter\setDisplayName().


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