/**
* Submit a set of fields against a profile.
*
* Note choice of submit versus create is discussed CRM-13234 & related to the fact
* 'profile' is being treated as a data-entry entity
*
* @param array $params
*
* @throws API_Exception
* @return array
* API result array
*/
function civicrm_api3_profile_submit($params)
{
$profileID = _civicrm_api3_profile_getProfileID($params['profile_id']);
if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_active')) {
//@todo declare pseudoconstant & let api do this
throw new API_Exception('Invalid value for profile_id');
}
$isContactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileType($profileID);
if (!empty($params['id']) && CRM_Core_BAO_UFField::checkProfileType($profileID) && !$isContactActivityProfile) {
throw new API_Exception('Update profiles including more than one entity not currently supported');
}
$contactParams = $activityParams = $missingParams = array();
$profileFields = civicrm_api3('Profile', 'getfields', array('action' => 'submit', 'profile_id' => $profileID));
$profileFields = $profileFields['values'];
if ($isContactActivityProfile) {
civicrm_api3_verify_mandatory($params, NULL, array('activity_id'));
$errors = CRM_Profile_Form::validateContactActivityProfile($params['activity_id'], $params['contact_id'], $profileID);
if (!empty($errors)) {
throw new API_Exception(array_pop($errors));
}
}
foreach ($profileFields as $fieldName => $field) {
if (!isset($params[$fieldName])) {
continue;
}
$value = $params[$fieldName];
if ($params[$fieldName] && isset($params[$fieldName . '_id'])) {
$value = $params[$fieldName . '_id'];
}
$contactEntities = array('contact', 'individual', 'organization', 'household');
$locationEntities = array('email', 'address', 'phone', 'website', 'im');
$entity = strtolower(CRM_Utils_Array::value('entity', $field));
if ($entity && !in_array($entity, array_merge($contactEntities, $locationEntities))) {
$contactParams['api.' . $entity . '.create'][$fieldName] = $value;
//@todo we are not currently declaring this option
if (isset($params['batch_id']) && strtolower($entity) == 'contribution') {
$contactParams['api.' . $entity . '.create']['batch_id'] = $params['batch_id'];
}
if (isset($params[$entity . '_id'])) {
//todo possibly declare $entity_id in getfields ?
$contactParams['api.' . $entity . '.create']['id'] = $params[$entity . '_id'];
}
} else {
$contactParams[_civicrm_api3_profile_translate_fieldnames_for_bao($fieldName)] = $value;
}
}
if (isset($contactParams['api.contribution.create']) && isset($contactParams['api.membership.create'])) {
$contactParams['api.membership_payment.create'] = array('contribution_id' => '$value.api.contribution.create.id', 'membership_id' => '$value.api.membership.create.id');
}
if (isset($contactParams['api.contribution.create']) && isset($contactParams['api.participant.create'])) {
$contactParams['api.participant_payment.create'] = array('contribution_id' => '$value.api.contribution.create.id', 'participant_id' => '$value.api.participant.create.id');
}
$contactParams['contact_id'] = CRM_Utils_Array::value('contact_id', $params);
$contactParams['profile_id'] = $profileID;
$contactParams['skip_custom'] = 1;
$contactProfileParams = civicrm_api3_profile_apply($contactParams);
// Contact profile fields
$profileParams = $contactProfileParams['values'];
// If profile having activity fields
if ($isContactActivityProfile && !empty($activityParams)) {
$activityParams['id'] = $params['activity_id'];
$profileParams['api.activity.create'] = $activityParams;
}
return civicrm_api3('contact', 'create', $profileParams);
}
/**
* Update Profile field values.
*
* @param array $params Associative array of property name/value
* pairs to update profile field values
*
* @return Updated Contact/ Activity object|CRM_Error
*
* @todo add example
* @todo add test cases
*
*/
function civicrm_api3_profile_set($params)
{
civicrm_api3_verify_mandatory($params, NULL, array('profile_id'));
if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $params['profile_id'], 'is_active')) {
return civicrm_api3_create_error('Invalid value for profile_id');
}
$isContactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileType($params['profile_id']);
if (CRM_Core_BAO_UFField::checkProfileType($params['profile_id']) && !$isContactActivityProfile) {
return civicrm_api3_create_error('Can not retrieve values for profiles include fields for more than one record type.');
}
$contactParams = $activityParams = $missingParams = array();
$profileFields = CRM_Core_BAO_UFGroup::getFields($params['profile_id'], FALSE, NULL, NULL, NULL, FALSE, NULL, TRUE, NULL, CRM_Core_Permission::EDIT);
if ($isContactActivityProfile) {
civicrm_api3_verify_mandatory($params, NULL, array('activity_id'));
require_once 'CRM/Profile/Form.php';
$errors = CRM_Profile_Form::validateContactActivityProfile($params['activity_id'], $params['contact_id'], $params['profile_id']);
if (!empty($errors)) {
return civicrm_api3_create_error(array_pop($errors));
}
}
foreach ($profileFields as $fieldName => $field) {
if (CRM_Utils_Array::value('is_required', $field)) {
if (!CRM_Utils_Array::value($fieldName, $params) || empty($params[$fieldName])) {
$missingParams[] = $fieldName;
}
}
if (!isset($params[$fieldName])) {
continue;
}
$value = $params[$fieldName];
if ($params[$fieldName] && isset($params[$fieldName . '_id'])) {
$value = $params[$fieldName . '_id'];
}
if ($isContactActivityProfile && CRM_Utils_Array::value('field_type', $field) == 'Activity') {
$activityParams[$fieldName] = $value;
} else {
$contactParams[$fieldName] = $value;
}
}
if (!empty($missingParams)) {
return civicrm_api3_create_error("Missing required parameters for profile id {$params['profile_id']}: " . implode(', ', $missingParams));
}
$contactParams['version'] = 3;
$contactParams['contact_id'] = CRM_Utils_Array::value('contact_id', $params);
$contactParams['profile_id'] = $params['profile_id'];
$contactParams['skip_custom'] = 1;
$contactProfileParams = civicrm_api3_profile_apply($contactParams);
if (CRM_Utils_Array::value('is_error', $contactProfileParams)) {
return $contactProfileParams;
}
// Contact profile fields
$profileParams = $contactProfileParams['values'];
// If profile having activity fields
if ($isContactActivityProfile && !empty($activityParams)) {
$activityParams['id'] = $params['activity_id'];
$profileParams['api.activity.create'] = $activityParams;
}
$groups = $tags = array();
if (isset($profileParams['group'])) {
$groups = $profileParams['group'];
unset($profileParams['group']);
}
if (isset($profileParams['tag'])) {
$tags = $profileParams['tag'];
unset($profileParams['tag']);
}
$result = civicrm_api('contact', 'create', $profileParams);
if (CRM_Utils_Array::value('is_error', $result)) {
return $result;
}
$ufGroupDetails = array();
$ufGroupParams = array('id' => $params['profile_id']);
CRM_Core_BAO_UFGroup::retrieve($ufGroupParams, $ufGroupDetails);
if (isset($profileFields['group'])) {
CRM_Contact_BAO_GroupContact::create($groups, $params['contact_id'], FALSE, 'Admin');
}
if (isset($profileFields['tag'])) {
require_once 'CRM/Core/BAO/EntityTag.php';
CRM_Core_BAO_EntityTag::create($tags, 'civicrm_contact', $params['contact_id']);
}
if (CRM_Utils_Array::value('add_to_group_id', $ufGroupDetails)) {
$contactIds = array($params['contact_id']);
CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $ufGroupDetails['add_to_group_id']);
}
return $result;
}
