3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Contact_BAO_Relationship
extends CRM_Contact_DAO_Relationship
{
38 * various constants to indicate different type of relationships
42 CONST PAST
= 1, DISABLED
= 2, CURRENT
= 4, INACTIVE
= 8;
45 * takes an associative array and creates a relationship object
48 * @param array $params (reference ) an assoc array of name/value pairs
49 * @param array $ids the array that holds all the db ids
50 * per http://wiki.civicrm.org/confluence/display/CRM/Database+layer
51 * "we are moving away from the $ids param "
53 * @return object CRM_Contact_BAO_Relationship object
57 static function create(&$params, $ids = array()) {
58 $valid = $invalid = $duplicate = $saved = 0;
59 $relationships = array();
60 $relationshipId = CRM_Utils_Array
::value('relationship', $ids, CRM_Utils_Array
::value('id', $params));
61 //CRM-9015 - the hooks are called here & in add (since add doesn't call create)
62 // but in future should be tidied per ticket
63 if(empty($relationshipId)){
65 $action = CRM_Core_Action
::ADD
;
69 $action = CRM_Core_Action
::UPDATE
;
72 CRM_Utils_Hook
::pre($hook, 'Relationship', $relationshipId, $params);
74 if (!$relationshipId) {
75 // creating a new relationship
76 $dataExists = self
::dataExists($params);
78 return array(FALSE, TRUE, FALSE, FALSE, NULL);
80 $relationshipIds = array();
81 foreach ($params['contact_check'] as $key => $value) {
83 // check if the relationship is valid between contacts.
84 // step 1: check if the relationship is valid if not valid skip and keep the count
85 // step 2: check the if two contacts already have a relationship if yes skip and keep the count
86 // step 3: if valid relationship then add the relation and keep the count
89 $errors = self
::checkValidRelationship($params, $ids, $key);
96 self
::checkDuplicateRelationship(
98 CRM_Utils_Array
::value('contact', $ids),
107 $relationship = self
::add($params, $ids, $key);
108 $relationshipIds[] = $relationship->id
;
109 $relationships[$relationship->id
] = $relationship;
112 // editing the relationship
115 // check for duplicate relationship
116 // @todo this code doesn't cope well with updates - causes e-Notices.
117 // API has a lot of code to work around
118 // this but should review this code & remove the extra handling from the api
119 // it seems doubtful any of this is relevant if the contact fields & relationship
120 // type fields are not set
122 self
::checkDuplicateRelationship(
124 CRM_Utils_Array
::value('contact', $ids),
125 $ids['contactTarget'],
130 return array($valid, $invalid, $duplicate, $saved, NULL);
133 $validContacts = TRUE;
134 //validate contacts in update mode also.
135 if (!empty($ids['contact']) && !empty($ids['contactTarget'])) {
136 if (self
::checkValidRelationship($params, $ids, $ids['contactTarget'])) {
137 $validContacts = FALSE;
141 if ($validContacts) {
142 // editing an existing relationship
143 $relationship = self
::add($params, $ids, $ids['contactTarget']);
144 $relationshipIds[] = $relationship->id
;
145 $relationships[$relationship->id
] = $relationship;
150 // do not add to recent items for import, CRM-4399
151 if (!(!empty($params['skipRecentView']) ||
$invalid ||
$duplicate)) {
152 $url = CRM_Utils_System
::url('civicrm/contact/view/rel',
153 "action=view&reset=1&id={$relationship->id}&cid={$relationship->contact_id_a}&context=home"
157 $session = CRM_Core_Session
::singleton();
158 $recentOther = array();
159 if (($session->get('userID') == $relationship->contact_id_a
) ||
160 CRM_Contact_BAO_Contact_Permission
::allow($relationship->contact_id_a
, CRM_Core_Permission
::EDIT
)
162 $rType = substr(CRM_Utils_Array
::value('relationship_type_id', $params), -3);
163 $recentOther = array(
164 'editUrl' => CRM_Utils_System
::url('civicrm/contact/view/rel',
165 "action=update&reset=1&id={$relationship->id}&cid={$relationship->contact_id_a}&rtype={$rType}&context=home"
167 'deleteUrl' => CRM_Utils_System
::url('civicrm/contact/view/rel',
168 "action=delete&reset=1&id={$relationship->id}&cid={$relationship->contact_id_a}&rtype={$rType}&context=home"
173 $title = CRM_Contact_BAO_Contact
::displayName($relationship->contact_id_a
) . ' (' . CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType',
174 $relationship->relationship_type_id
, 'label_a_b'
175 ) . ' ' . CRM_Contact_BAO_Contact
::displayName($relationship->contact_id_b
) . ')';
176 // add the recently created Relationship
177 CRM_Utils_Recent
::add($title,
181 $relationship->contact_id_a
,
187 return array($valid, $invalid, $duplicate, $saved, $relationshipIds, $relationships);
191 * This is the function that check/add if the relationship created is valid
193 * @param array $params (reference ) an assoc array of name/value pairs
194 * @param integer $contactId this is contact id for adding relationship
195 * @param array $ids the array that holds all the db ids
197 * @return object CRM_Contact_BAO_Relationship
201 static function add(&$params, $ids = array(), $contactId = NULL) {
203 CRM_Utils_Array
::value('relationship', $ids, CRM_Utils_Array
::value('id', $params));
206 if($relationshipId) {
209 //@todo hook are called from create and add - remove one
210 CRM_Utils_Hook
::pre($hook , 'Relationship', $relationshipId, $params);
212 $relationshipTypes = CRM_Utils_Array
::value('relationship_type_id', $params);
214 // explode the string with _ to get the relationship type id
215 // and to know which contact has to be inserted in
216 // contact_id_a and which one in contact_id_b
217 list($type, $first, $second) = explode('_', $relationshipTypes);
219 $
{'contact_' . $first} = CRM_Utils_Array
::value('contact', $ids);
220 $
{'contact_' . $second} = $contactId;
222 // check if the relationship type is Head of Household then update the
223 // household's primary contact with this contact.
225 CRM_Contact_BAO_Household
::updatePrimaryContact($contact_b, $contact_a);
228 $relationship = new CRM_Contact_BAO_Relationship();
229 //@todo this code needs to be updated for the possibility that not all fields are set
231 $relationship->contact_id_b
= $contact_b;
232 $relationship->contact_id_a
= $contact_a;
233 $relationship->relationship_type_id
= $type;
234 $relationship->id
= $relationshipId;
236 $dateFields = array('end_date', 'start_date');
238 foreach (self
::getdefaults() as $defaultField => $defaultValue){
239 if(isset($params[$defaultField])){
240 if(in_array($defaultField, $dateFields)){
241 $relationship->$defaultField = CRM_Utils_Date
::format(CRM_Utils_Array
::value($defaultField, $params));
242 if(!$relationship->$defaultField){
243 $relationship->$defaultField = 'NULL';
247 $relationship->$defaultField = $params[$defaultField];
250 elseif(!$relationshipId){
251 $relationship->$defaultField = $defaultValue;
255 $relationship->save();
257 // add custom field values
258 if (!empty($params['custom'])) {
259 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_relationship', $relationship->id
);
262 $relationship->free();
264 CRM_Utils_Hook
::post($hook, 'Relationship', $relationshipId, $relationship);
266 return $relationship;
269 * Specifiy defaults for creating a relationship
271 * @return array $defaults array of defaults for creating relationship
275 static function getdefaults() {
278 'is_permission_a_b' => 0,
279 'is_permission_b_a' => 0,
281 'start_date' => 'NULL',
283 'end_date' => 'NULL',
289 * Check if there is data to create the object
291 * @param array $params (reference ) an assoc array of name/value pairs
297 static function dataExists(&$params) {
298 // return if no data present
299 if (!is_array(CRM_Utils_Array
::value('contact_check', $params))) {
306 * Function to get get list of relationship type based on the contact type.
308 * @param int $contactId this is the contact id of the current contact.
309 * @param string $strContact this value is currently ignored, keeping it there for legacy reasons
310 * @param string $relationshipId the id of the existing relationship if any
311 * @param string $contactType contact type
312 * @param boolean $all if true returns relationship types in both the direction
313 * @param string $column name/label that going to retrieve from db.
316 * @param string $contactSubType includes relationshiptypes between this subtype
318 * @param boolean $onlySubTypeRelationTypes if set only subtype which is passed by $contactSubType
319 * related relationshiptypes get return
323 * @return array - array reference of all relationship types with context to current contact.
325 static function getContactRelationshipType($contactId = NULL,
326 $contactSuffix = NULL,
327 $relationshipId = NULL,
331 $biDirectional = TRUE,
332 $contactSubType = NULL,
333 $onlySubTypeRelationTypes = FALSE
335 $allRelationshipType = array();
336 $relationshipType = array();
337 $allRelationshipType = CRM_Core_PseudoConstant
::relationshipType($column);
339 $otherContactType = NULL;
340 if ($relationshipId) {
341 $relationship = new CRM_Contact_DAO_Relationship();
342 $relationship->id
= $relationshipId;
343 if ($relationship->find(TRUE)) {
344 $contact = new CRM_Contact_DAO_Contact();
345 $contact->id
= ($relationship->contact_id_a
=== $contactId) ?
$relationship->contact_id_b
: $relationship->contact_id_a
;
347 if ($contact->find(TRUE)) {
348 $otherContactType = $contact->contact_type
;
349 //CRM-5125 for contact subtype specific relationshiptypes
350 if ($contact->contact_sub_type
) {
351 $otherContactSubType = $contact->contact_sub_type
;
357 $contactSubType = array();
359 $contactType = CRM_Contact_BAO_Contact
::getContactType($contactId);
360 $contactSubType = CRM_Contact_BAO_Contact
::getContactSubType($contactId);
363 foreach ($allRelationshipType as $key => $value) {
364 // the contact type is required or matches
365 if (((!$value['contact_type_a']) ||
366 $value['contact_type_a'] == $contactType
368 // the other contact type is required or present or matches
369 ((!$value['contact_type_b']) ||
370 (!$otherContactType) ||
371 $value['contact_type_b'] == $otherContactType
374 (in_array($value['contact_sub_type_a'], $contactSubType) ||
375 ((!$value['contact_sub_type_b'] &&
376 !$value['contact_sub_type_a']
378 !$onlySubTypeRelationTypes
383 $relationshipType[$key . '_a_b'] = $value["{$column}_a_b"];
385 elseif (empty($value['contact_type_b'])) {
386 // case contact_type_b is "all contacts", CRM-9877
387 $relationshipType[$key . '_a_b'] = $value["{$column}_a_b"];
390 if (((!$value['contact_type_b']) ||
391 $value['contact_type_b'] == $contactType
393 ((!$value['contact_type_a']) ||
394 (!$otherContactType) ||
395 $value['contact_type_a'] == $otherContactType
398 (in_array($value['contact_sub_type_b'], $contactSubType) ||
399 ((!$value['contact_sub_type_a'] &&
400 !$value['contact_sub_type_b']
402 !$onlySubTypeRelationTypes
407 $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"];
409 elseif (empty($value['contact_type_a'])) {
410 // case contact_type_a is "all contacts", CRM-9877
411 $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"];
415 $relationshipType[$key . '_a_b'] = $value["{$column}_a_b"];
416 $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"];
420 if ($biDirectional) {
421 // lets clean up the data and eliminate all duplicate values
422 // (i.e. the relationship is bi-directional)
423 $relationshipType = array_unique($relationshipType);
426 // sort the relationshipType in ascending order CRM-7736
427 asort($relationshipType);
428 return $relationshipType;
431 static function clearCurrentEmployer($id, $action) {
432 $relationship = new CRM_Contact_DAO_Relationship();
433 $relationship->id
= $id;
434 $relationship->find(TRUE);
436 //to delete relationship between household and individual \
437 //or between individual and orgnization
438 if (($action & CRM_Core_Action
::DISABLE
) ||
($action & CRM_Core_Action
::DELETE
)) {
439 $relTypes = CRM_Utils_Array
::index(array('name_a_b'), CRM_Core_PseudoConstant
::relationshipType('name'));
440 if ($relationship->relationship_type_id
== $relTypes['Employee of']['id'] ||
441 $relationship->relationship_type_id
== $relTypes['Household Member of']['id']) {
442 $sharedContact = new CRM_Contact_DAO_Contact();
443 $sharedContact->id
= $relationship->contact_id_a
;
444 $sharedContact->find(TRUE);
446 if ($relationship->relationship_type_id
== 4 && $relationship->contact_id_b
== $sharedContact->employer_id
) {
447 CRM_Contact_BAO_Contact_Utils
::clearCurrentEmployer($relationship->contact_id_a
);
451 return $relationship;
455 * Function to delete the relationship
457 * @param int $id relationship id
464 static function del($id) {
465 // delete from relationship table
466 CRM_Utils_Hook
::pre('delete', 'Relationship', $id, CRM_Core_DAO
::$_nullArray);
468 $relationship = self
::clearCurrentEmployer($id, CRM_Core_Action
::DELETE
);
469 if (CRM_Core_Permission
::access('CiviMember')) {
470 // create $params array which isrequired to delete memberships
471 // of the related contacts.
473 'relationship_type_id' => "{$relationship->relationship_type_id}_a_b",
474 'contact_check' => array($relationship->contact_id_b
=> 1),
478 // calling relatedMemberships to delete the memberships of
480 self
::relatedMemberships($relationship->contact_id_a
,
483 CRM_Core_Action
::DELETE
,
488 $relationship->delete();
489 CRM_Core_Session
::setStatus(ts('Selected relationship has been deleted successfully.'), ts('Record Deleted'), 'success');
491 CRM_Utils_Hook
::post('delete', 'Relationship', $relationship->id
, $relationship);
493 // delete the recently created Relationship
494 $relationshipRecent = array(
496 'type' => 'Relationship',
498 CRM_Utils_Recent
::del($relationshipRecent);
500 return $relationship;
504 * Function to disable/enable the relationship
506 * @param int $id relationship id
513 static function disableEnableRelationship($id, $action) {
514 $relationship = self
::clearCurrentEmployer($id, $action);
515 if (CRM_Core_Permission
::access('CiviMember')) {
516 // create $params array which isrequired to delete memberships
517 // of the related contacts.
519 'relationship_type_id' => "{$relationship->relationship_type_id}_a_b",
520 'contact_check' => array($relationship->contact_id_b
=> 1),
524 // calling relatedMemberships to delete/add the memberships of
526 if ($action & CRM_Core_Action
::DISABLE
) {
527 CRM_Contact_BAO_Relationship
::relatedMemberships($relationship->contact_id_a
,
530 CRM_Core_Action
::DELETE
,
534 elseif ($action & CRM_Core_Action
::ENABLE
) {
535 $ids['contact'] = $relationship->contact_id_a
;
536 CRM_Contact_BAO_Relationship
::relatedMemberships($relationship->contact_id_a
,
539 CRM_Core_Action
::ADD
,
547 * Delete the object records that are associated with this contact
549 * @param int $contactId id of the contact to delete
555 static function deleteContact($contactId) {
556 $relationship = new CRM_Contact_DAO_Relationship();
557 $relationship->contact_id_a
= $contactId;
558 $relationship->delete();
560 $relationship = new CRM_Contact_DAO_Relationship();
561 $relationship->contact_id_b
= $contactId;
562 $relationship->delete();
564 CRM_Contact_BAO_Household
::updatePrimaryContact(NULL, $contactId);
568 * Function to get the other contact in a relationship
570 * @param int $id relationship id
572 * $returns returns the contact ids in the realtionship
576 static function getContactIds($id) {
577 $relationship = new CRM_Contact_DAO_Relationship();
579 $relationship->id
= $id;
580 $relationship->selectAdd();
581 $relationship->selectAdd('contact_id_a, contact_id_b');
582 $relationship->find(TRUE);
584 return $relationship;
588 * Function to check if the relationship type selected between two contacts is correct
590 * @param int $contact_a 1st contact id
591 * @param int $contact_b 2nd contact id
592 * @param int $relationshipTypeId relationship type id
594 * @return boolean true if it is valid relationship else false
598 static function checkRelationshipType($contact_a, $contact_b, $relationshipTypeId) {
599 $relationshipType = new CRM_Contact_DAO_RelationshipType();
600 $relationshipType->id
= $relationshipTypeId;
601 $relationshipType->selectAdd();
602 $relationshipType->selectAdd('contact_type_a, contact_type_b, contact_sub_type_a, contact_sub_type_b');
603 if ($relationshipType->find(TRUE)) {
604 $contact_type_a = CRM_Contact_BAO_Contact
::getContactType($contact_a);
605 $contact_type_b = CRM_Contact_BAO_Contact
::getContactType($contact_b);
607 $contact_sub_type_a = CRM_Contact_BAO_Contact
::getContactSubType($contact_a);
608 $contact_sub_type_b = CRM_Contact_BAO_Contact
::getContactSubType($contact_b);
610 if (((!$relationshipType->contact_type_a
) ||
($relationshipType->contact_type_a
== $contact_type_a)) &&
611 ((!$relationshipType->contact_type_b
) ||
($relationshipType->contact_type_b
== $contact_type_b)) &&
612 ((!$relationshipType->contact_sub_type_a
) ||
(in_array($relationshipType->contact_sub_type_a
,
615 ((!$relationshipType->contact_sub_type_b
) ||
(in_array($relationshipType->contact_sub_type_b
,
629 * this function does the validtion for valid relationship
631 * @param array $params this array contains the values there are subitted by the form
632 * @param array $ids the array that holds all the db ids
633 * @param integer $contactId this is contact id for adding relationship
639 static function checkValidRelationship(&$params, &$ids, $contactId) {
642 // get the string of relationship type
643 $relationshipTypes = CRM_Utils_Array
::value('relationship_type_id', $params);
644 list($type, $first, $second) = explode('_', $relationshipTypes);
645 $
{'contact_' . $first} = CRM_Utils_Array
::value('contact', $ids);
646 $
{'contact_' . $second} = $contactId;
647 // function to check if the relationship selected is correct
648 // i.e. employer relationship can exit between Individual and Organization (not between Individual and Individual)
649 if (!CRM_Contact_BAO_Relationship
::checkRelationshipType($contact_a, $contact_b, $type)) {
650 $errors = 'Please select valid relationship between these two contacts.';
656 * this function checks for duplicate relationship
658 * @param array $params (reference ) an assoc array of name/value pairs
659 * @param integer $id this the id of the contact whom we are adding relationship
660 * @param integer $contactId this is contact id for adding relationship
661 * @param integer $relationshipId this is relationship id for the contact
663 * @return boolean true if record exists else false
667 static function checkDuplicateRelationship(&$params, $id, $contactId = 0, $relationshipId = 0) {
668 $relationshipTypeId = CRM_Utils_Array
::value('relationship_type_id', $params);
669 list($type, $first, $second) = explode('_', $relationshipTypeId);
673 FROM civicrm_relationship
674 WHERE relationship_type_id = " . CRM_Utils_Type
::escape($type, 'Integer');
677 * CRM-11792 - date fields from API are in ISO format, but this function
678 * supports date arrays BAO has increasingly standardised to ISO format
679 * so I believe this function should support ISO rather than make API
680 * format it - however, need to support array format for now to avoid breakage
681 * @ time of writing this function is called from Relationship::create (twice)
682 * CRM_BAO_Contact_Utils::clearCurrentEmployer (seemingly without dates)
683 * CRM_Contact_Form_Task_AddToOrganization::postProcess &
684 * CRM_Contact_Form_Task_AddToHousehold::postProcess
685 * (I don't think the last 2 support dates but not sure
688 $dateFields = array('end_date', 'start_date');
689 foreach ($dateFields as $dateField){
690 if(array_key_exists($dateField, $params)) {
691 if (empty($params[$dateField]) ||
$params[$dateField] == 'null'){
692 //this is most likely coming from an api call & probably loaded
693 // from the DB to deal with some of the
694 // other myriad of excessive checks still in place both in
695 // the api & the create functions
696 $queryString .= " AND $dateField IS NULL";
699 elseif (is_array($params[$dateField])){
700 $queryString .= " AND $dateField = " .
701 CRM_Utils_Type
::escape(CRM_Utils_Date
::format($params[$dateField]), 'Date');
704 $queryString .= " AND $dateField = " .
705 CRM_Utils_Type
::escape($params[$dateField], 'Date');
711 " AND ( ( contact_id_a = " . CRM_Utils_Type
::escape($id, 'Integer') .
712 " AND contact_id_b = " . CRM_Utils_Type
::escape($contactId, 'Integer') .
713 " ) OR ( contact_id_a = " . CRM_Utils_Type
::escape($contactId, 'Integer') .
714 " AND contact_id_b = " . CRM_Utils_Type
::escape($id, 'Integer') . " ) ) ";
716 //if caseId is provided, include it duplicate checking.
717 if ($caseId = CRM_Utils_Array
::value('case_id', $params)) {
718 $queryString .= " AND case_id = " . CRM_Utils_Type
::escape($caseId, 'Integer');
721 if ($relationshipId) {
722 $queryString .= " AND id !=" . CRM_Utils_Type
::escape($relationshipId, 'Integer');
725 $relationship = new CRM_Contact_BAO_Relationship();
726 $relationship->query($queryString);
727 $relationship->fetch();
728 $relationship->free();
729 return ($relationship->id
) ?
TRUE : FALSE;
733 * update the is_active flag in the db
735 * @param int $id id of the database record
736 * @param boolean $is_active value we want to set the is_active field
738 * @return Object DAO object on success, null otherwise
741 static function setIsActive($id, $is_active) {
742 // as both the create & add functions have a bunch of logic in them that
743 // doesn't seem to cope with a normal update we will call the api which
744 // has tested handling for this
745 // however, a longer term solution would be to simplify the add, create & api functions
746 // to be more standard. It is debatable @ that point whether it's better to call the BAO
747 // direct as the api is more tested.
748 civicrm_api3('relationship', 'create', array('id' => $id, 'is_active' => $is_active));
750 // call (undocumented possibly deprecated) hook
751 CRM_Utils_Hook
::enableDisable('CRM_Contact_BAO_Relationship', $id, $is_active);
757 * Given the list of params in the params array, fetch the object
758 * and store the values in the values array
760 * @param array $params input parameters to find object
761 * @param array $values output values of the object
762 * @param array $ids the array that holds all the db ids
764 * @return array (reference) the values that could be potentially assigned to smarty
768 static function &getValues(&$params, &$values) {
769 if (empty($params)) {
774 // get the specific number of relationship or all relationships.
775 if (!empty($params['numRelationship'])) {
776 $v['data'] = &CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'], NULL, $params['numRelationship']);
779 $v['data'] = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id']);
782 // get the total count of relationships
783 $v['totalCount'] = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'], NULL, NULL, TRUE);
785 $values['relationship']['data'] = &$v['data'];
786 $values['relationship']['totalCount'] = &$v['totalCount'];
792 * helper function to form the sql for relationship retrieval
794 * @param int $contactId contact id
795 * @param int $status (check const at top of file)
796 * @param int $numRelationship no of relationships to display (limit)
797 * @param int $count get the no of relationships
798 * $param int $relationshipId relationship id
799 * @param string $direction the direction we are interested in a_b or b_a
800 * @param array $params array of extra values including relationship_type_id per api spec
802 * return string the query for this diretion
806 static function makeURLClause($contactId, $status, $numRelationship, $count, $relationshipId, $direction, $params = array()) {
807 $select = $from = $where = '';
811 if ($direction == 'a_b') {
812 $select .= ' SELECT count(DISTINCT civicrm_relationship.id) as cnt1, 0 as cnt2 ';
815 $select .= ' SELECT 0 as cnt1, count(DISTINCT civicrm_relationship.id) as cnt2 ';
819 $select .= ' SELECT civicrm_relationship.id as civicrm_relationship_id,
820 civicrm_contact.sort_name as sort_name,
821 civicrm_contact.display_name as display_name,
822 civicrm_contact.job_title as job_title,
823 civicrm_contact.employer_id as employer_id,
824 civicrm_contact.organization_name as organization_name,
825 civicrm_address.street_address as street_address,
826 civicrm_address.city as city,
827 civicrm_address.postal_code as postal_code,
828 civicrm_state_province.abbreviation as state,
829 civicrm_country.name as country,
830 civicrm_email.email as email,
831 civicrm_phone.phone as phone,
832 civicrm_contact.id as civicrm_contact_id,
833 civicrm_contact.contact_type as contact_type,
834 civicrm_relationship.contact_id_b as contact_id_b,
835 civicrm_relationship.contact_id_a as contact_id_a,
836 civicrm_relationship_type.id as civicrm_relationship_type_id,
837 civicrm_relationship.start_date as start_date,
838 civicrm_relationship.end_date as end_date,
839 civicrm_relationship.description as description,
840 civicrm_relationship.is_active as is_active,
841 civicrm_relationship.is_permission_a_b as is_permission_a_b,
842 civicrm_relationship.is_permission_b_a as is_permission_b_a,
843 civicrm_relationship.case_id as case_id';
845 if ($direction == 'a_b') {
846 $select .= ', civicrm_relationship_type.label_a_b as label_a_b,
847 civicrm_relationship_type.label_b_a as relation ';
850 $select .= ', civicrm_relationship_type.label_a_b as label_a_b,
851 civicrm_relationship_type.label_a_b as relation ';
856 FROM civicrm_relationship
857 INNER JOIN civicrm_relationship_type ON ( civicrm_relationship.relationship_type_id = civicrm_relationship_type.id )
858 INNER JOIN civicrm_contact ";
859 if ($direction == 'a_b') {
860 $from .= 'ON ( civicrm_contact.id = civicrm_relationship.contact_id_a ) ';
863 $from .= 'ON ( civicrm_contact.id = civicrm_relationship.contact_id_b ) ';
866 LEFT JOIN civicrm_address ON (civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1)
867 LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = civicrm_contact.id AND civicrm_phone.is_primary = 1)
868 LEFT JOIN civicrm_email ON (civicrm_email.contact_id = civicrm_contact.id AND civicrm_email.is_primary = 1)
869 LEFT JOIN civicrm_state_province ON (civicrm_address.state_province_id = civicrm_state_province.id)
870 LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id)
872 $where = 'WHERE ( 1 )';
874 if ($direction == 'a_b') {
875 $where .= ' AND civicrm_relationship.contact_id_b = ' . CRM_Utils_Type
::escape($contactId, 'Positive');
878 $where .= ' AND civicrm_relationship.contact_id_a = ' . CRM_Utils_Type
::escape($contactId, 'Positive');
881 if ($relationshipId) {
882 $where .= ' AND civicrm_relationship.id = ' . CRM_Utils_Type
::escape($relationshipId, 'Positive');
885 $date = date('Y-m-d');
886 if ($status == self
::PAST
) {
887 //this case for showing past relationship
888 $where .= ' AND civicrm_relationship.is_active = 1 ';
889 $where .= " AND civicrm_relationship.end_date < '" . $date . "'";
891 elseif ($status == self
::DISABLED
) {
892 // this case for showing disabled relationship
893 $where .= ' AND civicrm_relationship.is_active = 0 ';
895 elseif ($status == self
::CURRENT
) {
896 //this case for showing current relationship
897 $where .= ' AND civicrm_relationship.is_active = 1 ';
898 $where .= " AND (civicrm_relationship.end_date >= '" . $date . "' OR civicrm_relationship.end_date IS NULL) ";
900 elseif ($status == self
::INACTIVE
) {
901 //this case for showing inactive relationships
902 $where .= " AND (civicrm_relationship.end_date < '" . $date . "'";
903 $where .= ' OR civicrm_relationship.is_active = 0 )';
907 $where .= ' AND civicrm_contact.is_deleted = 0';
908 if(!empty($params['membership_type_id']) && empty($params['relationship_type_id'])) {
909 $where .= self
::membershipTypeToRelationshipTypes($params, $direction);
911 if(!empty($params['relationship_type_id'])) {
912 if(is_array($params['relationship_type_id'])) {
913 $where .= " AND " . CRM_Core_DAO
::createSQLFilter('relationship_type_id', $params['relationship_type_id'], 'Integer');
916 $where .= ' AND relationship_type_id = ' . CRM_Utils_Type
::escape($params['relationship_type_id'], 'Positive');
919 if ($direction == 'a_b') {
920 $where .= ' ) UNION ';
926 return array($select, $from, $where);
930 * This is the function to get the list of relationships
932 * @param int $contactId contact id
933 * @param int $status 1: Past 2: Disabled 3: Current
934 * @param int $numRelationship no of relationships to display (limit)
935 * @param int $count get the no of relationships
936 * $param int $relationshipId relationship id
937 * $param array $links the list of links to display
938 * $param int $permissionMask the permission mask to be applied for the actions
939 * $param boolean $permissionedContact to return only permissioned Contact
940 * $param array $params array of variables consistent with filters supported by the api
941 * return array $values relationship records
945 static function getRelationship($contactId = NULL,
946 $status = 0, $numRelationship = 0,
947 $count = 0, $relationshipId = 0,
948 $links = NULL, $permissionMask = NULL,
949 $permissionedContact = FALSE,
953 if (!$contactId && !$relationshipId) {
957 list($select1, $from1, $where1) = self
::makeURLClause($contactId, $status, $numRelationship,
958 $count, $relationshipId, 'a_b', $params
960 list($select2, $from2, $where2) = self
::makeURLClause($contactId, $status, $numRelationship,
961 $count, $relationshipId, 'b_a', $params
964 $order = $limit = '';
966 $order = ' ORDER BY civicrm_relationship_type_id, sort_name ';
968 if ($numRelationship) {
969 $limit = " LIMIT 0, $numRelationship";
973 // building the query string
975 $queryString = $select1 . $from1 . $where1 . $select2 . $from2 . $where2 . $order . $limit;
977 $relationship = new CRM_Contact_DAO_Relationship();
979 $relationship->query($queryString);
982 $relationshipCount = 0;
983 while ($relationship->fetch()) {
984 $relationshipCount +
= $relationship->cnt1 +
$relationship->cnt2
;
986 return $relationshipCount;
991 if ($status != self
::INACTIVE
) {
993 $mask = array_sum(array_keys($links));
994 if ($mask & CRM_Core_Action
::DISABLE
) {
995 $mask -= CRM_Core_Action
::DISABLE
;
997 if ($mask & CRM_Core_Action
::ENABLE
) {
998 $mask -= CRM_Core_Action
::ENABLE
;
1001 if ($status == self
::CURRENT
) {
1002 $mask |
= CRM_Core_Action
::DISABLE
;
1004 elseif ($status == self
::DISABLED
) {
1005 $mask |
= CRM_Core_Action
::ENABLE
;
1007 $mask = $mask & $permissionMask;
1010 while ($relationship->fetch()) {
1011 $rid = $relationship->civicrm_relationship_id
;
1012 $cid = $relationship->civicrm_contact_id
;
1013 if (($permissionedContact) &&
1014 (!CRM_Contact_BAO_Contact_Permission
::relationship($cid, $contactId))
1018 $values[$rid]['id'] = $rid;
1019 $values[$rid]['cid'] = $cid;
1020 $values[$rid]['contact_id_a'] = $relationship->contact_id_a
;
1021 $values[$rid]['contact_id_b'] = $relationship->contact_id_b
;
1022 $values[$rid]['relationship_type_id'] = $relationship->civicrm_relationship_type_id
;
1023 $values[$rid]['relation'] = $relationship->relation
;
1024 $values[$rid]['name'] = $relationship->sort_name
;
1025 $values[$rid]['display_name'] = $relationship->display_name
;
1026 $values[$rid]['job_title'] = $relationship->job_title
;
1027 $values[$rid]['email'] = $relationship->email
;
1028 $values[$rid]['phone'] = $relationship->phone
;
1029 $values[$rid]['employer_id'] = $relationship->employer_id
;
1030 $values[$rid]['organization_name'] = $relationship->organization_name
;
1031 $values[$rid]['country'] = $relationship->country
;
1032 $values[$rid]['city'] = $relationship->city
;
1033 $values[$rid]['state'] = $relationship->state
;
1034 $values[$rid]['start_date'] = $relationship->start_date
;
1035 $values[$rid]['end_date'] = $relationship->end_date
;
1036 $values[$rid]['description'] = $relationship->description
;
1037 $values[$rid]['is_active'] = $relationship->is_active
;
1038 $values[$rid]['is_permission_a_b'] = $relationship->is_permission_a_b
;
1039 $values[$rid]['is_permission_b_a'] = $relationship->is_permission_b_a
;
1040 $values[$rid]['case_id'] = $relationship->case_id
;
1043 $values[$rid]['status'] = $status;
1046 $values[$rid]['civicrm_relationship_type_id'] = $relationship->civicrm_relationship_type_id
;
1048 if ($relationship->contact_id_a
== $contactId) {
1049 $values[$rid]['rtype'] = 'a_b';
1052 $values[$rid]['rtype'] = 'b_a';
1058 'rtype' => $values[$rid]['rtype'],
1059 'cid' => $contactId,
1060 'cbid' => $values[$rid]['cid'],
1061 'caseid' => $values[$rid]['case_id'],
1062 'clientid' => $contactId,
1065 if ($status == self
::INACTIVE
) {
1066 // setting links for inactive relationships
1067 $mask = array_sum(array_keys($links));
1068 if (!$values[$rid]['is_active']) {
1069 $mask -= CRM_Core_Action
::DISABLE
;
1072 $mask -= CRM_Core_Action
::ENABLE
;
1073 $mask -= CRM_Core_Action
::DISABLE
;
1077 // Give access to manage case link by copying to MAX_ACTION index temporarily, depending on case permission of user.
1078 if ($values[$rid]['case_id']) {
1079 // Borrowed logic from CRM_Case_Page_Tab
1080 $hasCaseAccess = FALSE;
1081 if (CRM_Core_Permission
::check('access all cases and activities')) {
1082 $hasCaseAccess = TRUE;
1085 $userCases = CRM_Case_BAO_Case
::getCases(FALSE);
1086 if (array_key_exists($values[$rid]['case_id'], $userCases)) {
1087 $hasCaseAccess = TRUE;
1091 if ($hasCaseAccess) {
1092 // give access by copying to MAX_ACTION temporarily, otherwise leave at NONE which won't display
1093 $links[CRM_Core_Action
::MAX_ACTION
] = $links[CRM_Core_Action
::NONE
];
1094 $links[CRM_Core_Action
::MAX_ACTION
]['name'] = ts('Manage Case #%1', array(1 => $values[$rid]['case_id']));
1096 // Also make sure we have the right client cid since can get here from multiple relationship tabs.
1097 if ($values[$rid]['rtype'] == 'b_a') {
1098 $replace['clientid'] = $values[$rid]['cid'];
1103 $values[$rid]['action'] = CRM_Core_Action
::formLink(
1109 'relationship.selector.row',
1112 unset($links[CRM_Core_Action
::MAX_ACTION
]);
1116 $relationship->free();
1122 * Function to get get list of relationship type based on the target contact type.
1124 * @param string $targetContactType it's valid contact tpye(may be Individual , Organization , Household)
1126 * @return array - array reference of all relationship types with context to current contact type .
1129 function getRelationType($targetContactType) {
1130 $relationshipType = array();
1131 $allRelationshipType = CRM_Core_PseudoConstant
::relationshipType();
1133 foreach ($allRelationshipType as $key => $type) {
1134 if ($type['contact_type_b'] == $targetContactType) {
1135 $relationshipType[$key . '_a_b'] = $type['label_a_b'];
1139 return $relationshipType;
1143 * Function to create / update / delete membership for related contacts.
1145 * This function will create/update/delete membership for related
1146 * contact based on 1) contact have active membership 2) that
1147 * membership is is extedned by the same relationship type to that
1148 * of the existing relationship.
1150 * @param $contactId Int contact id
1151 * @param $params array array of values submitted by POST
1152 * @param $ids array array of ids
1153 * @param $action which action called this function
1158 static function relatedMemberships($contactId, &$params, $ids, $action = CRM_Core_Action
::ADD
, $active = TRUE) {
1159 // Check the end date and set the status of the relationship
1161 $status = self
::CURRENT
;
1163 if (!empty($params['end_date'])) {
1164 $endDate = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Date
::format($params['end_date']), NULL, 'Ymd');
1165 $today = date('Ymd');
1167 if ($today > $endDate) {
1168 $status = self
::PAST
;
1172 if (($action & CRM_Core_Action
::ADD
) &&
1173 ($status & self
::PAST
)
1175 // if relationship is PAST and action is ADD, no qustion
1176 // of creating RELATED membership and return back to
1181 $rel = explode('_', $params['relationship_type_id']);
1183 $relTypeId = $rel[0];
1184 $relDirection = "_{$rel[1]}_{$rel[2]}";
1185 $targetContact = array();
1186 if (($action & CRM_Core_Action
::ADD
) ||
1187 ($action & CRM_Core_Action
::DELETE
)
1189 $contact = $contactId;
1190 $targetContact = CRM_Utils_Array
::value('contact_check', $params);
1192 elseif ($action & CRM_Core_Action
::UPDATE
) {
1193 $contact = $ids['contact'];
1194 $targetContact = array($ids['contactTarget'] => 1);
1197 // Build the 'values' array for
1200 // This will allow us to check if either of the contacts in
1201 // relationship have active memberships.
1206 $values[$contact] = array(
1207 'relatedContacts' => $targetContact,
1208 'relationshipTypeId' => $relTypeId,
1209 'relationshipTypeDirection' => $relDirection,
1212 if (!empty($targetContact)) {
1213 foreach ($targetContact as $cid => $donCare) {
1214 $values[$cid] = array(
1215 'relatedContacts' => array($contact => 1),
1216 'relationshipTypeId' => $relTypeId,
1219 $relTypeParams = array('id' => $relTypeId);
1220 $relTypeValues = array();
1221 CRM_Contact_BAO_RelationshipType
::retrieve($relTypeParams, $relTypeValues);
1223 if (CRM_Utils_Array
::value('name_a_b', $relTypeValues) == CRM_Utils_Array
::value('name_b_a', $relTypeValues)) {
1224 $values[$cid]['relationshipTypeDirection'] = '_a_b';
1227 $values[$cid]['relationshipTypeDirection'] = ($relDirection == '_a_b') ?
'_b_a' : '_a_b';
1232 // Now get the active memberships for all the contacts.
1233 // If contact have any valid membership(s), then add it to
1235 foreach ($values as $cid => $subValues) {
1236 $memParams = array('contact_id' => $cid);
1237 $memberships = array();
1239 CRM_Member_BAO_Membership
::getValues($memParams, $memberships, $active);
1241 if (empty($memberships)) {
1245 $values[$cid]['memberships'] = $memberships;
1247 $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant
::membershipStatus());
1249 // done with 'values' array.
1250 // Finally add / edit / delete memberships for the related contacts
1251 foreach ($values as $cid => $details) {
1252 if (!array_key_exists('memberships', $details)) {
1256 $mainRelatedContactId = key(CRM_Utils_Array
::value('relatedContacts', $details, array()));
1258 foreach ($details['memberships'] as $membershipId => $membershipValues) {
1259 $relTypeIds = array();
1260 if ($action & CRM_Core_Action
::DELETE
) {
1261 // Delete memberships of the related contacts only if relationship type exists for membership type
1263 SELECT relationship_type_id, relationship_direction
1264 FROM civicrm_membership_type
1265 WHERE id = {$membershipValues['membership_type_id']}";
1266 $dao = CRM_Core_DAO
::executeQuery($query);
1267 $relTypeDirs = array();
1268 while ($dao->fetch()) {
1269 $relTypeId = $dao->relationship_type_id
;
1270 $relDirection = $dao->relationship_direction
;
1272 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $relTypeId);
1273 if (in_array($values[$cid]['relationshipTypeId'], $relTypeIds)) {
1274 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipId, $mainRelatedContactId);
1278 if (($action & CRM_Core_Action
::UPDATE
) &&
1279 ($status & self
::PAST
) &&
1280 ($membershipValues['owner_membership_id'])
1282 // If relationship is PAST and action is UPDATE
1283 // then delete the RELATED membership
1284 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipValues['owner_membership_id'],
1285 $membershipValues['membership_contact_id']
1290 // add / edit the memberships for related
1293 // Get the Membership Type Details.
1294 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipValues['membership_type_id']);
1295 // Check if contact's relationship type exists in membership type
1296 $relTypeDirs = array();
1297 if (!empty($membershipType['relationship_type_id'])) {
1298 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_type_id']);
1300 if (!empty($membershipType['relationship_direction'])) {
1301 $relDirections = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_direction']);
1303 foreach ($relTypeIds as $key => $value) {
1304 $relTypeDirs[] = $value . '_' . $relDirections[$key];
1306 $relTypeDir = $details['relationshipTypeId'] . $details['relationshipTypeDirection'];
1307 if (in_array($relTypeDir, $relTypeDirs)) {
1308 // Check if relationship being created/updated is
1309 // similar to that of membership type's
1312 $membershipValues['owner_membership_id'] = $membershipId;
1313 unset($membershipValues['id']);
1314 unset($membershipValues['membership_contact_id']);
1315 unset($membershipValues['contact_id']);
1316 unset($membershipValues['membership_id']);
1317 foreach ($details['relatedContacts'] as $relatedContactId => $donCare) {
1318 $membershipValues['contact_id'] = $relatedContactId;
1319 if ($deceasedStatusId &&
1320 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $relatedContactId, 'is_deceased')
1322 $membershipValues['status_id'] = $deceasedStatusId;
1323 $membershipValues['skipStatusCal'] = TRUE;
1326 'join_date', 'start_date', 'end_date') as $dateField) {
1327 if (!empty($membershipValues[$dateField])) {
1328 $membershipValues[$dateField] = CRM_Utils_Date
::processDate($membershipValues[$dateField]);
1332 if ($action & CRM_Core_Action
::UPDATE
) {
1333 //delete the membership record for related
1334 //contact before creating new membership record.
1335 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipId, $relatedContactId);
1338 // check whether we have some related memberships still available
1341 FROM civicrm_membership
1342 LEFT JOIN civicrm_membership_status ON (civicrm_membership_status.id = civicrm_membership.status_id)
1343 WHERE membership_type_id = {$membershipValues['membership_type_id']} AND owner_membership_id = {$membershipValues['owner_membership_id']}
1344 AND is_current_member = 1";
1345 $result = CRM_Core_DAO
::singleValueQuery($query);
1346 if ($result < CRM_Utils_Array
::value('max_related', $membershipValues, PHP_INT_MAX
)) {
1347 CRM_Member_BAO_Membership
::create($membershipValues, CRM_Core_DAO
::$_nullArray);
1351 elseif ($action & CRM_Core_Action
::UPDATE
) {
1352 // if action is update and updated relationship do
1353 // not match with the existing
1354 // membership=>relationship then we need to
1355 // delete the membership record created for
1356 // previous relationship.
1358 if (self
::isDeleteRelatedMembership($relTypeIds, $contactId, $mainRelatedContactId, $relTypeId, CRM_Utils_Array
::value('relationship_ids', $params))) {
1359 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipId, $mainRelatedContactId);
1367 * Helper function to check whether to delete the membership or
1373 static function isDeleteRelatedMembership($relTypeIds, $contactId, $mainRelatedContactId, $relTypeId, $relIds) {
1374 if (in_array($relTypeId, $relTypeIds)) {
1378 if (empty($relIds)) {
1382 $relParamas = array(1 => array($contactId, 'Integer'),
1383 2 => array($mainRelatedContactId, 'Integer'),
1386 if ($contactId == $mainRelatedContactId) {
1387 $recordsFound = (int)CRM_Core_DAO
::singleValueQuery("SELECT COUNT(*) FROM civicrm_relationship WHERE relationship_type_id IN ( " . implode(',', $relTypeIds) . " ) AND contact_id_a IN ( %1 ) OR contact_id_b IN ( %1 ) AND id IN (" . implode(',', $relIds) . ")", $relParamas);
1388 if ($recordsFound) {
1394 $recordsFound = (int)CRM_Core_DAO
::singleValueQuery("SELECT COUNT(*) FROM civicrm_relationship WHERE relationship_type_id IN ( " . implode(',', $relTypeIds) . " ) AND contact_id_a IN ( %1, %2 ) AND contact_id_b IN ( %1, %2 ) AND id NOT IN (" . implode(',', $relIds) . ")", $relParamas);
1396 if ($recordsFound) {
1404 * Function to get Current Employer for Contact
1406 * @param $contactIds Contact Ids
1408 * @return $currentEmployer array of the current employer
1413 static function getCurrentEmployer($contactIds) {
1414 $contacts = implode(',', $contactIds);
1417 SELECT organization_name, id, employer_id
1418 FROM civicrm_contact
1419 WHERE id IN ( {$contacts} )
1422 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
1423 $currentEmployer = array();
1424 while ($dao->fetch()) {
1425 $currentEmployer[$dao->id
]['org_id'] = $dao->employer_id
;
1426 $currentEmployer[$dao->id
]['org_name'] = $dao->organization_name
;
1429 return $currentEmployer;
1433 * Function to return list of permissioned employer for a given contact.
1435 * @param $contactID int contact id whose employers
1437 * @param $name string employers sort name
1441 * @return array array of employers.
1444 static function getPermissionedEmployer($contactID, $name = NULL) {
1445 //get the relationship id
1446 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType',
1447 'Employee of', 'id', 'name_a_b'
1450 return self
::getPermissionedContacts($contactID, $relTypeId, $name);
1455 * Function to return list of permissioned contacts for a given contact and relationship type
1457 * @param $contactID int contact id whose permissioned contacts are to be found.
1458 * @param $relTypeId string one or more relationship type id's
1459 * @param $name string
1463 * @return array of contacts
1465 static function getPermissionedContacts($contactID, $relTypeId, $name = NULL) {
1466 $contacts = array();
1470 SELECT cc.id as id, cc.sort_name as name
1471 FROM civicrm_relationship cr, civicrm_contact cc
1473 cr.contact_id_a = %1 AND
1474 cr.relationship_type_id IN (%2) AND
1475 cr.is_permission_a_b = 1 AND
1476 IF(cr.end_date IS NULL, 1, (DATEDIFF( CURDATE( ), cr.end_date ) <= 0)) AND
1477 cr.is_active = 1 AND
1478 cc.id = cr.contact_id_b";
1480 if (!empty($name)) {
1481 $name = CRM_Utils_Type
::escape($name, 'String');
1483 AND cc.sort_name LIKE '%$name%'";
1486 $args = array(1 => array($contactID, 'Integer'), 2 => array($relTypeId, 'String'));
1487 $dao = CRM_Core_DAO
::executeQuery($query, $args);
1489 while ($dao->fetch()) {
1490 $contacts[$dao->id
] = array(
1491 'name' => $dao->name
,
1492 'value' => $dao->id
,
1500 * Merge relationships from otherContact to mainContact
1501 * Called during contact merge operation
1503 * @param int $mainId contact id of main contact record.
1504 * @param int $otherId contact id of record which is going to merge.
1505 * @param array $sqls (reference) array of sql statements to append to.
1507 * @see CRM_Dedupe_Merger::cpTables()
1511 static function mergeRelationships($mainId, $otherId, &$sqls) {
1512 // Delete circular relationships
1513 $sqls[] = "DELETE FROM civicrm_relationship
1514 WHERE (contact_id_a = $mainId AND contact_id_b = $otherId)
1515 OR (contact_id_b = $mainId AND contact_id_a = $otherId)";
1517 // Delete relationship from other contact if main contact already has that relationship
1518 $sqls[] = "DELETE r2
1519 FROM civicrm_relationship r1, civicrm_relationship r2
1520 WHERE r1.relationship_type_id = r2.relationship_type_id
1523 r1.contact_id_a = $mainId AND r2.contact_id_a = $otherId AND r1.contact_id_b = r2.contact_id_b
1524 OR r1.contact_id_b = $mainId AND r2.contact_id_b = $otherId AND r1.contact_id_a = r2.contact_id_a
1526 (r1.contact_id_a = $mainId AND r2.contact_id_b = $otherId AND r1.contact_id_b = r2.contact_id_a
1527 OR r1.contact_id_b = $mainId AND r2.contact_id_a = $otherId AND r1.contact_id_a = r2.contact_id_b)
1528 AND r1.relationship_type_id IN (SELECT id FROM civicrm_relationship_type WHERE name_b_a = name_a_b)
1532 // Move relationships
1533 $sqls[] = "UPDATE IGNORE civicrm_relationship SET contact_id_a = $mainId WHERE contact_id_a = $otherId";
1534 $sqls[] = "UPDATE IGNORE civicrm_relationship SET contact_id_b = $mainId WHERE contact_id_b = $otherId";
1536 // Move current employer id (name will get updated later)
1537 $sqls[] = "UPDATE civicrm_contact SET employer_id = $mainId WHERE employer_id = $otherId";
1541 * Set 'is_valid' field to false for all relationships whose end date is in the past, ie. are expired.
1543 * @return True on success, false if error is encountered.
1545 static function disableExpiredRelationships() {
1546 $query = "SELECT id FROM civicrm_relationship WHERE is_active = 1 AND end_date < CURDATE()";
1548 $dao = CRM_Core_DAO
::executeQuery($query);
1549 while ($dao->fetch()) {
1550 $result = CRM_Contact_BAO_Relationship
::setIsActive($dao->id
, FALSE);
1551 // Result will be NULL if error occurred. We abort early if error detected.
1552 if ($result == NULL) {
1560 * Function filters the query by possible relationships for the membership type
1561 * It is intended to be called when constructing queries for the api (reciprocal & non-reciprocal)
1562 * and to add clauses to limit the return to those relationships which COULD inherit a membership type
1563 * (as opposed to those who inherit a particular membership
1565 * @param array $params api input array
1567 static function membershipTypeToRelationshipTypes(&$params, $direction = NULL) {
1568 $membershipType = civicrm_api3('membership_type', 'getsingle', array('id' => $params['membership_type_id'], 'return' => 'relationship_type_id, relationship_direction'));
1569 $relationshipTypes = $membershipType['relationship_type_id'];
1570 if(empty($relationshipTypes)) {
1573 // if we don't have any contact data we can only filter on type
1574 if(empty($params['contact_id']) && empty($params['contact_id_a']) && empty($params['contact_id_a'])) {
1575 $params['relationship_type_id'] = array('IN' => $relationshipTypes);
1579 $relationshipDirections = (array) $membershipType['relationship_direction'];
1580 // if we have contact_id_a OR contact_id_b we can make a call here
1581 // if we have contact??
1582 foreach ($relationshipDirections as $index => $mtdirection) {
1583 if(isset($params['contact_id_a']) && $mtdirection == 'a_b' ||
$direction == 'a_b') {
1584 $types[] = $relationshipTypes[$index];
1586 if(isset($params['contact_id_b']) && $mtdirection == 'b_a' ||
$direction == 'b_a') {
1587 $types[] = $relationshipTypes[$index];
1590 if(!empty($types)) {
1591 $params['relationship_type_id'] = array('IN' => $types);
1593 elseif(!empty($clauses)) {
1594 return explode(' OR ', $clauses);
1597 // effectively setting it to return no results
1598 $params['relationship_type_id'] = 0;