ExtractorBase Class Reference

Common implementation details for extractors. More...

Inheritance diagram for ExtractorBase:

Public Member Functions
	getProperties ()
	List the properties available in records generated by this extractor. Returns array Array of property names. More...
	getKeyProperties ()
	List the properties which form a unique key for the extracted data. Returns array Array keyed by property name, with value being an array containing a 'type' key whose value is the type of the property. More...
	extractFiltered ()
	Iterator taking into account any applicable filtering. Returns Record[] One data record from the source being extracted. More...
Public Member Functions inherited from OptionsResolverComponent
	getConfigurationValue (string $optionName)
	Retrieve a configuration value for a named option. Parameters string $optionName Name of the option to retrieve. Returns mixed|null Retrieved value, or NULL if unset. More...
	getAllConfigurationValues ()
	Retrieve a list of all available configuration values. Returns iterable Option values keyed by names. More...
Public Member Functions inherited from Extractor
	extractAll ()
	Iterator over all canonical source data. More...

Protected Member Functions
	optionDefinitions ()
Protected Member Functions inherited from OptionsResolverComponent
	optionDefinitions ()
	List of definition arrays for each option supported by the component. More...

Additional Inherited Members
Protected Attributes inherited from OptionsResolverComponent
	$configuration = []
	Resolved configuration for the component. More...
	$resolver
	Use Symfony OptionsResolver as our default configuration manager. More...

Detailed Description

Common implementation details for extractors.

Member Function Documentation

optionDefinitions()

optionDefinitions ( )

protected

getProperties()

getProperties

(

)

List the properties available in records generated by this extractor.

Returns

array Array of property names.

Implements PropertyList.

getKeyProperties()

getKeyProperties

(

)

List the properties which form a unique key for the extracted data.

Returns

array Array keyed by property name, with value being an array containing a 'type' key whose value is the type of the property.

Implements PropertyList.

extractFiltered()

extractFiltered

(

)

Iterator taking into account any applicable filtering.

Returns

Record[] One data record from the source being extracted.

Implements Extractor.