class CRM_Contribute_Import_Parser extends CRM_Import_Parser

Constants

MAX_ERRORS

Settings

MAX_WARNINGS

Settings

DEFAULT_TIMEOUT

Settings

VALID

Return codes

WARNING

Return codes

ERROR

Return codes

CONFLICT

Return codes

STOP

Return codes

DUPLICATE

Return codes

MULTIPLE_DUPE

Return codes

NO_MATCH

Return codes

UNPARSED_ADDRESS_WARNING

Return codes

MODE_MAPFIELD

Parser modes

MODE_PREVIEW

Parser modes

MODE_SUMMARY

Parser modes

MODE_IMPORT

Parser modes

DUPLICATE_SKIP

Codes for duplicate record handling

DUPLICATE_REPLACE

Codes for duplicate record handling

DUPLICATE_UPDATE

Codes for duplicate record handling

DUPLICATE_FILL

Codes for duplicate record handling

DUPLICATE_NOCHECK

Codes for duplicate record handling

CONTACT_INDIVIDUAL

Contact types

CONTACT_HOUSEHOLD

Contact types

CONTACT_ORGANIZATION

Contact types

SOFT_CREDIT

Contribution-specific result codes

SOFT_CREDIT_ERROR

Contribution-specific result codes

PLEDGE_PAYMENT

Contribution-specific result codes

PLEDGE_PAYMENT_ERROR

Contribution-specific result codes

Properties

protected $_totalCount Total number of non empty lines from CRM_Import_Parser
protected $_validCount Running total number of valid lines from CRM_Import_Parser
protected $_invalidRowCount Running total number of invalid rows from CRM_Import_Parser
protected int $_maxLinesToProcess Maximum number of non-empty/comment lines to process from CRM_Import_Parser
protected $_maxErrorCount Maximum number of invalid rows to store from CRM_Import_Parser
protected $_errors Array of error lines, bounded by MAX_ERROR from CRM_Import_Parser
protected $_conflictCount Total number of conflict lines from CRM_Import_Parser
protected $_conflicts Array of conflict lines from CRM_Import_Parser
protected $_duplicateCount Total number of duplicate (from database) lines from CRM_Import_Parser
protected $_duplicates Array of duplicate lines from CRM_Import_Parser
protected $_warningCount Running total number of warnings from CRM_Import_Parser
protected $_maxWarningCount Maximum number of warnings to store from CRM_Import_Parser
protected $_warnings Array of warning lines, bounded by MAX_WARNING from CRM_Import_Parser
protected array $_fields Array of all the fields that could potentially be part of this import process from CRM_Import_Parser
protected array $_activeFields Array of the fields that are actually part of the import process the position in the array also dictates their position in the import file from CRM_Import_Parser
protected int $_activeFieldCount Cache the count of active fields from CRM_Import_Parser
protected array $_rows Cache of preview rows from CRM_Import_Parser
protected string $_errorFileName Filename of error data from CRM_Import_Parser
protected string $_conflictFileName Filename of conflict data from CRM_Import_Parser
protected string $_duplicateFileName Filename of duplicate data from CRM_Import_Parser
int $_contactType Contact type from CRM_Import_Parser
int $_contactSubType Contact sub-type from CRM_Import_Parser
protected $_fileName
protected $_fileSize Imported file size
protected $_seperator Seperator being used
protected $_lineCount Total number of lines in file
protected $_validSoftCreditRowCount Running total number of valid soft credit rows
protected $_invalidSoftCreditRowCount Running total number of invalid soft credit rows
protected $_validPledgePaymentRowCount Running total number of valid pledge payment rows
protected $_invalidPledgePaymentRowCount Running total number of invalid pledge payment rows
protected $_pledgePaymentErrors Array of pledge payment error lines, bounded by MAX_ERROR
protected $_softCreditErrors Array of pledge payment error lines, bounded by MAX_ERROR
protected string $_pledgePaymentErrorsFileName Filename of pledge payment error data
protected string $_softCreditErrorsFileName Filename of soft credit error data
protected boolean $_haveColumnHeader Whether the file has a column header or not

Methods

__construct()

Class constructor.

init()

Abstract function definitions.

mixed
fini()

No description

mixed
mapField(array $values)

Map field.

mixed
preview(array $values)

Preview.

mixed
summary($values)

No description

mixed
import($onDuplicate, $values)

No description

int
setActiveFieldValues(array $elements, $erroneousField)

Set and validate field values.

array
getActiveFieldParams()

Format the field values for input to the api.

array
getSelectValues()

No description

array
getSelectTypes()

No description

array
getHeaderPatterns()

No description

array
getDataPatterns()

No description

static void
encloseScrub(array $values, string $enclosure = "'")

Remove single-quote enclosures from a value array (row).

void
setMaxLinesToProcess(int $max)

Setter function.

static string
errorFileName($type)

Determines the file extension based on error code.

static string
saveFileName($type)

Determines the file name based on error code.

mixed
run(string $fileName, string $seperator = ',', $mapper, bool $skipColumnHeader = FALSE, int $mode = self::MODE_PREVIEW, int $contactType = self::CONTACT_INDIVIDUAL, int $onDuplicate = self::DUPLICATE_SKIP)

No description

setActiveFields(array $fieldKeys)

Given a list of the importable field keys that the user has selected set the active fields array to this list

setActiveFieldSoftCredit(array $elements)

No description

setActiveFieldSoftCreditType(array $elements)

No description

addField(string $name, $title, int $type = CRM_Utils_Type::T_INT, string $headerPattern = '//', string $dataPattern = '//')

No description

set(CRM_Core_Session $store, int $mode = self::MODE_SUMMARY)

Store parser values.

static 
exportCSV(string $fileName, array $header, array $data)

Export data to a CSV file.

Details

in CRM_Import_Parser at line 193
__construct()

Class constructor.

in CRM_Import_Parser at line 201
abstract protected init()

Abstract function definitions.

in CRM_Import_Parser at line 206
abstract protected mixed fini()

Return Value

mixed

in CRM_Import_Parser at line 215
abstract protected mixed mapField(array $values)

Map field.

Parameters

array $values

Return Value

mixed

in CRM_Import_Parser at line 224
abstract protected mixed preview(array $values)

Preview.

Parameters

array $values

Return Value

mixed

in CRM_Import_Parser at line 231
abstract protected mixed summary($values)

Parameters

$values

Return Value

mixed

in CRM_Import_Parser at line 239
abstract protected mixed import($onDuplicate, $values)

Parameters

$onDuplicate
$values

Return Value

mixed

in CRM_Import_Parser at line 251
int setActiveFieldValues(array $elements, $erroneousField)

Set and validate field values.

Parameters

array $elements array.
$erroneousField reference.

Return Value

int

at line 446
array getActiveFieldParams()

Format the field values for input to the api.

Return Value

array (reference) associative array of name/value pairs

in CRM_Import_Parser at line 298
array getSelectValues()

Return Value

array

in CRM_Import_Parser at line 309
array getSelectTypes()

Return Value

array

in CRM_Import_Parser at line 322
array getHeaderPatterns()

Return Value

array

in CRM_Import_Parser at line 335
array getDataPatterns()

Return Value

array

in CRM_Import_Parser at line 351
static void encloseScrub(array $values, string $enclosure = "'")

Remove single-quote enclosures from a value array (row).

Parameters

array $values
string $enclosure

Return Value

void

in CRM_Import_Parser at line 368
void setMaxLinesToProcess(int $max)

Setter function.

Parameters

int $max

Return Value

void

at line 605
static string errorFileName($type)

Determines the file extension based on error code.

Parameters

$type

Return Value

string

at line 639
static string saveFileName($type)

Determines the file name based on error code.

Parameters

$type

Return Value

string

at line 121
mixed run(string $fileName, string $seperator = ',', $mapper, bool $skipColumnHeader = FALSE, int $mode = self::MODE_PREVIEW, int $contactType = self::CONTACT_INDIVIDUAL, int $onDuplicate = self::DUPLICATE_SKIP)

Parameters

string $fileName
string $seperator
$mapper
bool $skipColumnHeader
int $mode
int $contactType
int $onDuplicate

Return Value

mixed

Exceptions

Exception

at line 410
setActiveFields(array $fieldKeys)

Given a list of the importable field keys that the user has selected set the active fields array to this list

Parameters

array $fieldKeys mapped array of values

at line 425
setActiveFieldSoftCredit(array $elements)

Parameters

array $elements

at line 434
setActiveFieldSoftCreditType(array $elements)

Parameters

array $elements

at line 477
addField(string $name, $title, int $type = CRM_Utils_Type::T_INT, string $headerPattern = '//', string $dataPattern = '//')

Parameters

string $name
$title
int $type
string $headerPattern
string $dataPattern

at line 501
set(CRM_Core_Session $store, int $mode = self::MODE_SUMMARY)

Store parser values.

Parameters

CRM_Core_Session $store
int $mode

at line 567
static exportCSV(string $fileName, array $header, array $data)

Export data to a CSV file.

Parameters

string $fileName
array $header
array $data