CRM_Export_BAO_Export

class CRM_Export_BAO_Export

This class contains the functions for Component export

Constants

EXPORT_ROW_COUNT

Methods

static 
exportComponents(int $selectAll, array $ids, array $params, string $order = NULL, array $fields = NULL, array $moreReturnProperties = NULL, int $exportMode = CRM_Export_Form_Select::CONTACT_EXPORT, string $componentClause = NULL, string $componentTable = NULL, bool $mergeSameAddress = FALSE, bool $mergeSameHousehold = FALSE, array $exportParams = [], string $queryOperator = 'AND')

Get the list the export fields.

static 
invoke()

Handle import error file creation.

static 
exportCustom($customSearchClass, $formValues, $order)

No description

static 
writeDetailsToTable(CRM_Export_BAO_ExportProcessor $processor, $details)

No description

static array
getIDsForRelatedContact(array $ids, int $exportMode)

Get the ids that we want to get related contact details for.

static 
buildRelatedContactArray($selectAll, $ids, CRM_Export_BAO_ExportProcessor $processor, $componentTable)

No description

Details

at line 75
static exportComponents(int $selectAll, array $ids, array $params, string $order = NULL, array $fields = NULL, array $moreReturnProperties = NULL, int $exportMode = CRM_Export_Form_Select::CONTACT_EXPORT, string $componentClause = NULL, string $componentTable = NULL, bool $mergeSameAddress = FALSE, bool $mergeSameHousehold = FALSE, array $exportParams = [], string $queryOperator = 'AND')

Get the list the export fields.

Parameters

int $selectAll User preference while export.
array $ids Contact ids.
array $params Associated array of fields.
string $order Order by clause.
array $fields Associated array of fields.
array $moreReturnProperties Additional return fields.
int $exportMode Export mode.
string $componentClause Component clause.
string $componentTable Component table.
bool $mergeSameAddress Merge records if they have same address.
bool $mergeSameHousehold Merge records if they belong to the same household.
array $exportParams
string $queryOperator

Exceptions

CRM_Core_Exception

at line 226
static invoke()

Handle import error file creation.

at line 268
static exportCustom($customSearchClass, $formValues, $order)

Parameters

$customSearchClass
$formValues
$order

at line 317
static writeDetailsToTable(CRM_Export_BAO_ExportProcessor $processor, $details)

Parameters

CRM_Export_BAO_ExportProcessor $processor
$details

at line 368
static protected array getIDsForRelatedContact(array $ids, int $exportMode)

Get the ids that we want to get related contact details for.

Parameters

array $ids
int $exportMode

Return Value

array

at line 408
static protected buildRelatedContactArray($selectAll, $ids, CRM_Export_BAO_ExportProcessor $processor, $componentTable)

Parameters

$selectAll
$ids
CRM_Export_BAO_ExportProcessor $processor
$componentTable