Open Journal Systems  3.3.0
GenericSequencerFilter Class Reference
Inheritance diagram for GenericSequencerFilter:
CompositeFilter PersistableFilter Filter DataObject

Public Member Functions

 __construct (&$filterGroup, $displayName=null)
 
 getClassName ()
 
process (&$input)
 
- Public Member Functions inherited from CompositeFilter
 _getCompositeSettingName ($settingName)
 
_getSubfilterSetting ($settingName)
 
 _resolveCompositeSettingName ($compositeSettingName)
 
 addFilter (&$filter)
 
getData ($key, $locale=null)
 
getFilter ($seq)
 
getFilters ()
 
 getInternalSettings ()
 
 getLocalizedSettingNames ()
 
getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 getSettingsMapping ()
 
 getSettingsMappingForSetting ($settingName)
 
 hasData ($key, $locale=null)
 
 hasSettings ()
 
 isCompatibleWithRuntimeEnvironment ()
 
 setData ($key, $value, $locale=null)
 
 setSettingsMapping ($settingsMapping)
 
- Public Member Functions inherited from PersistableFilter
 __construct ($filterGroup)
 
 addSetting ($setting)
 
 getFilterGroup ()
 
 getIsTemplate ()
 
 getParentFilterId ()
 
 hasSetting ($settingName)
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
- Public Member Functions inherited from Filter
 __construct ($inputType, $outputType)
 
 addError ($message)
 
 clearErrors ()
 
execute (&$input, $returnErrors=false)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSequence ()
 
 hasErrors ()
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSequence ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 unsetData ($key, $locale=null)
 
 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 ()
 
- Data Fields inherited from CompositeFilter
 $_filters = array()
 
 $_maxSeq = 0
 
- Data Fields inherited from PersistableFilter
 $_filterGroup
 
 $_settings = array()
 
- Data Fields inherited from Filter
 $_errors = array()
 
 $_input
 
 $_inputType
 
 $_output
 
 $_outputType
 
 $_runtimeEnvironment = false
 
- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

A generic filter that is configured with a number of ordered filters. It takes the input argument of the first filter, passes its output to the next filter and so on and finally returns the result of the last filter in the chain to the caller.

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

Constructor & Destructor Documentation

◆ __construct()

GenericSequencerFilter::__construct ( $filterGroup,
  $displayName = null 
)

Constructor

Reimplemented from CompositeFilter.

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

Member Function Documentation

◆ getClassName()

GenericSequencerFilter::getClassName ( )
See also
PersistableFilter::getClassName()

Reimplemented from PersistableFilter.

Definition at line 35 of file GenericSequencerFilter.inc.php.

◆ process()

& GenericSequencerFilter::process ( $input)
See also
Filter::process()
Parameters
$inputmixed
Returns
mixed

Reimplemented from Filter.

Definition at line 48 of file GenericSequencerFilter.inc.php.

References Filter\addError(), and CompositeFilter\getFilters().


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