CRM_Custom_Import_Parser_Api
extends CRM_Import_Parser
in package
Class CRM_Custom_Import_Parser_Api
Table of Contents
Methods
- getRequiredFields() : array<string|int, mixed>
- Get the required fields.
- getUserJobInfo() : array<string|int, mixed>
- Get information about the provided job.
- import() : void
- Main import function.
- setFieldMetadata() : void
- Set the import metadata.
- getCustomGroupID() : int
- getGroupFieldsForImport() : array<string|int, mixed>
- Return the field ids and names (with groups) for import purpose.
Methods
getRequiredFields()
Get the required fields.
public
getRequiredFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getUserJobInfo()
Get information about the provided job.
public
static getUserJobInfo() : array<string|int, mixed>
- name
- id (generally the same as name)
- label
Return values
array<string|int, mixed>import()
Main import function.
public
import(array<string|int, mixed> $values) : void
Parameters
- $values : array<string|int, mixed>
-
The array of values belonging to this line.
setFieldMetadata()
Set the import metadata.
public
setFieldMetadata() : void
getCustomGroupID()
private
getCustomGroupID() : int
Return values
intgetGroupFieldsForImport()
Return the field ids and names (with groups) for import purpose.
private
getGroupFieldsForImport(int $customGroupID) : array<string|int, mixed>
Parameters
- $customGroupID : int
-
Custom group ID.