Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
TemplateBasedFilter Class Reference
Inheritance diagram for TemplateBasedFilter:
PersistableFilter Filter DataObject Nlm30CitationSchemaCitationOutputFormatFilter TemplateBasedReferencesListFilter Nlm30CitationSchemaAbntFilter Nlm30CitationSchemaApaFilter Nlm30CitationSchemaMlaFilter Nlm30CitationSchemaNlm30XmlFilter Nlm30CitationSchemaVancouverFilter PKPSubmissionNlm30XmlFilter PlainTextReferencesListFilter

Public Member Functions

 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)
 
 tempGroup ($inputType, $outputType)
 
- 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)
 
 supportedRuntimeEnvironmentSettings ()
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
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

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Abstract base class for all filters that transform their input via smarty templates.

Definition at line 19 of file TemplateBasedFilter.inc.php.

Member Function Documentation

TemplateBasedFilter::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 60 of file TemplateBasedFilter.inc.php.

Referenced by process().

TemplateBasedFilter::getBasePath ( )

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

Returns
string

Definition at line 38 of file TemplateBasedFilter.inc.php.

Referenced by process().

TemplateBasedFilter::getTemplateName ( )

Return the template name to be used by this filter.

Returns
string

Definition at line 47 of file TemplateBasedFilter.inc.php.

Referenced by process().

& TemplateBasedFilter::process ( $input)
TemplateBasedFilter::TemplateBasedFilter ( $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Definition at line 24 of file TemplateBasedFilter.inc.php.


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