3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * This class generates form components for relationship
40 class CRM_Contact_Form_Relationship
extends CRM_Core_Form
{
43 * The relationship id, used when editing the relationship
47 public $_relationshipId;
50 * The contact id, used when add/edit relationship
57 * This is a string which is either a_b or b_a used to determine the relationship between to contacts
62 * This is a string which is used to determine the relationship between to contacts
67 * Display name of contact a
69 public $_display_name_a;
72 * Display name of contact b
74 public $_display_name_b;
77 * The relationship type id
81 public $_relationshipTypeId;
84 * An array of all relationship names
88 public $_allRelationshipNames;
98 public $_isCurrentEmployer;
103 public $_contactType;
106 * The relationship values if Updating relationship
111 * Casid if it called from case context
120 public function preProcess() {
121 //custom data related code
122 $this->_cdType
= CRM_Utils_Array
::value('type', $_GET);
123 $this->assign('cdType', FALSE);
124 if ($this->_cdType
) {
125 $this->assign('cdType', TRUE);
126 return CRM_Custom_Form_CustomData
::preProcess($this);
129 $this->_contactId
= $this->get('contactId');
131 $this->_contactType
= CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId
, 'contact_type');
133 $this->_relationshipId
= $this->get('id');
135 $this->_rtype
= CRM_Utils_Request
::retrieve('rtype', 'String', $this);
137 $this->_rtypeId
= CRM_Utils_Request
::retrieve('relTypeId', 'String', $this);
139 $this->_display_name_a
= CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId
, 'display_name');
141 $this->assign('display_name_a', $this->_display_name_a
);
143 // Set page title based on action
144 switch ($this->_action
) {
145 case CRM_Core_Action
::VIEW
:
146 CRM_Utils_System
::setTitle(ts('View Relationship for %1', array(1 => $this->_display_name_a
)));
149 case CRM_Core_Action
::ADD
:
150 CRM_Utils_System
::setTitle(ts('Add Relationship for %1', array(1 => $this->_display_name_a
)));
153 case CRM_Core_Action
::UPDATE
:
154 CRM_Utils_System
::setTitle(ts('Edit Relationship for %1', array(1 => $this->_display_name_a
)));
157 case CRM_Core_Action
::DELETE
:
158 CRM_Utils_System
::setTitle(ts('Delete Relationship for %1', array(1 => $this->_display_name_a
)));
162 $this->_caseId
= CRM_Utils_Request
::retrieve('caseID', 'Integer', $this);
164 //get the relationship values.
165 $this->_values
= array();
166 if ($this->_relationshipId
) {
167 $params = array('id' => $this->_relationshipId
);
168 CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_Relationship', $params, $this->_values
);
171 if (!$this->_rtypeId
) {
172 $params = $this->controller
->exportValues($this->_name
);
173 if (isset($params['relationship_type_id'])) {
174 $this->_rtypeId
= $params['relationship_type_id'];
176 elseif (!empty($this->_values
)) {
177 $this->_rtypeId
= $this->_values
['relationship_type_id'] . '_' . $this->_rtype
;
181 //get the relationship type id
182 $this->_relationshipTypeId
= str_replace(array('_a_b', '_b_a'), array('', ''), $this->_rtypeId
);
184 //get the relationship type
185 if (!$this->_rtype
) {
186 $this->_rtype
= str_replace($this->_relationshipTypeId
. '_', '', $this->_rtypeId
);
189 //need to assign custom data type and subtype to the template - FIXME: explain why
190 $this->assign('customDataType', 'Relationship');
191 $this->assign('customDataSubType', $this->_relationshipTypeId
);
192 $this->assign('entityID', $this->_relationshipId
);
194 //use name as it remain constant, CRM-3336
195 $this->_allRelationshipNames
= CRM_Core_PseudoConstant
::relationshipType('name');
198 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
199 if ($this->_allRelationshipNames
[$this->_relationshipTypeId
]["name_a_b"] == 'Employee of') {
200 $this->_isCurrentEmployer
= $this->_values
['contact_id_b'] == CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_values
['contact_id_a'], 'employer_id');
204 // when custom data is included in this page
205 if (!empty($_POST['hidden_custom'])) {
206 CRM_Custom_Form_CustomData
::preProcess($this);
207 CRM_Custom_Form_CustomData
::buildQuickForm($this);
208 CRM_Custom_Form_CustomData
::setDefaultValues($this);
213 * Set default values for the form. Relationship that in edit/view mode
214 * the default values are retrieved from the database
219 public function setDefaultValues() {
220 if ($this->_cdType
) {
221 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
226 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
227 if (!empty($this->_values
)) {
228 $defaults['relationship_type_id'] = $this->_rtypeId
;
229 if (!empty($this->_values
['start_date'])) {
230 list($defaults['start_date']) = CRM_Utils_Date
::setDateDefaults($this->_values
['start_date']);
232 if (!empty($this->_values
['end_date'])) {
233 list($defaults['end_date']) = CRM_Utils_Date
::setDateDefaults($this->_values
['end_date']);
235 $defaults['description'] = CRM_Utils_Array
::value('description', $this->_values
);
236 $defaults['is_active'] = CRM_Utils_Array
::value('is_active', $this->_values
);
238 // The javascript on the form will swap these fields if it is a b_a relationship, so we compensate here
239 $defaults['is_permission_a_b'] = CRM_Utils_Array
::value('is_permission_' . $this->_rtype
, $this->_values
);
240 $defaults['is_permission_b_a'] = CRM_Utils_Array
::value('is_permission_' . strrev($this->_rtype
), $this->_values
);
242 $defaults['is_current_employer'] = $this->_isCurrentEmployer
;
244 // Load info about the related contact
245 $contact = new CRM_Contact_DAO_Contact();
246 if ($this->_rtype
== 'a_b' && $this->_values
['contact_id_a'] == $this->_contactId
) {
247 $contact->id
= $this->_values
['contact_id_b'];
250 $contact->id
= $this->_values
['contact_id_a'];
252 if ($contact->find(TRUE)) {
253 $defaults['related_contact_id'] = $contact->id
;
254 $this->_display_name_b
= $contact->display_name
;
255 $this->assign('display_name_b', $this->_display_name_b
);
259 'entity_id' => $this->_relationshipId
,
260 'entity_table' => 'civicrm_relationship',
264 $note = civicrm_api('Note', 'getsingle', $noteParams);
265 $defaults['note'] = CRM_Utils_Array
::value('note', $note);
269 $defaults['is_active'] = $defaults['is_current_employer'] = 1;
270 $defaults['relationship_type_id'] = $this->_rtypeId
;
273 $this->_enabled
= $defaults['is_active'];
278 * add the rules for form.
282 public function addRules() {
283 if ($this->_cdType
) {
287 if (!($this->_action
& CRM_Core_Action
::DELETE
)) {
288 $this->addFormRule(array('CRM_Contact_Form_Relationship', 'dateRule'));
293 * Build the form object.
297 public function buildQuickForm() {
298 if ($this->_cdType
) {
299 return CRM_Custom_Form_CustomData
::buildQuickForm($this);
302 if ($this->_action
& CRM_Core_Action
::DELETE
) {
303 $this->addButtons(array(
306 'name' => ts('Delete'),
311 'name' => ts('Cancel'),
317 // Just in case custom data includes a rich text field
318 $this->assign('includeWysiwygEditor', TRUE);
321 $relationshipList = CRM_Contact_BAO_Relationship
::getContactRelationshipType($this->_contactId
, $this->_rtype
, $this->_relationshipId
);
323 // Metadata needed on clientside
324 $contactTypes = CRM_Contact_BAO_ContactType
::contactTypeInfo(TRUE);
326 // Get just what we need to keep the dom small
327 $whatWeWant = array_flip(array('contact_type_a', 'contact_type_b', 'contact_sub_type_a', 'contact_sub_type_b'));
328 foreach ($this->_allRelationshipNames
as $id => $vals) {
329 if ($vals['name_a_b'] === 'Employee of') {
330 $this->assign('employmentRelationship', $id);
332 if (isset($relationshipList["{$id}_a_b"]) ||
isset($relationshipList["{$id}_b_a"])) {
333 $jsData[$id] = array_filter(array_intersect_key($this->_allRelationshipNames
[$id], $whatWeWant));
334 // Add user-friendly placeholder
335 foreach (array('a', 'b') as $x) {
336 $type = !empty($jsData[$id]["contact_sub_type_$x"]) ?
$jsData[$id]["contact_sub_type_$x"] : CRM_Utils_Array
::value("contact_type_$x", $jsData[$id]);
337 $jsData[$id]["placeholder_$x"] = $type ?
ts('- select %1 -', array(strtolower($contactTypes[$type]['label']))) : ts('- select contact -');
341 $this->assign('relationshipData', $jsData);
345 'relationship_type_id',
346 ts('Relationship Type'),
347 array('' => ts('- select -')) +
$relationshipList,
349 array('class' => 'crm-select2 huge')
352 $label = $this->_action
& CRM_Core_Action
::ADD ?
ts('Contact(s)') : ts('Contact');
353 $contactField = $this->addEntityRef('related_contact_id', $label, array(
357 // This field cannot be updated
358 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
359 $contactField->freeze();
362 $this->add('advcheckbox', 'is_current_employer', $this->_contactType
== 'Organization' ?
ts('Current Employee') : ts('Current Employer'));
364 $this->addDate('start_date', ts('Start Date'), FALSE, array('formatType' => 'searchDate'));
365 $this->addDate('end_date', ts('End Date'), FALSE, array('formatType' => 'searchDate'));
367 $this->add('advcheckbox', 'is_active', ts('Enabled?'));
369 // CRM-14612 - Don't use adv-checkbox as it interferes with the form js
370 $this->add('checkbox', 'is_permission_a_b');
371 $this->add('checkbox', 'is_permission_b_a');
373 $this->add('text', 'description', ts('Description'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Relationship', 'description'));
375 CRM_Contact_Form_Edit_Notes
::buildQuickForm($this);
377 if ($this->_action
& CRM_Core_Action
::VIEW
) {
378 $this->addButtons(array(
381 'name' => ts('Done'),
386 // make this form an upload since we don't know if the custom data injected dynamically is of type file etc.
387 $this->addButtons(array(
390 'name' => ts('Save Relationship'),
395 'name' => ts('Cancel'),
402 * This function is called when the form is submitted.
407 public function postProcess() {
408 // store the submitted values in an array
409 $params = $this->controller
->exportValues($this->_name
);
411 // action is taken depending upon the mode
412 if ($this->_action
& CRM_Core_Action
::DELETE
) {
413 CRM_Contact_BAO_Relationship
::del($this->_relationshipId
);
417 $ids = array('contact' => $this->_contactId
);
419 $relationshipTypeId = str_replace(array('_', 'a', 'b'), '', $params['relationship_type_id']);
421 // CRM-14612 - Don't use adv-checkbox as it interferes with the form js
422 $params['is_permission_a_b'] = CRM_Utils_Array
::value('is_permission_a_b', $params, 0);
423 $params['is_permission_b_a'] = CRM_Utils_Array
::value('is_permission_b_a', $params, 0);
425 // Update mode (always single)
426 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
427 $ids['relationship'] = $this->_relationshipId
;
428 $relation = CRM_Contact_BAO_Relationship
::getContactIds($this->_relationshipId
);
429 $ids['contactTarget'] = ($relation->contact_id_a
== $this->_contactId
) ?
$relation->contact_id_b
: $relation->contact_id_a
;
431 if ($this->_isCurrentEmployer
) {
432 // if relationship type changes, relationship is disabled, or "current employer" is unchecked,
433 // clear the current employer. CRM-3235.
434 $relChanged = $relationshipTypeId != $this->_values
['relationship_type_id'];
435 if (!$params['is_active'] ||
!$params['is_current_employer'] ||
$relChanged) {
436 CRM_Contact_BAO_Contact_Utils
::clearCurrentEmployer($this->_values
['contact_id_a']);
437 // Refresh contact summary if in ajax mode
438 $this->ajaxResponse
['reloadBlocks'] = array('#crm-contactinfo-content');
442 // Create mode (could be 1 or more relationships)
444 // Fill up this weird param with contact ids like the weird relationship bao expects
445 $params['contact_check'] = array_fill_keys(explode(',', $params['related_contact_id']), 1);
446 if (!$this->_rtype
) {
447 list(, $this->_rtype
) = explode('_', $params['relationship_type_id'], 2);
450 $params['start_date'] = CRM_Utils_Date
::processDate($params['start_date'], NULL, TRUE);
451 $params['end_date'] = CRM_Utils_Date
::processDate($params['end_date'], NULL, TRUE);
453 // Process custom data
454 $customFields = CRM_Core_BAO_CustomField
::getFields('Relationship', FALSE, FALSE, $relationshipTypeId);
455 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess(
458 $this->_relationshipId
,
462 // Save relationships
463 list($valid, $invalid, $duplicate, $saved, $relationshipIds) = CRM_Contact_BAO_Relationship
::createMultiple($params, $ids);
465 // if this is called from case view,
466 //create an activity for case role removal.CRM-4480
467 if ($this->_caseId
) {
468 CRM_Case_BAO_Case
::createCaseRoleActivity($this->_caseId
, $relationshipIds, $params['contact_check'], $this->_contactId
);
472 CRM_Core_Session
::setStatus(ts('Relationship created.', array(
474 'plural' => '%count relationships created.',
475 )), ts('Saved'), 'success');
478 CRM_Core_Session
::setStatus(ts('%count relationship record was not created due to an invalid contact type.', array(
480 'plural' => '%count relationship records were not created due to invalid contact types.',
481 )), ts('%count invalid relationship record', array(
483 'plural' => '%count invalid relationship records',
487 CRM_Core_Session
::setStatus(ts('One relationship was not created because it already exists.', array(
488 'count' => $duplicate,
489 'plural' => '%count relationships were not created because they already exist.',
490 )), ts('%count duplicate relationship', array(
491 'count' => $duplicate,
492 'plural' => '%count duplicate relationships',
496 CRM_Core_Session
::setStatus(ts('Relationship record has been updated.'), ts('Saved'), 'success');
500 if ($this->_action
& CRM_Core_Action
::UPDATE ||
$params['note']) {
501 foreach ($relationshipIds as $id) {
504 'entity_table' => 'civicrm_relationship',
506 $existing = civicrm_api3('note', 'get', $noteParams);
507 if (!empty($existing['id'])) {
508 $noteParams['id'] = $existing['id'];
510 $noteParams['note'] = $params['note'];
511 $noteParams['contact_id'] = $this->_contactId
;
512 if (!empty($existing['id']) ||
$params['note']) {
513 $action = $params['note'] ?
'create' : 'delete';
514 civicrm_api3('note', $action, $noteParams);
519 // Membership for related contacts CRM-1657
520 if (CRM_Core_Permission
::access('CiviMember') && (!$duplicate)) {
521 $params['relationship_ids'] = $relationshipIds;
522 if ($this->_action
& CRM_Core_Action
::ADD
&& !empty($params['is_active'])) {
523 CRM_Contact_BAO_Relationship
::relatedMemberships($this->_contactId
,
528 elseif ($this->_action
& CRM_Core_Action
::UPDATE
) {
530 //only if the relationship has been toggled to enable /disable
531 if (CRM_Utils_Array
::value('is_active', $params) != $this->_enabled
) {
532 $active = !empty($params['is_active']) ? CRM_Core_Action
::ENABLE
: CRM_Core_Action
::DISABLE
;
533 CRM_Contact_BAO_Relationship
::disableEnableRelationship($this->_relationshipId
, $active);
536 // Refresh contact tabs which might have been affected
537 $this->ajaxResponse
['updateTabs'] = array(
538 '#tab_member' => CRM_Contact_BAO_Contact
::getCountComponent('membership', $this->_contactId
),
539 '#tab_contribute' => CRM_Contact_BAO_Contact
::getCountComponent('contribution', $this->_contactId
),
542 // Set current employee/employer relationship, CRM-3532
543 if ($params['is_current_employer'] && $this->_allRelationshipNames
[$relationshipTypeId]["name_a_b"] == 'Employee of') {
544 $employerParams = array();
545 foreach ($relationshipIds as $id) {
546 // Fixme this is dumb why do we have to look this up again?
547 $rel = CRM_Contact_BAO_Relationship
::getContactIds($id);
548 $employerParams[$rel->contact_id_a
] = $rel->contact_id_b
;
550 CRM_Contact_BAO_Contact_Utils
::setCurrentEmployer($employerParams);
551 // Refresh contact summary if in ajax mode
552 $this->ajaxResponse
['reloadBlocks'] = array('#crm-contactinfo-content');
559 * @param array $params
560 * (reference ) an assoc array of name/value pairs.
563 * mixed true or array of errors
565 public static function dateRule($params) {
568 // check start and end date
569 if (!empty($params['start_date']) && !empty($params['end_date'])) {
570 $start_date = CRM_Utils_Date
::format(CRM_Utils_Array
::value('start_date', $params));
571 $end_date = CRM_Utils_Date
::format(CRM_Utils_Array
::value('end_date', $params));
572 if ($start_date && $end_date && (int ) $end_date < (int ) $start_date) {
573 $errors['end_date'] = ts('The relationship end date cannot be prior to the start date.');
577 return empty($errors) ?
TRUE : $errors;