*
*/
-/**
- * Include common API util functions
- */
-require_once 'api/v3/utils.php';
-
/**
* Retrieve Profile field values.
*
- * @param array $params Associative array of property name/value
+ * @param array $params Associative array of property name/value
* pairs to get profile field values
*
+ * @throws API_Exception
* @return Profile field values|CRM_Error
*
* NOTE this api is not standard & since it is tested we need to honour that
* in order to avoid breaking code. (This could still be confusing :-( but we have to keep the tested behaviour working
*
* Note that if contact_id is empty an array of defaults is returned
- *
*/
function civicrm_api3_profile_get($params) {
$nonStandardLegacyBehaviour = is_numeric($params['profile_id']) ? TRUE : FALSE;
}
$profiles = (array) $params['profile_id'];
$values = array();
+ $ufGroupBAO = new CRM_Core_BAO_UFGroup();
foreach ($profiles as $profileID) {
$profileID = _civicrm_api3_profile_getProfileID($profileID);
$values[$profileID] = array();
}
else {
$contactFields[$fieldName] = $field;
+ // we should return 'Primary' with & without capitalisation. it is more consistent with api to not
+ // capitalise, but for form support we need it for now. Hopefully we can move away from it
+ $contactFields[strtolower($fieldName)] = $field;
+ }
}
- }
- CRM_Core_BAO_UFGroup::setProfileDefaults($params['contact_id'], $contactFields, $values[$profileID], TRUE);
+ $ufGroupBAO->setProfileDefaults($params['contact_id'], $contactFields, $values[$profileID], TRUE);
if ($params['activity_id']) {
- CRM_Core_BAO_UFGroup::setComponentDefaults($activityFields, $params['activity_id'], 'Activity', $values[$profileID], TRUE);
+ $ufGroupBAO->setComponentDefaults($activityFields, $params['activity_id'], 'Activity', $values[$profileID], TRUE);
}
}
elseif(!empty($params['contact_id'])) {
- CRM_Core_BAO_UFGroup::setProfileDefaults($params['contact_id'], $profileFields, $values[$profileID], TRUE);
- }
- else{
- $values[$profileID] = array_fill_keys(array_keys($profileFields), '');
- }
+ $ufGroupBAO->setProfileDefaults($params['contact_id'], $profileFields, $values[$profileID], TRUE);
+ foreach ($values[$profileID] as $fieldName => $field){
+ // we should return 'Primary' with & without capitalisation. it is more consistent with api to not
+ // capitalise, but for form support we need it for now. Hopefully we can move away from it
+ $values[$profileID][strtolower($fieldName)] = $field;
+ }
+ }
+ else{
+ $values[$profileID] = array_fill_keys(array_keys($profileFields), '');
+ }
}
if($nonStandardLegacyBehaviour) {
$result = civicrm_api3_create_success();
* 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', $params['profile_id'], 'is_active')) {
+ 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($params['profile_id']);
+ $isContactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileType($profileID);
- if (CRM_Core_BAO_UFField::checkProfileType($params['profile_id']) && !$isContactActivityProfile) {
- throw new API_Exception('Can not retrieve values for profiles include fields for more than one record type.');
+ 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 = CRM_Core_BAO_UFGroup::getFields($params['profile_id'],
- FALSE,
- NULL,
- NULL,
- NULL,
- FALSE,
- NULL,
- TRUE,
- NULL,
- CRM_Core_Permission::EDIT
- );
-
+ $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'],
- $params['profile_id']
+ $profileID
);
if (!empty($errors)) {
throw new API_Exception(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;
}
if ($params[$fieldName] && isset($params[$fieldName . '_id'])) {
$value = $params[$fieldName . '_id'];
}
-
- if ($isContactActivityProfile && CRM_Utils_Array::value('field_type', $field) == 'Activity') {
- $activityParams[$fieldName] = $value;
+ $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[$fieldName] = $value;
+ $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 (!empty($missingParams)) {
- throw new API_Exception("Missing required parameters for profile id {$params['profile_id']}: " . implode(', ', $missingParams));
+ 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['version'] = 3;
$contactParams['contact_id'] = CRM_Utils_Array::value('contact_id', $params);
- $contactParams['profile_id'] = $params['profile_id'];
+ $contactParams['profile_id'] = $profileID;
$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'];
return civicrm_api3('contact', 'create', $profileParams);
$ufGroupDetails = array();
- $ufGroupParams = array('id' => $params['profile_id']);
+ $ufGroupParams = array('id' => $profileID);
CRM_Core_BAO_UFGroup::retrieve($ufGroupParams, $ufGroupDetails);
if (isset($profileFields['group'])) {
return $result;
}
+
+/**
+ * The api standards expect field names to be lower case but the BAO uses mixed case
+ * so we accept 'email-primary' but pass 'email-Primary' to the BAO
+ * we could make the BAO handle email-primary but this would alter the fieldname seen by hooks
+ * & we would need to consider that change
+ * @param string $fieldName API field name
+ *
+ * @return string BAO Field Name
+ */
+function _civicrm_api3_profile_translate_fieldnames_for_bao($fieldName){
+ $fieldName = str_replace('url', 'URL', $fieldName);
+ return str_replace('primary', 'Primary', $fieldName);
+}
/**
* metadata for submit action
* @param array $params
// we don't resolve state, country & county for performance reasons
$resolveOptions = CRM_Utils_Array::value('get_options',$apirequest['params']) == 'all' ? True : False;
$profileID = _civicrm_api3_profile_getProfileID($apirequest['params']['profile_id']);
- $params = _civicrm_api3_buildprofile_submitfields($profileID, $resolveOptions);
+ $params = _civicrm_api3_buildprofile_submitfields($profileID, $resolveOptions, CRM_Utils_Array::value('cache_clear', $params));
+ }
+ elseif (isset($apirequest['params']['cache_clear'])) {
+ _civicrm_api3_buildprofile_submitfields(FALSE, FALSE, True);
}
$params['profile_id']['api.required'] = TRUE;
}
* @param array $params Associative array of property name/value
* pairs to update profile field values
*
- * @return Updated Contact/ Activity object|CRM_Error
+ * @return array Updated Contact/ Activity object|CRM_Error
*
*
*/
* @deprecated - appears to be an internal function - should not be accessible via api
* Provide formatted values for profile fields.
*
- * @param array $params Associative array of property name/value
+ * @param array $params Associative array of property name/value
* pairs to profile field values
*
+ * @throws API_Exception
* @return formatted profile field values|CRM_Error
*
* @todo add example
* @todo add test cases
- *
*/
function civicrm_api3_profile_apply($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');
- }
-
$profileFields = CRM_Core_BAO_UFGroup::getFields($params['profile_id'],
FALSE,
NULL,
);
if (empty($data)) {
- return civicrm_api3_create_error('Enable to format profile parameters.');
+ throw new API_Exception('Enable to format profile parameters.');
}
return civicrm_api3_create_success($data);
*
* Note that that since the existing code for deriving a blank profile is not easily accessible our
* interim solution is just to return an empty array
+ *
+ * @param $params
+ *
+ * @return array
*/
function _civicrm_api3_profile_getbillingpseudoprofile(&$params) {
- $addressFields = array('street_address', 'city', 'state_province_id', 'country_id', 'postal_code');
+
$locations = civicrm_api3('address', 'getoptions', array('field' => 'location_type_id'));
$locationTypeID = array_search('Billing', $locations['values']);
if(empty($params['contact_id'])) {
+ $config = CRM_Core_Config::singleton();
$blanks = array(
'billing_first_name' => '',
'billing_middle_name' => '',
'billing_last_name' => '',
+ 'email-' . $locationTypeID => '',
+ 'billing_email-' . $locationTypeID => '',
+ 'billing_city-' . $locationTypeID => '',
+ 'billing_postal_code-' . $locationTypeID => '',
+ 'billing_street_address-' . $locationTypeID => '',
+ 'billing_country_id-' . $locationTypeID => $config->defaultContactCountry,
+ 'billing_state_province_id-' . $locationTypeID => $config->defaultContactStateProvince,
);
- foreach ($addressFields as $field) {
- $blanks['billing_' . $field . '_' . $locationTypeID] = '';
- }
return $blanks;
}
+
+ $addressFields = array('street_address', 'city', 'state_province_id', 'country_id', 'postal_code');
$result = civicrm_api3('contact', 'getsingle', array(
'id' => $params['contact_id'],
'api.address.get.1' => array('location_type_id' => 'Billing', 'return' => $addressFields),
'api.address.get.2' => array('is_billing' => True, 'return' => $addressFields),
'api.email.get.1' => array('location_type_id' => 'Billing',),
'api.email.get.2' => array('is_billing' => True,),
- 'return' => 'api.email.get, api.address.get, api.address.getoptions, state_province, email, first_name, last_name, middle_name, ' . implode($addressFields, ','),
+ 'return' => 'api.email.get, api.address.get, api.address.getoptions, country, state_province, email, first_name, last_name, middle_name, ' . implode($addressFields, ','),
)
);
*
* @param integer $profileID
* @param integer $optionsBehaviour 0 = don't resolve, 1 = resolve non-aggressively, 2 = resolve aggressively - ie include country & state
+ * @param $is_flush
+ *
+ * @internal param $params
+ *
+ * @return
*/
-function _civicrm_api3_buildprofile_submitfields($profileID, $optionsBehaviour = 1) {
+function _civicrm_api3_buildprofile_submitfields($profileID, $optionsBehaviour = 1, $is_flush) {
static $profileFields = array();
+ if($is_flush) {
+ $profileFields = array();
+ if(empty($profileID)) {
+ return;
+ }
+ }
if(isset($profileFields[$profileID])) {
return $profileFields[$profileID];
}
$fields = civicrm_api3('uf_field', 'get', array('uf_group_id' => $profileID));
$entities = array();
-
- foreach ($fields['values'] as $id => $field) {
+ foreach ($fields['values'] as $field) {
if(!$field['is_active']) {
continue;
}
list($entity, $fieldName) = _civicrm_api3_map_profile_fields_to_entity($field);
- $profileFields[$profileID][$fieldName] = array(
+ $aliasArray = array();
+ if(strtolower($fieldName) != $fieldName) {
+ $aliasArray['api.aliases'] = array($fieldName);
+ $fieldName = strtolower($fieldName);
+ }
+ $profileFields[$profileID][$fieldName] = array_merge(array(
'api.required' => $field['is_required'],
'title' => $field['label'],
'help_pre' => CRM_Utils_Array::value('help_pre', $field),
'help_post' => CRM_Utils_Array::value('help_post', $field),
- );
-
- $realFieldName = $field['field_name'];
+ 'entity' => $entity,
+ 'weight' => CRM_Utils_Array::value('weight', $field),
+ ), $aliasArray);
+
+ $ufFieldTaleFieldName = $field['field_name'];
+ if(isset($entity[$ufFieldTaleFieldName]['name'])) {
+ // in the case where we are dealing with an alias we map back to a name
+ // this will be tested by 'membership_type_id' field
+ $ufFieldTaleFieldName = $entity[$ufFieldTaleFieldName]['name'];
+ }
//see function notes
// as we build up a list of these we should be able to determine a generic approach
//
'soft_credit' => 'soft_credit_to',
'group' => 'group_id',
'tag' => 'tag_id',
+ 'soft_credit_type' => 'soft_credit_type_id',
);
- if(array_key_exists($realFieldName, $hardCodedEntityFields)) {
- $realFieldName = $hardCodedEntityFields[$realFieldName];
+ if(array_key_exists($ufFieldTaleFieldName, $hardCodedEntityFields)) {
+ $ufFieldTaleFieldName = $hardCodedEntityFields[$ufFieldTaleFieldName];
}
- $entities[$entity][$fieldName] = $realFieldName;
+ $entities[$entity][$fieldName] = $ufFieldTaleFieldName;
}
foreach ($entities as $entity => $entityFields) {
$result = civicrm_api3($entity, 'getfields', array('action' => 'create'));
$entityGetFieldsResult = _civicrm_api3_profile_appendaliases($result['values'], $entity);
foreach ($entityFields as $entityfield => $realName) {
- $profileFields[$profileID][$entityfield] = $entityGetFieldsResult[$realName];
+ $fieldName = strtolower($entityfield);
+ if(!strstr($fieldName, '-')) {
+ if(strtolower($realName) != $fieldName) {
+ // we want to keep the '-' pattern for locations but otherwise
+ // we are going to make the api-standard field the main / preferred name but support the db name
+ // in future naming the fields in the DB to reflect the way the rest of the api / BAO / metadata works would
+ // reduce code
+ $fieldName = strtolower($realName);
+ }
+ if(isset($entityGetFieldsResult[$realName]['uniqueName'])) {
+ // we won't alias the field name on here are we are using uniqueNames for the possibility of needing to differentiate
+ // which entity 'status_id' belongs to
+ $fieldName = $entityGetFieldsResult[$realName]['uniqueName'];
+ }
+ else{
+ if(isset($entityGetFieldsResult[$realName]['name'])) {
+ // this will sort out membership_type_id vs membership_type
+ $fieldName = $entityGetFieldsResult[$realName]['name'];
+ }
+ }
+ }
+ $profileFields[$profileID][$fieldName] = array_merge($entityGetFieldsResult[$realName], $profileFields[$profileID][$entityfield]);
+ if(!isset($profileFields[$profileID][$fieldName]['api.aliases'])) {
+ $profileFields[$profileID][$fieldName]['api.aliases'] = array();
+ }
if($optionsBehaviour && !empty($entityGetFieldsResult[$realName]['pseudoconstant'])) {
if($optionsBehaviour > 1 || !in_array($realName, array('state_province_id', 'county_id', 'country_id'))) {
$options = civicrm_api3($entity, 'getoptions', array('field' => $realName));
- $profileFields[$profileID][$entityfield]['options'] = $options['values'];
+ $profileFields[$profileID][$fieldName]['options'] = $options['values'];
+ }
+ }
+
+ if($entityfield != $fieldName) {
+ if(isset($profileFields[$profileID][$entityfield])) {
+ unset($profileFields[$profileID][$entityfield]);
}
+ // we will make the mixed case version (e.g. of 'Primary') an alias
+ $profileFields[$profileID][$fieldName]['api.aliases'][] = $entityfield;
}
/**
* putting this on hold -this would cause the api to set the default - but could have unexpected behaviour
if(isset($result['values'][$realName]['default_value'])) {
- //this would be the case for a custom field with a configured default
- $profileFields[$profileID][$entityfield]['api.default'] = $result['values'][$realName]['default_value'];
+ //this would be the case for a custom field with a configured default
+ $profileFields[$profileID][$entityfield]['api.default'] = $result['values'][$realName]['default_value'];
}
- */
+ */
}
}
+ uasort($profileFields[$profileID], "_civicrm_api3_order_by_weight");
return $profileFields[$profileID];
}
+function _civicrm_api3_order_by_weight($a, $b) {
+ return CRM_Utils_Array::value('weight', $b) < CRM_Utils_Array::value('weight', $a) ? TRUE : FALSE;
+}
+
/**
* Here we map the profile fields as stored in the uf_field table to their 'real entity'
* we also return the profile fieldname
*
+ * @param $field
+ *
+ * @return array
*/
function _civicrm_api3_map_profile_fields_to_entity(&$field) {
$entity = $field['field_type'];
$contactTypes = civicrm_api3('contact', 'getoptions', array('field' => 'contact_type'));
if(in_array($entity, $contactTypes['values'])) {
- $entity = 'Contact';
+ $entity = 'contact';
}
+ $entity = _civicrm_api_get_entity_name_from_camel($entity);
+ $locationFields = array('email' => 'email');
$fieldName = $field['field_name'];
if(!empty($field['location_type_id'])) {
if($fieldName == 'email') {
- $entity = 'Email';
+ $entity = 'email';
}
else{
- $entity = 'Address';
+ $entity = 'address';
}
$fieldName .= '-' . $field['location_type_id'];
}
+ elseif(array_key_exists($fieldName, $locationFields)) {
+ $fieldName .= '-Primary';
+ $entity = 'email';
+ }
if(!empty($field['phone_type_id'])) {
$fieldName .= '-' . $field['location_type_id'];
- $entity = 'Phone';
+ $entity = 'phone';
}
+
// @todo - sort this out!
//here we do a hard-code list of known fields that don't map to where they are mapped to
// not a great solution but probably if we looked in the BAO we'd find a scary switch statement
// in a perfect world the uf_field table would hold the correct entity for each item
// & only the relationships between entities would need to be coded
$hardCodedEntityMappings = array(
- 'street_address' => 'Address',
- 'street_number' => 'Address',
- 'supplemental_address_1' => 'Address',
- 'supplemental_address_2' => 'Address',
- 'supplemental_address_3' => 'Address',
- 'postal_code' => 'Address',
- 'city' => 'Address',
- 'email' => 'Email',
- 'state_province' => 'Address',
- 'country' => 'Address',
- 'county' => 'Address',
+ 'street_address' => 'address',
+ 'street_number' => 'address',
+ 'supplemental_address_1' => 'address',
+ 'supplemental_address_2' => 'address',
+ 'supplemental_address_3' => 'address',
+ 'postal_code' => 'address',
+ 'city' => 'address',
+ 'email' => 'email',
+ 'state_province' => 'address',
+ 'country' => 'address',
+ 'county' => 'address',
//note that in discussions about how to restructure the api we discussed making these membership
// fields into 'membership_payment' fields - which would entail declaring them in getfields
// & renaming them in existing profiles
- 'financial_type' => 'Contribution',
- 'total_amount' => 'Contribution',
- 'receive_date' => 'Contribution',
- 'payment_instrument' => 'Contribution',
- 'check_number' => 'Contribution',
- 'contribution_status_id' => 'Contribution',
- 'soft_credit' => 'Contribution',
- 'group' => 'GroupContact',
- 'tag' => 'EntityTag',
+ 'financial_type' => 'contribution',
+ 'total_amount' => 'contribution',
+ 'receive_date' => 'contribution',
+ 'payment_instrument' => 'contribution',
+ 'check_number' => 'contribution',
+ 'contribution_status_id' => 'contribution',
+ 'soft_credit' => 'contribution',
+ 'soft_credit_type' => 'contribution_soft',
+ 'group' => 'group_contact',
+ 'tag' => 'entity_tag',
);
if(array_key_exists($fieldName, $hardCodedEntityMappings)) {
$entity = $hardCodedEntityMappings[$fieldName];
* how we add a a pseudoconstant to this pseudoapi to make that work
*/
function _civicrm_api3_profile_getProfileID($profileID) {
- if(!empty($profileID) && !strtolower($profileID) == 'billing' && !is_numeric($profileID)) {
+ if(!empty($profileID) && strtolower($profileID) != 'billing' && !is_numeric($profileID)) {
$profileID = civicrm_api3('uf_group', 'getvalue', array('return' => 'id', 'name' => $profileID));
}
return $profileID;
/**
* helper function to add all aliases as keys to getfields response so we can look for keys within it
* since the relationship between profile fields & api / metadata based fields is a bit inconsistent
+ *
* @param array $values
*
* e.g getfields response incl 'membership_type_id' - with api.aliases = 'membership_type'
* returned array will include both as keys (with the same values)
+ * @param $entity
+ *
+ * @return array
*/
function _civicrm_api3_profile_appendaliases($values, $entity) {
foreach ($values as $field => $spec) {
}
}
//special case on membership & contribution - can't see how to handle in a generic way
- if(in_array($entity, array('Membership', 'Contribution'))) {
- $values['send_receipt'] = array('title' => 'Send Receipt', 'type' => 16);
+ if(in_array($entity, array('membership', 'contribution'))) {
+ $values['send_receipt'] = array('title' => 'Send Receipt', 'type' => (int) 16);
}
return $values;
-}
\ No newline at end of file
+}
projects / civicrm-core.git / blobdiff