3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
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 CRM_Contact_BAO_Relationship object
57 static function create(&$params, $ids = array()) {
58 $valid = $invalid = $duplicate = $saved = 0;
59 $relationships = $relationshipIds = 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 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 * 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 null $contactSuffix
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.
314 * @param bool $biDirectional
315 * @param string $contactSubType includes relationshiptypes between this subtype
316 * @param boolean $onlySubTypeRelationTypes if set only subtype which is passed by $contactSubType
317 * related relationshiptypes get return
322 * @return array - array reference of all relationship types with context to current contact.
324 static function getContactRelationshipType($contactId = NULL,
325 $contactSuffix = NULL,
326 $relationshipId = NULL,
330 $biDirectional = TRUE,
331 $contactSubType = NULL,
332 $onlySubTypeRelationTypes = FALSE
334 $allRelationshipType = array();
335 $relationshipType = array();
336 $allRelationshipType = CRM_Core_PseudoConstant
::relationshipType($column);
338 $otherContactType = NULL;
339 if ($relationshipId) {
340 $relationship = new CRM_Contact_DAO_Relationship();
341 $relationship->id
= $relationshipId;
342 if ($relationship->find(TRUE)) {
343 $contact = new CRM_Contact_DAO_Contact();
344 $contact->id
= ($relationship->contact_id_a
=== $contactId) ?
$relationship->contact_id_b
: $relationship->contact_id_a
;
346 if ($contact->find(TRUE)) {
347 $otherContactType = $contact->contact_type
;
348 //CRM-5125 for contact subtype specific relationshiptypes
349 if ($contact->contact_sub_type
) {
350 $otherContactSubType = $contact->contact_sub_type
;
356 $contactSubType = array();
358 $contactType = CRM_Contact_BAO_Contact
::getContactType($contactId);
359 $contactSubType = CRM_Contact_BAO_Contact
::getContactSubType($contactId);
362 foreach ($allRelationshipType as $key => $value) {
363 // the contact type is required or matches
364 if (((!$value['contact_type_a']) ||
365 $value['contact_type_a'] == $contactType
367 // the other contact type is required or present or matches
368 ((!$value['contact_type_b']) ||
369 (!$otherContactType) ||
370 $value['contact_type_b'] == $otherContactType
373 (in_array($value['contact_sub_type_a'], $contactSubType) ||
374 in_array($value['contact_sub_type_b'], $contactSubType) ||
375 ((!$value['contact_sub_type_b'] &&
376 !$value['contact_sub_type_a']
378 !$onlySubTypeRelationTypes
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 in_array($value['contact_sub_type_a'], $contactSubType) ||
396 ((!$value['contact_sub_type_a'] &&
397 !$value['contact_sub_type_b']
399 !$onlySubTypeRelationTypes
404 $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"];
408 $relationshipType[$key . '_a_b'] = $value["{$column}_a_b"];
409 $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"];
413 if ($biDirectional) {
414 // lets clean up the data and eliminate all duplicate values
415 // (i.e. the relationship is bi-directional)
416 $relationshipType = array_unique($relationshipType);
419 // sort the relationshipType in ascending order CRM-7736
420 asort($relationshipType);
421 return $relationshipType;
428 * @return CRM_Contact_DAO_Relationship
430 static function clearCurrentEmployer($id, $action) {
431 $relationship = new CRM_Contact_DAO_Relationship();
432 $relationship->id
= $id;
433 $relationship->find(TRUE);
435 //to delete relationship between household and individual \
436 //or between individual and orgnization
437 if (($action & CRM_Core_Action
::DISABLE
) ||
($action & CRM_Core_Action
::DELETE
)) {
438 $relTypes = CRM_Utils_Array
::index(array('name_a_b'), CRM_Core_PseudoConstant
::relationshipType('name'));
439 if ($relationship->relationship_type_id
== $relTypes['Employee of']['id'] ||
440 $relationship->relationship_type_id
== $relTypes['Household Member of']['id']) {
441 $sharedContact = new CRM_Contact_DAO_Contact();
442 $sharedContact->id
= $relationship->contact_id_a
;
443 $sharedContact->find(TRUE);
445 if ($relationship->relationship_type_id
== 4 && $relationship->contact_id_b
== $sharedContact->employer_id
) {
446 CRM_Contact_BAO_Contact_Utils
::clearCurrentEmployer($relationship->contact_id_a
);
450 return $relationship;
454 * Delete the relationship
456 * @param int $id relationship id
463 static function del($id) {
464 // delete from relationship table
465 CRM_Utils_Hook
::pre('delete', 'Relationship', $id, CRM_Core_DAO
::$_nullArray);
467 $relationship = self
::clearCurrentEmployer($id, CRM_Core_Action
::DELETE
);
468 if (CRM_Core_Permission
::access('CiviMember')) {
469 // create $params array which isrequired to delete memberships
470 // of the related contacts.
472 'relationship_type_id' => "{$relationship->relationship_type_id}_a_b",
473 'contact_check' => array($relationship->contact_id_b
=> 1),
477 // calling relatedMemberships to delete the memberships of
479 self
::relatedMemberships($relationship->contact_id_a
,
482 CRM_Core_Action
::DELETE
,
487 $relationship->delete();
488 CRM_Core_Session
::setStatus(ts('Selected relationship has been deleted successfully.'), ts('Record Deleted'), 'success');
490 CRM_Utils_Hook
::post('delete', 'Relationship', $relationship->id
, $relationship);
492 // delete the recently created Relationship
493 $relationshipRecent = array(
495 'type' => 'Relationship',
497 CRM_Utils_Recent
::del($relationshipRecent);
499 return $relationship;
503 * Disable/enable the relationship
505 * @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 * Get the other contact in a relationship
570 * @param int $id relationship id
572 * $returns returns the contact ids in the realtionship
574 * @return \CRM_Contact_DAO_Relationship
578 static function getContactIds($id) {
579 $relationship = new CRM_Contact_DAO_Relationship();
581 $relationship->id
= $id;
582 $relationship->selectAdd();
583 $relationship->selectAdd('contact_id_a, contact_id_b');
584 $relationship->find(TRUE);
586 return $relationship;
590 * Check if the relationship type selected between two contacts is correct
592 * @param int $contact_a 1st contact id
593 * @param int $contact_b 2nd contact id
594 * @param int $relationshipTypeId relationship type id
596 * @return boolean true if it is valid relationship else false
600 static function checkRelationshipType($contact_a, $contact_b, $relationshipTypeId) {
601 $relationshipType = new CRM_Contact_DAO_RelationshipType();
602 $relationshipType->id
= $relationshipTypeId;
603 $relationshipType->selectAdd();
604 $relationshipType->selectAdd('contact_type_a, contact_type_b, contact_sub_type_a, contact_sub_type_b');
605 if ($relationshipType->find(TRUE)) {
606 $contact_type_a = CRM_Contact_BAO_Contact
::getContactType($contact_a);
607 $contact_type_b = CRM_Contact_BAO_Contact
::getContactType($contact_b);
609 $contact_sub_type_a = CRM_Contact_BAO_Contact
::getContactSubType($contact_a);
610 $contact_sub_type_b = CRM_Contact_BAO_Contact
::getContactSubType($contact_b);
612 if (((!$relationshipType->contact_type_a
) ||
($relationshipType->contact_type_a
== $contact_type_a)) &&
613 ((!$relationshipType->contact_type_b
) ||
($relationshipType->contact_type_b
== $contact_type_b)) &&
614 ((!$relationshipType->contact_sub_type_a
) ||
(in_array($relationshipType->contact_sub_type_a
,
617 ((!$relationshipType->contact_sub_type_b
) ||
(in_array($relationshipType->contact_sub_type_b
,
631 * This function does the validtion for valid relationship
633 * @param array $params this array contains the values there are subitted by the form
634 * @param array $ids the array that holds all the db ids
635 * @param integer $contactId this is contact id for adding relationship
641 static function checkValidRelationship(&$params, &$ids, $contactId) {
644 // get the string of relationship type
645 $relationshipTypes = CRM_Utils_Array
::value('relationship_type_id', $params);
646 list($type, $first, $second) = explode('_', $relationshipTypes);
647 $
{'contact_' . $first} = CRM_Utils_Array
::value('contact', $ids);
648 $
{'contact_' . $second} = $contactId;
649 // function to check if the relationship selected is correct
650 // i.e. employer relationship can exit between Individual and Organization (not between Individual and Individual)
651 if (!CRM_Contact_BAO_Relationship
::checkRelationshipType($contact_a, $contact_b, $type)) {
652 $errors = 'Please select valid relationship between these two contacts.';
658 * This function checks for duplicate relationship
660 * @param array $params (reference ) an assoc array of name/value pairs
661 * @param integer $id this the id of the contact whom we are adding relationship
662 * @param integer $contactId this is contact id for adding relationship
663 * @param integer $relationshipId this is relationship id for the contact
665 * @return boolean true if record exists else false
669 static function checkDuplicateRelationship(&$params, $id, $contactId = 0, $relationshipId = 0) {
670 $relationshipTypeId = CRM_Utils_Array
::value('relationship_type_id', $params);
671 list($type, $first, $second) = explode('_', $relationshipTypeId);
675 FROM civicrm_relationship
676 WHERE relationship_type_id = " . CRM_Utils_Type
::escape($type, 'Integer');
679 * CRM-11792 - date fields from API are in ISO format, but this function
680 * supports date arrays BAO has increasingly standardised to ISO format
681 * so I believe this function should support ISO rather than make API
682 * format it - however, need to support array format for now to avoid breakage
683 * @ time of writing this function is called from Relationship::create (twice)
684 * CRM_BAO_Contact_Utils::clearCurrentEmployer (seemingly without dates)
685 * CRM_Contact_Form_Task_AddToOrganization::postProcess &
686 * CRM_Contact_Form_Task_AddToHousehold::postProcess
687 * (I don't think the last 2 support dates but not sure
690 $dateFields = array('end_date', 'start_date');
691 foreach ($dateFields as $dateField){
692 if(array_key_exists($dateField, $params)) {
693 if (empty($params[$dateField]) ||
$params[$dateField] == 'null'){
694 //this is most likely coming from an api call & probably loaded
695 // from the DB to deal with some of the
696 // other myriad of excessive checks still in place both in
697 // the api & the create functions
698 $queryString .= " AND $dateField IS NULL";
701 elseif (is_array($params[$dateField])){
702 $queryString .= " AND $dateField = " .
703 CRM_Utils_Type
::escape(CRM_Utils_Date
::format($params[$dateField]), 'Date');
706 $queryString .= " AND $dateField = " .
707 CRM_Utils_Type
::escape($params[$dateField], 'Date');
713 " AND ( ( contact_id_a = " . CRM_Utils_Type
::escape($id, 'Integer') .
714 " AND contact_id_b = " . CRM_Utils_Type
::escape($contactId, 'Integer') .
715 " ) OR ( contact_id_a = " . CRM_Utils_Type
::escape($contactId, 'Integer') .
716 " AND contact_id_b = " . CRM_Utils_Type
::escape($id, 'Integer') . " ) ) ";
718 //if caseId is provided, include it duplicate checking.
719 if ($caseId = CRM_Utils_Array
::value('case_id', $params)) {
720 $queryString .= " AND case_id = " . CRM_Utils_Type
::escape($caseId, 'Integer');
723 if ($relationshipId) {
724 $queryString .= " AND id !=" . CRM_Utils_Type
::escape($relationshipId, 'Integer');
727 $relationship = new CRM_Contact_BAO_Relationship();
728 $relationship->query($queryString);
729 $relationship->fetch();
730 $relationship->free();
731 return ($relationship->id
) ?
TRUE : FALSE;
735 * Update the is_active flag in the db
737 * @param int $id id of the database record
738 * @param boolean $is_active value we want to set the is_active field
740 * @throws CiviCRM_API3_Exception
741 * @return Object DAO object on success, null otherwise
744 static function setIsActive($id, $is_active) {
745 // as both the create & add functions have a bunch of logic in them that
746 // doesn't seem to cope with a normal update we will call the api which
747 // has tested handling for this
748 // however, a longer term solution would be to simplify the add, create & api functions
749 // to be more standard. It is debatable @ that point whether it's better to call the BAO
750 // direct as the api is more tested.
751 $result = civicrm_api('relationship', 'create', array(
753 'is_active' => $is_active,
757 if (is_array($result) && !empty($result['is_error']) && $result['error_message'] != 'Relationship already exists') {
758 throw new CiviCRM_API3_Exception($result['error_message'], CRM_Utils_Array
::value('error_code', $result, 'undefined'), $result);
761 // call (undocumented possibly deprecated) hook
762 CRM_Utils_Hook
::enableDisable('CRM_Contact_BAO_Relationship', $id, $is_active);
768 * Given the list of params in the params array, fetch the object
769 * and store the values in the values array
771 * @param array $params input parameters to find object
772 * @param array $values output values of the object
774 * @return array (reference) the values that could be potentially assigned to smarty
778 static function &getValues(&$params, &$values) {
779 if (empty($params)) {
784 // get the specific number of relationship or all relationships.
785 if (!empty($params['numRelationship'])) {
786 $v['data'] = &CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'], NULL, $params['numRelationship']);
789 $v['data'] = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id']);
792 // get the total count of relationships
793 $v['totalCount'] = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'], NULL, NULL, TRUE);
795 $values['relationship']['data'] = &$v['data'];
796 $values['relationship']['totalCount'] = &$v['totalCount'];
802 * Helper function to form the sql for relationship retrieval
804 * @param int $contactId contact id
805 * @param int $status (check const at top of file)
806 * @param int $numRelationship no of relationships to display (limit)
807 * @param int $count get the no of relationships
808 * $param int $relationshipId relationship id
809 * @param int $relationshipId
810 * @param string $direction the direction we are interested in a_b or b_a
811 * @param array $params array of extra values including relationship_type_id per api spec
813 * return string the query for this diretion
819 static function makeURLClause($contactId, $status, $numRelationship, $count, $relationshipId, $direction, $params = array()) {
820 $select = $from = $where = '';
824 if ($direction == 'a_b') {
825 $select .= ' SELECT count(DISTINCT civicrm_relationship.id) as cnt1, 0 as cnt2 ';
828 $select .= ' SELECT 0 as cnt1, count(DISTINCT civicrm_relationship.id) as cnt2 ';
832 $select .= ' SELECT civicrm_relationship.id as civicrm_relationship_id,
833 civicrm_contact.sort_name as sort_name,
834 civicrm_contact.display_name as display_name,
835 civicrm_contact.job_title as job_title,
836 civicrm_contact.employer_id as employer_id,
837 civicrm_contact.organization_name as organization_name,
838 civicrm_address.street_address as street_address,
839 civicrm_address.city as city,
840 civicrm_address.postal_code as postal_code,
841 civicrm_state_province.abbreviation as state,
842 civicrm_country.name as country,
843 civicrm_email.email as email,
844 civicrm_contact.contact_type as contact_type,
845 civicrm_phone.phone as phone,
846 civicrm_contact.id as civicrm_contact_id,
847 civicrm_relationship.contact_id_b as contact_id_b,
848 civicrm_relationship.contact_id_a as contact_id_a,
849 civicrm_relationship_type.id as civicrm_relationship_type_id,
850 civicrm_relationship.start_date as start_date,
851 civicrm_relationship.end_date as end_date,
852 civicrm_relationship.description as description,
853 civicrm_relationship.is_active as is_active,
854 civicrm_relationship.is_permission_a_b as is_permission_a_b,
855 civicrm_relationship.is_permission_b_a as is_permission_b_a,
856 civicrm_relationship.case_id as case_id';
858 if ($direction == 'a_b') {
859 $select .= ', civicrm_relationship_type.label_a_b as label_a_b,
860 civicrm_relationship_type.label_b_a as relation ';
863 $select .= ', civicrm_relationship_type.label_a_b as label_a_b,
864 civicrm_relationship_type.label_a_b as relation ';
869 FROM civicrm_relationship
870 INNER JOIN civicrm_relationship_type ON ( civicrm_relationship.relationship_type_id = civicrm_relationship_type.id )
871 INNER JOIN civicrm_contact ";
872 if ($direction == 'a_b') {
873 $from .= 'ON ( civicrm_contact.id = civicrm_relationship.contact_id_a ) ';
876 $from .= 'ON ( civicrm_contact.id = civicrm_relationship.contact_id_b ) ';
879 LEFT JOIN civicrm_address ON (civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1)
880 LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = civicrm_contact.id AND civicrm_phone.is_primary = 1)
881 LEFT JOIN civicrm_email ON (civicrm_email.contact_id = civicrm_contact.id AND civicrm_email.is_primary = 1)
882 LEFT JOIN civicrm_state_province ON (civicrm_address.state_province_id = civicrm_state_province.id)
883 LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id)
885 $where = 'WHERE ( 1 )';
887 if ($direction == 'a_b') {
888 $where .= ' AND civicrm_relationship.contact_id_b = ' . CRM_Utils_Type
::escape($contactId, 'Positive');
891 $where .= ' AND civicrm_relationship.contact_id_a = ' . CRM_Utils_Type
::escape($contactId, 'Positive') . '
892 AND civicrm_relationship.contact_id_a != civicrm_relationship.contact_id_b ';
895 if ($relationshipId) {
896 $where .= ' AND civicrm_relationship.id = ' . CRM_Utils_Type
::escape($relationshipId, 'Positive');
899 $date = date('Y-m-d');
900 if ($status == self
::PAST
) {
901 //this case for showing past relationship
902 $where .= ' AND civicrm_relationship.is_active = 1 ';
903 $where .= " AND civicrm_relationship.end_date < '" . $date . "'";
905 elseif ($status == self
::DISABLED
) {
906 // this case for showing disabled relationship
907 $where .= ' AND civicrm_relationship.is_active = 0 ';
909 elseif ($status == self
::CURRENT
) {
910 //this case for showing current relationship
911 $where .= ' AND civicrm_relationship.is_active = 1 ';
912 $where .= " AND (civicrm_relationship.end_date >= '" . $date . "' OR civicrm_relationship.end_date IS NULL) ";
914 elseif ($status == self
::INACTIVE
) {
915 //this case for showing inactive relationships
916 $where .= " AND (civicrm_relationship.end_date < '" . $date . "'";
917 $where .= ' OR civicrm_relationship.is_active = 0 )';
921 $where .= ' AND civicrm_contact.is_deleted = 0';
922 if(!empty($params['membership_type_id']) && empty($params['relationship_type_id'])) {
923 $where .= self
::membershipTypeToRelationshipTypes($params, $direction);
925 if(!empty($params['relationship_type_id'])) {
926 if(is_array($params['relationship_type_id'])) {
927 $where .= " AND " . CRM_Core_DAO
::createSQLFilter('relationship_type_id', $params['relationship_type_id'], 'Integer');
930 $where .= ' AND relationship_type_id = ' . CRM_Utils_Type
::escape($params['relationship_type_id'], 'Positive');
933 if ($direction == 'a_b') {
934 $where .= ' ) UNION ';
940 return array($select, $from, $where);
944 * This is the function to get the list of relationships
946 * @param int $contactId contact id
947 * @param int $status 1: Past 2: Disabled 3: Current
948 * @param int $numRelationship no of relationships to display (limit)
949 * @param int $count get the no of relationships
950 * $param int $relationshipId relationship id
951 * $param array $links the list of links to display
952 * $param int $permissionMask the permission mask to be applied for the actions
953 * $param boolean $permissionedContact to return only permissioned Contact
954 * $param array $params array of variables consistent with filters supported by the api
955 * return array $values relationship records
956 * @param int $relationshipId
958 * @param null $permissionMask
959 * @param bool $permissionedContact
960 * @param array $params
966 static function getRelationship($contactId = NULL,
967 $status = 0, $numRelationship = 0,
968 $count = 0, $relationshipId = 0,
969 $links = NULL, $permissionMask = NULL,
970 $permissionedContact = FALSE,
974 if (!$contactId && !$relationshipId) {
978 list($select1, $from1, $where1) = self
::makeURLClause($contactId, $status, $numRelationship,
979 $count, $relationshipId, 'a_b', $params
981 list($select2, $from2, $where2) = self
::makeURLClause($contactId, $status, $numRelationship,
982 $count, $relationshipId, 'b_a', $params
985 $order = $limit = '';
987 if (empty($params['sort'])) {
988 $order = ' ORDER BY civicrm_relationship_type_id, sort_name ';
991 $order = " ORDER BY {$params['sort']} ";
995 if (!empty($params['offset']) && $params['offset'] > 0) {
996 $offset = $params['offset'];
999 if ($numRelationship) {
1000 $limit = " LIMIT {$offset}, $numRelationship";
1004 // building the query string
1005 $queryString = $select1 . $from1 . $where1 . $select2 . $from2 . $where2 . $order . $limit;
1007 $relationship = new CRM_Contact_DAO_Relationship();
1009 $relationship->query($queryString);
1012 $relationshipCount = 0;
1013 while ($relationship->fetch()) {
1014 $relationshipCount +
= $relationship->cnt1 +
$relationship->cnt2
;
1016 return $relationshipCount;
1021 if ($status != self
::INACTIVE
) {
1023 $mask = array_sum(array_keys($links));
1024 if ($mask & CRM_Core_Action
::DISABLE
) {
1025 $mask -= CRM_Core_Action
::DISABLE
;
1027 if ($mask & CRM_Core_Action
::ENABLE
) {
1028 $mask -= CRM_Core_Action
::ENABLE
;
1031 if ($status == self
::CURRENT
) {
1032 $mask |
= CRM_Core_Action
::DISABLE
;
1034 elseif ($status == self
::DISABLED
) {
1035 $mask |
= CRM_Core_Action
::ENABLE
;
1037 $mask = $mask & $permissionMask;
1040 while ($relationship->fetch()) {
1041 $rid = $relationship->civicrm_relationship_id
;
1042 $cid = $relationship->civicrm_contact_id
;
1043 if (($permissionedContact) &&
1044 (!CRM_Contact_BAO_Contact_Permission
::relationship($cid, $contactId))
1048 $values[$rid]['id'] = $rid;
1049 $values[$rid]['cid'] = $cid;
1050 $values[$rid]['contact_id_a'] = $relationship->contact_id_a
;
1051 $values[$rid]['contact_id_b'] = $relationship->contact_id_b
;
1052 $values[$rid]['contact_type'] = $relationship->contact_type
;
1053 $values[$rid]['relationship_type_id'] = $relationship->civicrm_relationship_type_id
;
1054 $values[$rid]['relation'] = $relationship->relation
;
1055 $values[$rid]['name'] = $relationship->sort_name
;
1056 $values[$rid]['display_name'] = $relationship->display_name
;
1057 $values[$rid]['job_title'] = $relationship->job_title
;
1058 $values[$rid]['email'] = $relationship->email
;
1059 $values[$rid]['phone'] = $relationship->phone
;
1060 $values[$rid]['employer_id'] = $relationship->employer_id
;
1061 $values[$rid]['organization_name'] = $relationship->organization_name
;
1062 $values[$rid]['country'] = $relationship->country
;
1063 $values[$rid]['city'] = $relationship->city
;
1064 $values[$rid]['state'] = $relationship->state
;
1065 $values[$rid]['start_date'] = $relationship->start_date
;
1066 $values[$rid]['end_date'] = $relationship->end_date
;
1067 $values[$rid]['description'] = $relationship->description
;
1068 $values[$rid]['is_active'] = $relationship->is_active
;
1069 $values[$rid]['is_permission_a_b'] = $relationship->is_permission_a_b
;
1070 $values[$rid]['is_permission_b_a'] = $relationship->is_permission_b_a
;
1071 $values[$rid]['case_id'] = $relationship->case_id
;
1074 $values[$rid]['status'] = $status;
1077 $values[$rid]['civicrm_relationship_type_id'] = $relationship->civicrm_relationship_type_id
;
1079 if ($relationship->contact_id_a
== $contactId) {
1080 $values[$rid]['rtype'] = 'a_b';
1083 $values[$rid]['rtype'] = 'b_a';
1089 'rtype' => $values[$rid]['rtype'],
1090 'cid' => $contactId,
1091 'cbid' => $values[$rid]['cid'],
1092 'caseid' => $values[$rid]['case_id'],
1093 'clientid' => $contactId,
1096 if ($status == self
::INACTIVE
) {
1097 // setting links for inactive relationships
1098 $mask = array_sum(array_keys($links));
1099 if (!$values[$rid]['is_active']) {
1100 $mask -= CRM_Core_Action
::DISABLE
;
1103 $mask -= CRM_Core_Action
::ENABLE
;
1104 $mask -= CRM_Core_Action
::DISABLE
;
1108 // Give access to manage case link by copying to MAX_ACTION index temporarily, depending on case permission of user.
1109 if ($values[$rid]['case_id']) {
1110 // Borrowed logic from CRM_Case_Page_Tab
1111 $hasCaseAccess = FALSE;
1112 if (CRM_Core_Permission
::check('access all cases and activities')) {
1113 $hasCaseAccess = TRUE;
1116 $userCases = CRM_Case_BAO_Case
::getCases(FALSE);
1117 if (array_key_exists($values[$rid]['case_id'], $userCases)) {
1118 $hasCaseAccess = TRUE;
1122 if ($hasCaseAccess) {
1123 // give access by copying to MAX_ACTION temporarily, otherwise leave at NONE which won't display
1124 $links[CRM_Core_Action
::MAX_ACTION
] = $links[CRM_Core_Action
::NONE
];
1125 $links[CRM_Core_Action
::MAX_ACTION
]['name'] = ts('Manage Case #%1', array(1 => $values[$rid]['case_id']));
1126 $links[CRM_Core_Action
::MAX_ACTION
]['class'] = 'no-popup';
1128 // Also make sure we have the right client cid since can get here from multiple relationship tabs.
1129 if ($values[$rid]['rtype'] == 'b_a') {
1130 $replace['clientid'] = $values[$rid]['cid'];
1135 $values[$rid]['action'] = CRM_Core_Action
::formLink(
1141 'relationship.selector.row',
1144 unset($links[CRM_Core_Action
::MAX_ACTION
]);
1148 $relationship->free();
1154 * Get get list of relationship type based on the target contact type.
1156 * @param string $targetContactType it's valid contact tpye(may be Individual , Organization , Household)
1158 * @return array - array reference of all relationship types with context to current contact type .
1161 function getRelationType($targetContactType) {
1162 $relationshipType = array();
1163 $allRelationshipType = CRM_Core_PseudoConstant
::relationshipType();
1165 foreach ($allRelationshipType as $key => $type) {
1166 if ($type['contact_type_b'] == $targetContactType) {
1167 $relationshipType[$key . '_a_b'] = $type['label_a_b'];
1171 return $relationshipType;
1175 * Create / update / delete membership for related contacts.
1177 * This function will create/update/delete membership for related
1178 * contact based on 1) contact have active membership 2) that
1179 * membership is is extedned by the same relationship type to that
1180 * of the existing relationship.
1182 * @param $contactId Int contact id
1183 * @param $params array array of values submitted by POST
1184 * @param $ids array array of ids
1185 * @param \const|\which $action which action called this function
1187 * @param bool $active
1191 static function relatedMemberships($contactId, &$params, $ids, $action = CRM_Core_Action
::ADD
, $active = TRUE) {
1192 // Check the end date and set the status of the relationship
1194 $status = self
::CURRENT
;
1196 if (!empty($params['end_date'])) {
1197 $endDate = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Date
::format($params['end_date']), NULL, 'Ymd');
1198 $today = date('Ymd');
1200 if ($today > $endDate) {
1201 $status = self
::PAST
;
1205 if (($action & CRM_Core_Action
::ADD
) &&
1206 ($status & self
::PAST
)
1208 // if relationship is PAST and action is ADD, no qustion
1209 // of creating RELATED membership and return back to
1214 $rel = explode('_', $params['relationship_type_id']);
1216 $relTypeId = $rel[0];
1217 $relDirection = "_{$rel[1]}_{$rel[2]}";
1218 $targetContact = array();
1219 if (($action & CRM_Core_Action
::ADD
) ||
1220 ($action & CRM_Core_Action
::DELETE
)
1222 $contact = $contactId;
1223 $targetContact = CRM_Utils_Array
::value('contact_check', $params);
1225 elseif ($action & CRM_Core_Action
::UPDATE
) {
1226 $contact = $ids['contact'];
1227 $targetContact = array($ids['contactTarget'] => 1);
1230 // Build the 'values' array for
1233 // This will allow us to check if either of the contacts in
1234 // relationship have active memberships.
1239 $values[$contact] = array(
1240 'relatedContacts' => $targetContact,
1241 'relationshipTypeId' => $relTypeId,
1242 'relationshipTypeDirection' => $relDirection,
1245 if (!empty($targetContact)) {
1246 foreach ($targetContact as $cid => $donCare) {
1247 $values[$cid] = array(
1248 'relatedContacts' => array($contact => 1),
1249 'relationshipTypeId' => $relTypeId,
1252 $relTypeParams = array('id' => $relTypeId);
1253 $relTypeValues = array();
1254 CRM_Contact_BAO_RelationshipType
::retrieve($relTypeParams, $relTypeValues);
1256 if (CRM_Utils_Array
::value('name_a_b', $relTypeValues) == CRM_Utils_Array
::value('name_b_a', $relTypeValues)) {
1257 $values[$cid]['relationshipTypeDirection'] = '_a_b';
1260 $values[$cid]['relationshipTypeDirection'] = ($relDirection == '_a_b') ?
'_b_a' : '_a_b';
1265 // Now get the active memberships for all the contacts.
1266 // If contact have any valid membership(s), then add it to
1268 foreach ($values as $cid => $subValues) {
1269 $memParams = array('contact_id' => $cid);
1270 $memberships = array();
1272 CRM_Member_BAO_Membership
::getValues($memParams, $memberships, $active);
1274 if (empty($memberships)) {
1278 $values[$cid]['memberships'] = $memberships;
1280 $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant
::membershipStatus());
1282 // done with 'values' array.
1283 // Finally add / edit / delete memberships for the related contacts
1284 foreach ($values as $cid => $details) {
1285 if (!array_key_exists('memberships', $details)) {
1289 $mainRelatedContactId = key(CRM_Utils_Array
::value('relatedContacts', $details, array()));
1291 foreach ($details['memberships'] as $membershipId => $membershipValues) {
1292 $relTypeIds = array();
1293 if ($action & CRM_Core_Action
::DELETE
) {
1294 // Delete memberships of the related contacts only if relationship type exists for membership type
1296 SELECT relationship_type_id, relationship_direction
1297 FROM civicrm_membership_type
1298 WHERE id = {$membershipValues['membership_type_id']}";
1299 $dao = CRM_Core_DAO
::executeQuery($query);
1300 $relTypeDirs = array();
1301 while ($dao->fetch()) {
1302 $relTypeId = $dao->relationship_type_id
;
1303 $relDirection = $dao->relationship_direction
;
1305 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $relTypeId);
1306 if (in_array($values[$cid]['relationshipTypeId'], $relTypeIds)) {
1307 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipId, $mainRelatedContactId);
1311 if (($action & CRM_Core_Action
::UPDATE
) &&
1312 ($status & self
::PAST
) &&
1313 ($membershipValues['owner_membership_id'])
1315 // If relationship is PAST and action is UPDATE
1316 // then delete the RELATED membership
1317 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipValues['owner_membership_id'],
1318 $membershipValues['membership_contact_id']
1323 // add / edit the memberships for related
1326 // Get the Membership Type Details.
1327 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($membershipValues['membership_type_id']);
1328 // Check if contact's relationship type exists in membership type
1329 $relTypeDirs = array();
1330 if (!empty($membershipType['relationship_type_id'])) {
1331 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_type_id']);
1333 if (!empty($membershipType['relationship_direction'])) {
1334 $relDirections = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $membershipType['relationship_direction']);
1336 foreach ($relTypeIds as $key => $value) {
1337 $relTypeDirs[] = $value . '_' . $relDirections[$key];
1339 $relTypeDir = $details['relationshipTypeId'] . $details['relationshipTypeDirection'];
1340 if (in_array($relTypeDir, $relTypeDirs)) {
1341 // Check if relationship being created/updated is
1342 // similar to that of membership type's
1345 $membershipValues['owner_membership_id'] = $membershipId;
1346 unset($membershipValues['id']);
1347 unset($membershipValues['membership_contact_id']);
1348 unset($membershipValues['contact_id']);
1349 unset($membershipValues['membership_id']);
1350 foreach ($details['relatedContacts'] as $relatedContactId => $donCare) {
1351 $membershipValues['contact_id'] = $relatedContactId;
1352 if ($deceasedStatusId &&
1353 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $relatedContactId, 'is_deceased')
1355 $membershipValues['status_id'] = $deceasedStatusId;
1356 $membershipValues['skipStatusCal'] = TRUE;
1359 'join_date', 'start_date', 'end_date') as $dateField) {
1360 if (!empty($membershipValues[$dateField])) {
1361 $membershipValues[$dateField] = CRM_Utils_Date
::processDate($membershipValues[$dateField]);
1365 if ($action & CRM_Core_Action
::UPDATE
) {
1366 //delete the membership record for related
1367 //contact before creating new membership record.
1368 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipId, $relatedContactId);
1371 // check whether we have some related memberships still available
1374 FROM civicrm_membership
1375 LEFT JOIN civicrm_membership_status ON (civicrm_membership_status.id = civicrm_membership.status_id)
1376 WHERE membership_type_id = {$membershipValues['membership_type_id']} AND owner_membership_id = {$membershipValues['owner_membership_id']}
1377 AND is_current_member = 1";
1378 $result = CRM_Core_DAO
::singleValueQuery($query);
1379 if ($result < CRM_Utils_Array
::value('max_related', $membershipValues, PHP_INT_MAX
)) {
1380 CRM_Member_BAO_Membership
::create($membershipValues, CRM_Core_DAO
::$_nullArray);
1384 elseif ($action & CRM_Core_Action
::UPDATE
) {
1385 // if action is update and updated relationship do
1386 // not match with the existing
1387 // membership=>relationship then we need to
1388 // delete the membership record created for
1389 // previous relationship.
1391 if (self
::isDeleteRelatedMembership($relTypeIds, $contactId, $mainRelatedContactId, $relTypeId, CRM_Utils_Array
::value('relationship_ids', $params))) {
1392 CRM_Member_BAO_Membership
::deleteRelatedMemberships($membershipId, $mainRelatedContactId);
1400 * Helper function to check whether to delete the membership or
1406 static function isDeleteRelatedMembership($relTypeIds, $contactId, $mainRelatedContactId, $relTypeId, $relIds) {
1407 if (in_array($relTypeId, $relTypeIds)) {
1411 if (empty($relIds)) {
1415 $relParamas = array(1 => array($contactId, 'Integer'),
1416 2 => array($mainRelatedContactId, 'Integer'),
1419 if ($contactId == $mainRelatedContactId) {
1420 $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);
1421 if ($recordsFound) {
1427 $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);
1429 if ($recordsFound) {
1437 * Get Current Employer for Contact
1439 * @param $contactIds Contact Ids
1441 * @return array $currentEmployer array of the current employer@static
1443 static function getCurrentEmployer($contactIds) {
1444 $contacts = implode(',', $contactIds);
1447 SELECT organization_name, id, employer_id
1448 FROM civicrm_contact
1449 WHERE id IN ( {$contacts} )
1452 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
1453 $currentEmployer = array();
1454 while ($dao->fetch()) {
1455 $currentEmployer[$dao->id
]['org_id'] = $dao->employer_id
;
1456 $currentEmployer[$dao->id
]['org_name'] = $dao->organization_name
;
1459 return $currentEmployer;
1463 * Return list of permissioned employer for a given contact.
1465 * @param $contactID int contact id whose employers
1467 * @param $name string employers sort name
1471 * @return array array of employers.
1474 static function getPermissionedEmployer($contactID, $name = NULL) {
1475 //get the relationship id
1476 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType',
1477 'Employee of', 'id', 'name_a_b'
1480 return self
::getPermissionedContacts($contactID, $relTypeId, $name);
1485 * Function to return list of permissioned contacts for a given contact and relationship type
1487 * @param $contactID int contact id whose permissioned contacts are to be found.
1488 * @param $relTypeId string one or more relationship type id's
1489 * @param $name string
1493 * @return array of contacts
1495 static function getPermissionedContacts($contactID, $relTypeId, $name = NULL) {
1496 $contacts = array();
1500 SELECT cc.id as id, cc.sort_name as name
1501 FROM civicrm_relationship cr, civicrm_contact cc
1503 cr.contact_id_a = %1 AND
1504 cr.relationship_type_id IN (%2) AND
1505 cr.is_permission_a_b = 1 AND
1506 IF(cr.end_date IS NULL, 1, (DATEDIFF( CURDATE( ), cr.end_date ) <= 0)) AND
1507 cr.is_active = 1 AND
1508 cc.id = cr.contact_id_b";
1510 if (!empty($name)) {
1511 $name = CRM_Utils_Type
::escape($name, 'String');
1513 AND cc.sort_name LIKE '%$name%'";
1516 $args = array(1 => array($contactID, 'Integer'), 2 => array($relTypeId, 'String'));
1517 $dao = CRM_Core_DAO
::executeQuery($query, $args);
1519 while ($dao->fetch()) {
1520 $contacts[$dao->id
] = array(
1521 'name' => $dao->name
,
1522 'value' => $dao->id
,
1530 * Merge relationships from otherContact to mainContact
1531 * Called during contact merge operation
1533 * @param int $mainId contact id of main contact record.
1534 * @param int $otherId contact id of record which is going to merge.
1535 * @param array $sqls (reference) array of sql statements to append to.
1537 * @see CRM_Dedupe_Merger::cpTables()
1541 static function mergeRelationships($mainId, $otherId, &$sqls) {
1542 // Delete circular relationships
1543 $sqls[] = "DELETE FROM civicrm_relationship
1544 WHERE (contact_id_a = $mainId AND contact_id_b = $otherId)
1545 OR (contact_id_b = $mainId AND contact_id_a = $otherId)";
1547 // Delete relationship from other contact if main contact already has that relationship
1548 $sqls[] = "DELETE r2
1549 FROM civicrm_relationship r1, civicrm_relationship r2
1550 WHERE r1.relationship_type_id = r2.relationship_type_id
1553 r1.contact_id_a = $mainId AND r2.contact_id_a = $otherId AND r1.contact_id_b = r2.contact_id_b
1554 OR r1.contact_id_b = $mainId AND r2.contact_id_b = $otherId AND r1.contact_id_a = r2.contact_id_a
1556 (r1.contact_id_a = $mainId AND r2.contact_id_b = $otherId AND r1.contact_id_b = r2.contact_id_a
1557 OR r1.contact_id_b = $mainId AND r2.contact_id_a = $otherId AND r1.contact_id_a = r2.contact_id_b)
1558 AND r1.relationship_type_id IN (SELECT id FROM civicrm_relationship_type WHERE name_b_a = name_a_b)
1562 // Move relationships
1563 $sqls[] = "UPDATE IGNORE civicrm_relationship SET contact_id_a = $mainId WHERE contact_id_a = $otherId";
1564 $sqls[] = "UPDATE IGNORE civicrm_relationship SET contact_id_b = $mainId WHERE contact_id_b = $otherId";
1566 // Move current employer id (name will get updated later)
1567 $sqls[] = "UPDATE civicrm_contact SET employer_id = $mainId WHERE employer_id = $otherId";
1571 * Set 'is_valid' field to false for all relationships whose end date is in the past, ie. are expired.
1573 * @return True on success, false if error is encountered.
1575 static function disableExpiredRelationships() {
1576 $query = "SELECT id FROM civicrm_relationship WHERE is_active = 1 AND end_date < CURDATE()";
1578 $dao = CRM_Core_DAO
::executeQuery($query);
1579 while ($dao->fetch()) {
1580 $result = CRM_Contact_BAO_Relationship
::setIsActive($dao->id
, FALSE);
1581 // Result will be NULL if error occurred. We abort early if error detected.
1582 if ($result == NULL) {
1590 * Function filters the query by possible relationships for the membership type
1591 * It is intended to be called when constructing queries for the api (reciprocal & non-reciprocal)
1592 * and to add clauses to limit the return to those relationships which COULD inherit a membership type
1593 * (as opposed to those who inherit a particular membership
1595 * @param array $params api input array
1596 * @param null $direction
1600 static function membershipTypeToRelationshipTypes(&$params, $direction = NULL) {
1601 $membershipType = civicrm_api3('membership_type', 'getsingle', array('id' => $params['membership_type_id'], 'return' => 'relationship_type_id, relationship_direction'));
1602 $relationshipTypes = $membershipType['relationship_type_id'];
1603 if(empty($relationshipTypes)) {
1606 // if we don't have any contact data we can only filter on type
1607 if(empty($params['contact_id']) && empty($params['contact_id_a']) && empty($params['contact_id_a'])) {
1608 $params['relationship_type_id'] = array('IN' => $relationshipTypes);
1612 $relationshipDirections = (array) $membershipType['relationship_direction'];
1613 // if we have contact_id_a OR contact_id_b we can make a call here
1614 // if we have contact??
1615 foreach ($relationshipDirections as $index => $mtdirection) {
1616 if(isset($params['contact_id_a']) && $mtdirection == 'a_b' ||
$direction == 'a_b') {
1617 $types[] = $relationshipTypes[$index];
1619 if(isset($params['contact_id_b']) && $mtdirection == 'b_a' ||
$direction == 'b_a') {
1620 $types[] = $relationshipTypes[$index];
1623 if(!empty($types)) {
1624 $params['relationship_type_id'] = array('IN' => $types);
1626 elseif(!empty($clauses)) {
1627 return explode(' OR ', $clauses);
1630 // effectively setting it to return no results
1631 $params['relationship_type_id'] = 0;
1638 * This function is a wrapper for contact relationship selector
1640 * @param array $params associated array for params record id.
1642 * @return array $contactRelationships associated array of contact relationships
1645 public static function getContactRelationshipSelector(&$params) {
1646 // format the params
1647 $params['offset'] = ($params['page'] - 1) * $params['rp'];
1648 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
1650 if ($params['context'] == 'past') {
1651 $relationshipStatus = CRM_Contact_BAO_Relationship
::INACTIVE
;
1654 $relationshipStatus = CRM_Contact_BAO_Relationship
::CURRENT
;
1657 // check logged in user for permission
1658 $page = new CRM_Core_Page();
1659 CRM_Contact_Page_View
::checkUserPermission($page, $params['contact_id']);
1660 $permissions = array($page->_permission
);
1661 if ($page->_permission
== CRM_Core_Permission
::EDIT
) {
1662 $permissions[] = CRM_Core_Permission
::DELETE
;
1664 $mask = CRM_Core_Action
::mask($permissions);
1666 if ($params['context'] != 'user') {
1667 $links = CRM_Contact_Page_View_Relationship
::links();
1668 $permissionedContacts = FALSE;
1671 $links = CRM_Contact_Page_View_UserDashBoard
::links();
1672 $permissionedContacts = TRUE;
1675 // get contact relationships
1676 $relationships = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'],
1677 $relationshipStatus,
1678 $params['rp'], 0, 0,
1680 $permissionedContacts,
1684 $contactRelationships = array();
1685 $params['total'] = 0;
1686 if (!empty($relationships)) {
1687 // get the total relationships
1688 if ($params['context'] != 'user') {
1689 $params['total'] = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'],
1690 $relationshipStatus, 0, 1, 0, NULL, NULL, $permissionedContacts);
1693 // FIX ME: we cannot directly determine total permissioned relationship, hence re-fire query
1694 $permissionedRelationships = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'],
1695 $relationshipStatus,
1699 $params['total'] = count($permissionedRelationships);
1703 foreach ($relationships as $relationshipId => $values) {
1704 //Add image icon for related contacts: CRM-14919
1705 $icon = CRM_Contact_BAO_Contact_Utils
::getImage($values['contact_type'],
1709 $contactRelationships[$relationshipId]['name'] = $icon.' '.CRM_Utils_System
::href(
1711 'civicrm/contact/view',
1712 "reset=1&cid={$values['cid']}");
1714 $contactRelationships[$relationshipId]['relation'] = CRM_Utils_System
::href(
1715 $values['relation'],
1716 'civicrm/contact/view/rel',
1717 "action=view&reset=1&cid={$values['cid']}&id={$values['id']}&rtype={$values['rtype']}");
1719 if ($params['context'] == 'current') {
1720 if (($params['contact_id'] == $values['contact_id_a'] AND $values['is_permission_a_b'] == 1) OR
1721 ($params['contact_id'] == $values['contact_id_b'] AND $values['is_permission_b_a'] == 1)
1723 $contactRelationships[$relationshipId]['name'] .= '<span id="permission-a-b" class="crm-marker permission-relationship"> *</span>';
1726 if (($values['cid'] == $values['contact_id_a'] AND $values['is_permission_a_b'] == 1) OR
1727 ($values['cid'] == $values['contact_id_b'] AND $values['is_permission_b_a'] == 1)
1729 $contactRelationships[$relationshipId]['relation'] .= '<span id="permission-b-a" class="crm-marker permission-relationship"> *</span>';
1733 if (!empty($values['description'])) {
1734 $contactRelationships[$relationshipId]['relation'] .= "<p class='description'>{$values['description']}</p>";
1737 $contactRelationships[$relationshipId]['start_date'] = CRM_Utils_Date
::customFormat($values['start_date']);
1738 $contactRelationships[$relationshipId]['end_date'] = CRM_Utils_Date
::customFormat($values['end_date']);
1739 $contactRelationships[$relationshipId]['city'] = $values['city'];
1740 $contactRelationships[$relationshipId]['state'] = $values['state'];
1741 $contactRelationships[$relationshipId]['email'] = $values['email'];
1742 $contactRelationships[$relationshipId]['phone'] = $values['phone'];
1743 $contactRelationships[$relationshipId]['links'] = $values['action'];
1744 $contactRelationships[$relationshipId]['id'] = $values['id'];
1745 $contactRelationships[$relationshipId]['is_active'] = $values['is_active'];
1748 return $contactRelationships;