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           $componentPaymentFields = array();
 418           foreach (CRM_Export_BAO_Export::componentPaymentFields() as $payField => $payTitle) {
 419             $componentPaymentFields[$payField] = array('title' => $payTitle);
 420           }
 421           $fields['Participant'] = array_merge($fields['Participant'], $componentPaymentFields);
 422         }
 423
 424         $compArray['Participant'] = ts('Participant');
 425       }
 426     }
 427
 428     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT)) {
 429       if (CRM_Core_Permission::access('CiviMember')) {
 430         $fields['Membership'] = CRM_Member_BAO_Membership::getMembershipFields($exportMode);
 431         unset($fields['Membership']['membership_contact_id']);
 432         $compArray['Membership'] = ts('Membership');
 433       }
 434     }
 435
 436     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT)) {
 437       if (CRM_Core_Permission::access('CiviPledge')) {
 438         $fields['Pledge'] = CRM_Pledge_BAO_Pledge::exportableFields();
 439         unset($fields['Pledge']['pledge_contact_id']);
 440         $compArray['Pledge'] = ts('Pledge');
 441       }
 442     }
 443
 444     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::CASE_EXPORT)) {
 445       if (CRM_Core_Permission::access('CiviCase')) {
 446         $fields['Case'] = CRM_Case_BAO_Case::exportableFields();
 447         $compArray['Case'] = ts('Case');
 448
 449         $fields['Activity'] = CRM_Activity_BAO_Activity::exportableFields('Case');
 450         $compArray['Activity'] = ts('Case Activity');
 451
 452         unset($fields['Case']['case_contact_id']);
 453       }
 454     }
 455     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::GRANT_EXPORT)) {
 456       if (CRM_Core_Permission::access('CiviGrant')) {
 457         $fields['Grant'] = CRM_Grant_BAO_Grant::exportableFields();
 458         unset($fields['Grant']['grant_contact_id']);
 459         if ($mappingType == 'Search Builder') {
 460           unset($fields['Grant']['grant_type_id']);
 461         }
 462         $compArray['Grant'] = ts('Grant');
 463       }
 464     }
 465
 466     if (($mappingType == 'Search Builder') || ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT)) {
 467       $fields['Activity'] = CRM_Activity_BAO_Activity::exportableFields('Activity');
 468       $compArray['Activity'] = ts('Activity');
 469     }
 470
 471     //Contact Sub Type For export
 472     $contactSubTypes = array();
 473     $subTypes = CRM_Contact_BAO_ContactType::subTypeInfo();
 474
 475     foreach ($subTypes as $subType => $val) {
 476       //adding subtype specific relationships CRM-5256
 477       $csRelationships = array();
 478
 479       if ($mappingType == 'Export') {
 480         $subTypeRelationshipTypes
 481           = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, $val['parent'],
 482             FALSE, 'label', TRUE, $subType);
 483
 484         foreach ($subTypeRelationshipTypes as $key => $var) {
 485           if (!array_key_exists($key, $fields[$val['parent']])) {
 486             list($type) = explode('_', $key);
 487
 488             $csRelationships[$key]['title'] = $var;
 489             $csRelationships[$key]['headerPattern'] = '/' . preg_quote($var, '/') . '/';
 490             $csRelationships[$key]['export'] = TRUE;
 491             $csRelationships[$key]['relationship_type_id'] = $type;
 492             $csRelationships[$key]['related'] = TRUE;
 493             $csRelationships[$key]['hasRelationType'] = 1;
 494           }
 495         }
 496       }
 497
 498       $fields[$subType] = $fields[$val['parent']] + $csRelationships;
 499
 500       //custom fields for sub type
 501       $subTypeFields = CRM_Core_BAO_CustomField::getFieldsForImport($subType);
 502       $fields[$subType] += $subTypeFields;
 503
 504       if (!empty($subTypeFields) || !empty($csRelationships)) {
 505         $contactSubTypes[$subType] = $val['label'];
 506       }
 507     }
 508
 509     unset($subTypes);
 510
 511     foreach ($fields as $key => $value) {
 512
 513       foreach ($value as $key1 => $value1) {
 514         //CRM-2676, replacing the conflict for same custom field name from different custom group.
 515         $customGroupName = self::getCustomGroupName($key1);
 516
 517         if ($customGroupName) {
 518           $relatedMapperFields[$key][$key1] = $mapperFields[$key][$key1] = $customGroupName . ': ' . $value1['title'];
 519         }
 520         else {
 521           $relatedMapperFields[$key][$key1] = $mapperFields[$key][$key1] = $value1['title'];
 522         }
 523         if (isset($value1['hasLocationType'])) {
 524           $hasLocationTypes[$key][$key1] = $value1['hasLocationType'];
 525         }
 526
 527         if (isset($value1['hasRelationType'])) {
 528           $hasRelationTypes[$key][$key1] = $value1['hasRelationType'];
 529           unset($relatedMapperFields[$key][$key1]);
 530         }
 531       }
 532
 533       if (array_key_exists('related', $relatedMapperFields[$key])) {
 534         unset($relatedMapperFields[$key]['related']);
 535       }
 536     }
 537
 538     $mapperKeys = array_keys($mapperFields);
 539
 540     $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 541
 542     $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 543
 544     // FIXME: dirty hack to make the default option show up first.  This
 545     // avoids a mozilla browser bug with defaults on dynamically constructed
 546     // selector widgets.
 547     if ($defaultLocationType) {
 548       $defaultLocation = $locationTypes[$defaultLocationType->id];
 549       unset($locationTypes[$defaultLocationType->id]);
 550       $locationTypes = array($defaultLocationType->id => $defaultLocation) + $locationTypes;
 551     }
 552
 553     $locationTypes = array(' ' => ts('Primary')) + $locationTypes;
 554
 555     // since we need a hierarchical list to display contact types & subtypes,
 556     // this is what we going to display in first selector
 557     $contactTypes = CRM_Contact_BAO_ContactType::getSelectElements(FALSE, FALSE);
 558     if ($mappingType == 'Search Builder') {
 559       $contactTypes = array('Contact' => ts('Contacts')) + $contactTypes;
 560     }
 561
 562     $sel1 = array('' => ts('- select record type -')) + $contactTypes + $compArray;
 563
 564     foreach ($sel1 as $key => $sel) {
 565       if ($key) {
 566         // sort everything BUT the contactType which is sorted seperately by
 567         // an initial commit of CRM-13278 (check ksort above)
 568         if (!in_array($key, $contactType)) {
 569           asort($mapperFields[$key]);
 570         }
 571         $sel2[$key] = array('' => ts('- select field -')) + $mapperFields[$key];
 572       }
 573     }
 574
 575     $sel3[''] = NULL;
 576     $sel5[''] = NULL;
 577     $phoneTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id');
 578     $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
 579     asort($phoneTypes);
 580
 581     foreach ($sel1 as $k => $sel) {
 582       if ($k) {
 583         foreach ($locationTypes as $key => $value) {
 584           if (trim($key) != '') {
 585             $sel4[$k]['phone'][$key] = &$phoneTypes;
 586             $sel4[$k]['im'][$key] = &$imProviders;
 587           }
 588         }
 589       }
 590     }
 591
 592     foreach ($sel1 as $k => $sel) {
 593       if ($k) {
 594         foreach ($mapperFields[$k] as $key => $value) {
 595           if (isset($hasLocationTypes[$k][$key])) {
 596             $sel3[$k][$key] = $locationTypes;
 597           }
 598           else {
 599             $sel3[$key] = NULL;
 600           }
 601         }
 602       }
 603     }
 604
 605     // Array for core fields and relationship custom data
 606     $relationshipTypes = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
 607
 608     if ($mappingType == 'Export') {
 609       foreach ($sel1 as $k => $sel) {
 610         if ($k) {
 611           foreach ($mapperFields[$k] as $field => $dontCare) {
 612             if (isset($hasRelationTypes[$k][$field])) {
 613               list($id, $first, $second) = explode('_', $field);
 614               // FIX ME: For now let's not expose custom data related to relationship
 615               $relationshipCustomFields = array();
 616               //$relationshipCustomFields    = self::getRelationTypeCustomGroupData( $id );
 617               //asort($relationshipCustomFields);
 618
 619               $relationshipType = new CRM_Contact_BAO_RelationshipType();
 620               $relationshipType->id = $id;
 621               if ($relationshipType->find(TRUE)) {
 622                 $direction = "contact_sub_type_$second";
 623                 if (isset($relationshipType->$direction)) {
 624                   $relatedFields = array_merge((array) $relatedMapperFields[$relationshipType->$direction], (array) $relationshipCustomFields);
 625                 }
 626                 else {
 627                   $target_type = 'contact_type_' . $second;
 628                   $relatedFields = array_merge((array) $relatedMapperFields[$relationshipType->$target_type], (array) $relationshipCustomFields);
 629                 }
 630               }
 631               $relationshipType->free();
 632               asort($relatedFields);
 633               $sel5[$k][$field] = $relatedFields;
 634             }
 635           }
 636         }
 637       }
 638
 639       //Location Type for relationship fields
 640       foreach ($sel5 as $k => $v) {
 641         if ($v) {
 642           foreach ($v as $rel => $fields) {
 643             foreach ($fields as $field => $fieldLabel) {
 644               if (isset($hasLocationTypes[$k][$field])) {
 645                 $sel6[$k][$rel][$field] = $locationTypes;
 646               }
 647             }
 648           }
 649         }
 650       }
 651
 652       //PhoneTypes for  relationship fields
 653       $sel7[''] = NULL;
 654       foreach ($sel6 as $k => $rel) {
 655         if ($k) {
 656           foreach ($rel as $phonekey => $phonevalue) {
 657             foreach ($locationTypes as $locType => $loc) {
 658               if (trim($locType) != '') {
 659                 $sel7[$k][$phonekey]['phone'][$locType] = &$phoneTypes;
 660                 $sel7[$k][$phonekey]['im'][$locType] = &$imProviders;
 661               }
 662             }
 663           }
 664         }
 665       }
 666     }
 667
 668     //special fields that have location, hack for primary location
 669     $specialFields = array(
 670       'street_address',
 671       'supplemental_address_1',
 672       'supplemental_address_2',
 673       'city',
 674       'postal_code',
 675       'postal_code_suffix',
 676       'geo_code_1',
 677       'geo_code_2',
 678       'state_province',
 679       'country',
 680       'phone',
 681       'email',
 682       'im',
 683     );
 684
 685     if (isset($mappingId)) {
 686       $colCnt = 0;
 687
 688       list($mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType, $mappingImProvider,
 689         $mappingRelation, $mappingOperator, $mappingValue
 690         ) = CRM_Core_BAO_Mapping::getMappingFields($mappingId);
 691
 692       $blkCnt = count($mappingName);
 693       if ($blkCnt >= $blockCount) {
 694         $blockCount = $blkCnt + 1;
 695       }
 696       for ($x = 1; $x < $blockCount; $x++) {
 697         if (isset($mappingName[$x])) {
 698           $colCnt = count($mappingName[$x]);
 699           if ($colCnt >= $columnCount[$x]) {
 700             $columnCount[$x] = $colCnt;
 701           }
 702         }
 703       }
 704     }
 705
 706     $form->_blockCount = $blockCount;
 707     $form->_columnCount = $columnCount;
 708
 709     $form->set('blockCount', $form->_blockCount);
 710     $form->set('columnCount', $form->_columnCount);
 711
 712     $defaults = $noneArray = $nullArray = array();
 713
 714     //used to warn for mismatch column count or mismatch mapping
 715     $warning = 0;
 716     for ($x = 1; $x < $blockCount; $x++) {
 717
 718       for ($i = 0; $i < $columnCount[$x]; $i++) {
 719
 720         $sel = &$form->addElement('hierselect', "mapper[$x][$i]", ts('Mapper for Field %1', array(1 => $i)), NULL);
 721         $jsSet = FALSE;
 722
 723         if (isset($mappingId)) {
 724           $locationId = isset($mappingLocation[$x][$i]) ? $mappingLocation[$x][$i] : 0;
 725           if (isset($mappingName[$x][$i])) {
 726             if (is_array($mapperFields[$mappingContactType[$x][$i]])) {
 727
 728               if (isset($mappingRelation[$x][$i])) {
 729
 730                 $contactDetails = strtolower(str_replace(" ", "_", $mappingName[$x][$i]));
 731                 $relLocationId = isset($mappingLocation[$x][$i]) ? $mappingLocation[$x][$i] : 0;
 732                 if (!$relLocationId && in_array($mappingName[$x][$i], $specialFields)) {
 733                   $relLocationId = " ";
 734                 }
 735
 736                 $relPhoneType = isset($mappingPhoneType[$x][$i]) ? $mappingPhoneType[$x][$i] : NULL;
 737
 738                 $defaults["mapper[$x][$i]"] = array(
 739                   $mappingContactType[$x][$i],
 740                   $mappingRelation[$x][$i],
 741                   $locationId,
 742                   $phoneType,
 743                   $mappingName[$x][$i],
 744                   $relLocationId,
 745                   $relPhoneType,
 746                 );
 747
 748                 if (!$locationId) {
 749                   $noneArray[] = array($x, $i, 2);
 750                 }
 751                 if (!$phoneType && !$imProvider) {
 752                   $noneArray[] = array($x, $i, 3);
 753                 }
 754                 if (!$mappingName[$x][$i]) {
 755                   $noneArray[] = array($x, $i, 4);
 756                 }
 757                 if (!$relLocationId) {
 758                   $noneArray[] = array($x, $i, 5);
 759                 }
 760                 if (!$relPhoneType) {
 761                   $noneArray[] = array($x, $i, 6);
 762                 }
 763                 $noneArray[] = array($x, $i, 2);
 764               }
 765               else {
 766                 $phoneType = isset($mappingPhoneType[$x][$i]) ? $mappingPhoneType[$x][$i] : NULL;
 767                 $imProvider = isset($mappingImProvider[$x][$i]) ? $mappingImProvider[$x][$i] : NULL;
 768                 if (!$locationId && in_array($mappingName[$x][$i], $specialFields)) {
 769                   $locationId = " ";
 770                 }
 771
 772                 $defaults["mapper[$x][$i]"] = array(
 773                   $mappingContactType[$x][$i],
 774                   $mappingName[$x][$i],
 775                   $locationId,
 776                   $phoneType,
 777                 );
 778                 if (!$mappingName[$x][$i]) {
 779                   $noneArray[] = array($x, $i, 1);
 780                 }
 781                 if (!$locationId) {
 782                   $noneArray[] = array($x, $i, 2);
 783                 }
 784                 if (!$phoneType && !$imProvider) {
 785                   $noneArray[] = array($x, $i, 3);
 786                 }
 787
 788                 $noneArray[] = array($x, $i, 4);
 789                 $noneArray[] = array($x, $i, 5);
 790                 $noneArray[] = array($x, $i, 6);
 791               }
 792
 793               $jsSet = TRUE;
 794
 795               if (CRM_Utils_Array::value($i, CRM_Utils_Array::value($x, $mappingOperator))) {
 796                 $defaults["operator[$x][$i]"] = CRM_Utils_Array::value($i, $mappingOperator[$x]);
 797               }
 798
 799               if (CRM_Utils_Array::value($i, CRM_Utils_Array::value($x, $mappingValue))) {
 800                 $defaults["value[$x][$i]"] = CRM_Utils_Array::value($i, $mappingValue[$x]);
 801               }
 802             }
 803           }
 804         }
 805         //Fix for Search Builder
 806         if ($mappingType == 'Export') {
 807           $j = 7;
 808         }
 809         else {
 810           $j = 4;
 811         }
 812
 813         $formValues = $form->exportValues();
 814         if (!$jsSet) {
 815           if (empty($formValues)) {
 816             // Incremented length for third select box(relationship type)
 817             for ($k = 1; $k < $j; $k++) {
 818               $noneArray[] = array($x, $i, $k);
 819             }
 820           }
 821           else {
 822             if (!empty($formValues['mapper'][$x])) {
 823               foreach ($formValues['mapper'][$x] as $value) {
 824                 for ($k = 1; $k < $j; $k++) {
 825                   if (!isset($formValues['mapper'][$x][$i][$k]) ||
 826                     (!$formValues['mapper'][$x][$i][$k])
 827                   ) {
 828                     $noneArray[] = array($x, $i, $k);
 829                   }
 830                   else {
 831                     $nullArray[] = array($x, $i, $k);
 832                   }
 833                 }
 834               }
 835             }
 836             else {
 837               for ($k = 1; $k < $j; $k++) {
 838                 $noneArray[] = array($x, $i, $k);
 839               }
 840             }
 841           }
 842         }
 843         //Fix for Search Builder
 844         if ($mappingType == 'Export') {
 845           if (!isset($mappingId) || $i >= count(reset($mappingName))) {
 846             if (isset($formValues['mapper']) &&
 847               isset($formValues['mapper'][$x][$i][1]) &&
 848               array_key_exists($formValues['mapper'][$x][$i][1], $relationshipTypes)
 849             ) {
 850               $sel->setOptions(array($sel1, $sel2, $sel5, $sel6, $sel7, $sel3, $sel4));
 851             }
 852             else {
 853               $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
 854             }
 855           }
 856           else {
 857             $sel->setOptions(array($sel1, $sel2, $sel3, $sel4, $sel5, $sel6, $sel7));
 858           }
 859         }
 860         else {
 861           $sel->setOptions(array($sel1, $sel2, $sel3, $sel4));
 862         }
 863
 864         if ($mappingType == 'Search Builder') {
 865           //CRM -2292, restricted array set
 866           $operatorArray = array('' => ts('-operator-')) + CRM_Core_SelectValues::getSearchBuilderOperators();
 867
 868           $form->add('select', "operator[$x][$i]", '', $operatorArray);
 869           $form->add('text', "value[$x][$i]", '');
 870         }
 871       }
 872       //end of columnCnt for
 873       if ($mappingType == 'Search Builder') {
 874         $title = ts('Another search field');
 875       }
 876       else {
 877         $title = ts('Select more fields');
 878       }
 879
 880       $form->addElement('submit', "addMore[$x]", $title, array('class' => 'submit-link'));
 881     }
 882     //end of block for
 883
 884     $js = "<script type='text/javascript'>\n";
 885     $formName = "document.{$name}";
 886     if (!empty($nullArray)) {
 887       $js .= "var nullArray = [";
 888       $elements = array();
 889       $seen = array();
 890       foreach ($nullArray as $element) {
 891         $key = "{$element[0]}, {$element[1]}, {$element[2]}";
 892         if (!isset($seen[$key])) {
 893           $elements[] = "[$key]";
 894           $seen[$key] = 1;
 895         }
 896       }
 897       $js .= implode(', ', $elements);
 898       $js .= "]";
 899       $js .= "
 900                 for (var i=0;i<nullArray.length;i++) {
 901                     if ( {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'] ) {
 902                         {$formName}['mapper['+nullArray[i][0]+']['+nullArray[i][1]+']['+nullArray[i][2]+']'].style.display = '';
 903                     }
 904                 }
 905 ";
 906     }
 907     if (!empty($noneArray)) {
 908       $js .= "var noneArray = [";
 909       $elements = array();
 910       $seen = array();
 911       foreach ($noneArray as $element) {
 912         $key = "{$element[0]}, {$element[1]}, {$element[2]}";
 913         if (!isset($seen[$key])) {
 914           $elements[] = "[$key]";
 915           $seen[$key] = 1;
 916         }
 917       }
 918       $js .= implode(', ', $elements);
 919       $js .= "]";
 920       $js .= "
 921                 for (var i=0;i<noneArray.length;i++) {
 922                     if ( {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'] ) {
 923   {$formName}['mapper['+noneArray[i][0]+']['+noneArray[i][1]+']['+noneArray[i][2]+']'].style.display = 'none';
 924                     }
 925                 }
 926 ";
 927     }
 928     $js .= "</script>\n";
 929
 930     $form->assign('initHideBoxes', $js);
 931     $form->assign('columnCount', $columnCount);
 932     $form->assign('blockCount', $blockCount);
 933     $form->setDefaults($defaults);
 934
 935     $form->setDefaultAction('refresh');
 936   }
 937
 938   /**
 939    * Function returns all custom fields with group title and
 940    * field label
 941    *
 942    * @param int $relationshipTypeId
 943    *   Related relationship type id.
 944    *
 945    * @return array
 946    *   all custom field titles
 947    */
 948   public function getRelationTypeCustomGroupData($relationshipTypeId) {
 949
 950     $customFields = CRM_Core_BAO_CustomField::getFields('Relationship', NULL, NULL, $relationshipTypeId, NULL, NULL);
 951     $groupTitle = array();
 952     foreach ($customFields as $krelation => $vrelation) {
 953       $groupTitle[$vrelation['label']] = $vrelation['groupTitle'] . '...' . $vrelation['label'];
 954     }
 955     return $groupTitle;
 956   }
 957
 958
 959   /**
 960    * Function returns all  Custom group Names.
 961    *
 962    * @param int $customfieldId
 963    *   Related file id.
 964    *
 965    * @return null|string
 966    *   $customGroupName all custom group names
 967    */
 968   public static function getCustomGroupName($customfieldId) {
 969     if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($customfieldId)) {
 970       $customGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $customFieldId, 'custom_group_id');
 971       $customGroupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupId, 'title');
 972
 973       if (strlen($customGroupName) > 13) {
 974         $customGroupName = substr($customGroupName, 0, 10) . '...';
 975       }
 976
 977       return $customGroupName;
 978     }
 979   }
 980
 981   /**
 982    * Function returns associated array of elements, that will be passed for search
 983    *
 984    * @param array $params
 985    *   Associated array of submitted values.
 986    * @param bool $row
 987    *   Row no of the fields.
 988    *
 989    *
 990    * @return array
 991    *   formatted associated array of elements
 992    */
 993   public static function formattedFields(&$params, $row = FALSE) {
 994     $fields = array();
 995
 996     if (empty($params) || !isset($params['mapper'])) {
 997       return $fields;
 998     }
 999
1000     $types = array('Individual', 'Organization', 'Household');
1001     foreach ($params['mapper'] as $key => $value) {
1002       $contactType = NULL;
1003       foreach ($value as $k => $v) {
1004         if (in_array($v[0], $types)) {
1005           if ($contactType && $contactType != $v[0]) {
1006             CRM_Core_Error::fatal(ts("Cannot have two clauses with different types: %1, %2",
1007               array(1 => $contactType, 2 => $v[0])
1008             ));
1009           }
1010           $contactType = $v[0];
1011         }
1012         if (!empty($v['1'])) {
1013           $fldName = $v[1];
1014           $v2 = CRM_Utils_Array::value('2', $v);
1015           if ($v2 && trim($v2)) {
1016             $fldName .= "-{$v[2]}";
1017           }
1018
1019           $v3 = CRM_Utils_Array::value('3', $v);
1020           if ($v3 && trim($v3)) {
1021             $fldName .= "-{$v[3]}";
1022           }
1023
1024           $value = $params['value'][$key][$k];
1025           if ($fldName == 'group' || $fldName == 'tag') {
1026             $value = trim($value);
1027             $value = str_replace('(', '', $value);
1028             $value = str_replace(')', '', $value);
1029
1030             $v = explode(',', $value);
1031             $value = array();
1032             foreach ($v as $i) {
1033               $value[$i] = 1;
1034             }
1035           }
1036
1037           if ($v[0] == 'Contribution' && substr($fldName, 0, 7) != 'custom_'
1038             && substr($fldName, 0, 10) != 'financial_'
1039             && substr($fldName, 0, 8) != 'payment_') {
1040             if (substr($fldName, 0, 13) != 'contribution_') {
1041               $fldName = 'contribution_' . $fldName;
1042             }
1043           }
1044
1045           // CRM-14563: we store checkbox, multi-select and adv-multi select custom field using separator, hence it
1046           // needs special handling.
1047           if ($cfID = CRM_Core_BAO_CustomField::getKeyID($v[1])) {
1048             $isCustomField = TRUE;
1049             $customFieldType = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $cfID, 'html_type');
1050             $specialHTMLType = array(
1051               'CheckBox',
1052               'Multi-Select',
1053               'AdvMulti-Select',
1054               'Multi-Select State/Province',
1055               'Multi-Select Country',
1056             );
1057
1058             // override the operator to handle separator ( note: this might have some performance issues )
1059             if (in_array($customFieldType, $specialHTMLType)) {
1060               // FIX ME: != and few other operators are not handled
1061               $specialOperators = array('=', 'IN', 'LIKE');
1062
1063               if (in_array($params['operator'][$key][$k], $specialOperators)) {
1064                 $params['operator'][$key][$k] = 'RLIKE';
1065               }
1066             }
1067           }
1068
1069           // CRM-14983: verify if values are comma separated convert to array
1070           if (!is_array($value) && (strpos($value, ',') !== FALSE || strstr($value, '(')) && empty($isCustomField) && $params['operator'][$key][$k] == 'IN') {
1071             preg_match('#\((.*?)\)#', $value, $match);
1072             $tmpArray = explode(',', $match[1]);
1073             $value = array_combine(array_values($tmpArray), array_values($tmpArray));
1074           }
1075
1076           if ($row) {
1077             $fields[] = array(
1078               $fldName,
1079               $params['operator'][$key][$k],
1080               $value,
1081               $key,
1082               $k,
1083             );
1084           }
1085           else {
1086             $fields[] = array(
1087               $fldName,
1088               $params['operator'][$key][$k],
1089               $value,
1090               $key,
1091               0,
1092             );
1093           }
1094         }
1095       }
1096       if ($contactType) {
1097         $fields[] = array(
1098           'contact_type',
1099           '=',
1100           $contactType,
1101           $key,
1102           0,
1103         );
1104       }
1105     }
1106
1107     //add sortByCharacter values
1108     if (isset($params['sortByCharacter'])) {
1109       $fields[] = array(
1110         'sortByCharacter',
1111         '=',
1112         $params['sortByCharacter'],
1113         0,
1114         0,
1115       );
1116     }
1117     return $fields;
1118   }
1119
1120   /**
1121    * @param array $params
1122    *
1123    * @return array
1124    */
1125   public static function &returnProperties(&$params) {
1126     $fields = array(
1127       'contact_type' => 1,
1128       'contact_sub_type' => 1,
1129       'sort_name' => 1,
1130     );
1131
1132     if (empty($params) || empty($params['mapper'])) {
1133       return $fields;
1134     }
1135
1136     $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1137     foreach ($params['mapper'] as $key => $value) {
1138       foreach ($value as $k => $v) {
1139         if (isset($v[1])) {
1140           if ($v[1] == 'groups' || $v[1] == 'tags') {
1141             continue;
1142           }
1143
1144           if (isset($v[2]) && is_numeric($v[2])) {
1145             if (!array_key_exists('location', $fields)) {
1146               $fields['location'] = array();
1147             }
1148
1149             // make sure that we have a location fields and a location type for this
1150             $locationName = $locationTypes[$v[2]];
1151             if (!array_key_exists($locationName, $fields['location'])) {
1152               $fields['location'][$locationName] = array();
1153               $fields['location'][$locationName]['location_type'] = $v[2];
1154             }
1155
1156             if ($v[1] == 'phone' || $v[1] == 'email' || $v[1] == 'im') {
1157               // phone type handling
1158               if (isset($v[3])) {
1159                 $fields['location'][$locationName][$v[1] . "-" . $v[3]] = 1;
1160               }
1161               else {
1162                 $fields['location'][$locationName][$v[1]] = 1;
1163               }
1164             }
1165             else {
1166               $fields['location'][$locationName][$v[1]] = 1;
1167             }
1168           }
1169           else {
1170             $fields[$v[1]] = 1;
1171           }
1172         }
1173       }
1174     }
1175
1176     return $fields;
1177   }
1178
1179   /**
1180    * Save the mapping field info for search builder / export given the formvalues
1181    *
1182    * @param array $params
1183    *   Asscociated array of formvalues.
1184    * @param int $mappingId
1185    *   Mapping id.
1186    *
1187    * @return NULL
1188    */
1189   public static function saveMappingFields(&$params, $mappingId) {
1190     //delete mapping fields records for exixting mapping
1191     $mappingFields = new CRM_Core_DAO_MappingField();
1192     $mappingFields->mapping_id = $mappingId;
1193     $mappingFields->delete();
1194
1195     if (empty($params['mapper'])) {
1196       return NULL;
1197     }
1198
1199     //save record in mapping field table
1200     foreach ($params['mapper'] as $key => $value) {
1201       $colCnt = 0;
1202       foreach ($value as $k => $v) {
1203
1204         if (!empty($v['1'])) {
1205           $saveMappingFields = new CRM_Core_DAO_MappingField();
1206
1207           $saveMappingFields->mapping_id = $mappingId;
1208           $saveMappingFields->name = CRM_Utils_Array::value('1', $v);
1209           $saveMappingFields->contact_type = CRM_Utils_Array::value('0', $v);
1210           $locationId = CRM_Utils_Array::value('2', $v);
1211           $saveMappingFields->location_type_id = is_numeric($locationId) ? $locationId : NULL;
1212
1213           if ($v[1] == 'phone') {
1214             $saveMappingFields->phone_type_id = CRM_Utils_Array::value('3', $v);
1215           }
1216           elseif ($v[1] == 'im') {
1217             $saveMappingFields->im_provider_id = CRM_Utils_Array::value('3', $v);
1218           }
1219
1220           if (!empty($params['operator'])) {
1221             $saveMappingFields->operator = CRM_Utils_Array::value($k, $params['operator'][$key]);
1222           }
1223           if (!empty($params['value'])) {
1224             $saveMappingFields->value = CRM_Utils_Array::value($k, $params['value'][$key]);
1225           }
1226           // Handle mapping for 'related contact' fields
1227           if (count(explode('_', CRM_Utils_Array::value('1', $v))) > 2) {
1228             list($id, $first, $second) = explode('_', CRM_Utils_Array::value('1', $v));
1229             if (($first == 'a' && $second == 'b') || ($first == 'b' && $second == 'a')) {
1230
1231               if (!empty($v['2'])) {
1232                 $saveMappingFields->name = CRM_Utils_Array::value('2', $v);
1233               }
1234               elseif (!empty($v['4'])) {
1235                 $saveMappingFields->name = CRM_Utils_Array::value('4', $v);
1236               }
1237
1238               if (is_numeric(CRM_Utils_Array::value('3', $v))) {
1239                 $locationTypeid = CRM_Utils_Array::value('3', $v);
1240               }
1241               elseif (is_numeric(CRM_Utils_Array::value('5', $v))) {
1242                 $locationTypeid = CRM_Utils_Array::value('5', $v);
1243               }
1244
1245               if (is_numeric(CRM_Utils_Array::value('4', $v))) {
1246                 $phoneTypeid = CRM_Utils_Array::value('4', $v);
1247               }
1248               elseif (is_numeric(CRM_Utils_Array::value('6', $v))) {
1249                 $phoneTypeid = CRM_Utils_Array::value('6', $v);
1250               }
1251
1252               $saveMappingFields->location_type_id = is_numeric($locationTypeid) ? $locationTypeid : NULL;
1253               $saveMappingFields->phone_type_id = is_numeric($phoneTypeid) ? $phoneTypeid : NULL;
1254               $saveMappingFields->relationship_type_id = $id;
1255               $saveMappingFields->relationship_direction = "{$first}_{$second}";
1256             }
1257           }
1258
1259           $saveMappingFields->grouping = $key;
1260           $saveMappingFields->column_number = $colCnt;
1261           $saveMappingFields->save();
1262           $colCnt++;
1263           $locationTypeid = $phoneTypeid = NULL;
1264         }
1265       }
1266     }
1267   }
1268
1269 }