CRM_Import_DataSource

abstract class CRM_Import_DataSource

This class defines the DataSource interface but must be subclassed to be useful.

Methods

array
getInfo()

Provides information about the data source.

preProcess(CRM_Core_Form $form)

Set variables up before form is built.

buildQuickForm(CRM_Core_Form $form)

This is function is called by the form object to get the DataSource's form snippet.

postProcess(array $params, string $db, CRM_Core_Form $form)

Process the form submission.

bool
checkPermission()

Determine if the current user has access to this data source.

Details

at line 51
abstract array getInfo()

Provides information about the data source.

Return Value

array Description of this data source, including: - title: string, translated, required - permissions: array, optional

at line 58
abstract preProcess(CRM_Core_Form $form)

Set variables up before form is built.

Parameters

CRM_Core_Form $form

at line 67
abstract buildQuickForm(CRM_Core_Form $form)

This is function is called by the form object to get the DataSource's form snippet.

It should add all fields necessary to get the data uploaded to the temporary table in the DB.

Parameters

CRM_Core_Form $form

at line 76
abstract postProcess(array $params, string $db, CRM_Core_Form $form)

Process the form submission.

Parameters

array $params
string $db
CRM_Core_Form $form

at line 83
bool checkPermission()

Determine if the current user has access to this data source.

Return Value

bool