CRM_Member_Import_Parser_Membership

class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser

class to parse membership csv files

Constants

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

Properties

protected int	$_totalCount	Total number of non empty lines	from CRM_Import_Parser
protected int	$_validCount	Running total number of valid lines	from CRM_Import_Parser
protected int	$_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 array	$_errors	Array of error lines, bounded by MAX_ERROR	from CRM_Import_Parser
protected int	$_conflictCount	Total number of conflict lines	from CRM_Import_Parser
protected array	$_conflicts	Array of conflict lines	from CRM_Import_Parser
protected int	$_duplicateCount	Total number of duplicate (from database) lines	from CRM_Import_Parser
protected array	$_duplicates	Array of duplicate lines	from CRM_Import_Parser
protected int	$_warningCount	Running total number of warnings	from CRM_Import_Parser
protected int	$_maxWarningCount	Maximum number of warnings to store	from CRM_Import_Parser
protected array	$_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	$importableFieldsMetadata	Metadata for all available fields, keyed by unique name.	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		from CRM_Member_Import_Parser
protected int	$_fileSize	Imported file size	from CRM_Member_Import_Parser
protected string	$_seperator	Seperator being used	from CRM_Member_Import_Parser
protected int	$_lineCount	Total number of lines in file	from CRM_Member_Import_Parser
protected bool	$_haveColumnHeader	Whether the file has a column header or not	from CRM_Member_Import_Parser
protected	$_mapperKeys
protected array	$fieldMetadata	Array of metadata for all available fields.
protected array	$_newMemberships	Array of successfully imported membership id's

Methods

array

getImportableFieldsMetadata()

Get metadata for all importable fields in std getfields style format.

from CRM_Import_Parser

setImportableFieldsMetadata(array $importableFieldsMetadata)

Set metadata for all importable fields in std getfields style format.

from CRM_Import_Parser

__construct($mapperKeys)

Class constructor.

init()

The initializer code, called before the processing

mixed

fini()

The initializer code, called before the processing

mixed

mapField(array $values)

Handle the values in mapField mode.

mixed

preview(array $values)

Handle the values in preview mode.

mixed

summary($values)

Handle the values in summary mode.

mixed

import($onDuplicate, $values)

Handle the values in import mode.

int

setActiveFieldValues(array $elements, $erroneousField)

Set and validate field values.

from CRM_Import_Parser

array

getActiveFieldParams()

Format the field values for input to the api.

from CRM_Member_Import_Parser

NULL|$currTimestamp

progressImport($statusID, bool $startImport = TRUE, $startTimestamp = NULL, $prevTimestamp = NULL, $totalRowCount = NULL)

Add progress bar to the import process. Calculates time remaining, status etc.

from CRM_Import_Parser

array

getSelectValues()

No description

from CRM_Import_Parser

array

getSelectTypes()

No description

from CRM_Import_Parser

array

getHeaderPatterns()

No description

from CRM_Import_Parser

array

getDataPatterns()

No description

from CRM_Import_Parser

static void

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

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

from CRM_Import_Parser

void

setMaxLinesToProcess(int $max)

Setter function.

from CRM_Import_Parser

static string

errorFileName($type)

Determines the file extension based on error code.

from CRM_Import_Parser

static string

saveFileName($type)

Determines the file name based on error code.

from CRM_Import_Parser

array

checkContactDuplicate(array $formatValues)

Check if contact is a duplicate .

from CRM_Import_Parser

mixed

parsePseudoConstantField(string|int|null $submittedValue, array $fieldSpec)

Parse a field which could be represented by a label or name value rather than the DB value.

from CRM_Import_Parser

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, int $statusID = NULL, int $totalRowCount = NULL)

No description

from CRM_Member_Import_Parser

void

setActiveFields(array $fieldKeys)

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

from CRM_Member_Import_Parser

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

No description

from CRM_Member_Import_Parser

void

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

Store parser values.

from CRM_Member_Import_Parser

static void

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

Export data to a CSV file.

from CRM_Member_Import_Parser

array

getImportedMemberships()

Get the array of successfully imported membership id's

formattedDates(array $calcDates, $formatted)

to calculate join, start and end dates

array|error

membership_format_params(array $params, array $values, array|bool $create = FALSE) ^deprecated

No description

bool

isContactIDColumnPresent()

Is the contact ID mapped.

Details

in CRM_Import_Parser at line 155
`array getImportableFieldsMetadata()`

Get metadata for all importable fields in std getfields style format.

Return Value

array

in CRM_Import_Parser at line 163
`setImportableFieldsMetadata(array $importableFieldsMetadata)`

Set metadata for all importable fields in std getfields style format.

Parameters

array

$importableFieldsMetadata

at line 63
`__construct($mapperKeys)`

Class constructor.

Parameters

$mapperKeys

at line 73
`init()`

The initializer code, called before the processing

at line 583
`mixed fini()`

The initializer code, called before the processing

Return Value

mixed

at line 116
`mixed mapField(array $values)`

Handle the values in mapField mode.

Parameters

array

$values

Return Value

mixed

at line 129
`mixed preview(array $values)`

Handle the values in preview mode.

Parameters

array

$values

Return Value

mixed

at line 142
`mixed summary($values)`

Handle the values in summary mode.

Parameters

$values

Return Value

mixed

at line 271
`mixed import($onDuplicate, $values)`

Handle the values in import mode.

Parameters

	$onDuplicate
	$values

Return Value

mixed

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

Set and validate field values.

Parameters

array	$elements	array.
	$erroneousField	reference.

Return Value

int

in CRM_Member_Import_Parser at line 309
`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 343
`NULL|$currTimestamp progressImport($statusID, bool $startImport = TRUE, $startTimestamp = NULL, $prevTimestamp = NULL, $totalRowCount = NULL)`

Add progress bar to the import process. Calculates time remaining, status etc.

Parameters

	$statusID	status id of the import process saved in $config->uploadDir.
bool	$startImport	True when progress bar is to be initiated.
	$startTimestamp	Initial timstamp when the import was started.
	$prevTimestamp	Previous timestamp when this function was last called.
	$totalRowCount	Total number of rows in the import file.

Return Value

NULL|$currTimestamp

in CRM_Import_Parser at line 385
`array getSelectValues()`

Return Value

array

in CRM_Import_Parser at line 396
`array getSelectTypes()`

Return Value

array

in CRM_Import_Parser at line 409
`array getHeaderPatterns()`

Return Value

array

in CRM_Import_Parser at line 422
`array getDataPatterns()`

Return Value

array

in CRM_Import_Parser at line 438
`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 455
`void setMaxLinesToProcess(int $max)`

Setter function.

Parameters

int

$max

Return Value

void

in CRM_Import_Parser at line 465
`static string errorFileName($type)`

Determines the file extension based on error code.

Parameters

$type

Return Value

string

in CRM_Import_Parser at line 504
`static string saveFileName($type)`

Determines the file name based on error code.

Parameters

$type

Return Value

string

in CRM_Import_Parser at line 541
`protected array checkContactDuplicate(array $formatValues)`

Check if contact is a duplicate .

Parameters

array

$formatValues

Return Value

array

in CRM_Import_Parser at line 563
`protected mixed parsePseudoConstantField(string|int|null $submittedValue, array $fieldSpec)`

Parse a field which could be represented by a label or name value rather than the DB value.

We will try to match name first or (per https://lab.civicrm.org/dev/core/issues/1285 if we have an id.

but if not available then see if we have a label that can be converted to a name.

Parameters

string\|int\|null	$submittedValue
array	$fieldSpec	Metadata for the field

Return Value

mixed

in CRM_Member_Import_Parser at line 78
`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, int $statusID = NULL, int $totalRowCount = NULL)`

Parameters

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

Return Value

mixed

Exceptions

Exception

in CRM_Member_Import_Parser at line 291
`void 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

Return Value

void

in CRM_Member_Import_Parser at line 330
`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

in CRM_Member_Import_Parser at line 358
`void set(CRM_Core_Session $store, int $mode = self::MODE_SUMMARY)`

Store parser values.

Parameters

CRM_Core_Session	$store
int	$mode

Return Value

void

in CRM_Member_Import_Parser at line 414
`static void exportCSV(string $fileName, array $header, array $data)`

Export data to a CSV file.

Parameters

string	$fileName
array	$header
array	$data

Return Value

void

at line 574
`array getImportedMemberships()`

Get the array of successfully imported membership id's

Return Value

array

at line 595
`formattedDates(array $calcDates, $formatted)`

to calculate join, start and end dates

Parameters

array	$calcDates	Array of dates returned by getDatesForMembershipType().
	$formatted

at line 632
`array|error membership_format_params(array $params, array $values, array|bool $create = FALSE) ^deprecated`

^deprecated - this function formats params according to v2 standards but need to be sure about the impact of not calling it so retaining on the import class take the input parameter list as specified in the data model and convert it into the same format that we use in QF and BAO object

Parameters

array	$params	Associative array of property name/value. pairs to insert in new contact.
array	$values	The reformatted properties that we can use internally.
array\|bool	$create	Is the formatted Values array going to be used for CRM_Member_BAO_Membership:create()

Return Value

array|error

Exceptions

Exception

at line 747
`protected bool isContactIDColumnPresent()`

Is the contact ID mapped.

Return Value

bool

CRM_Member_Import_Parser_Membership

Constants

Properties

Methods

Details

in CRM_Import_Parser at line 155 array getImportableFieldsMetadata()

Return Value

in CRM_Import_Parser at line 163 setImportableFieldsMetadata(array $importableFieldsMetadata)

Parameters

at line 63 __construct($mapperKeys)

Parameters

at line 73 init()

at line 583 mixed fini()

Return Value

at line 116 mixed mapField(array $values)

Parameters

Return Value

at line 129 mixed preview(array $values)

Parameters

Return Value

at line 142 mixed summary($values)

Parameters

Return Value

at line 271 mixed import($onDuplicate, $values)

Parameters

Return Value

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

Parameters

Return Value

in CRM_Member_Import_Parser at line 309 array getActiveFieldParams()

Return Value

in CRM_Import_Parser at line 343 NULL|$currTimestamp progressImport($statusID, bool $startImport = TRUE, $startTimestamp = NULL, $prevTimestamp = NULL, $totalRowCount = NULL)

Parameters

Return Value

in CRM_Import_Parser at line 385 array getSelectValues()

Return Value

in CRM_Import_Parser at line 396 array getSelectTypes()

Return Value

in CRM_Import_Parser at line 409 array getHeaderPatterns()

Return Value

in CRM_Import_Parser at line 422 array getDataPatterns()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in CRM_Import_Parser at line 465 static string errorFileName($type)

Parameters

Return Value

in CRM_Import_Parser at line 504 static string saveFileName($type)

Parameters

Return Value

in CRM_Import_Parser at line 541 protected array checkContactDuplicate(array $formatValues)

Parameters

Return Value

in CRM_Import_Parser at line 563 protected mixed parsePseudoConstantField(string|int|null $submittedValue, array $fieldSpec)

Parameters

Return Value

in CRM_Member_Import_Parser at line 78 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, int $statusID = NULL, int $totalRowCount = NULL)

Parameters

Return Value

Exceptions

in CRM_Member_Import_Parser at line 291 void setActiveFields(array $fieldKeys)

Parameters

Return Value

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

Parameters

in CRM_Member_Import_Parser at line 358 void set(CRM_Core_Session $store, int $mode = self::MODE_SUMMARY)

Parameters

Return Value

in CRM_Member_Import_Parser at line 414 static void exportCSV(string $fileName, array $header, array $data)

Parameters

Return Value

at line 574 array getImportedMemberships()

Return Value

at line 595 formattedDates(array $calcDates, $formatted)

Parameters

at line 632 array|error membership_format_params(array $params, array $values, array|bool $create = FALSE) deprecated

in CRM_Import_Parser at line 155
`array getImportableFieldsMetadata()`

in CRM_Import_Parser at line 163
`setImportableFieldsMetadata(array $importableFieldsMetadata)`

at line 63
`__construct($mapperKeys)`

at line 73
`init()`

at line 583
`mixed fini()`

at line 116
`mixed mapField(array $values)`

at line 129
`mixed preview(array $values)`

at line 142
`mixed summary($values)`

at line 271
`mixed import($onDuplicate, $values)`

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

in CRM_Member_Import_Parser at line 309
`array getActiveFieldParams()`

in CRM_Import_Parser at line 343
`NULL|$currTimestamp progressImport($statusID, bool $startImport = TRUE, $startTimestamp = NULL, $prevTimestamp = NULL, $totalRowCount = NULL)`

in CRM_Import_Parser at line 385
`array getSelectValues()`

in CRM_Import_Parser at line 396
`array getSelectTypes()`

in CRM_Import_Parser at line 409
`array getHeaderPatterns()`

in CRM_Import_Parser at line 422
`array getDataPatterns()`

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

in CRM_Import_Parser at line 455
`void setMaxLinesToProcess(int $max)`

in CRM_Import_Parser at line 465
`static string errorFileName($type)`

in CRM_Import_Parser at line 504
`static string saveFileName($type)`

in CRM_Import_Parser at line 541
`protected array checkContactDuplicate(array $formatValues)`

in CRM_Import_Parser at line 563
`protected mixed parsePseudoConstantField(string|int|null $submittedValue, array $fieldSpec)`

in CRM_Member_Import_Parser at line 291
`void setActiveFields(array $fieldKeys)`

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

in CRM_Member_Import_Parser at line 358
`void set(CRM_Core_Session $store, int $mode = self::MODE_SUMMARY)`

in CRM_Member_Import_Parser at line 414
`static void exportCSV(string $fileName, array $header, array $data)`

at line 574
`array getImportedMemberships()`

at line 595
`formattedDates(array $calcDates, $formatted)`

at line 632
`array|error membership_format_params(array $params, array $values, array|bool $create = FALSE) ^deprecated`

at line 747
`protected bool isContactIDColumnPresent()`