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
118 self
::checkDuplicateRelationship(
120 CRM_Utils_Array
::value('contact', $ids),
121 $ids['contactTarget'],
126 return array($valid, $invalid, $duplicate, $saved, NULL);
129 $validContacts = TRUE;
130 //validate contacts in update mode also.
131 if (CRM_Utils_Array
::value('contact', $ids) &&
132 CRM_Utils_Array
::value('contactTarget', $ids)
134 if (self
::checkValidRelationship($params, $ids, $ids['contactTarget'])) {
135 $validContacts = FALSE;
139 if ($validContacts) {
140 // editing an existing relationship
141 $relationship = self
::add($params, $ids, $ids['contactTarget']);
142 $relationshipIds[] = $relationship->id
;
143 $relationships[$relationship->id
] = $relationship;
148 // do not add to recent items for import, CRM-4399
149 if (!(CRM_Utils_Array
::value('skipRecentView', $params) ||
$invalid ||
$duplicate)) {
150 $url = CRM_Utils_System
::url('civicrm/contact/view/rel',
151 "action=view&reset=1&id={$relationship->id}&cid={$relationship->contact_id_a}&context=home"
155 $session = CRM_Core_Session
::singleton();
156 $recentOther = array();
157 if (($session->get('userID') == $relationship->contact_id_a
) ||
158 CRM_Contact_BAO_Contact_Permission
::allow($relationship->contact_id_a
, CRM_Core_Permission
::EDIT
)
160 $rType = substr(CRM_Utils_Array
::value('relationship_type_id', $params), -3);
161 $recentOther = array(
162 'editUrl' => CRM_Utils_System
::url('civicrm/contact/view/rel',
163 "action=update&reset=1&id={$relationship->id}&cid={$relationship->contact_id_a}&rtype={$rType}&context=home"
165 'deleteUrl' => CRM_Utils_System
::url('civicrm/contact/view/rel',
166 "action=delete&reset=1&id={$relationship->id}&cid={$relationship->contact_id_a}&rtype={$rType}&context=home"
171 $title = CRM_Contact_BAO_Contact
::displayName($relationship->contact_id_a
) . ' (' . CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType',
172 $relationship->relationship_type_id
, 'label_a_b'
173 ) . ' ' . CRM_Contact_BAO_Contact
::displayName($relationship->contact_id_b
) . ')';
174 // add the recently created Relationship
175 CRM_Utils_Recent
::add($title,
179 $relationship->contact_id_a
,
185 return array($valid, $invalid, $duplicate, $saved, $relationshipIds, $relationships);
189 * This is the function that check/add if the relationship created is valid
191 * @param array $params (reference ) an assoc array of name/value pairs
192 * @param integer $contactId this is contact id for adding relationship
193 * @param array $ids the array that holds all the db ids
195 * @return object CRM_Contact_BAO_Relationship
199 static function add(&$params, &$ids, $contactId) {
200 if (CRM_Utils_Array
::value('relationship', $ids)) {
201 CRM_Utils_Hook
::pre('edit', 'Relationship', $ids['relationship'], $params);
204 CRM_Utils_Hook
::pre('create', 'Relationship', NULL, $params);
207 $relationshipTypes = CRM_Utils_Array
::value('relationship_type_id', $params);
209 // expolode the string with _ to get the relationship type id and to know which contact has to be inserted in
210 // contact_id_a and which one in contact_id_b
211 list($type, $first, $second) = explode('_', $relationshipTypes);
213 $
{'contact_' . $first} = CRM_Utils_Array
::value('contact', $ids);
214 $
{'contact_' . $second} = $contactId;
216 //check if the relationship type is Head of Household then update the household's primary contact with this contact.
218 CRM_Contact_BAO_Household
::updatePrimaryContact($contact_b, $contact_a);
221 $relationship = new CRM_Contact_BAO_Relationship();
222 $relationship->contact_id_b
= $contact_b;
223 $relationship->contact_id_a
= $contact_a;
224 $relationship->relationship_type_id
= $type;
225 $relationship->id
= CRM_Utils_Array
::value('relationship', $ids);
227 $dateFields = array('end_date', 'start_date');
229 foreach (self
::getdefaults() as $defaultField => $defaultValue){
230 if(isset($params[$defaultField])){
231 if(in_array($defaultField, $dateFields)){
232 $relationship->$defaultField = CRM_Utils_Date
::format(CRM_Utils_Array
::value($defaultField, $params));
233 if(!$relationship->$defaultField){
234 $relationship->$defaultField = 'NULL';
238 $relationship->$defaultField = $params[$defaultField];
241 elseif(empty($relationship->id
)){
242 $relationship->$defaultField = $defaultValue;
246 $relationship->save();
248 // add custom field values
249 if (CRM_Utils_Array
::value('custom', $params)) {
250 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_relationship', $relationship->id
);
253 $relationship->free();
255 if (CRM_Utils_Array
::value('relationship', $ids)) {
256 CRM_Utils_Hook
::post('edit', 'Relationship', $relationship->id
, $relationship);
259 CRM_Utils_Hook
::post('create', 'Relationship', $relationship->id
, $relationship);
262 return $relationship;
265 * Specifiy defaults for creating a relationship
267 * @return array $defaults array of defaults for creating relationship
271 static function getdefaults() {
274 'is_permission_a_b' => 0,
275 'is_permission_b_a' => 0,
277 'start_date' => 'NULL',
279 'end_date' => 'NULL',
285 * Check if there is data to create the object
287 * @param array $params (reference ) an assoc array of name/value pairs
293 static function dataExists(&$params) {
294 // return if no data present
295 if (!is_array(CRM_Utils_Array
::value('contact_check', $params))) {
302 * Function to get get list of relationship type based on the contact type.
304 * @param int $contactId this is the contact id of the current contact.
305 * @param string $strContact this value is currently ignored, keeping it there for legacy reasons
306 * @param string $relationshipId the id of the existing relationship if any
307 * @param string $contactType contact type
308 * @param boolean $all if true returns relationship types in both the direction
309 * @param string $column name/label that going to retrieve from db.
312 * @param string $contactSubType includes relationshiptypes between this subtype
314 * @param boolean $onlySubTypeRelationTypes if set only subtype which is passed by $contactSubType
315 * related relationshiptypes get return
319 * @return array - array reference of all relationship types with context to current contact.
321 static function getContactRelationshipType($contactId = NULL,
322 $contactSuffix = NULL,
323 $relationshipId = NULL,
327 $biDirectional = TRUE,
328 $contactSubType = NULL,
329 $onlySubTypeRelationTypes = FALSE
331 $allRelationshipType = array();
332 $relationshipType = array();
333 $allRelationshipType = CRM_Core_PseudoConstant
::relationshipType($column);
335 $otherContactType = NULL;
336 if ($relationshipId) {
337 $relationship = new CRM_Contact_DAO_Relationship();
338 $relationship->id
= $relationshipId;
339 if ($relationship->find(TRUE)) {
340 $contact = new CRM_Contact_DAO_Contact();
341 $contact->id
= ($relationship->contact_id_a
=== $contactId) ?
$relationship->contact_id_b
: $relationship->contact_id_a
;
343 if ($contact->find(TRUE)) {
344 $otherContactType = $contact->contact_type
;
345 //CRM-5125 for contact subtype specific relationshiptypes
346 if ($contact->contact_sub_type
) {
347 $otherContactSubType = $contact->contact_sub_type
;
353 $contactSubType = array();
355 $contactType = CRM_Contact_BAO_Contact
::getContactType($contactId);
356 $contactSubType = CRM_Contact_BAO_Contact
::getContactSubType($contactId);
359 foreach ($allRelationshipType as $key => $value) {
360 // the contact type is required or matches
361 if (((!$value['contact_type_a']) ||
362 $value['contact_type_a'] == $contactType
364 // the other contact type is required or present or matches
365 ((!$value['contact_type_b']) ||
366 (!$otherContactType) ||
367 $value['contact_type_b'] == $otherContactType
370 (in_array($value['contact_sub_type_a'], $contactSubType) ||
371 ((!$value['contact_sub_type_b'] &&
372 !$value['contact_sub_type_a']
374 !$onlySubTypeRelationTypes
379 $relationshipType[$key . '_a_b'] = $value["{$column}_a_b"];
381 elseif (empty($value['contact_type_b'])) {
382 // case contact_type_b is "all contacts", CRM-9877
383 $relationshipType[$key . '_a_b'] = $value["{$column}_a_b"];
386 if (((!$value['contact_type_b']) ||
387 $value['contact_type_b'] == $contactType
389 ((!$value['contact_type_a']) ||
390 (!$otherContactType) ||
391 $value['contact_type_a'] == $otherContactType
394 (in_array($value['contact_sub_type_b'], $contactSubType) ||
395 ((!$value['contact_sub_type_a'] &&
396 !$value['contact_sub_type_b']
398 !$onlySubTypeRelationTypes
403 $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"];
405 elseif (empty($value['contact_type_a'])) {
406 // case contact_type_a is "all contacts", CRM-9877
407 $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"];
411 $relationshipType[$key . '_a_b'] = $value["{$column}_a_b"];
412 $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"];
416 if ($biDirectional) {
417 // lets clean up the data and eliminate all duplicate values
418 // (i.e. the relationship is bi-directional)
419 $relationshipType = array_unique($relationshipType);
422 // sort the relationshipType in ascending order CRM-7736
423 asort($relationshipType);
424 return $relationshipType;
427 static function clearCurrentEmployer($id, $action) {
428 $relationship = new CRM_Contact_DAO_Relationship();
429 $relationship->id
= $id;
430 $relationship->find(TRUE);
432 //to delete relationship between household and individual \
433 //or between individual and orgnization
434 if (($action & CRM_Core_Action
::DISABLE
) ||
($action & CRM_Core_Action
::DELETE
)) {
435 $relTypes = CRM_Utils_Array
::index(array('name_a_b'), CRM_Core_PseudoConstant
::relationshipType('name'));
436 if ($relationship->relationship_type_id
== $relTypes['Employee of']['id'] ||
437 $relationship->relationship_type_id
== $relTypes['Household Member of']['id']) {
438 $sharedContact = new CRM_Contact_DAO_Contact();
439 $sharedContact->id
= $relationship->contact_id_a
;
440 $sharedContact->find(TRUE);
442 if ($relationship->relationship_type_id
== 4 && $relationship->contact_id_b
== $sharedContact->employer_id
) {
443 CRM_Contact_BAO_Contact_Utils
::clearCurrentEmployer($relationship->contact_id_a
);
447 return $relationship;
451 * Function to delete the relationship
453 * @param int $id relationship id
460 static function del($id) {
461 // delete from relationship table
462 CRM_Utils_Hook
::pre('delete', 'Relationship', $id, CRM_Core_DAO
::$_nullArray);
464 $relationship = self
::clearCurrentEmployer($id, CRM_Core_Action
::DELETE
);
465 if (CRM_Core_Permission
::access('CiviMember')) {
466 // create $params array which isrequired to delete memberships
467 // of the related contacts.
469 'relationship_type_id' => "{$relationship->relationship_type_id}_a_b",
470 'contact_check' => array($relationship->contact_id_b
=> 1),
474 // calling relatedMemberships to delete the memberships of
476 self
::relatedMemberships($relationship->contact_id_a
,
479 CRM_Core_Action
::DELETE
,
484 $relationship->delete();
485 CRM_Core_Session
::setStatus(ts('Selected relationship has been deleted successfully.'), ts('Record Deleted'), 'success');
487 CRM_Utils_Hook
::post('delete', 'Relationship', $relationship->id
, $relationship);
489 // delete the recently created Relationship
490 $relationshipRecent = array(
492 'type' => 'Relationship',
494 CRM_Utils_Recent
::del($relationshipRecent);
496 return $relationship;
500 * Function to disable/enable the relationship
502 * @param int $id relationship id
509 static function disableEnableRelationship($id, $action) {
510 $relationship = self
::clearCurrentEmployer($id, $action);
511 if (CRM_Core_Permission
::access('CiviMember')) {
512 // create $params array which isrequired to delete memberships
513 // of the related contacts.
515 'relationship_type_id' => "{$relationship->relationship_type_id}_a_b",
516 'contact_check' => array($relationship->contact_id_b
=> 1),
520 // calling relatedMemberships to delete/add the memberships of
522 if ($action & CRM_Core_Action
::DISABLE
) {
523 CRM_Contact_BAO_Relationship
::relatedMemberships($relationship->contact_id_a
,
526 CRM_Core_Action
::DELETE
,
530 elseif ($action & CRM_Core_Action
::ENABLE
) {
531 $ids['contact'] = $relationship->contact_id_a
;
532 CRM_Contact_BAO_Relationship
::relatedMemberships($relationship->contact_id_a
,
535 CRM_Core_Action
::ADD
,
543 * Delete the object records that are associated with this contact
545 * @param int $contactId id of the contact to delete
551 static function deleteContact($contactId) {
552 $relationship = new CRM_Contact_DAO_Relationship();
553 $relationship->contact_id_a
= $contactId;
554 $relationship->delete();
556 $relationship = new CRM_Contact_DAO_Relationship();
557 $relationship->contact_id_b
= $contactId;
558 $relationship->delete();
560 CRM_Contact_BAO_Household
::updatePrimaryContact(NULL, $contactId);
564 * Function to get the other contact in a relationship
566 * @param int $id relationship id
568 * $returns returns the contact ids in the realtionship
572 static function getContactIds($id) {
573 $relationship = new CRM_Contact_DAO_Relationship();
575 $relationship->id
= $id;
576 $relationship->selectAdd();
577 $relationship->selectAdd('contact_id_a, contact_id_b');
578 $relationship->find(TRUE);
580 return $relationship;
584 * Function to check if the relationship type selected between two contacts is correct
586 * @param int $contact_a 1st contact id
587 * @param int $contact_b 2nd contact id
588 * @param int $relationshipTypeId relationship type id
590 * @return boolean true if it is valid relationship else false
594 static function checkRelationshipType($contact_a, $contact_b, $relationshipTypeId) {
595 $relationshipType = new CRM_Contact_DAO_RelationshipType();
596 $relationshipType->id
= $relationshipTypeId;
597 $relationshipType->selectAdd();
598 $relationshipType->selectAdd('contact_type_a, contact_type_b, contact_sub_type_a, contact_sub_type_b');
599 if ($relationshipType->find(TRUE)) {
600 $contact_type_a = CRM_Contact_BAO_Contact
::getContactType($contact_a);
601 $contact_type_b = CRM_Contact_BAO_Contact
::getContactType($contact_b);
603 $contact_sub_type_a = CRM_Contact_BAO_Contact
::getContactSubType($contact_a);
604 $contact_sub_type_b = CRM_Contact_BAO_Contact
::getContactSubType($contact_b);
606 if (((!$relationshipType->contact_type_a
) ||
($relationshipType->contact_type_a
== $contact_type_a)) &&
607 ((!$relationshipType->contact_type_b
) ||
($relationshipType->contact_type_b
== $contact_type_b)) &&
608 ((!$relationshipType->contact_sub_type_a
) ||
(in_array($relationshipType->contact_sub_type_a
,
611 ((!$relationshipType->contact_sub_type_b
) ||
(in_array($relationshipType->contact_sub_type_b
,
625 * this function does the validtion for valid relationship
627 * @param array $params this array contains the values there are subitted by the form
628 * @param array $ids the array that holds all the db ids
629 * @param integer $contactId this is contact id for adding relationship
635 static function checkValidRelationship(&$params, &$ids, $contactId) {
638 // get the string of relationship type
639 $relationshipTypes = CRM_Utils_Array
::value('relationship_type_id', $params);
640 list($type, $first, $second) = explode('_', $relationshipTypes);
641 $
{'contact_' . $first} = CRM_Utils_Array
::value('contact', $ids);
642 $
{'contact_' . $second} = $contactId;
643 // function to check if the relationship selected is correct
644 // i.e. employer relationship can exit between Individual and Organization (not between Individual and Individual)
645 if (!CRM_Contact_BAO_Relationship
::checkRelationshipType($contact_a, $contact_b, $type)) {
646 $errors = 'Please select valid relationship between these two contacts.';
652 * this function checks for duplicate relationship
654 * @param array $params (reference ) an assoc array of name/value pairs
655 * @param integer $id this the id of the contact whom we are adding relationship
656 * @param integer $contactId this is contact id for adding relationship
657 * @param integer $relationshipId this is relationship id for the contact
659 * @return boolean true if record exists else false
663 static function checkDuplicateRelationship(&$params, $id, $contactId = 0, $relationshipId = 0) {
664 $relationshipTypeId = CRM_Utils_Array
::value('relationship_type_id', $params);
665 list($type, $first, $second) = explode('_', $relationshipTypeId);
667 $queryString = " SELECT id
668 FROM civicrm_relationship
669 WHERE relationship_type_id = " . CRM_Utils_Type
::escape($type, 'Integer');
672 * CRM-11792 - date fields from API are in ISO format, but this function supports date arrays
673 * BAO has increasingly standardised to ISO format so I believe this function should support
674 * ISO rather than make API format it - however, need to support array format for now to avoid breakage
675 * @ time of writing this function is called from Relationship::create (twice)
676 * CRM_BAO_Contact_Utils::clearCurrentEmployer (seemingly without dates)
677 * CRM_Contact_Form_Task_AddToOrganization::postProcess &
678 * CRM_Contact_Form_Task_AddToHousehold::postProcess
679 * (I don't think the last 2 support dates but not sure
682 $dateFields = array('end_date', 'start_date');
683 foreach ($dateFields as $dateField){
684 if(array_key_exists($dateField, $params)) {
685 if (empty($params[$dateField]) ||
$params[$dateField] == 'null'){
686 //this is most likely coming from an api call & probably loaded from the DB to deal with some of the
687 //other myriad of excessive checks still in place both in the api & the create functions
688 $queryString .= " AND $dateField IS NULL";
691 elseif (is_array($params[$dateField])){
692 $queryString .= " AND $dateField = " . CRM_Utils_Type
::escape(CRM_Utils_Date
::format($params[$dateField]), 'Date');
695 $queryString .= " AND $dateField = " . CRM_Utils_Type
::escape($params[$dateField], 'Date');
701 " AND ( ( contact_id_a = " . CRM_Utils_Type
::escape($id, 'Integer') .
702 " AND contact_id_b = " . CRM_Utils_Type
::escape($contactId, 'Integer') .
703 " ) OR ( contact_id_a = " . CRM_Utils_Type
::escape($contactId, 'Integer') .
704 " AND contact_id_b = " . CRM_Utils_Type
::escape($id, 'Integer') . " ) ) ";
706 //if caseId is provided, include it duplicate checking.
707 if ($caseId = CRM_Utils_Array
::value('case_id', $params)) {
708 $queryString .= " AND case_id = " . CRM_Utils_Type
::escape($caseId, 'Integer');
711 if ($relationshipId) {
712 $queryString .= " AND id !=" . CRM_Utils_Type
::escape($relationshipId, 'Integer');
715 $relationship = new CRM_Contact_BAO_Relationship();
716 $relationship->query($queryString);
717 $relationship->fetch();
718 $relationship->free();
719 return ($relationship->id
) ?
TRUE : FALSE;
723 * update the is_active flag in the db
725 * @param int $id id of the database record
726 * @param boolean $is_active value we want to set the is_active field
728 * @return Object DAO object on success, null otherwise
731 static function setIsActive($id, $is_active) {
732 CRM_Core_DAO
::setFieldValue('CRM_Contact_DAO_Relationship', $id, 'is_active', $is_active);
735 CRM_Utils_Hook
::enableDisable('CRM_Contact_BAO_Relationship', $id, $is_active);
741 * Given the list of params in the params array, fetch the object
742 * and store the values in the values array
744 * @param array $params input parameters to find object
745 * @param array $values output values of the object
746 * @param array $ids the array that holds all the db ids
748 * @return array (reference) the values that could be potentially assigned to smarty
752 static function &getValues(&$params, &$values) {
753 if (empty($params)) {
758 // get the specific number of relationship or all relationships.
759 if (CRM_Utils_Array
::value('numRelationship', $params)) {
760 $v['data'] = &CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'], NULL, $params['numRelationship']);
763 $v['data'] = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id']);
766 // get the total count of relationships
767 $v['totalCount'] = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'], NULL, NULL, TRUE);
769 $values['relationship']['data'] = &$v['data'];
770 $values['relationship']['totalCount'] = &$v['totalCount'];
776 * helper function to form the sql for relationship retrieval
778 * @param int $contactId contact id
779 * @param int $status (check const at top of file)
780 * @param int $numRelationship no of relationships to display (limit)
781 * @param int $count get the no of relationships
782 * $param int $relationshipId relationship id
783 * @param string $direction the direction we are interested in a_b or b_a
784 * @param array $params array of extra values including relationship_type_id per api spec
786 * return string the query for this diretion
790 static function makeURLClause($contactId, $status, $numRelationship, $count, $relationshipId, $direction, $params = array()) {
791 $select = $from = $where = '';
795 if ($direction == 'a_b') {
796 $select .= ' SELECT count(DISTINCT civicrm_relationship.id) as cnt1, 0 as cnt2 ';
799 $select .= ' SELECT 0 as cnt1, count(DISTINCT civicrm_relationship.id) as cnt2 ';
803 $select .= ' SELECT civicrm_relationship.id as civicrm_relationship_id,
804 civicrm_contact.sort_name as sort_name,
805 civicrm_contact.display_name as display_name,
806 civicrm_contact.job_title as job_title,
807 civicrm_contact.employer_id as employer_id,
808 civicrm_contact.organization_name as organization_name,
809 civicrm_address.street_address as street_address,
810 civicrm_address.city as city,
811 civicrm_address.postal_code as postal_code,
812 civicrm_state_province.abbreviation as state,
813 civicrm_country.name as country,
814 civicrm_email.email as email,
815 civicrm_phone.phone as phone,
816 civicrm_contact.id as civicrm_contact_id,
817 civicrm_contact.contact_type as contact_type,
818 civicrm_relationship.contact_id_b as contact_id_b,
819 civicrm_relationship.contact_id_a as contact_id_a,
820 civicrm_relationship_type.id as civicrm_relationship_type_id,
821 civicrm_relationship.start_date as start_date,
822 civicrm_relationship.end_date as end_date,
823 civicrm_relationship.description as description,
824 civicrm_relationship.is_active as is_active,
825 civicrm_relationship.is_permission_a_b as is_permission_a_b,
826 civicrm_relationship.is_permission_b_a as is_permission_b_a,
827 civicrm_relationship.case_id as case_id';
829 if ($direction == 'a_b') {
830 $select .= ', civicrm_relationship_type.label_a_b as label_a_b,
831 civicrm_relationship_type.label_b_a as relation ';
834 $select .= ', civicrm_relationship_type.label_a_b as label_a_b,
835 civicrm_relationship_type.label_a_b as relation ';
840 FROM civicrm_relationship
841 INNER JOIN civicrm_relationship_type ON ( civicrm_relationship.relationship_type_id = civicrm_relationship_type.id )
842 INNER JOIN civicrm_contact ";
843 if ($direction == 'a_b') {
844 $from .= 'ON ( civicrm_contact.id = civicrm_relationship.contact_id_a ) ';
847 $from .= 'ON ( civicrm_contact.id = civicrm_relationship.contact_id_b ) ';
850 LEFT JOIN civicrm_address ON (civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1)
851 LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = civicrm_contact.id AND civicrm_phone.is_primary = 1)
852 LEFT JOIN civicrm_email ON (civicrm_email.contact_id = civicrm_contact.id AND civicrm_email.is_primary = 1)
853 LEFT JOIN civicrm_state_province ON (civicrm_address.state_province_id = civicrm_state_province.id)
854 LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id)
856 $where = 'WHERE ( 1 )';
858 if ($direction == 'a_b') {
859 $where .= ' AND civicrm_relationship.contact_id_b = ' . CRM_Utils_Type
::escape($contactId, 'Positive');
862 $where .= ' AND civicrm_relationship.contact_id_a = ' . CRM_Utils_Type
::escape($contactId, 'Positive');
865 if ($relationshipId) {
866 $where .= ' AND civicrm_relationship.id = ' . CRM_Utils_Type
::escape($relationshipId, 'Positive');
869 $date = date('Y-m-d');
870 if ($status == self
::PAST
) {
871 //this case for showing past relationship
872 $where .= ' AND civicrm_relationship.is_active = 1 ';
873 $where .= " AND civicrm_relationship.end_date < '" . $date . "'";
875 elseif ($status == self
::DISABLED
) {
876 // this case for showing disabled relationship
877 $where .= ' AND civicrm_relationship.is_active = 0 ';
879 elseif ($status == self
::CURRENT
) {
880 //this case for showing current relationship
881 $where .= ' AND civicrm_relationship.is_active = 1 ';
882 $where .= " AND (civicrm_relationship.end_date >= '" . $date . "' OR civicrm_relationship.end_date IS NULL) ";
884 elseif ($status == self
::INACTIVE
) {
885 //this case for showing inactive relationships
886 $where .= " AND (civicrm_relationship.end_date < '" . $date . "'";
887 $where .= ' OR civicrm_relationship.is_active = 0 )';
891 $where .= ' AND civicrm_contact.is_deleted = 0';
892 if(!empty($params['membership_type_id']) && empty($params['relationship_type_id'])) {
893 $where .= self
::membershipTypeToRelationshipTypes($params, $direction);
895 if(!empty($params['relationship_type_id'])) {
896 if(is_array($params['relationship_type_id'])) {
897 $where .= " AND " . CRM_Core_DAO
::createSQLFilter('relationship_type_id', $params['relationship_type_id'], 'Integer');
900 $where .= ' AND relationship_type_id = ' . CRM_Utils_Type
::escape($params['relationship_type_id'], 'Positive');
903 if ($direction == 'a_b') {
904 $where .= ' ) UNION ';
910 return array($select, $from, $where);
914 * This is the function to get the list of relationships
916 * @param int $contactId contact id
917 * @param int $status 1: Past 2: Disabled 3: Current
918 * @param int $numRelationship no of relationships to display (limit)
919 * @param int $count get the no of relationships
920 * $param int $relationshipId relationship id
921 * $param array $links the list of links to display
922 * $param int $permissionMask the permission mask to be applied for the actions
923 * $param boolean $permissionedContact to return only permissioned Contact
924 * $param array $params array of variables consistent with filters supported by the api
925 * return array $values relationship records
929 static function getRelationship($contactId = NULL,
930 $status = 0, $numRelationship = 0,
931 $count = 0, $relationshipId = 0,
932 $links = NULL, $permissionMask = NULL,
933 $permissionedContact = FALSE,
937 if (!$contactId && !$relationshipId) {
941 list($select1, $from1, $where1) = self
::makeURLClause($contactId, $status, $numRelationship,
942 $count, $relationshipId, 'a_b', $params
944 list($select2, $from2, $where2) = self
::makeURLClause($contactId, $status, $numRelationship,
945 $count, $relationshipId, 'b_a', $params
948 $order = $limit = '';
950 $order = ' ORDER BY civicrm_relationship_type_id, sort_name ';
952 if ($numRelationship) {
953 $limit = " LIMIT 0, $numRelationship";
957 // building the query string
959 $queryString = $select1 . $from1 . $where1 . $select2 . $from2 . $where2 . $order . $limit;
961 $relationship = new CRM_Contact_DAO_Relationship();
963 $relationship->query($queryString);
966 $relationshipCount = 0;
967 while ($relationship->fetch()) {
968 $relationshipCount +
= $relationship->cnt1 +
$relationship->cnt2
;
970 return $relationshipCount;
975 if ($status != self
::INACTIVE
) {
977 $mask = array_sum(array_keys($links));
978 if ($mask & CRM_Core_Action
::DISABLE
) {
979 $mask -= CRM_Core_Action
::DISABLE
;
981 if ($mask & CRM_Core_Action
::ENABLE
) {
982 $mask -= CRM_Core_Action
::ENABLE
;
985 if ($status == self
::CURRENT
) {
986 $mask |
= CRM_Core_Action
::DISABLE
;
988 elseif ($status == self
::DISABLED
) {
989 $mask |
= CRM_Core_Action
::ENABLE
;
991 $mask = $mask & $permissionMask;
994 while ($relationship->fetch()) {
995 $rid = $relationship->civicrm_relationship_id
;
996 $cid = $relationship->civicrm_contact_id
;
997 if (($permissionedContact) &&
998 (!CRM_Contact_BAO_Contact_Permission
::relationship($cid, $contactId))
1002 $values[$rid]['id'] = $rid;
1003 $values[$rid]['cid'] = $cid;
1004 $values[$rid]['contact_id_a'] = $relationship->contact_id_a
;
1005 $values[$rid]['contact_id_b'] = $relationship->contact_id_b
;
1006 $values[$rid]['relationship_type_id'] = $relationship->civicrm_relationship_type_id
;
1007 $values[$rid]['relation'] = $relationship->relation
;
1008 $values[$rid]['name'] = $relationship->sort_name
;
1009 $values[$rid]['display_name'] = $relationship->display_name
;
1010 $values[$rid]['job_title'] = $relationship->job_title
;
1011 $values[$rid]['email'] = $relationship->email
;
1012 $values[$rid]['phone'] = $relationship->phone
;
1013 $values[$rid]['employer_id'] = $relationship->employer_id
;
1014 $values[$rid]['organization_name'] = $relationship->organization_name
;
1015 $values[$rid]['country'] = $relationship->country
;
1016 $values[$rid]['city'] = $relationship->city
;
1017 $values[$rid]['state'] = $relationship->state
;
1018 $values[$rid]['start_date'] = $relationship->start_date
;
1019 $values[$rid]['end_date'] = $relationship->end_date
;
1020 $values[$rid]['description'] = $relationship->description
;
1021 $values[$rid]['is_active'] = $relationship->is_active
;
1022 $values[$rid]['is_permission_a_b'] = $relationship->is_permission_a_b
;
1023 $values[$rid]['is_permission_b_a'] = $relationship->is_permission_b_a
;
1024 $values[$rid]['case_id'] = $relationship->case_id
;
1027 $values[$rid]['status'] = $status;
1030 $values[$rid]['civicrm_relationship_type_id'] = $relationship->civicrm_relationship_type_id
;
1032 if ($relationship->contact_id_a
== $contactId) {
1033 $values[$rid]['rtype'] = 'a_b';
1036 $values[$rid]['rtype'] = 'b_a';
1042 'rtype' => $values[$rid]['rtype'],
1043 'cid' => $contactId,
1044 'cbid' => $values[$rid]['cid'],
1045 'caseid' => $values[$rid]['case_id'],
1046 'clientid' => $contactId,
1049 if ($status == self
::INACTIVE
) {
1050 // setting links for inactive relationships
1051 $mask = array_sum(array_keys($links));
1052 if (!$values[$rid]['is_active']) {
1053 $mask -= CRM_Core_Action
::DISABLE
;
1056 $mask -= CRM_Core_Action
::ENABLE
;
1057 $mask -= CRM_Core_Action
::DISABLE
;
1061 // Give access to manage case link by copying to MAX_ACTION index temporarily, depending on case permission of user.
1062 if ($values[$rid]['case_id']) {
1063 // Borrowed logic from CRM_Case_Page_Tab
1064 $hasCaseAccess = FALSE;
1065 if (CRM_Core_Permission
::check('access all cases and activities')) {
1066 $hasCaseAccess = TRUE;
1069 $userCases = CRM_Case_BAO_Case
::getCases(FALSE);
1070 if (array_key_exists($values[$rid]['case_id'], $userCases)) {
1071 $hasCaseAccess = TRUE;
1075 if ($hasCaseAccess) {
1076 // give access by copying to MAX_ACTION temporarily, otherwise leave at NONE which won't display
1077 $links[CRM_Core_Action
::MAX_ACTION
] = $links[CRM_Core_Action
::NONE
];
1078 $links[CRM_Core_Action
::MAX_ACTION
]['name'] = ts('Manage Case #%1', array(1 => $values[$rid]['case_id']));
1080 // Also make sure we have the right client cid since can get here from multiple relationship tabs.
1081 if ($values[$rid]['rtype'] == 'b_a') {
1082 $replace['clientid'] = $values[$rid]['cid'];
1087 $values[$rid]['action'] = CRM_Core_Action
::formLink($links, $mask, $replace);
1088 unset($links[CRM_Core_Action
::MAX_ACTION
]);
1092 $relationship->free();
1098 * Function to get get list of relationship type based on the target contact type.
1100 * @param string $targetContactType it's valid contact tpye(may be Individual , Organization , Household)
1102 * @return array - array reference of all relationship types with context to current contact type .
1105 function getRelationType($targetContactType) {
1106 $relationshipType = array();
1107 $allRelationshipType = CRM_Core_PseudoConstant
::relationshipType();
1109 foreach ($allRelationshipType as $key => $type) {
1110 if ($type['contact_type_b'] == $targetContactType) {
1111 $relationshipType[$key . '_a_b'] = $type['label_a_b'];
1115 return $relationshipType;
1119 * Function to create / update / delete membership for related contacts.
1121 * This function will create/update/delete membership for related
1122 * contact based on 1) contact have active membership 2) that
1123 * membership is is extedned by the same relationship type to that
1124 * of the existing relationship.
1126 * @param $contactId Int contact id
1127 * @param $params array array of values submitted by POST
1128 * @param $ids array array of ids
1129 * @param $action which action called this function
1134 static function relatedMemberships($contactId, &$params, $ids, $action = CRM_Core_Action
::ADD
, $active = TRUE) {
1135 // Check the end date and set the status of the relationship
1137 $status = self
::CURRENT
;
1139 if (!empty($params['end_date'])) {
1140 $endDate = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Date
::format($params['end_date']), NULL, 'Ymd');
1141 $today = date('Ymd');
1143 if ($today > $endDate) {
1144 $status = self
::PAST
;
1148 if (($action & CRM_Core_Action
::ADD
) &&
1149 ($status & self
::PAST
)
1151 // if relationship is PAST and action is ADD, no qustion
1152 // of creating RELATED membership and return back to
1157 $rel = explode('_', $params['relationship_type_id']);
1159 $relTypeId = $rel[0];
1160 $relDirection = "_{$rel[1]}_{$rel[2]}";
1161 $targetContact = array();
1162 if (($action & CRM_Core_Action
::ADD
) ||
1163 ($action & CRM_Core_Action
::DELETE
)
1165 $contact = $contactId;
1166 $targetContact = CRM_Utils_Array
::value('contact_check', $params);
1168 elseif ($action & CRM_Core_Action
::UPDATE
) {
1169 $contact = $ids['contact'];
1170 $targetContact = array($ids['contactTarget'] => 1);
1173 // Build the 'values' array for
1176 // This will allow us to check if either of the contacts in
1177 // relationship have active memberships.
1182 $values[$contact] = array(
1183 'relatedContacts' => $targetContact,
1184 'relationshipTypeId' => $relTypeId,
1185 'relationshipTypeDirection' => $relDirection,
1188 if (!empty($targetContact)) {
1189 foreach ($targetContact as $cid => $donCare) {
1190 $values[$cid] = array(
1191 'relatedContacts' => array($contact => 1),
1192 'relationshipTypeId' => $relTypeId,
1195 $relTypeParams = array('id' => $relTypeId);
1196 $relTypeValues = array();
1197 CRM_Contact_BAO_RelationshipType
::retrieve($relTypeParams, $relTypeValues);
1199 if (CRM_Utils_Array
::value('name_a_b', $relTypeValues) == CRM_Utils_Array
::value('name_b_a', $relTypeValues)) {
1200 $values[$cid]['relationshipTypeDirection'] = '_a_b';
1203 $values[$cid]['relationshipTypeDirection'] = ($relDirection == '_a_b') ?
'_b_a' : '_a_b';
1208 // Now get the active memberships for all the contacts.
1209 // If contact have any valid membership(s), then add it to
1211 foreach ($values as $cid => $subValues) {
1212 $memParams = array('contact_id' => $cid);
1213 $memberships = array();
1215 CRM_Member_BAO_Membership
::getValues($memParams, $memberships, $active);
1217 if (empty($memberships)) {
1221 $values[$cid]['memberships'] = $memberships;
1223 $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant
::membershipStatus());
1225 // done with 'values' array.
1226 // Finally add / edit / delete memberships for the related contacts
1227 foreach ($values as $cid => $details) {
1228 if (!array_key_exists('memberships', $details)) {
1232 $mainRelatedContactId = key(CRM_Utils_Array
::value('relatedContacts', $details, array()));
1234 foreach ($details['memberships'] as $membershipId => $membershipValues) {
1235 $relTypeIds = array();
1236 if ($action & CRM_Core_Action
::DELETE
) {
1237 // Delete memberships of the related contacts only if relationship type exists for membership type
1239 SELECT relationship_type_id, relationship_direction
1240 FROM civicrm_membership_type
1241 WHERE id = {$membershipValues['membership_type_id']}";
1242 $dao = CRM_Core_DAO
::executeQuery($query);
1243 $relTypeDirs = array();
1244 while ($dao->fetch()) {
1245 $relTypeId = $dao->relationship_type_id
;
1246 $relDirection = $dao->relationship_direction
;
1248 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $relTypeId);
1249 if (in_array($values[$cid]['relationshipTypeId'], $relTypeIds)) {
1250 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipId, $mainRelatedContactId);
1254 if (($action & CRM_Core_Action
::UPDATE
) &&
1255 ($status & self
::PAST
) &&
1256 ($membershipValues['owner_membership_id'])
1258 // If relationship is PAST and action is UPDATE
1259 // then delete the RELATED membership
1260 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipValues['owner_membership_id'],
1261 $membershipValues['membership_contact_id']
1266 // add / edit the memberships for related
1269 // Get the Membership Type Details.
1270 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipValues['membership_type_id']);
1271 // Check if contact's relationship type exists in membership type
1272 $relTypeDirs = array();
1273 if (CRM_Utils_Array
::value('relationship_type_id', $membershipType)) {
1274 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_type_id']);
1276 if (CRM_Utils_Array
::value('relationship_direction', $membershipType)) {
1277 $relDirections = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_direction']);
1279 foreach ($relTypeIds as $key => $value) {
1280 $relTypeDirs[] = $value . '_' . $relDirections[$key];
1282 $relTypeDir = $details['relationshipTypeId'] . $details['relationshipTypeDirection'];
1283 if (in_array($relTypeDir, $relTypeDirs)) {
1284 // Check if relationship being created/updated is
1285 // similar to that of membership type's
1288 $membershipValues['owner_membership_id'] = $membershipId;
1289 unset($membershipValues['id']);
1290 unset($membershipValues['membership_contact_id']);
1291 unset($membershipValues['contact_id']);
1292 unset($membershipValues['membership_id']);
1293 foreach ($details['relatedContacts'] as $relatedContactId => $donCare) {
1294 $membershipValues['contact_id'] = $relatedContactId;
1295 if ($deceasedStatusId &&
1296 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $relatedContactId, 'is_deceased')
1298 $membershipValues['status_id'] = $deceasedStatusId;
1299 $membershipValues['skipStatusCal'] = TRUE;
1302 'join_date', 'start_date', 'end_date') as $dateField) {
1303 if (CRM_Utils_Array
::value($dateField, $membershipValues)) {
1304 $membershipValues[$dateField] = CRM_Utils_Date
::processDate($membershipValues[$dateField]);
1308 if ($action & CRM_Core_Action
::UPDATE
) {
1309 //delete the membership record for related
1310 //contact before creating new membership record.
1311 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipId, $relatedContactId);
1314 // check whether we have some related memberships still available
1317 FROM civicrm_membership
1318 LEFT JOIN civicrm_membership_status ON (civicrm_membership_status.id = civicrm_membership.status_id)
1319 WHERE membership_type_id = {$membershipValues['membership_type_id']} AND owner_membership_id = {$membershipValues['owner_membership_id']}
1320 AND is_current_member = 1";
1321 $result = CRM_Core_DAO
::singleValueQuery($query);
1322 if ($result < CRM_Utils_Array
::value('max_related', $membershipValues, PHP_INT_MAX
)) {
1323 CRM_Member_BAO_Membership
::create($membershipValues, CRM_Core_DAO
::$_nullArray);
1327 elseif ($action & CRM_Core_Action
::UPDATE
) {
1328 // if action is update and updated relationship do
1329 // not match with the existing
1330 // membership=>relationship then we need to
1331 // delete the membership record created for
1332 // previous relationship.
1334 if (self
::isDeleteRelatedMembership($relTypeIds, $contactId, $mainRelatedContactId, $relTypeId, CRM_Utils_Array
::value('relationship_ids', $params))) {
1335 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipId, $mainRelatedContactId);
1343 * Helper function to check whether to delete the membership or
1349 static function isDeleteRelatedMembership($relTypeIds, $contactId, $mainRelatedContactId, $relTypeId, $relIds) {
1350 if (in_array($relTypeId, $relTypeIds)) {
1354 if (empty($relIds)) {
1358 $relParamas = array(1 => array($contactId, 'Integer'),
1359 2 => array($mainRelatedContactId, 'Integer'),
1362 if ($contactId == $mainRelatedContactId) {
1363 $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);
1364 if ($recordsFound) {
1370 $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);
1372 if ($recordsFound) {
1380 * Function to get Current Employer for Contact
1382 * @param $contactIds Contact Ids
1384 * @return $currentEmployer array of the current employer
1389 static function getCurrentEmployer($contactIds) {
1390 $contacts = implode(',', $contactIds);
1393 SELECT organization_name, id, employer_id
1394 FROM civicrm_contact
1395 WHERE id IN ( {$contacts} )
1398 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
1399 $currentEmployer = array();
1400 while ($dao->fetch()) {
1401 $currentEmployer[$dao->id
]['org_id'] = $dao->employer_id
;
1402 $currentEmployer[$dao->id
]['org_name'] = $dao->organization_name
;
1405 return $currentEmployer;
1409 * Function to return list of permissioned employer for a given contact.
1411 * @param $contactID int contact id whose employers
1413 * @param $name string employers sort name
1417 * @return array array of employers.
1420 static function getPermissionedEmployer($contactID, $name = NULL) {
1421 //get the relationship id
1422 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType',
1423 'Employee of', 'id', 'name_a_b'
1426 return self
::getPermissionedContacts($contactID, $relTypeId, $name);
1431 * Function to return list of permissioned contacts for a given contact and relationship type
1433 * @param $contactID int contact id whose permissioned contacts are to be found.
1434 * @param $relTypeId relationship type id
1435 * @param $name string
1439 * @return array of contacts
1441 static function getPermissionedContacts($contactID, $relTypeId, $name = NULL) {
1442 $contacts = array();
1446 SELECT cc.id as id, cc.sort_name as name
1447 FROM civicrm_relationship cr, civicrm_contact cc
1449 cr.contact_id_a = %1 AND
1450 cr.relationship_type_id = %2 AND
1451 cr.is_permission_a_b = 1 AND
1452 IF(cr.end_date IS NULL, 1, (DATEDIFF( CURDATE( ), cr.end_date ) <= 0)) AND
1453 cr.is_active = 1 AND
1454 cc.id = cr.contact_id_b";
1456 if (!empty($name)) {
1457 $name = CRM_Utils_Type
::escape($name, 'String');
1459 AND cc.sort_name LIKE '%$name%'";
1462 $args = array(1 => array($contactID, 'Integer'), 2 => array($relTypeId, 'Integer'));
1463 $dao = CRM_Core_DAO
::executeQuery($query, $args);
1465 while ($dao->fetch()) {
1466 $contacts[$dao->id
] = array(
1467 'name' => $dao->name
,
1468 'value' => $dao->id
,
1475 static function getValidContactTypeList($relType) {
1476 // string looks like 4_a_b
1477 $rel_parts = explode('_', $relType);
1478 $allRelationshipType = CRM_Core_PseudoConstant
::relationshipType('label');
1479 $contactProfiles = CRM_Core_BAO_UFGroup
::getReservedProfiles('Contact', NULL);
1481 if ($rel_parts[1] == 'a') {
1482 $leftType = $allRelationshipType[$rel_parts[0]]['contact_type_b'];
1485 $leftType = $allRelationshipType[$rel_parts[0]]['contact_type_a'];
1488 // Handle 'All Contacts' contact type for left side of relationship ($leftType is empty in this case)
1489 // In this case all reserved profiles are available
1490 if ($leftType == '') {
1491 $contactTypes = $contactProfiles;
1493 $contactTypes = array();
1494 foreach ($contactProfiles as $key => $value) {
1495 if (strpos($value, $leftType) !== FALSE) {
1496 $contactTypes = array($key => $value);
1501 return $contactTypes;
1505 * Merge relationships from otherContact to mainContact
1506 * Called during contact merge operation
1508 * @param int $mainId contact id of main contact record.
1509 * @param int $otherId contact id of record which is going to merge.
1510 * @param array $sqls (reference) array of sql statements to append to.
1512 * @see CRM_Dedupe_Merger::cpTables()
1516 static function mergeRelationships($mainId, $otherId, &$sqls) {
1517 // Delete circular relationships
1518 $sqls[] = "DELETE FROM civicrm_relationship
1519 WHERE (contact_id_a = $mainId AND contact_id_b = $otherId)
1520 OR (contact_id_b = $mainId AND contact_id_a = $otherId)";
1522 // Delete relationship from other contact if main contact already has that relationship
1523 $sqls[] = "DELETE r2
1524 FROM civicrm_relationship r1, civicrm_relationship r2
1525 WHERE r1.relationship_type_id = r2.relationship_type_id
1528 r1.contact_id_a = $mainId AND r2.contact_id_a = $otherId AND r1.contact_id_b = r2.contact_id_b
1529 OR r1.contact_id_b = $mainId AND r2.contact_id_b = $otherId AND r1.contact_id_a = r2.contact_id_a
1531 (r1.contact_id_a = $mainId AND r2.contact_id_b = $otherId AND r1.contact_id_b = r2.contact_id_a
1532 OR r1.contact_id_b = $mainId AND r2.contact_id_a = $otherId AND r1.contact_id_a = r2.contact_id_b)
1533 AND r1.relationship_type_id IN (SELECT id FROM civicrm_relationship_type WHERE name_b_a = name_a_b)
1537 // Move relationships
1538 $sqls[] = "UPDATE IGNORE civicrm_relationship SET contact_id_a = $mainId WHERE contact_id_a = $otherId";
1539 $sqls[] = "UPDATE IGNORE civicrm_relationship SET contact_id_b = $mainId WHERE contact_id_b = $otherId";
1541 // Move current employer id (name will get updated later)
1542 $sqls[] = "UPDATE civicrm_contact SET employer_id = $mainId WHERE employer_id = $otherId";
1546 * Set 'is_valid' field to false for all relationships whose end date is in the past, ie. are expired.
1548 * @return True on success, false if error is encountered.
1550 static function disableExpiredRelationships() {
1551 $query = "SELECT id FROM civicrm_relationship WHERE is_active = 1 AND end_date < CURDATE()";
1553 $dao = CRM_Core_DAO
::executeQuery($query);
1554 while ($dao->fetch()) {
1555 $result = CRM_Contact_BAO_Relationship
::setIsActive($dao->id
, FALSE);
1556 // Result will be NULL if error occurred. We abort early if error detected.
1557 if ($result == NULL) {
1565 * Function filters the query by possible relationships for the membership type
1566 * It is intended to be called when constructing queries for the api (reciprocal & non-reciprocal)
1567 * and to add clauses to limit the return to those relationships which COULD inherit a membership type
1568 * (as opposed to those who inherit a particular membership
1570 * @param array $params api input array
1572 static function membershipTypeToRelationshipTypes(&$params, $direction = NULL) {
1573 $membershipType = civicrm_api3('membership_type', 'getsingle', array('id' => $params['membership_type_id'], 'return' => 'relationship_type_id, relationship_direction'));
1574 $relationshipTypes = $membershipType['relationship_type_id'];
1575 if(empty($relationshipTypes)) {
1578 // if we don't have any contact data we can only filter on type
1579 if(empty($params['contact_id']) && empty($params['contact_id_a']) && empty($params['contact_id_a'])) {
1580 $params['relationship_type_id'] = array('IN' => $relationshipTypes);
1584 $relationshipDirections = (array) $membershipType['relationship_direction'];
1585 // if we have contact_id_a OR contact_id_b we can make a call here
1586 // if we have contact??
1587 foreach ($relationshipDirections as $index => $mtdirection) {
1588 if(isset($params['contact_id_a']) && $mtdirection == 'a_b' ||
$direction == 'a_b') {
1589 $types[] = $relationshipTypes[$index];
1591 if(isset($params['contact_id_b']) && $mtdirection == 'b_a' ||
$direction == 'b_a') {
1592 $types[] = $relationshipTypes[$index];
1595 if(!empty($types)) {
1596 $params['relationship_type_id'] = array('IN' => $types);
1598 elseif(!empty($clauses)) {
1599 return explode(' OR ', $clauses);
1602 // effectively setting it to return no results
1603 $params['relationship_type_id'] = 0;