CRM/Contact/Form/Relationship.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  * This class generates form components for relationship.
  30  */
  31 class CRM_Contact_Form_Relationship extends CRM_Core_Form {
  32
  33   /**
  34    * The relationship id, used when editing the relationship
  35    *
  36    * @var int
  37    */
  38   public $_relationshipId;
  39
  40   /**
  41    * The contact id, used when add/edit relationship
  42    *
  43    * @var int
  44    */
  45   public $_contactId;
  46
  47   /**
  48    * This is a string which is either a_b or  b_a  used to determine the relationship between to contacts
  49    */
  50   public $_rtype;
  51
  52   /**
  53    * This is a string which is used to determine the relationship between to contacts
  54    */
  55   public $_rtypeId;
  56
  57   /**
  58    * Display name of contact a
  59    */
  60   public $_display_name_a;
  61
  62   /**
  63    * Display name of contact b
  64    */
  65   public $_display_name_b;
  66
  67   /**
  68    * The relationship type id
  69    *
  70    * @var int
  71    */
  72   public $_relationshipTypeId;
  73
  74   /**
  75    * An array of all relationship names
  76    *
  77    * @var array
  78    */
  79   public $_allRelationshipNames;
  80
  81   /**
  82    * @var bool
  83    */
  84   public $_enabled;
  85
  86   /**
  87    * @var bool
  88    */
  89   public $_isCurrentEmployer;
  90
  91   /**
  92    * @var string
  93    */
  94   public $_contactType;
  95
  96   /**
  97    * The relationship values if Updating relationship
  98    */
  99   public $_values;
 100
 101   /**
 102    * Casid if it called from case context
 103    */
 104   public $_caseId;
 105
 106   /**
 107    * @var mixed
 108    */
 109   public $_cdType;
 110
 111   public function preProcess() {
 112     //custom data related code
 113     $this->_cdType = CRM_Utils_Array::value('type', $_GET);
 114     $this->assign('cdType', FALSE);
 115     if ($this->_cdType) {
 116       $this->assign('cdType', TRUE);
 117       return CRM_Custom_Form_CustomData::preProcess($this);
 118     }
 119
 120     $this->_contactId = $this->get('contactId');
 121
 122     $this->_contactType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'contact_type');
 123
 124     $this->_relationshipId = $this->get('id');
 125
 126     $this->_rtype = CRM_Utils_Request::retrieve('rtype', 'String', $this);
 127
 128     $this->_rtypeId = CRM_Utils_Request::retrieve('relTypeId', 'String', $this);
 129
 130     $this->_display_name_a = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'display_name');
 131
 132     $this->assign('display_name_a', $this->_display_name_a);
 133
 134     // Set page title based on action
 135     switch ($this->_action) {
 136       case CRM_Core_Action::VIEW:
 137         CRM_Utils_System::setTitle(ts('View Relationship for %1', array(1 => $this->_display_name_a)));
 138         break;
 139
 140       case CRM_Core_Action::ADD:
 141         CRM_Utils_System::setTitle(ts('Add Relationship for %1', array(1 => $this->_display_name_a)));
 142         break;
 143
 144       case CRM_Core_Action::UPDATE:
 145         CRM_Utils_System::setTitle(ts('Edit Relationship for %1', array(1 => $this->_display_name_a)));
 146         break;
 147
 148       case CRM_Core_Action::DELETE:
 149         CRM_Utils_System::setTitle(ts('Delete Relationship for %1', array(1 => $this->_display_name_a)));
 150         break;
 151     }
 152
 153     $this->_caseId = CRM_Utils_Request::retrieve('caseID', 'Integer', $this);
 154
 155     //get the relationship values.
 156     $this->_values = array();
 157     if ($this->_relationshipId) {
 158       $params = array('id' => $this->_relationshipId);
 159       CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_Relationship', $params, $this->_values);
 160     }
 161
 162     if (!$this->_rtypeId) {
 163       $params = $this->controller->exportValues($this->_name);
 164       if (isset($params['relationship_type_id'])) {
 165         $this->_rtypeId = $params['relationship_type_id'];
 166       }
 167       elseif (!empty($this->_values)) {
 168         $this->_rtypeId = $this->_values['relationship_type_id'] . '_' . $this->_rtype;
 169       }
 170     }
 171
 172     //get the relationship type id
 173     $this->_relationshipTypeId = str_replace(array('_a_b', '_b_a'), array('', ''), $this->_rtypeId);
 174
 175     //get the relationship type
 176     if (!$this->_rtype) {
 177       $this->_rtype = str_replace($this->_relationshipTypeId . '_', '', $this->_rtypeId);
 178     }
 179
 180     //need to assign custom data type and subtype to the template - FIXME: explain why
 181     $this->assign('customDataType', 'Relationship');
 182     $this->assign('customDataSubType', $this->_relationshipTypeId);
 183     $this->assign('entityID', $this->_relationshipId);
 184
 185     //use name as it remain constant, CRM-3336
 186     $this->_allRelationshipNames = CRM_Core_PseudoConstant::relationshipType('name');
 187
 188     // Current employer?
 189     if ($this->_action & CRM_Core_Action::UPDATE) {
 190       if ($this->_allRelationshipNames[$this->_relationshipTypeId]["name_a_b"] == 'Employee of') {
 191         $this->_isCurrentEmployer = $this->_values['contact_id_b'] == CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_values['contact_id_a'], 'employer_id');
 192       }
 193     }
 194
 195     // when custom data is included in this page
 196     if (!empty($_POST['hidden_custom'])) {
 197       CRM_Custom_Form_CustomData::preProcess($this);
 198       CRM_Custom_Form_CustomData::buildQuickForm($this);
 199       CRM_Custom_Form_CustomData::setDefaultValues($this);
 200     }
 201   }
 202
 203   /**
 204    * Set default values for the form.
 205    */
 206   public function setDefaultValues() {
 207     if ($this->_cdType) {
 208       return CRM_Custom_Form_CustomData::setDefaultValues($this);
 209     }
 210
 211     $defaults = array();
 212
 213     if ($this->_action & CRM_Core_Action::UPDATE) {
 214       if (!empty($this->_values)) {
 215         $defaults['relationship_type_id'] = $this->_rtypeId;
 216         if (!empty($this->_values['start_date'])) {
 217           list($defaults['start_date']) = CRM_Utils_Date::setDateDefaults($this->_values['start_date']);
 218         }
 219         if (!empty($this->_values['end_date'])) {
 220           list($defaults['end_date']) = CRM_Utils_Date::setDateDefaults($this->_values['end_date']);
 221         }
 222         $defaults['description'] = CRM_Utils_Array::value('description', $this->_values);
 223         $defaults['is_active'] = CRM_Utils_Array::value('is_active', $this->_values);
 224
 225         // The javascript on the form will swap these fields if it is a b_a relationship, so we compensate here
 226         $defaults['is_permission_a_b'] = CRM_Utils_Array::value('is_permission_' . $this->_rtype, $this->_values);
 227         $defaults['is_permission_b_a'] = CRM_Utils_Array::value('is_permission_' . strrev($this->_rtype), $this->_values);
 228
 229         $defaults['is_current_employer'] = $this->_isCurrentEmployer;
 230
 231         // Load info about the related contact
 232         $contact = new CRM_Contact_DAO_Contact();
 233         if ($this->_rtype == 'a_b' && $this->_values['contact_id_a'] == $this->_contactId) {
 234           $contact->id = $this->_values['contact_id_b'];
 235         }
 236         else {
 237           $contact->id = $this->_values['contact_id_a'];
 238         }
 239         if ($contact->find(TRUE)) {
 240           $defaults['related_contact_id'] = $contact->id;
 241           $this->_display_name_b = $contact->display_name;
 242           $this->assign('display_name_b', $this->_display_name_b);
 243         }
 244
 245         $noteParams = array(
 246           'entity_id' => $this->_relationshipId,
 247           'entity_table' => 'civicrm_relationship',
 248           'limit' => 1,
 249           'version' => 3,
 250         );
 251         $note = civicrm_api('Note', 'getsingle', $noteParams);
 252         $defaults['note'] = CRM_Utils_Array::value('note', $note);
 253       }
 254     }
 255     else {
 256       $defaults['is_active'] = $defaults['is_current_employer'] = 1;
 257       $defaults['relationship_type_id'] = $this->_rtypeId;
 258     }
 259
 260     $this->_enabled = $defaults['is_active'];
 261     return $defaults;
 262   }
 263
 264   /**
 265    * Add the rules for form.
 266    */
 267   public function addRules() {
 268     if ($this->_cdType) {
 269       return;
 270     }
 271
 272     if (!($this->_action & CRM_Core_Action::DELETE)) {
 273       $this->addFormRule(array('CRM_Contact_Form_Relationship', 'dateRule'));
 274     }
 275   }
 276
 277   /**
 278    * Build the form object.
 279    */
 280   public function buildQuickForm() {
 281     if ($this->_cdType) {
 282       return CRM_Custom_Form_CustomData::buildQuickForm($this);
 283     }
 284
 285     if ($this->_action & CRM_Core_Action::DELETE) {
 286       $this->addButtons(array(
 287           array(
 288             'type' => 'next',
 289             'name' => ts('Delete'),
 290             'isDefault' => TRUE,
 291           ),
 292           array(
 293             'type' => 'cancel',
 294             'name' => ts('Cancel'),
 295           ),
 296         )
 297       );
 298       return;
 299     }
 300     // Just in case custom data includes a rich text field
 301     $this->assign('includeWysiwygEditor', TRUE);
 302
 303     // Select list
 304     $relationshipList = CRM_Contact_BAO_Relationship::getContactRelationshipType($this->_contactId, $this->_rtype, $this->_relationshipId);
 305
 306     // Metadata needed on clientside
 307     $contactTypes = CRM_Contact_BAO_ContactType::contactTypeInfo(TRUE);
 308     $jsData = array();
 309     // Get just what we need to keep the dom small
 310     $whatWeWant = array_flip(array('contact_type_a', 'contact_type_b', 'contact_sub_type_a', 'contact_sub_type_b'));
 311     foreach ($this->_allRelationshipNames as $id => $vals) {
 312       if ($vals['name_a_b'] === 'Employee of') {
 313         $this->assign('employmentRelationship', $id);
 314       }
 315       if (isset($relationshipList["{$id}_a_b"]) || isset($relationshipList["{$id}_b_a"])) {
 316         $jsData[$id] = array_filter(array_intersect_key($this->_allRelationshipNames[$id], $whatWeWant));
 317         // Add user-friendly placeholder
 318         foreach (array('a', 'b') as $x) {
 319           $type = !empty($jsData[$id]["contact_sub_type_$x"]) ? $jsData[$id]["contact_sub_type_$x"] : CRM_Utils_Array::value("contact_type_$x", $jsData[$id]);
 320           $jsData[$id]["placeholder_$x"] = $type ? ts('- select %1 -', array(strtolower($contactTypes[$type]['label']))) : ts('- select contact -');
 321         }
 322       }
 323     }
 324     $this->assign('relationshipData', $jsData);
 325
 326     $this->add(
 327       'select',
 328       'relationship_type_id',
 329       ts('Relationship Type'),
 330       array('' => ts('- select -')) + $relationshipList,
 331       TRUE,
 332       array('class' => 'crm-select2 huge')
 333     );
 334
 335     $label = $this->_action & CRM_Core_Action::ADD ? ts('Contact(s)') : ts('Contact');
 336     $contactField = $this->addEntityRef('related_contact_id', $label, array(
 337         'multiple' => TRUE,
 338         'create' => TRUE,
 339       ), TRUE);
 340     // This field cannot be updated
 341     if ($this->_action & CRM_Core_Action::UPDATE) {
 342       $contactField->freeze();
 343     }
 344
 345     $this->add('advcheckbox', 'is_current_employer', $this->_contactType == 'Organization' ? ts('Current Employee') : ts('Current Employer'));
 346
 347     $this->addDate('start_date', ts('Start Date'), FALSE, array('formatType' => 'searchDate'));
 348     $this->addDate('end_date', ts('End Date'), FALSE, array('formatType' => 'searchDate'));
 349
 350     $this->add('advcheckbox', 'is_active', ts('Enabled?'));
 351
 352     // CRM-14612 - Don't use adv-checkbox as it interferes with the form js
 353     $this->add('checkbox', 'is_permission_a_b');
 354     $this->add('checkbox', 'is_permission_b_a');
 355
 356     $this->add('text', 'description', ts('Description'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Relationship', 'description'));
 357
 358     CRM_Contact_Form_Edit_Notes::buildQuickForm($this);
 359
 360     if ($this->_action & CRM_Core_Action::VIEW) {
 361       $this->addButtons(array(
 362         array(
 363           'type' => 'cancel',
 364           'name' => ts('Done'),
 365         ),
 366       ));
 367     }
 368     else {
 369       // make this form an upload since we don't know if the custom data injected dynamically is of type file etc.
 370       $this->addButtons(array(
 371         array(
 372           'type' => 'upload',
 373           'name' => ts('Save Relationship'),
 374           'isDefault' => TRUE,
 375         ),
 376         array(
 377           'type' => 'cancel',
 378           'name' => ts('Cancel'),
 379         ),
 380       ));
 381     }
 382   }
 383
 384   /**
 385    * This function is called when the form is submitted.
 386    */
 387   public function postProcess() {
 388     // Store the submitted values in an array.
 389     $params = $this->controller->exportValues($this->_name);
 390
 391     // action is taken depending upon the mode
 392     if ($this->_action & CRM_Core_Action::DELETE) {
 393       CRM_Contact_BAO_Relationship::del($this->_relationshipId);
 394       return;
 395     }
 396
 397     $relationshipTypeParts = explode('_', $params['relationship_type_id']);
 398     $params['relationship_type_id'] = $relationshipTypeParts[0];
 399     if (!$this->_rtype) {
 400       // Do we need to wrap this in an if - when is rtype used & is relationship_type_id always set then?
 401       $this->_rtype = $params['relationship_type_id'];
 402     }
 403     $params['contact_id_' .  $relationshipTypeParts[1]] = $this->_contactId;
 404
 405     // Update mode (always single)
 406     if ($this->_action & CRM_Core_Action::UPDATE) {
 407       $update = TRUE;
 408       $params['id'] = $this->_relationshipId;
 409       $ids['relationship'] = $this->_relationshipId;
 410       $relation = CRM_Contact_BAO_Relationship::getRelationshipByID($this->_relationshipId);
 411       if ($relation->contact_id_a == $this->_contactId) {
 412         $params['contact_id_a'] = $this->_contactId;
 413         $params['contact_id_b'] = array($params['related_contact_id']);
 414       }
 415       else {
 416         $params['contact_id_b'] = $this->_contactId;
 417         $params['contact_id_a'] = array($params['related_contact_id']);
 418       }
 419       $ids['contactTarget'] = ($relation->contact_id_a == $this->_contactId) ? $relation->contact_id_b : $relation->contact_id_a;
 420
 421       // @todo this belongs in the BAO.
 422       if ($this->_isCurrentEmployer) {
 423         // if relationship type changes, relationship is disabled, or "current employer" is unchecked,
 424         // clear the current employer. CRM-3235.
 425         $relChanged = $params['relationship_type_id'] != $this->_values['relationship_type_id'];
 426         if (!$params['is_active'] || !$params['is_current_employer'] || $relChanged) {
 427           CRM_Contact_BAO_Contact_Utils::clearCurrentEmployer($this->_values['contact_id_a']);
 428           // Refresh contact summary if in ajax mode
 429           $this->ajaxResponse['reloadBlocks'] = array('#crm-contactinfo-content');
 430         }
 431       }
 432     }
 433     // Create mode (could be 1 or more relationships)
 434     else {
 435       $params['contact_id_' .  $relationshipTypeParts[2]] = explode(',', $params['related_contact_id']);
 436     }
 437
 438     // Save the relationships.
 439     $outcome = CRM_Contact_BAO_Relationship::createMultiple($params, $relationshipTypeParts[1]);
 440     $relationshipIds = $outcome['relationship_ids'];
 441     if (empty($outcome['saved']) && !empty($update)) {
 442       $outcome['saved'] = $update;
 443     }
 444     $this->setMessage($outcome);
 445
 446     // if this is called from case view,
 447     //create an activity for case role removal.CRM-4480
 448     // @todo this belongs in the BAO.
 449     if ($this->_caseId) {
 450       CRM_Case_BAO_Case::createCaseRoleActivity($this->_caseId, $relationshipIds, $params['contact_check'], $this->_contactId);
 451     }
 452
 453     // Save notes
 454     // @todo this belongs in the BAO.
 455     if ($this->_action & CRM_Core_Action::UPDATE || $params['note']) {
 456       foreach ($relationshipIds as $id) {
 457         $noteParams = array(
 458           'entity_id' => $id,
 459           'entity_table' => 'civicrm_relationship',
 460         );
 461         $existing = civicrm_api3('note', 'get', $noteParams);
 462         if (!empty($existing['id'])) {
 463           $noteParams['id'] = $existing['id'];
 464         }
 465         $noteParams['note'] = $params['note'];
 466         $noteParams['contact_id'] = $this->_contactId;
 467         if (!empty($existing['id']) || $params['note']) {
 468           $action = $params['note'] ? 'create' : 'delete';
 469           civicrm_api3('note', $action, $noteParams);
 470         }
 471       }
 472     }
 473
 474     $params['relationship_ids'] = $relationshipIds;
 475
 476     // Refresh contact tabs which might have been affected
 477     $this->ajaxResponse['updateTabs'] = array(
 478       '#tab_member' => CRM_Contact_BAO_Contact::getCountComponent('membership', $this->_contactId),
 479       '#tab_contribute' => CRM_Contact_BAO_Contact::getCountComponent('contribution', $this->_contactId),
 480     );
 481
 482     // Set current employee/employer relationship, CRM-3532
 483     if ($params['is_current_employer'] && $this->_allRelationshipNames[$params['relationship_type_id']]["name_a_b"] ==
 484     'Employee of') {
 485       $employerParams = array();
 486       foreach ($relationshipIds as $id) {
 487         // Fixme this is dumb why do we have to look this up again?
 488         $rel = CRM_Contact_BAO_Relationship::getRelationshipByID($id);
 489         $employerParams[$rel->contact_id_a] = $rel->contact_id_b;
 490       }
 491       // @todo this belongs in the BAO.
 492       CRM_Contact_BAO_Contact_Utils::setCurrentEmployer($employerParams);
 493       // Refresh contact summary if in ajax mode
 494       $this->ajaxResponse['reloadBlocks'] = array('#crm-contactinfo-content');
 495     }
 496   }
 497
 498   /**
 499    * Date validation.
 500    *
 501    * @param array $params
 502    *   (reference ) an assoc array of name/value pairs.
 503    *
 504    * @return bool|array
 505    *   mixed true or array of errors
 506    */
 507   public static function dateRule($params) {
 508     $errors = array();
 509
 510     // check start and end date
 511     if (!empty($params['start_date']) && !empty($params['end_date'])) {
 512       $start_date = CRM_Utils_Date::format(CRM_Utils_Array::value('start_date', $params));
 513       $end_date = CRM_Utils_Date::format(CRM_Utils_Array::value('end_date', $params));
 514       if ($start_date && $end_date && (int ) $end_date < (int ) $start_date) {
 515         $errors['end_date'] = ts('The relationship end date cannot be prior to the start date.');
 516       }
 517     }
 518
 519     return empty($errors) ? TRUE : $errors;
 520   }
 521
 522   /**
 523    * Set Status message to reflect outcome of the update action.
 524    *
 525    * @param array $outcome
 526    *   Outcome of save action - including
 527    *   - 'valid' : Number of valid relationships attempted.
 528    *   - 'invalid' : Number of invalid relationships attempted.
 529    *   - 'duplicate' : Number of duplicate relationships attempted.
 530    *   - 'saved' : boolean of whether save was successful
 531    */
 532   protected function setMessage($outcome) {
 533     if (!empty($outcome['valid']) && empty($outcome['saved'])) {
 534       CRM_Core_Session::setStatus(ts('Relationship created.', array(
 535         'count' => $outcome['valid'],
 536         'plural' => '%count relationships created.',
 537       )), ts('Saved'), 'success');
 538     }
 539     if (!empty($outcome['invalid'])) {
 540       CRM_Core_Session::setStatus(ts('%count relationship record was not created due to an invalid contact type.', array(
 541         'count' => $outcome['invalid'],
 542         'plural' => '%count relationship records were not created due to invalid contact types.',
 543       )), ts('%count invalid relationship record', array(
 544         'count' => $outcome['invalid'],
 545         'plural' => '%count invalid relationship records',
 546       )));
 547     }
 548     if (!empty($outcome['duplicate'])) {
 549       CRM_Core_Session::setStatus(ts('One relationship was not created because it already exists.', array(
 550         'count' => $outcome['duplicate'],
 551         'plural' => '%count relationships were not created because they already exist.',
 552       )), ts('%count duplicate relationship', array(
 553         'count' => $outcome['duplicate'],
 554         'plural' => '%count duplicate relationships',
 555       )));
 556     }
 557     if (!empty($outcome['saved'])) {
 558       CRM_Core_Session::setStatus(ts('Relationship record has been updated.'), ts('Saved'), 'success');
 559     }
 560   }
 561
 562 }