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

Public Member Functions

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

Class that converts a submission to a plain text references list based on the configured ordering type and citation output filter.

Definition at line 21 of file PlainTextReferencesListFilter.inc.php.

Member Function Documentation

PlainTextReferencesListFilter::addTemplateVars (   $templateMgr,
  $submission,
  $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 79 of file PlainTextReferencesListFilter.inc.php.

References DataObject\getData().

PlainTextReferencesListFilter::getBasePath ( )

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

Returns
string

Definition at line 96 of file PlainTextReferencesListFilter.inc.php.

PlainTextReferencesListFilter::getCitationOutputFilterTypeDescriptions ( )

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

Returns
array

Definition at line 42 of file PlainTextReferencesListFilter.inc.php.

PlainTextReferencesListFilter::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 55 of file PlainTextReferencesListFilter.inc.php.

PlainTextReferencesListFilter::getTemplateName ( )

Return the template name to be used by this filter.

Returns
string

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

PlainTextReferencesListFilter::PlainTextReferencesListFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Definition at line 26 of file PlainTextReferencesListFilter.inc.php.

References PersistableFilter\addSetting().

& PlainTextReferencesListFilter::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.

Definition at line 66 of file PlainTextReferencesListFilter.inc.php.

References DataObject\getData().


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