CRM_Import_Parser
class 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 |
Properties
protected | $_totalCount | Total number of non empty lines | |
protected | $_validCount | Running total number of valid lines | |
protected | $_invalidRowCount | Running total number of invalid rows | |
protected int | $_maxLinesToProcess | Maximum number of non-empty/comment lines to process | |
protected | $_maxErrorCount | Maximum number of invalid rows to store | |
protected | $_errors | Array of error lines, bounded by MAX_ERROR | |
protected | $_conflictCount | Total number of conflict lines | |
protected | $_conflicts | Array of conflict lines | |
protected | $_duplicateCount | Total number of duplicate (from database) lines | |
protected | $_duplicates | Array of duplicate lines | |
protected | $_warningCount | Running total number of warnings | |
protected | $_maxWarningCount | Maximum number of warnings to store | |
protected | $_warnings | Array of warning lines, bounded by MAX_WARNING | |
protected array | $_fields | Array of all the fields that could potentially be part of this import process | |
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 | |
protected int | $_activeFieldCount | Cache the count of active fields | |
protected array | $_rows | Cache of preview rows | |
protected string | $_errorFileName | Filename of error data | |
protected string | $_conflictFileName | Filename of conflict data | |
protected string | $_duplicateFileName | Filename of duplicate data | |
int | $_contactType | Contact type | |
int | $_contactSubType | Contact sub-type |
Methods
Class constructor.
Abstract function definitions.
No description
Map field.
Preview.
No description
No description
Set and validate field values.
Format the field values for input to the api.
No description
No description
No description
No description
Remove single-quote enclosures from a value array (row).
Setter function.
Determines the file extension based on error code.
Determines the file name based on error code.
Details
at line 193
__construct()
Class constructor.
at line 201
abstract protected
init()
Abstract function definitions.
at line 206
abstract protected mixed
fini()
at line 215
abstract protected mixed
mapField(array $values)
Map field.
at line 224
abstract protected mixed
preview(array $values)
Preview.
at line 231
abstract protected mixed
summary($values)
at line 239
abstract protected mixed
import($onDuplicate, $values)
at line 251
int
setActiveFieldValues(array $elements, $erroneousField)
Set and validate field values.
at line 281
array
getActiveFieldParams()
Format the field values for input to the api.
at line 298
array
getSelectValues()
at line 309
array
getSelectTypes()
at line 322
array
getHeaderPatterns()
at line 335
array
getDataPatterns()
at line 351
static void
encloseScrub(array $values, string $enclosure = "'")
Remove single-quote enclosures from a value array (row).
at line 368
void
setMaxLinesToProcess(int $max)
Setter function.
at line 378
static string
errorFileName($type)
Determines the file extension based on error code.
at line 417
static string
saveFileName($type)
Determines the file name based on error code.