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

Common implementation details for loaders. More...

Inheritance diagram for LoaderBase:
OptionsResolverComponent Loader ConfigurableComponent ConfigurableComponent PropertyList PrintR VarDump

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...
 
- 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...
 
- Public Member Functions inherited from Loader
 __invoke (RecordPayload $payload)
 This needs to return disposition (success, failure) and key of result. More...
 
 delete (array $key)
 Remove a record which has been loaded from the destination. 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 loaders.

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.