CRM_Contact_Import_Field

class CRM_Contact_Import_Field

Class CRM_Contact_Import_Field

Properties

string $_name Name of the field
string $_title Title of the field to be used in display
enum $_type Type of field
bool $_required Is this field required
object $_payload Data to be carried for use by a derived class
string $_columnPattern Regexp to match the CSV header of this column/field
string $_dataPattern Regexp to match the pattern of data from various column/fields
string $_headerPattern Regexp to match the pattern of header from various column/fields
int $_hasLocationType Location type
string $_phoneType Does this field have a phone type
object $_value Value of this field
string $_related Does this field have a relationship info
string $_relatedContactType Does this field have a relationship Contact Type
string $_relatedContactDetails Does this field have a relationship Contact Details
int $_relatedContactLocType Does this field have a related Contact info of Location Type
string $_relatedContactPhoneType Does this field have a related Contact info of Phone Type

Methods

__construct(string $name, $title, int $type = CRM_Utils_Type::T_INT, string $columnPattern = '//', string $dataPattern = '//', null $hasLocationType = NULL, null $phoneType = NULL, null $related = NULL, null $relatedContactType = NULL, null $relatedContactDetails = NULL, null $relatedContactLocType = NULL, null $relatedContactPhoneType = NULL)

No description

resetValue()

No description

setValue(mixed $value)

The value is in string format.

bool
validate()

Validate something we didn't document.

Details

at line 148
__construct(string $name, $title, int $type = CRM_Utils_Type::T_INT, string $columnPattern = '//', string $dataPattern = '//', null $hasLocationType = NULL, null $phoneType = NULL, null $related = NULL, null $relatedContactType = NULL, null $relatedContactDetails = NULL, null $relatedContactLocType = NULL, null $relatedContactPhoneType = NULL)

Parameters

string $name
$title
int $type
string $columnPattern
string $dataPattern
null $hasLocationType
null $phoneType
null $related
null $relatedContactType
null $relatedContactDetails
null $relatedContactLocType
null $relatedContactPhoneType

at line 165
resetValue()

at line 177
setValue(mixed $value)

The value is in string format.

Convert the value to the type of this field and set the field value with the appropriate type

Parameters

mixed $value

at line 186
bool validate()

Validate something we didn't document.

Return Value

bool