+ // 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',
+ );
+
+ 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]);
+ }
+ if(!in_array($entityfield, $profileFields[$profileID][$fieldName]['api.aliases'])) {
+ // 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',
+ '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);
+ }