X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FProfile.php;h=d57751b1924dc5c67163cea2d982e38a916aa04f;hb=e2c0856b24630f71827582e867228d09db210d02;hp=dc3a71222e07ac56af27e4d31cc4736dc95df211;hpb=9c2e4fb9824d9913d19a7f7e24ada6093a409461;p=civicrm-core.git diff --git a/api/v3/Profile.php b/api/v3/Profile.php index dc3a71222e..d57751b192 100644 --- a/api/v3/Profile.php +++ b/api/v3/Profile.php @@ -36,29 +36,32 @@ * */ -/** - * 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 * but the correct behaviour is for it to return an id indexed array as this supports - * multiple instances + * multiple instances - if a single profile is passed in we will not return a normal api result array + * 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; - + if(!empty($params['check_permissions']) && !empty($params['contact_id']) && !1 === civicrm_api3('contact', 'getcount', array('contact_id' => $params['contact_id'], 'check_permissions' => 1))) { + throw new API_Exception('permission denied'); + } $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(); if (strtolower($profileID) == 'billing') { $values[$profileID] = _civicrm_api3_profile_getbillingpseudoprofile($params); @@ -70,10 +73,6 @@ function civicrm_api3_profile_get($params) { $isContactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileType($profileID); - if (CRM_Core_BAO_UFField::checkProfileType($profileID) && !$isContactActivityProfile) { - throw new API_Exception('Can not retrieve values for profiles include fields for more than one record type.'); - } - $profileFields = CRM_Core_BAO_UFGroup::getFields($profileID, FALSE, NULL, @@ -81,7 +80,7 @@ function civicrm_api3_profile_get($params) { NULL, FALSE, NULL, - TRUE, + empty($params['check_permissions']) ? FALSE : TRUE, NULL, CRM_Core_Permission::EDIT ); @@ -105,18 +104,29 @@ function civicrm_api3_profile_get($params) { } 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); } } - else { - CRM_Core_BAO_UFGroup::setProfileDefaults($params['contact_id'], $profileFields, $values[$profileID], TRUE); - } + elseif(!empty($params['contact_id'])) { + $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(); @@ -130,68 +140,49 @@ function civicrm_api3_profile_get($params) { function _civicrm_api3_profile_get_spec(&$params) { $params['profile_id']['api.required'] = TRUE; - // does this mean we use a different call to get a 'blank' profile? - $params['contact_id']['api.required'] = TRUE; + $params['contact_id']['description'] = 'If no contact is specified an array of defaults will be returned'; } + /** - * Update Profile field values. - * - * @param array $params Associative array of property name/value - * pairs to update profile field values + * 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 * - * @return Updated Contact/ Activity object|CRM_Error - * - * @todo add example - * @todo add test cases + * @param array $params * + * @throws API_Exception + * @return array API result array */ -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')) { +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($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)) { - return civicrm_api3_create_error(array_pop($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; } @@ -200,28 +191,44 @@ function civicrm_api3_profile_set($params) { 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']; @@ -246,7 +253,7 @@ function civicrm_api3_profile_set($params) { 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'])) { @@ -272,28 +279,77 @@ function civicrm_api3_profile_set($params) { } return $result; + } /** - * Provide formatted values for profile fields. + * 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 + * @param array $apirequest + */ +function _civicrm_api3_profile_submit_spec(&$params, $apirequest) { + if(isset($apirequest['params']['profile_id'])) { + // we will return what is required for this profile + // note the problem with simply over-riding getfields & then calling generic if needbe is we don't have the + // api request array to pass to it. + //@todo - it may make more sense just to pass the apiRequest to getfields + //@todo get_options should take an array - @ the moment it is only takes 'all' - which is supported + // by other getfields fn + // 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, 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; +} + +/** + * @deprecated - calling this function directly is deprecated as 'set' is not a clear action + * use submit + * Update Profile field values. * * @param array $params Associative array of property name/value + * pairs to update profile field values + * + * @return array Updated Contact/ Activity object|CRM_Error + * + * + */ +function civicrm_api3_profile_set($params) { + return civicrm_api3('profile', 'submit', $params); +} + +/** + * @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 * 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, @@ -315,42 +371,59 @@ function civicrm_api3_profile_apply($params) { ); 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); } -/** - * Return UFGroup fields - */ -function civicrm_api3_profile_getfields($params) { - $dao = _civicrm_api3_get_DAO('UFGroup'); - $d = new $dao(); - $fields = $d->fields(); - return civicrm_api3_create_success($fields); -} /** * This is a function to help us 'pretend' billing is a profile & treat it like it is one. * It gets standard credit card address fields etc * Note this is 'better' that the inbuilt version as it will pull in fallback values * billing location -> is_billing -> primary + * + * 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'); + + $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, + ); + 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.getoptions' => array('field' => 'location_type_id',), 'api.address.get.1' => array('location_type_id' => 'Billing', 'return' => $addressFields), // getting the is_billing required or not is an extra db call but probably cheap enough as this isn't an import api '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, 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, ','), ) ); - $locationTypeID = array_search('Billing', $result['api.address.getoptions']['values']); $values = array( 'billing_first_name' => $result['first_name'], @@ -383,5 +456,260 @@ function _civicrm_api3_profile_getbillingpseudoprofile(&$params) { else{ $values['billing-email'. '-' . $locationTypeID] = $result['email']; } + // return both variants of email to reflect inconsistencies in form layer + $values['email'. '-' . $locationTypeID] = $values['billing-email'. '-' . $locationTypeID]; + return $values; +} + +/** + * Here we will build up getfields type data for all the fields in the profile. Because the integration with the + * form layer in core is so hard-coded we are not going to attempt to re-use it + * However, as this function is unit-tested & hence 'locked in' we can aspire to extract sharable + * code out of the form-layer over time. + * + * The function deciphers which fields belongs to which entites & retrieves metadata about the entities + * Unfortunately we have inconsistencies such as 'contribution' uses contribution_status_id + * & participant has 'participant_status' so we have to standardise from the outside in here - + * find the oddities, 'mask them' at this layer, add tests & work to standardise over time so we can remove this handling + * + * @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, $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 $field) { + if(!$field['is_active']) { + continue; + } + list($entity, $fieldName) = _civicrm_api3_map_profile_fields_to_entity($field); + $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), + '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 + // + $hardCodedEntityFields = array( + 'state_province' => 'state_province_id', + 'country' => 'country_id', + 'participant_status' => 'status_id', + 'gender' => 'gender_id', + 'financial_type' => 'financial_type_id', + 'soft_credit' => 'soft_credit_to', + 'group' => 'group_id', + 'tag' => 'tag_id', + 'soft_credit_type' => 'soft_credit_type_id', + ); + + if(array_key_exists($ufFieldTaleFieldName, $hardCodedEntityFields)) { + $ufFieldTaleFieldName = $hardCodedEntityFields[$ufFieldTaleFieldName]; + } + + $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) { + $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][$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']; + } + */ + } + } + 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 = _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'; + } + else{ + $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'; + } + + // @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', + //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', + 'soft_credit_type' => 'contribution_soft', + 'group' => 'group_contact', + 'tag' => 'entity_tag', + ); + if(array_key_exists($fieldName, $hardCodedEntityMappings)) { + $entity = $hardCodedEntityMappings[$fieldName]; + } + return array($entity, $fieldName); +} + +/** + * @todo this should be handled by the api wrapper using getfields info - need to check + * 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)) { + $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) { + if(!empty($spec['api.aliases'])) { + foreach ($spec['api.aliases'] as $alias) { + $values[$alias] = $spec; + } + } + if(!empty($spec['uniqueName'])) { + $values[$spec['uniqueName']] = $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' => (int) 16); + } return $values; }