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

Public Member Functions

 GenericMultiplexerFilter (&$filterGroup, $displayName=null)
 
 getClassName ()
 
 getTolerateFailures ()
 
process (&$input)
 
 setTolerateFailures ($tolerateFailures)
 
- Public Member Functions inherited from CompositeFilter
 _getCompositeSettingName ($settingName)
 
_getSubfilterSetting ($settingName)
 
 _resolveCompositeSettingName ($compositeSettingName)
 
 addFilter (&$filter)
 
 CompositeFilter (&$filterGroup, $displayName=null)
 
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
 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)
 

Public Attributes

 $_tolerateFailures = false
 
- Public Attributes inherited from CompositeFilter
 $_filters = array()
 
 $_maxSeq = 0
 
- 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()
 

Additional Inherited Members

- Static Public Member Functions inherited from PersistableFilter
static tempGroup ($inputType, $outputType)
 
- Static Public Member Functions inherited from Filter
static supportedRuntimeEnvironmentSettings ()
 

Detailed Description

A generic filter that is configured with a number of equal type filters. It takes the input argument, applies all given filters to it and returns an array of outputs as a result.

The result can then be sent to either an iterator filter or to a de-multiplexer filter.

Definition at line 23 of file GenericMultiplexerFilter.inc.php.

Member Function Documentation

GenericMultiplexerFilter::GenericMultiplexerFilter ( $filterGroup,
  $displayName = null 
)

Constructor

Parameters
$filterGroupFilterGroup
$displayNamestring

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

GenericMultiplexerFilter::getClassName ( )
See Also
PersistentFilter::getClassName()

Definition at line 71 of file GenericMultiplexerFilter.inc.php.

GenericMultiplexerFilter::getTolerateFailures ( )

Returns true when sub-filters can fail as long as at least one filter returns a result.

Returns
boolean

Definition at line 60 of file GenericMultiplexerFilter.inc.php.

& GenericMultiplexerFilter::process ( $input)
See Also
Filter::process()
Parameters
$inputmixed
Returns
array

Definition at line 84 of file GenericMultiplexerFilter.inc.php.

GenericMultiplexerFilter::setTolerateFailures (   $tolerateFailures)

Set to true if sub-filters can fail as long as at least one filter returns a result.

Parameters
$tolerateFailuresboolean

Definition at line 51 of file GenericMultiplexerFilter.inc.php.

References $_tolerateFailures.

Member Data Documentation

boolean GenericMultiplexerFilter::$_tolerateFailures = false

whether some sub-filters can fail as long as at least one filter returns a result.

Definition at line 31 of file GenericMultiplexerFilter.inc.php.

Referenced by setTolerateFailures().


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