Documentation

CRM_Utils_Migrate_ExportJSON
in package

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

Table of Contents

Constants

CHUNK_SIZE  = 128

Properties

$_allContactIDs  : mixed
$_contactIDs  : mixed
$_discoverContacts  : mixed
$_renameGroups  : mixed
$_renameTags  : mixed
$_sitePrefix  : mixed
$_values  : mixed

Methods

__construct()  : mixed
activity()  : mixed
addAdditionalContacts()  : mixed
address()  : mixed
appendValue()  : mixed
auxTable()  : mixed
contact()  : mixed
dbFields()  : array<string|int, mixed>
email()  : mixed
entityTag()  : mixed
export()  : mixed
getValues()  : mixed
Given a set of contact IDs get the values.
group()  : mixed
groupContact()  : mixed
im()  : mixed
metaData()  : mixed
note()  : mixed
optionGroup()  : mixed
phone()  : mixed
relationship()  : mixed
run()  : mixed
savedSearch()  : mixed
splitContactIDs()  : array<string|int, mixed>
Split a large array of contactIDs into more manageable smaller chunks.
sql()  : mixed
table()  : mixed
tag()  : mixed
website()  : mixed

Constants

Properties

$_discoverContacts

protected mixed $_discoverContacts = \FALSE

$_renameGroups

protected mixed $_renameGroups = 1

$_sitePrefix

protected mixed $_sitePrefix = 'Site 1'

Methods

__construct()

public __construct(array<string|int, mixed> &$params) : mixed
Parameters
$params : array<string|int, mixed>

activity()

public activity(array<string|int, mixed> &$contactIDs, mixed &$additionalContacts) : mixed
Parameters
$contactIDs : array<string|int, mixed>
$additionalContacts : mixed

addAdditionalContacts()

public addAdditionalContacts(array<string|int, mixed> $contactIDs, array<string|int, mixed> &$additionalContacts) : mixed
Parameters
$contactIDs : array<string|int, mixed>
$additionalContacts : array<string|int, mixed>

address()

public address(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

appendValue()

public appendValue(int $id, string $name, array<string|int, mixed> $value) : mixed
Parameters
$id : int
$name : string
$value : array<string|int, mixed>

auxTable()

public auxTable(array<string|int, mixed> $tables) : mixed
Parameters
$tables : array<string|int, mixed>

contact()

public contact(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

dbFields()

public dbFields(string $daoName[, bool $onlyKeys = FALSE ]) : array<string|int, mixed>
Parameters
$daoName : string
$onlyKeys : bool = FALSE
Return values
array<string|int, mixed>

email()

public email(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

entityTag()

public entityTag(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

export()

public export(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

getValues()

Given a set of contact IDs get the values.

public getValues(array<string|int, mixed> &$contactIDs, array<string|int, mixed> &$additionalContactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>
$additionalContactIDs : array<string|int, mixed>

group()

public group(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>
Tags
todo

support group inheritance

Parent child group ids are encoded in a text string

groupContact()

public groupContact(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

im()

public im(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

note()

public note(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

optionGroup()

public optionGroup(array<string|int, mixed> $optionGroupVars) : mixed
Parameters
$optionGroupVars : array<string|int, mixed>

phone()

public phone(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

relationship()

public relationship(array<string|int, mixed> &$contactIDs, mixed &$additionalContacts) : mixed
Parameters
$contactIDs : array<string|int, mixed>
$additionalContacts : mixed

run()

public run(string $fileName[, string $lastExportTime = NULL ][, bool $discoverContacts = FALSE ]) : mixed
Parameters
$fileName : string
$lastExportTime : string = NULL
$discoverContacts : bool = FALSE

savedSearch()

public savedSearch(array<string|int, mixed> &$groupIDs) : mixed
Parameters
$groupIDs : array<string|int, mixed>
Tags
todo

support search builder and custom saved searches

splitContactIDs()

Split a large array of contactIDs into more manageable smaller chunks.

public & splitContactIDs(array<string|int, mixed> &$contactIDs) : array<string|int, mixed>
Parameters
$contactIDs : array<string|int, mixed>
Return values
array<string|int, mixed>

sql()

public sql(string $sql, string $tableName, array<string|int, mixed> &$fields) : mixed
Parameters
$sql : string
$tableName : string
$fields : array<string|int, mixed>

table()

public table(array<string|int, mixed> &$ids, string $tableName, array<string|int, mixed> &$fields, string $whereField[, string|null $additionalWhereCond = NULL ]) : mixed
Parameters
$ids : array<string|int, mixed>
$tableName : string
$fields : array<string|int, mixed>
$whereField : string
$additionalWhereCond : string|null = NULL

tag()

public tag(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed>

website()

public website(array<string|int, mixed> &$contactIDs) : mixed
Parameters
$contactIDs : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results