CRM/Core/BAO/Mapping.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  * $Id$
  33  *
  34  */
  35 class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping {
  36
  37   /**
  38    * Class constructor.
  39    */
  40   public function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  45    * Fetch object based on array of properties.
  46    *
  47    * @param array $params
  48    *   (reference ) an assoc array of name/value pairs.
  49    * @param array $defaults
  50    *   (reference ) an assoc array to hold the flattened values.
  51    *
  52    * @return object
  53    *   CRM_Core_DAO_Mapping object on success, otherwise NULL
  54    */
  55   public static function retrieve(&$params, &$defaults) {
  56     $mapping = new CRM_Core_DAO_Mapping();
  57     $mapping->copyValues($params);
  58     if ($mapping->find(TRUE)) {
  59       CRM_Core_DAO::storeValues($mapping, $defaults);
  60       return $mapping;
  61     }
  62     return NULL;
  63   }
  64
  65   /**
  66    * Delete the mapping.
  67    *
  68    * @param int $id
  69    *   Mapping id.
  70    *
  71    * @return bool
  72    */
  73   public static function del($id) {
  74     // delete from mapping_field table
  75     $mappingField = new CRM_Core_DAO_MappingField();
  76     $mappingField->mapping_id = $id;
  77     $mappingField->find();
  78     while ($mappingField->fetch()) {
  79       $mappingField->delete();
  80     }
  81
  82     // delete from mapping table
  83     $mapping = new CRM_Core_DAO_Mapping();
  84     $mapping->id = $id;
  85     $mapping->delete();
  86     CRM_Core_Session::setStatus(ts('Selected mapping has been deleted successfully.'), ts('Deleted'), 'success');
  87
  88     return TRUE;
  89   }
  90
  91   /**
  92    * Takes an associative array and creates a contact object.
  93    *
  94    * The function extract all the params it needs to initialize the create a
  95    * contact object. the params array could contain additional unused name/value
  96    * pairs
  97    *
  98    * @param array $params
  99    *   An array of name/value pairs.
 100    *
 101    * @return object
 102    *   CRM_Core_DAO_Mapper object on success, otherwise NULL
 103    */
 104   public static function add($params) {
 105     $mapping = new CRM_Core_DAO_Mapping();
 106     $mapping->copyValues($params);
 107     $mapping->save();
 108
 109     return $mapping;
 110   }
 111
 112   /**
 113    * Get the list of mappings.
 114    *
 115    * @param string $mappingTypeId
 116    *   Mapping type id.
 117    *
 118    * @return array
 119    *   array of mapping name
 120    */
 121   public static function getMappings($mappingTypeId) {
 122     $mapping = array();
 123     $mappingDAO = new CRM_Core_DAO_Mapping();
 124     $mappingDAO->mapping_type_id = $mappingTypeId;
 125     $mappingDAO->find();
 126
 127     while ($mappingDAO->fetch()) {
 128       $mapping[$mappingDAO->id] = $mappingDAO->name;
 129     }
 130
 131     return $mapping;
 132   }
 133
 134   /**
 135    * Get the mapping fields.
 136    *
 137    * @param int $mappingId
 138    *   Mapping id.
 139    *
 140    * @return array
 141    *   array of mapping fields
 142    */
 143   public static function getMappingFields($mappingId) {
 144     //mapping is to be loaded from database
 145     $mapping = new CRM_Core_DAO_MappingField();
 146     $mapping->mapping_id = $mappingId;
 147     $mapping->orderBy('column_number');
 148     $mapping->find();
 149
 150     $mappingName = $mappingLocation = $mappingContactType = $mappingPhoneType = array();
 151     $mappingImProvider = $mappingRelation = $mappingOperator = $mappingValue = $mappingWebsiteType = array();
 152     while ($mapping->fetch()) {
 153       $mappingName[$mapping->grouping][$mapping->column_number] = $mapping->name;
 154       $mappingContactType[$mapping->grouping][$mapping->column_number] = $mapping->contact_type;
 155
 156       if (!empty($mapping->location_type_id)) {
 157         $mappingLocation[$mapping->grouping][$mapping->column_number] = $mapping->location_type_id;
 158       }
 159
 160       if (!empty($mapping->phone_type_id)) {
 161         $mappingPhoneType[$mapping->grouping][$mapping->column_number] = $mapping->phone_type_id;
 162       }
 163
 164       // get IM service provider type id from mapping fields
 165       if (!empty($mapping->im_provider_id)) {
 166         $mappingImProvider[$mapping->grouping][$mapping->column_number] = $mapping->im_provider_id;
 167       }
 168
 169       if (!empty($mapping->website_type_id)) {
 170         $mappingWebsiteType[$mapping->grouping][$mapping->column_number] = $mapping->website_type_id;
 171       }
 172
 173       if (!empty($mapping->relationship_type_id)) {
 174         $mappingRelation[$mapping->grouping][$mapping->column_number] = "{$mapping->relationship_type_id}_{$mapping->relationship_direction}";
 175       }
 176
 177       if (!empty($mapping->operator)) {
 178         $mappingOperator[$mapping->grouping][$mapping->column_number] = $mapping->operator;
 179       }
 180
 181       if (!empty($mapping->value)) {
 182         $mappingValue[$mapping->grouping][$mapping->column_number] = $mapping->value;
 183       }
 184     }
 185
 186     return array(
 187       $mappingName,
 188       $mappingContactType,
 189       $mappingLocation,
 190       $mappingPhoneType,
 191       $mappingImProvider,
 192       $mappingRelation,
 193       $mappingOperator,
 194       $mappingValue,
 195       $mappingWebsiteType,
 196     );
 197   }
 198
 199   /**
 200    * Check Duplicate Mapping Name.
 201    *
 202    * @param string $nameField
 203    *   mapping Name.
 204    * @param string $mapTypeId
 205    *   mapping Type.
 206    *
 207    * @return bool
 208    */
 209   public static function checkMapping($nameField, $mapTypeId) {
 210     $mapping = new CRM_Core_DAO_Mapping();
 211     $mapping->name = $nameField;
 212     $mapping->mapping_type_id = $mapTypeId;
 213     return (bool) $mapping->find(TRUE);
 214   }
 215
 216   /**
 217    * Function returns associated array of elements, that will be passed for search
 218    *
 219    * @param int $smartGroupId
 220    *   Smart group id.
 221    *
 222    * @return array
 223    *   associated array of elements
 224    */
 225   public static function getFormattedFields($smartGroupId) {
 226     $returnFields = array();
 227
 228     //get the fields from mapping table
 229     $dao = new CRM_Core_DAO_MappingField();
 230     $dao->mapping_id = $smartGroupId;
 231     $dao->find();
 232     while ($dao->fetch()) {
 233       $fldName = $dao->name;
 234       if ($dao->location_type_id) {
 235         $fldName .= "-{$dao->location_type_id}";
 236       }
 237       if ($dao->phone_type) {
 238         $fldName .= "-{$dao->phone_type}";
 239       }
 240       $returnFields[$fldName]['value'] = $dao->value;
 241       $returnFields[$fldName]['op'] = $dao->operator;
 242       $returnFields[$fldName]['grouping'] = $dao->grouping;
 243     }
 244     return $returnFields;
 245   }
 246
 247   /**
 248    * Build the mapping form.
 249    *
 250    * @param CRM_Core_Form $form
 251    * @param string $mappingType
 252    *   (Export/Import/Search Builder).
 253    * @param int $mappingId
 254    * @param int $columnNo
 255    * @param int $blockCount
 256    *   (no of blocks shown).
 257    * @param NULL $exportMode
 258    *
 259    * @return void
 260    */
 261   public static function buildMappingForm(&$form, $mappingType = 'Export', $mappingId = NULL, $columnNo, $blockCount = 3, $exportMode = NULL) {
 262     if ($mappingType == 'Export') {
 263       $name = "Map";
 264       $columnCount = array('1' => $columnNo);
 265     }
 266     elseif ($mappingType == 'Search Builder') {
 267       $name = "Builder";
 268       $columnCount = $columnNo;
 269     }
 270
 271     //get the saved mapping details
 272
 273     if ($mappingType == 'Export') {
 274       $form->applyFilter('saveMappingName', 'trim');
 275
 276       //to save the current mappings
 277       if (!isset($mappingId)) {
 278         $saveDetailsName = ts('Save this field mapping');
 279         $form->add('text', 'saveMappingName', ts('Name'));
 280         $form->add('text', 'saveMappingDesc', ts('Description'));
 281       }
 282       else {
 283         $form->assign('loadedMapping', $mappingId);
 284
 285         $params = array('id' => $mappingId);
 286         $temp = array();
 287         $mappingDetails = CRM_Core_BAO_Mapping::retrieve($params, $temp);
 288
 289         $form->assign('savedName', $mappingDetails->name);
 290
 291         $form->add('hidden', 'mappingId', $mappingId);
 292
 293         $form->addElement('checkbox', 'updateMapping', ts('Update this field mapping'), NULL);
 294         $saveDetailsName = ts('Save as a new field mapping');
 295         $form->add('text', 'saveMappingName', ts('Name'));
 296         $form->add('text', 'saveMappingDesc', ts('Description'));
 297       }
 298
 299       $form->addElement('checkbox', 'saveMapping', $saveDetailsName, NULL, array('onclick' => "showSaveDetails(this)"));
 300       $form->addFormRule(array('CRM_Export_Form_Map', 'formRule'), $form->get('mappingTypeId'));
 301     }
 302     elseif ($mappingType == 'Search Builder') {
 303       $form->addElement('submit', 'addBlock', ts('Also include contacts where'),
 304         array('class' => 'submit-link')
 305       );
 306     }
 307
 308     $defaults = array();
 309     $hasLocationTypes = array();
 310     $hasRelationTypes = array();
 311     $fields = array();
 312
 313     if ($mappingType == 'Export') {
 314       $required = TRUE;
 315     }
 316     elseif ($mappingType == 'Search Builder') {
 317       $required = FALSE;
 318     }
 319
 320     $contactType = array('Individual', 'Household', 'Organization');
 321     foreach ($contactType as $value) {
 322       if ($mappingType == 'Search Builder') {
 323         // get multiple custom group fields in this context
 324         $contactFields = CRM_Contact_BAO_Contact::exportableFields($value, FALSE, $required, FALSE, TRUE);
 325       }
 326       else {
 327         $contactFields = CRM_Contact_BAO_Contact::exportableFields($value, FALSE, $required);
 328       }
 329       $contactFields = array_merge($contactFields, CRM_Contact_BAO_Query_Hook::singleton()->getFields());
 330
 331       // exclude the address options disabled in the Address Settings
 332       $fields[$value] = CRM_Core_BAO_Address::validateAddressOptions($contactFields);
 333       ksort($fields[$value]);
 334       if ($mappingType == 'Export') {
 335         $relationships = array();
 336         $relationshipTypes = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, $value);
 337         asort($relationshipTypes);
 338
 339         foreach ($relationshipTypes as $key => $var) {
 340           list($type) = explode('_', $key);
 341
 342           $relationships[$key]['title'] = $var;
 343           $relationships[$key]['headerPattern'] = '/' . preg_quote($var, '/') . '/';
 344           $relationships[$key]['export'] = TRUE;
 345           $relationships[$key]['relationship_type_id'] = $type;
 346           $relationships[$key]['related'] = TRUE;
 347           $relationships[$key]['hasRelationType'] = 1;
 348         }
 349
 350         if (!empty($relationships)) {
 351           $fields[$value] = array_merge($fields[$value],
 352             array('related' => array('title' => ts('- related contact info -'))),
 353             $relationships
 354           );
 355         }
 356       }
 357     }
 358
 359     //get the current employer for mapping.
 360     if ($required) {
 361       $fields['Individual']['current_employer']['title'] = ts('Current Employer');
 362     }
 363
 364     // add component fields
 365     $compArray = array();
 366
 367     //we need to unset groups, tags, notes for component export
 368     if ($exportMode != CRM_Export_Form_Select::CONTACT_EXPORT) {
 369       foreach (array(
 370                  'groups',
 371                  'tags',
 372                  'notes',
 373                ) as $value) {
 374         unset($fields['Individual'][$value]);
 375         unset($fields['Household'][$value]);
 376         unset($fields['Organization'][$value]);
 377       }
 378     }
 379
 380     if ($mappingType == 'Search Builder') {
 381       //build the common contact fields array.
 382       $fields['Contact'] = array();
 383       foreach ($fields['Individual'] as $key => $value) {
 384         if (!empty($fields['Household'][$key]) && !empty($fields['Organization'][$key])) {
 385           $fields['Contact'][$key] = $value;
 386           unset($fields['Organization'][$key],
 387             $fields['Household'][$key],
 388             $fields['Individual'][$key]);
 389         }
 390       }
 391       if (array_key_exists('note', $fields['Contact'])) {
 392         $noteTitle = $fields['Contact']['note']['title'];
 393         $fields['Contact']['note']['title'] = $noteTitle . ': ' . ts('Body and Subject');
 394         $fields['Contact']['note_body'] = array('title' => $noteTitle . ': ' . ts('Body Only'), 'name' => 'note_body');
 395         $fields['Contact']['note_subject'] = array(
 396           'title' => $noteTitle . ': ' . ts('Subject Only'),
 397           'name' => 'note_subject',
 398         );
 399       }
 400     }
 401
 402     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::CONTRIBUTE_EXPORT)) {
 403       if (CRM_Core_Permission::access('CiviContribute')) {
 404         $fields['Contribution'] = CRM_Contribute_BAO_Contribution::exportableFields();
 405         foreach (array('contribution_contact_id', 'contribution_soft_credit_name', 'contribution_soft_credit_amount', 'contribution_soft_credit_type', 'contribution_soft_credit_contribution_id') as $element) {
 406           unset($fields['Contribution'][$element]);
 407         }
 408         $compArray['Contribution'] = ts('Contribution');
 409       }
 410     }
 411
 412     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT)) {
 413       if (CRM_Core_Permission::access('CiviEvent')) {
 414         $fields['Participant'] = CRM_Event_BAO_Participant::exportableFields();
 415         //get the component payment fields
 416         if ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT) {
 417           require_once 'CRM/Export/BAO/Export.php';
 418           $componentPaymentFields = array();
 419           foreach (CRM_Export_BAO_Export::componentPaymentFields() as $payField => $payTitle) {
 420             $componentPaymentFields[$payField] = array('title' => $payTitle);
 421           }
 422           $fields['Participant'] = array_merge($fields['Participant'], $componentPaymentFields);
 423         }
 424
 425         $compArray['Participant'] = ts('Participant');
 426       }
 427     }
 428
 429     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT)) {
 430       if (CRM_Core_Permission::access('CiviMember')) {
 431         $fields['Membership'] = CRM_Member_BAO_Membership::getMembershipFields($exportMode);
 432         unset($fields['Membership']['membership_contact_id']);
 433         $compArray['Membership'] = ts('Membership');
 434       }
 435     }
 436
 437     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT)) {
 438       if (CRM_Core_Permission::access('CiviPledge')) {
 439         $fields['Pledge'] = CRM_Pledge_BAO_Pledge::exportableFields();
 440         unset($fields['Pledge']['pledge_contact_id']);
 441         $compArray['Pledge'] = ts('Pledge');
 442       }
 443     }
 444
 445     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::CASE_EXPORT)) {
 446       if (CRM_Core_Permission::access('CiviCase')) {
 447         $fields['Case'] = CRM_Case_BAO_Case::exportableFields();
 448         $compArray['Case'] = ts('Case');
 449
 450         $fields['Activity'] = CRM_Activity_BAO_Activity::exportableFields('Case');
 451         $compArray['Activity'] = ts('Case Activity');
 452
 453         unset($fields['Case']['case_contact_id']);
 454       }
 455     }
 456     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::GRANT_EXPORT)) {
 457       if (CRM_Core_Permission::access('CiviGrant')) {
 458         $fields['Grant'] = CRM_Grant_BAO_Grant::exportableFields();
 459         unset($fields['Grant']['grant_contact_id']);
 460         if ($mappingType == 'Search Builder') {
 461           unset($fields['Grant']['grant_type_id']);
 462         }
 463         $compArray['Grant'] = ts('Grant');
 464       }
 465     }
 466
 467     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT)) {
 468       $fields['Activity'] = CRM_Activity_BAO_Activity::exportableFields('Activity');
 469       $compArray['Activity'] = ts('Activity');
 470     }
 471
 472     //Contact Sub Type For export
 473     $contactSubTypes = array();
 474     $subTypes = CRM_Contact_BAO_ContactType::subTypeInfo();
 475
 476     foreach ($subTypes as $subType => $val) {
 477       //adding subtype specific relationships CRM-5256
 478       $csRelationships = array();
 479
 480       if ($mappingType == 'Export') {
 481         $subTypeRelationshipTypes
 482           = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, $val['parent'],
 483             FALSE, 'label', TRUE, $subType);
 484
 485         foreach ($subTypeRelationshipTypes as $key => $var) {
 486           if (!array_key_exists($key, $fields[$val['parent']])) {
 487             list($type) = explode('_', $key);
 488
 489             $csRelationships[$key]['title'] = $var;
 490             $csRelationships[$key]['headerPattern'] = '/' . preg_quote($var, '/') . '/';
 491             $csRelationships[$key]['export'] = TRUE;
 492             $csRelationships[$key]['relationship_type_id'] = $type;
 493             $csRelationships[$key]['related'] = TRUE;
 494             $csRelationships[$key]['hasRelationType'] = 1;
 495           }
 496         }
 497       }
 498
 499       $fields[$subType] = $fields[$val['parent']] + $csRelationships;
 500
 501       //custom fields for sub type
 502       $subTypeFields = CRM_Core_BAO_CustomField::getFieldsForImport($subType);
 503       $fields[$subType] += $subTypeFields;
 504
 505       if (!empty($subTypeFields) || !empty($csRelationships)) {
 506         $contactSubTypes[$subType] = $val['label'];
 507       }
 508     }
 509
 510     unset($subTypes);
 511
 512     foreach ($fields as $key => $value) {
 513
 514       foreach ($value as $key1 => $value1) {
 515         //CRM-2676, replacing the conflict for same custom field name from different custom group.
 516         $customGroupName = self::getCustomGroupName($key1);
 517
 518         if ($customGroupName) {
 519           $relatedMapperFields[$key][$key1] = $mapperFields[$key][$key1] = $customGroupName . ': ' . $value1['title'];
 520         }
 521         else {
 522           $relatedMapperFields[$key][$key1] = $mapperFields[$key][$key1] = $value1['title'];
 523         }
 524         if (isset($value1['hasLocationType'])) {
 525           $hasLocationTypes[$key][$key1] = $value1['hasLocationType'];
 526         }
 527
 528         if (isset($value1['hasRelationType'])) {
 529           $hasRelationTypes[$key][$key1] = $value1['hasRelationType'];
 530           unset($relatedMapperFields[$key][$key1]);
 531         }
 532       }
 533
 534       if (array_key_exists('related', $relatedMapperFields[$key])) {
 535         unset($relatedMapperFields[$key]['related']);
 536       }
 537     }
 538
 539     $mapperKeys = array_keys($mapperFields);
 540
 541     $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 542
 543     $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 544
 545     // FIXME: dirty hack to make the default option show up first.  This
 546     // avoids a mozilla browser bug with defaults on dynamically constructed
 547     // selector widgets.
 548     if ($defaultLocationType) {
 549       $defaultLocation = $locationTypes[$defaultLocationType->id];
 550       unset($locationTypes[$defaultLocationType->id]);
 551       $locationTypes = array($defaultLocationType->id => $defaultLocation) + $locationTypes;
 552     }
 553
 554     $locationTypes = array(' ' => ts('Primary')) + $locationTypes;
 555
 556     // since we need a hierarchical list to display contact types & subtypes,
 557     // this is what we going to display in first selector
 558     $contactTypes = CRM_Contact_BAO_ContactType::getSelectElements(FALSE, FALSE);
 559     if ($mappingType == 'Search Builder') {
 560       $contactTypes = array('Contact' => ts('Contacts')) + $contactTypes;
 561     }
 562
 563     $sel1 = array('' => ts('- select record type -')) + $contactTypes + $compArray;
 564
 565     foreach ($sel1 as $key => $sel) {
 566       if ($key) {
 567         // sort everything BUT the contactType which is sorted seperately by
 568         // an initial commit of CRM-13278 (check ksort above)
 569         if (!in_array($key, $contactType)) {
 570           asort($mapperFields[$key]);
 571         }
 572         $sel2[$key] = array('' => ts('- select field -')) + $mapperFields[$key];
 573       }
 574     }
 575
 576     $sel3[''] = NULL;
 577     $sel5[''] = NULL;
 578     $phoneTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id');
 579     $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
 580     asort($phoneTypes);
 581
 582     foreach ($sel1 as $k => $sel) {
 583       if ($k) {
 584         foreach ($locationTypes as $key => $value) {
 585           if (trim($key) != '') {
 586             $sel4[$k]['phone'][$key] = &$phoneTypes;
 587             $sel4[$k]['im'][$key] = &$imProviders;
 588           }
 589         }
 590       }
 591     }
 592
 593     foreach ($sel1 as $k => $sel) {
 594       if ($k) {
 595         foreach ($mapperFields[$k] as $key => $value) {
 596           if (isset($hasLocationTypes[$k][$key])) {
 597             $sel3[$k][$key] = $locationTypes;
 598           }
 599           else {
 600             $sel3[$key] = NULL;
 601           }
 602         }
 603       }
 604     }
 605
 606     // Array for core fields and relationship custom data
 607     $relationshipTypes = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
 608
 609     if ($mappingType == 'Export') {
 610       foreach ($sel1 as $k => $sel) {
 611         if ($k) {
 612           foreach ($mapperFields[$k] as $field => $dontCare) {
 613             if (isset($hasRelationTypes[$k][$field])) {
 614               list($id, $first, $second) = explode('_', $field);
 615               // FIX ME: For now let's not expose custom data related to relationship
 616               $relationshipCustomFields = array();
 617               //$relationshipCustomFields    = self::getRelationTypeCustomGroupData( $id );
 618               //asort($relationshipCustomFields);
 619
 620               $relationshipType = new CRM_Contact_BAO_RelationshipType();
 621               $relationshipType->id = $id;
 622               if ($relationshipType->find(TRUE)) {
 623                 $direction = "contact_sub_type_$second";
 624                 if (isset($relationshipType->$direction)) {
 625                   $relatedFields = array_merge((array) $relatedMapperFields[$relationshipType->$direction], (array) $relationshipCustomFields);
 626                 }
 627                 else {
 628                   $target_type = 'contact_type_' . $second;
 629                   $relatedFields = array_merge((array) $relatedMapperFields[$relationshipType->$target_type], (array) $relationshipCustomFields);
 630                 }
 631               }
 632               $relationshipType->free();
 633               asort($relatedFields);
 634               $sel5[$k][$field] = $relatedFields;
 635             }
 636           }
 637         }
 638       }
 639
 640       //Location Type for relationship fields
 641       foreach ($sel5 as $k => $v) {
 642         if ($v) {
 643           foreach ($v as $rel => $fields) {
 644             foreach ($fields as $field => $fieldLabel) {
 645               if (isset($hasLocationTypes[$k][$field])) {
 646                 $sel6[$k][$rel][$field] = $locationTypes;
 647               }
 648             }
 649           }
 650         }
 651       }
 652
 653       //PhoneTypes for  relationship fields
 654       $sel7[''] = NULL;
 655       foreach ($sel6 as $k => $rel) {
 656         if ($k) {
 657           foreach ($rel as $phonekey => $phonevalue) {
 658             foreach ($locationTypes as $locType => $loc) {
 659               if (trim($locType) != '') {
 660                 $sel7[$k][$phonekey]['phone'][$locType] = &$phoneTypes;
 661                 $sel7[$k][$phonekey]['im'][$locType] = &$imProviders;
 662               }
 663             }
 664           }
 665         }
 666       }
 667     }
 668
 669     //special fields that have location, hack for primary location
 670     $specialFields = array(
 671       'street_address',
 672       'supplemental_address_1',
 673       'supplemental_address_2',
 674       'city',
 675       'postal_code',
 676       'postal_code_suffix',
 677       'geo_code_1',
 678       'geo_code_2',
 679       'state_province',
 680       'country',
 681       'phone',
 682       'email',
 683       'im',
 684     );
 685
 686     if (isset($mappingId)) {
 687       $colCnt = 0;
 688
 689       list($mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType, $mappingImProvider,
 690         $mappingRelation, $mappingOperator, $mappingValue
 691         ) = CRM_Core_BAO_Mapping::getMappingFields($mappingId);
 692
 693       $blkCnt = count($mappingName);
 694       if ($blkCnt >= $blockCount) {
 695         $blockCount = $blkCnt + 1;
 696       }
 697       for ($x = 1; $x < $blockCount; $x++) {
 698         if (isset($mappingName[$x])) {
 699           $colCnt = count($mappingName[$x]);
 700           if ($colCnt >= $columnCount[$x]) {
 701             $columnCount[$x] = $colCnt;
 702           }
 703         }
 704       }
 705     }
 706
 707     $form->_blockCount = $blockCount;
 708     $form->_columnCount = $columnCount;
 709
 710     $form->set('blockCount', $form->_blockCount);
 711     $form->set('columnCount', $form->_columnCount);
 712
 713     $defaults = $noneArray = $nullArray = array();
 714
 715     //used to warn for mismatch column count or mismatch mapping
 716     $warning = 0;
 717     for ($x = 1; $x < $blockCount; $x++) {
 718
 719       for ($i = 0; $i < $columnCount[$x]; $i++) {
 720
 721         $sel = &$form->addElement('hierselect', "mapper[$x][$i]", ts('Mapper for Field %1', array(1 => $i)), NULL);
 722         $jsSet = FALSE;
 723
 724         if (isset($mappingId)) {
 725           $locationId = isset($mappingLocation[$x][$i]) ? $mappingLocation[$x][$i] : 0;
 726           if (isset($mappingName[$x][$i])) {
 727             if (is_array($mapperFields[$mappingContactType[$x][$i]])) {
 728
 729               if (isset($mappingRelation[$x][$i])) {
 730
 731                 $contactDetails = strtolower(str_replace(" ", "_", $mappingName[$x][$i]));
 732                 $relLocationId = isset($mappingLocation[$x][$i]) ? $mappingLocation[$x][$i] : 0;
 733                 if (!$relLocationId && in_array($mappingName[$x][$i], $specialFields)) {
 734                   $relLocationId = " ";
 735                 }
 736
 737                 $relPhoneType = isset($mappingPhoneType[$x][$i]) ? $mappingPhoneType[$x][$i] : NULL;
 738
 739                 $defaults["mapper[$x][$i]"] = array(
 740                   $mappingContactType[$x][$i],
 741                   $mappingRelation[$x][$i],
 742                   $locationId,
 743                   $phoneType,
 744                   $mappingName[$x][$i],
 745                   $relLocationId,
 746                   $relPhoneType,
 747                 );
 748
 749                 if (!$locationId) {
 750                   $noneArray[] = array($x, $i, 2);
 751                 }
 752                 if (!$phoneType && !$imProvider) {
 753                   $noneArray[] = array($x, $i, 3);
 754                 }
 755                 if (!$mappingName[$x][$i]) {
 756                   $noneArray[] = array($x, $i, 4);
 757                 }
 758                 if (!$relLocationId) {
 759                   $noneArray[] = array($x, $i, 5);
 760                 }
 761                 if (!$relPhoneType) {
 762                   $noneArray[] = array($x, $i, 6);
 763                 }
 764                 $noneArray[] = array($x, $i, 2);
 765               }
 766               else {
 767                 $phoneType = isset($mappingPhoneType[$x][$i]) ? $mappingPhoneType[$x][$i] : NULL;
 768                 $imProvider = isset($mappingImProvider[$x][$i]) ? $mappingImProvider[$x][$i] : NULL;
 769                 if (!$locationId && in_array($mappingName[$x][$i], $specialFields)) {
 770                   $locationId = " ";
 771                 }
 772
 773                 $defaults["mapper[$x][$i]"] = array(
 774                   $mappingContactType[$x][$i],
 775                   $mappingName[$x][$i],
 776                   $locationId,
 777                   $phoneType,
 778                 );
 779                 if (!$mappingName[$x][$i]) {
 780                   $noneArray[] = array($x, $i, 1);
 781                 }
 782                 if (!$locationId) {
 783                   $noneArray[] = array($x, $i, 2);
 784                 }
 785                 if (!$phoneType && !$imProvider) {
 786                   $noneArray[] = array($x, $i, 3);
 787                 }
 788
 789                 $noneArray[] = array($x, $i, 4);
 790                 $noneArray[] = array($x, $i, 5);
 791                 $noneArray[] = array($x, $i, 6);
 792               }
 793
 794               $jsSet = TRUE;
 795
 796               if (CRM_Utils_Array::value($i, CRM_Utils_Array::value($x, $mappingOperator))) {
 797                 $defaults["operator[$x][$i]"] = CRM_Utils_Array::value($i, $mappingOperator[$x]);
 798               }
 799
 800               if (CRM_Utils_Array::value($i, CRM_Utils_Array::value($x, $mappingValue))) {
 801                 $defaults["value[$x][$i]"] = CRM_Utils_Array::value($i, $mappingValue[$x]);
 802               }
 803             }
 804           }
 805         }
 806         //Fix for Search Builder
 807         if ($mappingType == 'Export') {
 808           $j = 7;
 809         }
 810         else {
 811           $j = 4;
 812         }
 813
 814         $formValues = $form->exportValues();
 815         if (!$jsSet) {
 816           if (empty($formValues)) {
 817             // Incremented length for third select box(relationship type)
 818             for ($k = 1; $k < $j; $k++) {
 819               $noneArray[] = array($x, $i, $k);
 820             }
 821           }
 822           else {
 823             if (!empty($formValues['mapper'][$x])) {
 824               foreach ($formValues['mapper'][$x] as $value) {
 825                 for ($k = 1; $k < $j; $k++) {
 826                   if (!isset($formValues['mapper'][$x][$i][$k]) ||
 827                     (!$formValues['mapper'][$x][$i][$k])
 828                   ) {
 829                     $noneArray[] = array($x, $i, $k);
 830                   }
 831                   else {
 832                     $nullArray[] = array($x, $i, $k);
 833                   }
 834                 }
 835               }
 836             }
 837             else {
 838               for ($k = 1; $k < $j; $k++) {
 839                 $noneArray[] = array($x, $i, $k);
 840               }
 841             }
 842           }
 843         }
 844         //Fix for Search Builder
 845         if ($mappingType == 'Export') {
 846           if (!isset($mappingId) || $i >= count(reset($mappingName))) {
 847             if (isset($formValues['mapper']) &&
 848               isset($formValues['mapper'][$x][$i][1]) &&
 849               array_key_exists($formValues['mapper'][$x][$i][1], $relationshipTypes)
 850             ) {
 851               $sel->setOptions(array($sel1, $sel2, $sel5, $sel6, $sel7, $sel3, $sel4));
 852             }
 853             else {
 854               $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
 855             }
 856           }
 857           else {
 858             $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
 859           }
 860         }
 861         else {
 862           $sel->setOptions(array($sel1, $sel2, $sel3, $sel4));
 863         }
 864
 865         if ($mappingType == 'Search Builder') {
 866           //CRM -2292, restricted array set
 867           $operatorArray = array('' => ts('-operator-')) + CRM_Core_SelectValues::getSearchBuilderOperators();
 868
 869           $form->add('select', "operator[$x][$i]", '', $operatorArray);
 870           $form->add('text', "value[$x][$i]", '');
 871         }
 872       }
 873       //end of columnCnt for
 874       if ($mappingType == 'Search Builder') {
 875         $title = ts('Another search field');
 876       }
 877       else {
 878         $title = ts('Select more fields');
 879       }
 880
 881       $form->addElement('submit', "addMore[$x]", $title, array('class' => 'submit-link'));
 882     }
 883     //end of block for
 884
 885     $js = "<script type='text/javascript'>\n";
 886     $formName = "document.{$name}";
 887     if (!empty($nullArray)) {
 888       $js .= "var nullArray = [";
 889       $elements = array();
 890       $seen = array();
 891       foreach ($nullArray as $element) {
 892         $key = "{$element[0]}, {$element[1]}, {$element[2]}";
 893         if (!isset($seen[$key])) {
 894           $elements[] = "[$key]";
 895           $seen[$key] = 1;
 896         }
 897       }
 898       $js .= implode(', ', $elements);
 899       $js .= "]";
 900       $js .= "
 901                 for (var i=0;i<nullArray.length;i++) {
 902                     if ( {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'] ) {
 903                         {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'].style.display = '';
 904                     }
 905                 }
 906 ";
 907     }
 908     if (!empty($noneArray)) {
 909       $js .= "var noneArray = [";
 910       $elements = array();
 911       $seen = array();
 912       foreach ($noneArray as $element) {
 913         $key = "{$element[0]}, {$element[1]}, {$element[2]}";
 914         if (!isset($seen[$key])) {
 915           $elements[] = "[$key]";
 916           $seen[$key] = 1;
 917         }
 918       }
 919       $js .= implode(', ', $elements);
 920       $js .= "]";
 921       $js .= "
 922                 for (var i=0;i<noneArray.length;i++) {
 923                     if ( {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'] ) {
 924   {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'].style.display = 'none';
 925                     }
 926                 }
 927 ";
 928     }
 929     $js .= "</script>\n";
 930
 931     $form->assign('initHideBoxes', $js);
 932     $form->assign('columnCount', $columnCount);
 933     $form->assign('blockCount', $blockCount);
 934     $form->setDefaults($defaults);
 935
 936     $form->setDefaultAction('refresh');
 937   }
 938
 939   /**
 940    * Function returns all custom fields with group title and
 941    * field label
 942    *
 943    * @param int $relationshipTypeId
 944    *   Related relationship type id.
 945    *
 946    * @return array
 947    *   all custom field titles
 948    */
 949   public function getRelationTypeCustomGroupData($relationshipTypeId) {
 950
 951     $customFields = CRM_Core_BAO_CustomField::getFields('Relationship', NULL, NULL, $relationshipTypeId, NULL, NULL);
 952     $groupTitle = array();
 953     foreach ($customFields as $krelation => $vrelation) {
 954       $groupTitle[$vrelation['label']] = $vrelation['groupTitle'] . '...' . $vrelation['label'];
 955     }
 956     return $groupTitle;
 957   }
 958
 959
 960   /**
 961    * Function returns all  Custom group Names.
 962    *
 963    * @param int $customfieldId
 964    *   Related file id.
 965    *
 966    * @return null|string
 967    *   $customGroupName all custom group names
 968    */
 969   public static function getCustomGroupName($customfieldId) {
 970     if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($customfieldId)) {
 971       $customGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $customFieldId, 'custom_group_id');
 972       $customGroupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupId, 'title');
 973
 974       if (strlen($customGroupName) > 13) {
 975         $customGroupName = substr($customGroupName, 0, 10) . '...';
 976       }
 977
 978       return $customGroupName;
 979     }
 980   }
 981
 982   /**
 983    * Function returns associated array of elements, that will be passed for search
 984    *
 985    * @param array $params
 986    *   Associated array of submitted values.
 987    * @param bool $row
 988    *   Row no of the fields.
 989    *
 990    *
 991    * @return array
 992    *   formatted associated array of elements
 993    */
 994   public static function formattedFields(&$params, $row = FALSE) {
 995     $fields = array();
 996
 997     if (empty($params) || !isset($params['mapper'])) {
 998       return $fields;
 999     }
1000
1001     $types = array('Individual', 'Organization', 'Household');
1002     foreach ($params['mapper'] as $key => $value) {
1003       $contactType = NULL;
1004       foreach ($value as $k => $v) {
1005         if (in_array($v[0], $types)) {
1006           if ($contactType && $contactType != $v[0]) {
1007             CRM_Core_Error::fatal(ts("Cannot have two clauses with different types: %1, %2",
1008               array(1 => $contactType, 2 => $v[0])
1009             ));
1010           }
1011           $contactType = $v[0];
1012         }
1013         if (!empty($v['1'])) {
1014           $fldName = $v[1];
1015           $v2 = CRM_Utils_Array::value('2', $v);
1016           if ($v2 && trim($v2)) {
1017             $fldName .= "-{$v[2]}";
1018           }
1019
1020           $v3 = CRM_Utils_Array::value('3', $v);
1021           if ($v3 && trim($v3)) {
1022             $fldName .= "-{$v[3]}";
1023           }
1024
1025           $value = $params['value'][$key][$k];
1026           if ($fldName == 'group' || $fldName == 'tag') {
1027             $value = trim($value);
1028             $value = str_replace('(', '', $value);
1029             $value = str_replace(')', '', $value);
1030
1031             $v = explode(',', $value);
1032             $value = array();
1033             foreach ($v as $i) {
1034               $value[$i] = 1;
1035             }
1036           }
1037
1038           if ($v[0] == 'Contribution' && substr($fldName, 0, 7) != 'custom_'
1039             && substr($fldName, 0, 10) != 'financial_'
1040             && substr($fldName, 0, 8) != 'payment_') {
1041             if (substr($fldName, 0, 13) != 'contribution_') {
1042               $fldName = 'contribution_' . $fldName;
1043             }
1044           }
1045
1046           // CRM-14563: we store checkbox, multi-select and adv-multi select custom field using separator, hence it
1047           // needs special handling.
1048           if ($cfID = CRM_Core_BAO_CustomField::getKeyID($v[1])) {
1049             $isCustomField = TRUE;
1050             $customFieldType = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $cfID, 'html_type');
1051             $specialHTMLType = array(
1052               'CheckBox',
1053               'Multi-Select',
1054               'AdvMulti-Select',
1055               'Multi-Select State/Province',
1056               'Multi-Select Country',
1057             );
1058
1059             // override the operator to handle separator ( note: this might have some performance issues )
1060             if (in_array($customFieldType, $specialHTMLType)) {
1061               // FIX ME: != and few other operators are not handled
1062               $specialOperators = array('=', 'IN', 'LIKE');
1063
1064               if (in_array($params['operator'][$key][$k], $specialOperators)) {
1065                 $params['operator'][$key][$k] = 'RLIKE';
1066               }
1067             }
1068           }
1069
1070           // CRM-14983: verify if values are comma separated convert to array
1071           if (!is_array($value) && (strpos($value, ',') !== FALSE || strstr($value, '(')) && empty($isCustomField) && $params['operator'][$key][$k] == 'IN') {
1072             preg_match('#\((.*?)\)#', $value, $match);
1073             $tmpArray = explode(',', $match[1]);
1074             $value = array_combine(array_values($tmpArray), array_values($tmpArray));
1075           }
1076
1077           if ($row) {
1078             $fields[] = array(
1079               $fldName,
1080               $params['operator'][$key][$k],
1081               $value,
1082               $key,
1083               $k,
1084             );
1085           }
1086           else {
1087             $fields[] = array(
1088               $fldName,
1089               $params['operator'][$key][$k],
1090               $value,
1091               $key,
1092               0,
1093             );
1094           }
1095         }
1096       }
1097       if ($contactType) {
1098         $fields[] = array(
1099           'contact_type',
1100           '=',
1101           $contactType,
1102           $key,
1103           0,
1104         );
1105       }
1106     }
1107
1108     //add sortByCharacter values
1109     if (isset($params['sortByCharacter'])) {
1110       $fields[] = array(
1111         'sortByCharacter',
1112         '=',
1113         $params['sortByCharacter'],
1114         0,
1115         0,
1116       );
1117     }
1118     return $fields;
1119   }
1120
1121   /**
1122    * @param array $params
1123    *
1124    * @return array
1125    */
1126   public static function &returnProperties(&$params) {
1127     $fields = array(
1128       'contact_type' => 1,
1129       'contact_sub_type' => 1,
1130       'sort_name' => 1,
1131     );
1132
1133     if (empty($params) || empty($params['mapper'])) {
1134       return $fields;
1135     }
1136
1137     $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1138     foreach ($params['mapper'] as $key => $value) {
1139       foreach ($value as $k => $v) {
1140         if (isset($v[1])) {
1141           if ($v[1] == 'groups' || $v[1] == 'tags') {
1142             continue;
1143           }
1144
1145           if (isset($v[2]) && is_numeric($v[2])) {
1146             if (!array_key_exists('location', $fields)) {
1147               $fields['location'] = array();
1148             }
1149
1150             // make sure that we have a location fields and a location type for this
1151             $locationName = $locationTypes[$v[2]];
1152             if (!array_key_exists($locationName, $fields['location'])) {
1153               $fields['location'][$locationName] = array();
1154               $fields['location'][$locationName]['location_type'] = $v[2];
1155             }
1156
1157             if ($v[1] == 'phone' || $v[1] == 'email' || $v[1] == 'im') {
1158               // phone type handling
1159               if (isset($v[3])) {
1160                 $fields['location'][$locationName][$v[1] . "-" . $v[3]] = 1;
1161               }
1162               else {
1163                 $fields['location'][$locationName][$v[1]] = 1;
1164               }
1165             }
1166             else {
1167               $fields['location'][$locationName][$v[1]] = 1;
1168             }
1169           }
1170           else {
1171             $fields[$v[1]] = 1;
1172           }
1173         }
1174       }
1175     }
1176
1177     return $fields;
1178   }
1179
1180   /**
1181    * Save the mapping field info for search builder / export given the formvalues
1182    *
1183    * @param array $params
1184    *   Asscociated array of formvalues.
1185    * @param int $mappingId
1186    *   Mapping id.
1187    *
1188    * @return NULL
1189    */
1190   public static function saveMappingFields(&$params, $mappingId) {
1191     //delete mapping fields records for exixting mapping
1192     $mappingFields = new CRM_Core_DAO_MappingField();
1193     $mappingFields->mapping_id = $mappingId;
1194     $mappingFields->delete();
1195
1196     if (empty($params['mapper'])) {
1197       return NULL;
1198     }
1199
1200     //save record in mapping field table
1201     foreach ($params['mapper'] as $key => $value) {
1202       $colCnt = 0;
1203       foreach ($value as $k => $v) {
1204
1205         if (!empty($v['1'])) {
1206           $saveMappingFields = new CRM_Core_DAO_MappingField();
1207
1208           $saveMappingFields->mapping_id = $mappingId;
1209           $saveMappingFields->name = CRM_Utils_Array::value('1', $v);
1210           $saveMappingFields->contact_type = CRM_Utils_Array::value('0', $v);
1211           $locationId = CRM_Utils_Array::value('2', $v);
1212           $saveMappingFields->location_type_id = is_numeric($locationId) ? $locationId : NULL;
1213
1214           if ($v[1] == 'phone') {
1215             $saveMappingFields->phone_type_id = CRM_Utils_Array::value('3', $v);
1216           }
1217           elseif ($v[1] == 'im') {
1218             $saveMappingFields->im_provider_id = CRM_Utils_Array::value('3', $v);
1219           }
1220
1221           if (!empty($params['operator'])) {
1222             $saveMappingFields->operator = CRM_Utils_Array::value($k, $params['operator'][$key]);
1223           }
1224           if (!empty($params['value'])) {
1225             $saveMappingFields->value = CRM_Utils_Array::value($k, $params['value'][$key]);
1226           }
1227           // Handle mapping for 'related contact' fields
1228           if (count(explode('_', CRM_Utils_Array::value('1', $v))) > 2) {
1229             list($id, $first, $second) = explode('_', CRM_Utils_Array::value('1', $v));
1230             if (($first == 'a' && $second == 'b') || ($first == 'b' && $second == 'a')) {
1231
1232               if (!empty($v['2'])) {
1233                 $saveMappingFields->name = CRM_Utils_Array::value('2', $v);
1234               }
1235               elseif (!empty($v['4'])) {
1236                 $saveMappingFields->name = CRM_Utils_Array::value('4', $v);
1237               }
1238
1239               if (is_numeric(CRM_Utils_Array::value('3', $v))) {
1240                 $locationTypeid = CRM_Utils_Array::value('3', $v);
1241               }
1242               elseif (is_numeric(CRM_Utils_Array::value('5', $v))) {
1243                 $locationTypeid = CRM_Utils_Array::value('5', $v);
1244               }
1245
1246               if (is_numeric(CRM_Utils_Array::value('4', $v))) {
1247                 $phoneTypeid = CRM_Utils_Array::value('4', $v);
1248               }
1249               elseif (is_numeric(CRM_Utils_Array::value('6', $v))) {
1250                 $phoneTypeid = CRM_Utils_Array::value('6', $v);
1251               }
1252
1253               $saveMappingFields->location_type_id = is_numeric($locationTypeid) ? $locationTypeid : NULL;
1254               $saveMappingFields->phone_type_id = is_numeric($phoneTypeid) ? $phoneTypeid : NULL;
1255               $saveMappingFields->relationship_type_id = $id;
1256               $saveMappingFields->relationship_direction = "{$first}_{$second}";
1257             }
1258           }
1259
1260           $saveMappingFields->grouping = $key;
1261           $saveMappingFields->column_number = $colCnt;
1262           $saveMappingFields->save();
1263           $colCnt++;
1264           $locationTypeid = $phoneTypeid = NULL;
1265         }
1266       }
1267     }
1268   }
1269
1270 }