CRM_Utils_API_MatchOption

class CRM_Utils_API_MatchOption implements API_Wrapper

Class CRM_Utils_API_MatchOption

Methods

static CRM_Utils_API_MatchOption
singleton()

Singleton function.

array
fromApiInput(array $apiRequest)

No description

array
match(string $entity, array $createParams, array $keys, bool $isMandatory)

Attempt to match a contact. This filters/updates the $createParams if there is a match.

array
toApiOutput(array $apiRequest, array $result)

No description

array
createGetParams(array $origParams, array $keys)

Create APIv3 "get" parameters to lookup an existing record using $keys

Details

at line 72
static CRM_Utils_API_MatchOption singleton()

Singleton function.

Return Value

CRM_Utils_API_MatchOption

at line 82
array fromApiInput(array $apiRequest)

Parameters

array $apiRequest

Return Value

array modified $apiRequest

at line 149
array match(string $entity, array $createParams, array $keys, bool $isMandatory)

Attempt to match a contact. This filters/updates the $createParams if there is a match.

Parameters

string $entity
array $createParams
array $keys
bool $isMandatory

Return Value

array revised $createParams, including 'id' if known

Exceptions

API_Exception

at line 172
array toApiOutput(array $apiRequest, array $result)

Parameters

array $apiRequest
array $result

Return Value

array modified $result

at line 187
array createGetParams(array $origParams, array $keys)

Create APIv3 "get" parameters to lookup an existing record using $keys

Parameters

array $origParams Api request.
array $keys List of keys to match against.

Return Value

array APIv3 $params