Soong
Soong provides a general-purpose ETL library for data migration.
ArrayExtractor Class Reference

Extractor for in-memory arrays. More...

Inheritance diagram for ArrayExtractor:
CountableExtractorBase ExtractorBase Countable OptionsResolverComponent Extractor ConfigurableComponent ConfigurableComponent PropertyList

Public Member Functions

 extractAll ()
 Iterator over all canonical source data.Note filtering may be applied here to the raw data, if there are records in the raw source which are not part of the logical source for this extraction process.
Returns
Record[] One data record from the source being extracted.
Exceptions
More...
 
 getProperties ()
 List the properties available in records generated by this extractor.
Returns
array Array of property names.
More...
 
- Public Member Functions inherited from CountableExtractorBase
 count ()
 
- Public Member Functions inherited from ExtractorBase
 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$optionNameName 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...
 

Protected Member Functions

 optionDefinitions ()
 
 getUncachedCount ()
 
- Protected Member Functions inherited from CountableExtractorBase
 optionDefinitions ()
 
 getUncachedCount ()
 Determine the "real" count directly from the source. More...
 
- Protected Member Functions inherited from ExtractorBase
 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

Extractor for in-memory arrays.

Member Function Documentation

◆ optionDefinitions()

optionDefinitions ( )
protected

◆ extractAll()

extractAll ( )

Iterator over all canonical source data.Note filtering may be applied here to the raw data, if there are records in the raw source which are not part of the logical source for this extraction process.

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

Implements Extractor.

◆ getProperties()

getProperties ( )

List the properties available in records generated by this extractor.

Returns
array Array of property names.

Implements PropertyList.

◆ getUncachedCount()

getUncachedCount ( )
protected