api/v3/Profile.php

   1 <?php
   2
   3 /*
   4   +--------------------------------------------------------------------+
   5   | CiviCRM version 4.6                                                |
   6   +--------------------------------------------------------------------+
   7   | Copyright CiviCRM LLC (c) 2004-2014                                |
   8   +--------------------------------------------------------------------+
   9   | This file is a part of CiviCRM.                                    |
  10   |                                                                    |
  11   | CiviCRM is free software; you can copy, modify, and distribute it  |
  12   | under the terms of the GNU Affero General Public License           |
  13   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14   |                                                                    |
  15   | CiviCRM is distributed in the hope that it will be useful, but     |
  16   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18   | See the GNU Affero General Public License for more details.        |
  19   |                                                                    |
  20   | You should have received a copy of the GNU Affero General Public   |
  21   | License and the CiviCRM Licensing Exception along                  |
  22   | with this program; if not, contact CiviCRM LLC                     |
  23   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24   | GNU Affero General Public License or the licensing of CiviCRM,     |
  25   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26   +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * File for the CiviCRM APIv3 activity profile functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_ActivityProfile
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: ActivityProfile.php 30486 2011-05-20 16:12:09Z rajan $
  36  *
  37  */
  38
  39 /**
  40  * Retrieve Profile field values.
  41  *
  42  * @param array $params       Associative array of property name/value
  43  *                             pairs to get profile field values
  44  *
  45  * @throws API_Exception
  46  * @return Profile field values|CRM_Error
  47  *
  48  * NOTE this api is not standard & since it is tested we need to honour that
  49  * but the correct behaviour is for it to return an id indexed array as this supports
  50  * multiple instances - if a  single profile is passed in we will not return a normal api result array
  51  * in order to avoid breaking code. (This could still be confusing :-( but we have to keep the tested behaviour working
  52  *
  53  * Note that if contact_id is empty an array of defaults is returned
  54  */
  55 function civicrm_api3_profile_get($params) {
  56   $nonStandardLegacyBehaviour = is_numeric($params['profile_id']) ?  TRUE : FALSE;
  57   if(!empty($params['check_permissions']) && !empty($params['contact_id']) && !1 === civicrm_api3('contact', 'getcount', array('contact_id' => $params['contact_id'], 'check_permissions' => 1))) {
  58     throw new API_Exception('permission denied');
  59   }
  60   $profiles = (array) $params['profile_id'];
  61   $values = array();
  62   $ufGroupBAO = new CRM_Core_BAO_UFGroup();
  63   foreach ($profiles as $profileID) {
  64     $profileID = _civicrm_api3_profile_getProfileID($profileID);
  65     $values[$profileID] = array();
  66     if (strtolower($profileID) == 'billing') {
  67       $values[$profileID] = _civicrm_api3_profile_getbillingpseudoprofile($params);
  68       continue;
  69     }
  70     if(!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_active')) {
  71       throw new API_Exception('Invalid value for profile_id : ' . $profileID);
  72     }
  73
  74     $isContactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileType($profileID);
  75
  76     $profileFields = CRM_Core_BAO_UFGroup::getFields($profileID,
  77       FALSE,
  78       NULL,
  79       NULL,
  80       NULL,
  81       FALSE,
  82       NULL,
  83       empty($params['check_permissions']) ? FALSE : TRUE,
  84       NULL,
  85       CRM_Core_Permission::EDIT
  86     );
  87
  88
  89   if ($isContactActivityProfile) {
  90     civicrm_api3_verify_mandatory($params, NULL, array('activity_id'));
  91
  92     $errors = CRM_Profile_Form::validateContactActivityProfile($params['activity_id'],
  93       $params['contact_id'],
  94       $params['profile_id']
  95     );
  96     if (!empty($errors)) {
  97       throw new API_Exception(array_pop($errors));
  98     }
  99
 100     $contactFields = $activityFields = array();
 101     foreach ($profileFields as $fieldName => $field) {
 102       if (CRM_Utils_Array::value('field_type', $field) == 'Activity') {
 103         $activityFields[$fieldName] = $field;
 104       }
 105       else {
 106         $contactFields[$fieldName] = $field;
 107           // we should return 'Primary' with & without capitalisation. it is more consistent with api to not
 108           // capitalise, but for form support we need it for now. Hopefully we can move away from it
 109           $contactFields[strtolower($fieldName)] = $field;
 110         }
 111       }
 112
 113     $ufGroupBAO->setProfileDefaults($params['contact_id'], $contactFields, $values[$profileID], TRUE);
 114
 115     if ($params['activity_id']) {
 116       $ufGroupBAO->setComponentDefaults($activityFields, $params['activity_id'], 'Activity', $values[$profileID], TRUE);
 117     }
 118   }
 119   elseif(!empty($params['contact_id'])) {
 120     $ufGroupBAO->setProfileDefaults($params['contact_id'], $profileFields, $values[$profileID], TRUE);
 121       foreach ($values[$profileID] as $fieldName => $field){
 122         // we should return 'Primary' with & without capitalisation. it is more consistent with api to not
 123         // capitalise, but for form support we need it for now. Hopefully we can move away from it
 124         $values[$profileID][strtolower($fieldName)] = $field;
 125       }
 126     }
 127     else{
 128       $values[$profileID] = array_fill_keys(array_keys($profileFields), '');
 129     }
 130   }
 131   if($nonStandardLegacyBehaviour) {
 132     $result = civicrm_api3_create_success();
 133     $result['values'] = $values[$profileID];
 134     return $result;
 135   }
 136   else {
 137     return civicrm_api3_create_success($values, $params, 'Profile', 'Get');
 138   }
 139 }
 140
 141 /**
 142  * @param array $params
 143  */
 144 function _civicrm_api3_profile_get_spec(&$params) {
 145   $params['profile_id']['api.required'] = TRUE;
 146   $params['profile_id']['title'] = 'Profile ID';
 147   $params['contact_id']['description'] = 'If no contact is specified an array of defaults will be returned';
 148   $params['contact_id']['title'] = 'Contact ID';
 149 }
 150
 151 /**
 152  * Submit a set of fields against a profile.
 153  * Note choice of submit versus create is discussed CRM-13234 & related to the fact
 154  * 'profile' is being treated as a data-entry entity
 155  *
 156  * @param array $params
 157  *
 158  * @throws API_Exception
 159  * @return array API result array
 160  */
 161 function civicrm_api3_profile_submit($params) {
 162   $profileID = _civicrm_api3_profile_getProfileID($params['profile_id']);
 163   if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_active')) {
 164     //@todo declare pseudoconstant & let api do this
 165     throw new API_Exception('Invalid value for profile_id');
 166   }
 167
 168   $isContactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileType($profileID);
 169
 170   if (!empty($params['id']) && CRM_Core_BAO_UFField::checkProfileType($profileID) && !$isContactActivityProfile) {
 171     throw new API_Exception('Update profiles including more than one entity not currently supported');
 172   }
 173
 174   $contactParams = $activityParams = $missingParams = array();
 175
 176   $profileFields = civicrm_api3('profile', 'getfields', array('action' => 'submit', 'profile_id' => $profileID));
 177   $profileFields = $profileFields['values'];
 178   if ($isContactActivityProfile) {
 179     civicrm_api3_verify_mandatory($params, NULL, array('activity_id'));
 180
 181     $errors = CRM_Profile_Form::validateContactActivityProfile($params['activity_id'],
 182       $params['contact_id'],
 183       $profileID
 184     );
 185     if (!empty($errors)) {
 186       throw new API_Exception(array_pop($errors));
 187     }
 188   }
 189
 190   foreach ($profileFields as $fieldName => $field) {
 191     if (!isset($params[$fieldName])) {
 192       continue;
 193     }
 194
 195     $value = $params[$fieldName];
 196     if ($params[$fieldName] && isset($params[$fieldName . '_id'])) {
 197       $value = $params[$fieldName . '_id'];
 198     }
 199     $contactEntities = array('contact', 'individual', 'organization', 'household');
 200     $locationEntities = array('email', 'address', 'phone', 'website', 'im');
 201
 202     $entity = strtolower(CRM_Utils_Array::value('entity', $field));
 203     if($entity && !in_array($entity, array_merge($contactEntities, $locationEntities))) {
 204       $contactParams['api.' . $entity . '.create'][$fieldName] = $value;
 205       //@todo we are not currently declaring this option
 206       if(isset($params['batch_id']) && strtolower($entity) == 'contribution') {
 207         $contactParams['api.' . $entity . '.create']['batch_id'] = $params['batch_id'];
 208       }
 209       if(isset($params[$entity . '_id'])) {
 210         //todo possibly declare $entity_id in getfields ?
 211         $contactParams['api.' . $entity . '.create']['id'] = $params[$entity . '_id'];
 212       }
 213     }
 214     else {
 215       $contactParams[_civicrm_api3_profile_translate_fieldnames_for_bao($fieldName)] = $value;
 216     }
 217   }
 218   if(isset($contactParams['api.contribution.create']) && isset($contactParams['api.membership.create'])) {
 219     $contactParams['api.membership_payment.create'] = array(
 220       'contribution_id' => '$value.api.contribution.create.id',
 221       'membership_id' => '$value.api.membership.create.id'
 222     );
 223   }
 224
 225   if(isset($contactParams['api.contribution.create']) && isset($contactParams['api.participant.create'])) {
 226     $contactParams['api.participant_payment.create'] = array(
 227       'contribution_id' => '$value.api.contribution.create.id',
 228       'participant_id' => '$value.api.participant.create.id'
 229     );
 230   }
 231
 232   $contactParams['contact_id'] = CRM_Utils_Array::value('contact_id', $params);
 233   $contactParams['profile_id'] = $profileID;
 234   $contactParams['skip_custom'] = 1;
 235
 236   $contactProfileParams = civicrm_api3_profile_apply($contactParams);
 237
 238   // Contact profile fields
 239   $profileParams = $contactProfileParams['values'];
 240
 241   // If profile having activity fields
 242   if ($isContactActivityProfile && !empty($activityParams)) {
 243     $activityParams['id'] = $params['activity_id'];
 244     $profileParams['api.activity.create'] = $activityParams;
 245   }
 246
 247   $groups = $tags = array();
 248   if (isset($profileParams['group'])) {
 249     $groups = $profileParams['group'];
 250     unset($profileParams['group']);
 251   }
 252
 253   if (isset($profileParams['tag'])) {
 254     $tags = $profileParams['tag'];
 255     unset($profileParams['tag']);
 256   }
 257
 258   return civicrm_api3('contact', 'create', $profileParams);
 259
 260   $ufGroupDetails = array();
 261   $ufGroupParams = array('id' => $profileID);
 262   CRM_Core_BAO_UFGroup::retrieve($ufGroupParams, $ufGroupDetails);
 263
 264   if (isset($profileFields['group'])) {
 265     CRM_Contact_BAO_GroupContact::create($groups,
 266       $params['contact_id'],
 267       FALSE,
 268       'Admin'
 269     );
 270   }
 271
 272   if (isset($profileFields['tag'])) {
 273     CRM_Core_BAO_EntityTag::create($tags,
 274       'civicrm_contact',
 275       $params['contact_id']
 276     );
 277   }
 278
 279   if (!empty($ufGroupDetails['add_to_group_id'])) {
 280     $contactIds = array($params['contact_id']);
 281     CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds,
 282       $ufGroupDetails['add_to_group_id']
 283     );
 284   }
 285
 286   return $result;
 287
 288 }
 289
 290 /**
 291  * The api standards expect field names to be lower case but the BAO uses mixed case
 292  * so we accept 'email-primary' but pass 'email-Primary' to the BAO
 293  * we could make the BAO handle email-primary but this would alter the fieldname seen by hooks
 294  * & we would need to consider that change
 295  * @param string $fieldName API field name
 296  *
 297  * @return string BAO Field Name
 298  */
 299 function _civicrm_api3_profile_translate_fieldnames_for_bao($fieldName){
 300   $fieldName = str_replace('url', 'URL', $fieldName);
 301   return str_replace('primary', 'Primary', $fieldName);
 302 }
 303 /**
 304  * metadata for submit action
 305  * @param array $params
 306  * @param array $apirequest
 307  */
 308 function _civicrm_api3_profile_submit_spec(&$params, $apirequest) {
 309   if(isset($apirequest['params']['profile_id'])) {
 310     // we will return what is required for this profile
 311     // note the problem with simply over-riding getfields & then calling generic if needbe is we don't have the
 312     // api request array to pass to it.
 313     //@todo - it may make more sense just to pass the apiRequest to getfields
 314     //@todo get_options should take an array - @ the moment it is only takes 'all' - which is supported
 315     // by other getfields fn
 316     // we don't resolve state, country & county for performance reasons
 317     $resolveOptions = CRM_Utils_Array::value('get_options',$apirequest['params']) == 'all' ? True : False;
 318     $profileID = _civicrm_api3_profile_getProfileID($apirequest['params']['profile_id']);
 319     $params = _civicrm_api3_buildprofile_submitfields($profileID, $resolveOptions, CRM_Utils_Array::value('cache_clear', $params));
 320   }
 321   elseif (isset($apirequest['params']['cache_clear'])) {
 322     _civicrm_api3_buildprofile_submitfields(FALSE, FALSE, True);
 323   }
 324   $params['profile_id']['api.required'] = TRUE;
 325   $params['profile_id']['title'] = 'Profile ID';
 326 }
 327
 328 /**
 329  * @deprecated - calling this function directly is deprecated as 'set' is not a clear action
 330  * use submit
 331  * Update Profile field values.
 332  *
 333  * @param array  $params       Associative array of property name/value
 334  *                             pairs to update profile field values
 335  *
 336  * @return array Updated Contact/ Activity object|CRM_Error
 337  *
 338  *
 339  */
 340 function civicrm_api3_profile_set($params) {
 341   return civicrm_api3('profile', 'submit', $params);
 342 }
 343
 344 /**
 345  * @deprecated - appears to be an internal function - should not be accessible via api
 346  * Provide formatted values for profile fields.
 347  *
 348  * @param array $params       Associative array of property name/value
 349  *                             pairs to profile field values
 350  *
 351  * @throws API_Exception
 352  * @return formatted profile field values|CRM_Error
 353  *
 354  * @todo add example
 355  * @todo add test cases
 356  */
 357 function civicrm_api3_profile_apply($params) {
 358
 359   $profileFields = CRM_Core_BAO_UFGroup::getFields($params['profile_id'],
 360     FALSE,
 361     NULL,
 362     NULL,
 363     NULL,
 364     FALSE,
 365     NULL,
 366     TRUE,
 367     NULL,
 368     CRM_Core_Permission::EDIT
 369   );
 370
 371   list($data, $contactDetails) = CRM_Contact_BAO_Contact::formatProfileContactParams($params,
 372     $profileFields,
 373     CRM_Utils_Array::value('contact_id', $params),
 374     $params['profile_id'],
 375     CRM_Utils_Array::value('contact_type', $params),
 376     CRM_Utils_Array::value('skip_custom', $params, FALSE)
 377   );
 378
 379   if (empty($data)) {
 380     throw new API_Exception('Enable to format profile parameters.');
 381   }
 382
 383   return civicrm_api3_create_success($data);
 384 }
 385
 386
 387 /**
 388  * This is a function to help us 'pretend' billing is a profile & treat it like it is one.
 389  * It gets standard credit card address fields etc
 390  * Note this is 'better' that the inbuilt version as it will pull in fallback values
 391  *  billing location -> is_billing -> primary
 392  *
 393  *  Note that that since the existing code for deriving a blank profile is not easily accessible our
 394  *  interim solution is just to return an empty array
 395  *
 396  * @param array $params
 397  *
 398  * @return array
 399  */
 400 function _civicrm_api3_profile_getbillingpseudoprofile(&$params) {
 401
 402   $locations = civicrm_api3('address', 'getoptions', array('field' => 'location_type_id'));
 403   $locationTypeID = array_search('Billing', $locations['values']);
 404
 405   if(empty($params['contact_id'])) {
 406     $config = CRM_Core_Config::singleton();
 407     $blanks =  array(
 408       'billing_first_name' => '',
 409       'billing_middle_name' => '',
 410       'billing_last_name' => '',
 411       'email-' . $locationTypeID => '',
 412       'billing_email-' . $locationTypeID => '',
 413       'billing_city-' . $locationTypeID => '',
 414       'billing_postal_code-' . $locationTypeID => '',
 415       'billing_street_address-' . $locationTypeID => '',
 416       'billing_country_id-' . $locationTypeID => $config->defaultContactCountry,
 417       'billing_state_province_id-' . $locationTypeID => $config->defaultContactStateProvince,
 418     );
 419     return $blanks;
 420   }
 421
 422   $addressFields = array('street_address', 'city', 'state_province_id', 'country_id', 'postal_code');
 423   $result = civicrm_api3('contact', 'getsingle', array(
 424     'id' => $params['contact_id'],
 425     'api.address.get.1' => array('location_type_id' => 'Billing',  'return' => $addressFields),
 426     // getting the is_billing required or not is an extra db call but probably cheap enough as this isn't an import api
 427     'api.address.get.2' => array('is_billing' => True, 'return' => $addressFields),
 428     'api.email.get.1' => array('location_type_id' => 'Billing',),
 429     'api.email.get.2' => array('is_billing' => True,),
 430     'return' => 'api.email.get, api.address.get, api.address.getoptions, country, state_province, email, first_name, last_name, middle_name, ' . implode($addressFields, ','),
 431    )
 432   );
 433
 434   $values = array(
 435     'billing_first_name' => $result['first_name'],
 436     'billing_middle_name' => $result['middle_name'],
 437     'billing_last_name' => $result['last_name'],
 438   );
 439
 440   if(!empty($result['api.address.get.1']['count'])) {
 441     foreach ($addressFields as $fieldname) {
 442       $values['billing_' . $fieldname . '-' . $locationTypeID] = isset($result['api.address.get.1']['values'][0][$fieldname])  ? $result['api.address.get.1']['values'][0][$fieldname] : '';
 443     }
 444   }
 445   elseif(!empty($result['api.address.get.2']['count'])) {
 446     foreach ($addressFields as $fieldname) {
 447       $values['billing_' . $fieldname . '-' . $locationTypeID] = isset($result['api.address.get.2']['values'][0][$fieldname])  ? $result['api.address.get.2']['values'][0][$fieldname] : '';
 448     }
 449   }
 450   else{
 451     foreach ($addressFields as $fieldname) {
 452       $values['billing_' . $fieldname . '-' . $locationTypeID] = isset($result[$fieldname]) ? $result[$fieldname] : '';
 453     }
 454   }
 455
 456   if(!empty($result['api.email.get.1']['count'])) {
 457     $values['billing-email'. '-' . $locationTypeID] = $result['api.email.get.1']['values'][0]['email'];
 458   }
 459   elseif(!empty($result['api.email.get.2']['count'])) {
 460     $values['billing-email'. '-' . $locationTypeID] = $result['api.email.get.2']['values'][0]['email'];
 461   }
 462   else{
 463     $values['billing-email'. '-' . $locationTypeID] = $result['email'];
 464   }
 465   // return both variants of email to reflect inconsistencies in form layer
 466   $values['email'. '-' . $locationTypeID] = $values['billing-email'. '-' . $locationTypeID];
 467   return $values;
 468 }
 469
 470 /**
 471  * Here we will build  up getfields type data for all the fields in the profile. Because the integration with the
 472  * form layer in core is so hard-coded we are not going to attempt to re-use it
 473  * However, as this function is unit-tested & hence 'locked in' we can aspire to extract sharable
 474  * code out of the form-layer over time.
 475  *
 476  * The function deciphers which fields belongs to which entites & retrieves metadata about the entities
 477  * Unfortunately we have inconsistencies such as 'contribution' uses contribution_status_id
 478  * & participant has 'participant_status' so we have to standardise from the outside in here -
 479  * find the oddities, 'mask them' at this layer, add tests & work to standardise over time so we can remove this handling
 480  *
 481  * @param integer $profileID
 482  * @param integer $optionsBehaviour 0 = don't resolve, 1 = resolve non-aggressively, 2 = resolve aggressively - ie include country & state
 483  * @param $is_flush
 484  *
 485  * @return
 486  */
 487
 488 function _civicrm_api3_buildprofile_submitfields($profileID, $optionsBehaviour = 1, $is_flush) {
 489   static $profileFields = array();
 490   if($is_flush) {
 491     $profileFields = array();
 492     if(empty($profileID)) {
 493       return;
 494     }
 495   }
 496   if(isset($profileFields[$profileID])) {
 497     return $profileFields[$profileID];
 498   }
 499   $fields = civicrm_api3('uf_field', 'get', array('uf_group_id' => $profileID));
 500   $entities = array();
 501   foreach ($fields['values'] as $field) {
 502     if(!$field['is_active']) {
 503       continue;
 504     }
 505     list($entity, $fieldName) = _civicrm_api3_map_profile_fields_to_entity($field);
 506     $aliasArray = array();
 507     if(strtolower($fieldName) != $fieldName) {
 508       $aliasArray['api.aliases'] = array($fieldName);
 509       $fieldName = strtolower($fieldName);
 510     }
 511     $profileFields[$profileID][$fieldName] = array_merge(array(
 512       'api.required' => $field['is_required'],
 513       'title' => $field['label'],
 514       'help_pre' => CRM_Utils_Array::value('help_pre', $field),
 515       'help_post' => CRM_Utils_Array::value('help_post', $field),
 516       'entity' => $entity,
 517       'weight' => CRM_Utils_Array::value('weight', $field),
 518     ), $aliasArray);
 519
 520     $ufFieldTaleFieldName = $field['field_name'];
 521     if(isset($entity[$ufFieldTaleFieldName]['name'])) {
 522       // in the case where we are dealing with an alias we map back to a name
 523       // this will be tested by 'membership_type_id' field
 524       $ufFieldTaleFieldName = $entity[$ufFieldTaleFieldName]['name'];
 525     }
 526     //see function notes
 527     // as we build up a list of these we should be able to determine a generic approach
 528     //
 529     $hardCodedEntityFields = array(
 530       'state_province' => 'state_province_id',
 531       'country' => 'country_id',
 532       'participant_status' => 'status_id',
 533       'gender' => 'gender_id',
 534       'financial_type' => 'financial_type_id',
 535       'soft_credit' => 'soft_credit_to',
 536       'group' => 'group_id',
 537       'tag' => 'tag_id',
 538       'soft_credit_type' => 'soft_credit_type_id',
 539     );
 540
 541     if(array_key_exists($ufFieldTaleFieldName, $hardCodedEntityFields)) {
 542       $ufFieldTaleFieldName = $hardCodedEntityFields[$ufFieldTaleFieldName];
 543     }
 544
 545     $entities[$entity][$fieldName] = $ufFieldTaleFieldName;
 546   }
 547
 548   foreach ($entities as $entity => $entityFields) {
 549     $result = civicrm_api3($entity, 'getfields', array('action' => 'create'));
 550     $entityGetFieldsResult = _civicrm_api3_profile_appendaliases($result['values'], $entity);
 551     foreach ($entityFields as $entityfield => $realName) {
 552       $fieldName = strtolower($entityfield);
 553       if(!strstr($fieldName, '-')) {
 554          if(strtolower($realName) != $fieldName) {
 555         // we want to keep the '-' pattern for locations but otherwise
 556         // we are going to make the api-standard field the main / preferred name but support the db name
 557         // in future naming the fields in the DB to reflect the way the rest of the api / BAO / metadata works would
 558         // reduce code
 559         $fieldName = strtolower($realName);
 560         }
 561         if(isset($entityGetFieldsResult[$realName]['uniqueName'])) {
 562           // we won't alias the field name on here are we are using uniqueNames for the possibility of needing to differentiate
 563           // which entity 'status_id' belongs to
 564           $fieldName = $entityGetFieldsResult[$realName]['uniqueName'];
 565         }
 566         else{
 567           if(isset($entityGetFieldsResult[$realName]['name'])) {
 568             // this will sort out membership_type_id vs membership_type
 569             $fieldName = $entityGetFieldsResult[$realName]['name'];
 570           }
 571         }
 572       }
 573       $profileFields[$profileID][$fieldName] = array_merge($entityGetFieldsResult[$realName], $profileFields[$profileID][$entityfield]);
 574       if(!isset($profileFields[$profileID][$fieldName]['api.aliases'])) {
 575        $profileFields[$profileID][$fieldName]['api.aliases'] = array();
 576       }
 577       if($optionsBehaviour && !empty($entityGetFieldsResult[$realName]['pseudoconstant'])) {
 578         if($optionsBehaviour > 1  || !in_array($realName, array('state_province_id', 'county_id', 'country_id'))) {
 579           $options = civicrm_api3($entity, 'getoptions', array('field' => $realName));
 580           $profileFields[$profileID][$fieldName]['options'] = $options['values'];
 581         }
 582       }
 583
 584       if($entityfield != $fieldName) {
 585         if(isset($profileFields[$profileID][$entityfield])) {
 586           unset($profileFields[$profileID][$entityfield]);
 587         }
 588         if(!in_array($entityfield, $profileFields[$profileID][$fieldName]['api.aliases'])) {
 589           // we will make the mixed case version (e.g. of 'Primary') an alias
 590           $profileFields[$profileID][$fieldName]['api.aliases'][] = $entityfield;
 591         }
 592       }
 593       /**
 594        * putting this on hold -this would cause the api to set the default - but could have unexpected behaviour
 595       if(isset($result['values'][$realName]['default_value'])) {
 596       //this would be the case for a custom field with a configured default
 597       $profileFields[$profileID][$entityfield]['api.default'] = $result['values'][$realName]['default_value'];
 598       }
 599        */
 600     }
 601   }
 602   uasort($profileFields[$profileID], "_civicrm_api3_order_by_weight");
 603   return $profileFields[$profileID];
 604 }
 605
 606 /**
 607  * @param $a
 608  * @param $b
 609  *
 610  * @return bool
 611  */
 612 function _civicrm_api3_order_by_weight($a, $b) {
 613   return CRM_Utils_Array::value('weight', $b) < CRM_Utils_Array::value('weight', $a) ? TRUE : FALSE;
 614 }
 615
 616 /**
 617  * Here we map the profile fields as stored in the uf_field table to their 'real entity'
 618  * we also return the profile fieldname
 619  *
 620  * @param $field
 621  *
 622  * @return array
 623  */
 624 function _civicrm_api3_map_profile_fields_to_entity(&$field) {
 625   $entity = $field['field_type'];
 626   $contactTypes = civicrm_api3('contact', 'getoptions', array('field' => 'contact_type'));
 627   if(in_array($entity, $contactTypes['values'])) {
 628     $entity = 'contact';
 629   }
 630   $entity = _civicrm_api_get_entity_name_from_camel($entity);
 631   $locationFields = array('email' => 'email');
 632   $fieldName = $field['field_name'];
 633   if(!empty($field['location_type_id'])) {
 634     if($fieldName == 'email') {
 635       $entity = 'email';
 636     }
 637     else{
 638       $entity = 'address';
 639     }
 640     $fieldName .= '-' . $field['location_type_id'];
 641   }
 642   elseif(array_key_exists($fieldName, $locationFields)) {
 643     $fieldName .= '-Primary';
 644     $entity = 'email';
 645   }
 646   if(!empty($field['phone_type_id'])) {
 647     $fieldName .= '-' . $field['location_type_id'];
 648     $entity = 'phone';
 649   }
 650
 651   // @todo - sort this out!
 652   //here we do a hard-code list of known fields that don't map to where they are mapped to
 653   // not a great solution but probably if we looked in the BAO we'd find a scary switch statement
 654   // in a perfect world the uf_field table would hold the correct entity for each item
 655   // & only the relationships between entities would need to be coded
 656   $hardCodedEntityMappings = array(
 657     'street_address' => 'address',
 658     'street_number' => 'address',
 659     'supplemental_address_1' => 'address',
 660     'supplemental_address_2' => 'address',
 661     'supplemental_address_3' => 'address',
 662     'postal_code' => 'address',
 663     'city' => 'address',
 664     'email' => 'email',
 665     'state_province' => 'address',
 666     'country' => 'address',
 667     'county' => 'address',
 668     //note that in discussions about how to restructure the api we discussed making these membership
 669     // fields into 'membership_payment' fields - which would entail declaring them in getfields
 670     // & renaming them in existing profiles
 671     'financial_type' => 'contribution',
 672     'total_amount' => 'contribution',
 673     'receive_date' => 'contribution',
 674     'payment_instrument' => 'contribution',
 675     'check_number' => 'contribution',
 676     'contribution_status_id' => 'contribution',
 677     'soft_credit' => 'contribution',
 678     'soft_credit_type' => 'contribution_soft',
 679     'group' => 'group_contact',
 680     'tag' => 'entity_tag',
 681    );
 682   if(array_key_exists($fieldName, $hardCodedEntityMappings)) {
 683     $entity = $hardCodedEntityMappings[$fieldName];
 684   }
 685   return array($entity, $fieldName);
 686 }
 687
 688 /**
 689  * @todo this should be handled by the api wrapper using getfields info - need to check
 690  * how we add a a pseudoconstant to this pseudo api to make that work
 691  *
 692  * @param int $profileID
 693  *
 694  * @return integer|string
 695  * @throws CiviCRM_API3_Exception
 696  */
 697 function _civicrm_api3_profile_getProfileID($profileID) {
 698   if(!empty($profileID) && strtolower($profileID) != 'billing' && !is_numeric($profileID)) {
 699     $profileID = civicrm_api3('uf_group', 'getvalue', array('return' => 'id', 'name' => $profileID));
 700   }
 701   return $profileID;
 702 }
 703
 704 /**
 705  * helper function to add all aliases as keys to getfields response so we can look for keys within it
 706  * since the relationship between profile fields & api / metadata based fields is a bit inconsistent
 707  *
 708  * @param array $values
 709  *
 710  * e.g getfields response incl 'membership_type_id' - with api.aliases = 'membership_type'
 711  * returned array will include both as keys (with the same values)
 712  * @param $entity
 713  *
 714  * @return array
 715  */
 716 function _civicrm_api3_profile_appendaliases($values, $entity) {
 717   foreach ($values as $field => $spec) {
 718     if(!empty($spec['api.aliases'])) {
 719       foreach ($spec['api.aliases'] as $alias) {
 720         $values[$alias] = $spec;
 721       }
 722     }
 723     if(!empty($spec['uniqueName'])) {
 724       $values[$spec['uniqueName']] = $spec;
 725     }
 726   }
 727   //special case on membership & contribution - can't see how to handle in a generic way
 728   if(in_array($entity, array('membership', 'contribution'))) {
 729     $values['send_receipt'] = array('title' => 'Send Receipt', 'type' => (int) 16);
 730   }
 731   return $values;
 732 }
 733
 734 /**
 735  * @deprecated api notice
 736  * @return array of deprecated actions
 737  */
 738 function _civicrm_api3_profile_deprecation() {
 739   return array(
 740     'set' => 'Profile api "set" action is deprecated in favor of "submit".',
 741     'apply' => 'Profile api "apply" action is deprecated in favor of "submit".',
 742   );
 743 }