Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
232624b1 | 4 | | CiviCRM version 4.4 | |
6a488035 TO |
5 | +--------------------------------------------------------------------+ |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
31 | * @copyright CiviCRM LLC (c) 2004-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { | |
36 | ||
37 | /** | |
38 | * various constants to indicate different type of relationships | |
39 | * | |
40 | * @var int | |
41 | */ | |
42 | CONST PAST = 1, DISABLED = 2, CURRENT = 4, INACTIVE = 8; | |
43 | ||
44 | /** | |
45 | * takes an associative array and creates a relationship object | |
46 | * | |
47 | * | |
48 | * @param array $params (reference ) an assoc array of name/value pairs | |
49 | * @param array $ids the array that holds all the db ids | |
26dcc9eb | 50 | * per http://wiki.civicrm.org/confluence/display/CRM/Database+layer |
51 | * "we are moving away from the $ids param " | |
6a488035 TO |
52 | * |
53 | * @return object CRM_Contact_BAO_Relationship object | |
54 | * @access public | |
55 | * @static | |
56 | */ | |
26dcc9eb | 57 | static function create(&$params, $ids = array()) { |
6a488035 | 58 | $valid = $invalid = $duplicate = $saved = 0; |
26dcc9eb | 59 | $relationships = array(); |
60 | $relationshipId = CRM_Utils_Array::value('relationship', $ids, CRM_Utils_Array::value('id', $params)); | |
6a488035 TO |
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 | |
26dcc9eb | 63 | if(empty($relationshipId)){ |
64 | $hook = 'create'; | |
65 | $action = CRM_Core_Action::ADD; | |
6a488035 | 66 | } |
26dcc9eb | 67 | else{ |
68 | $hook = 'edit'; | |
69 | $action = CRM_Core_Action::UPDATE; | |
6a488035 | 70 | } |
26dcc9eb | 71 | |
72 | CRM_Utils_Hook::pre($hook, 'Relationship', $relationshipId, $params); | |
73 | ||
6a488035 TO |
74 | if (!$relationshipId) { |
75 | // creating a new relationship | |
76 | $dataExists = self::dataExists($params); | |
77 | if (!$dataExists) { | |
43291913 | 78 | return array(FALSE, TRUE, FALSE, FALSE, NULL); |
6a488035 TO |
79 | } |
80 | $relationshipIds = array(); | |
81 | foreach ($params['contact_check'] as $key => $value) { | |
82 | $errors = ''; | |
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 | |
87 | ||
88 | // step 1 | |
89 | $errors = self::checkValidRelationship($params, $ids, $key); | |
90 | if ($errors) { | |
91 | $invalid++; | |
92 | continue; | |
93 | } | |
94 | ||
95 | if ( | |
96 | self::checkDuplicateRelationship( | |
97 | $params, | |
98 | CRM_Utils_Array::value('contact', $ids), | |
99 | // step 2 | |
100 | $key | |
101 | ) | |
102 | ) { | |
103 | $duplicate++; | |
104 | continue; | |
105 | } | |
106 | ||
107 | $relationship = self::add($params, $ids, $key); | |
108 | $relationshipIds[] = $relationship->id; | |
26dcc9eb | 109 | $relationships[$relationship->id] = $relationship; |
6a488035 TO |
110 | $valid++; |
111 | } | |
112 | // editing the relationship | |
113 | } | |
114 | else { | |
115 | // check for duplicate relationship | |
f0fc26a5 DL |
116 | // @todo this code doesn't cope well with updates - causes e-Notices. |
117 | // API has a lot of code to work around | |
49f8272d | 118 | // this but should review this code & remove the extra handling from the api |
f0fc26a5 DL |
119 | // it seems doubtful any of this is relevant if the contact fields & relationship |
120 | // type fields are not set | |
6a488035 TO |
121 | if ( |
122 | self::checkDuplicateRelationship( | |
123 | $params, | |
124 | CRM_Utils_Array::value('contact', $ids), | |
125 | $ids['contactTarget'], | |
126 | $relationshipId | |
127 | ) | |
128 | ) { | |
129 | $duplicate++; | |
43291913 | 130 | return array($valid, $invalid, $duplicate, $saved, NULL); |
6a488035 TO |
131 | } |
132 | ||
133 | $validContacts = TRUE; | |
134 | //validate contacts in update mode also. | |
8cc574cf | 135 | if (!empty($ids['contact']) && !empty($ids['contactTarget'])) { |
6a488035 TO |
136 | if (self::checkValidRelationship($params, $ids, $ids['contactTarget'])) { |
137 | $validContacts = FALSE; | |
138 | $invalid++; | |
139 | } | |
140 | } | |
141 | if ($validContacts) { | |
142 | // editing an existing relationship | |
143 | $relationship = self::add($params, $ids, $ids['contactTarget']); | |
144 | $relationshipIds[] = $relationship->id; | |
26dcc9eb | 145 | $relationships[$relationship->id] = $relationship; |
6a488035 TO |
146 | $saved++; |
147 | } | |
148 | } | |
149 | ||
150 | // do not add to recent items for import, CRM-4399 | |
8cc574cf | 151 | if (!(!empty($params['skipRecentView']) || $invalid || $duplicate)) { |
6a488035 TO |
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" | |
154 | ); | |
155 | ||
156 | ||
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) | |
161 | ) { | |
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" | |
166 | ), | |
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" | |
169 | ), | |
170 | ); | |
171 | } | |
172 | ||
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) . ')'; | |
6a488035 TO |
176 | // add the recently created Relationship |
177 | CRM_Utils_Recent::add($title, | |
178 | $url, | |
179 | $relationship->id, | |
180 | 'Relationship', | |
181 | $relationship->contact_id_a, | |
182 | NULL, | |
183 | $recentOther | |
184 | ); | |
185 | } | |
186 | ||
26dcc9eb | 187 | return array($valid, $invalid, $duplicate, $saved, $relationshipIds, $relationships); |
6a488035 TO |
188 | } |
189 | ||
190 | /** | |
191 | * This is the function that check/add if the relationship created is valid | |
192 | * | |
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 | |
196 | * | |
197 | * @return object CRM_Contact_BAO_Relationship | |
198 | * @access public | |
199 | * @static | |
200 | */ | |
49f8272d | 201 | static function add(&$params, $ids = array(), $contactId = NULL) { |
f0fc26a5 DL |
202 | $relationshipId = |
203 | CRM_Utils_Array::value('relationship', $ids, CRM_Utils_Array::value('id', $params)); | |
204 | ||
49f8272d E |
205 | $hook = 'create'; |
206 | if($relationshipId) { | |
207 | $hook = 'edit'; | |
6a488035 | 208 | } |
49f8272d E |
209 | //@todo hook are called from create and add - remove one |
210 | CRM_Utils_Hook::pre($hook , 'Relationship', $relationshipId, $params); | |
6a488035 TO |
211 | |
212 | $relationshipTypes = CRM_Utils_Array::value('relationship_type_id', $params); | |
213 | ||
f0fc26a5 DL |
214 | // explode the string with _ to get the relationship type id |
215 | // and to know which contact has to be inserted in | |
6a488035 TO |
216 | // contact_id_a and which one in contact_id_b |
217 | list($type, $first, $second) = explode('_', $relationshipTypes); | |
218 | ||
219 | ${'contact_' . $first} = CRM_Utils_Array::value('contact', $ids); | |
220 | ${'contact_' . $second} = $contactId; | |
221 | ||
f0fc26a5 DL |
222 | // check if the relationship type is Head of Household then update the |
223 | // household's primary contact with this contact. | |
6a488035 TO |
224 | if ($type == 6) { |
225 | CRM_Contact_BAO_Household::updatePrimaryContact($contact_b, $contact_a); | |
226 | } | |
227 | ||
228 | $relationship = new CRM_Contact_BAO_Relationship(); | |
49f8272d E |
229 | //@todo this code needs to be updated for the possibility that not all fields are set |
230 | // (update) | |
6a488035 TO |
231 | $relationship->contact_id_b = $contact_b; |
232 | $relationship->contact_id_a = $contact_a; | |
233 | $relationship->relationship_type_id = $type; | |
49f8272d | 234 | $relationship->id = $relationshipId; |
6a488035 TO |
235 | |
236 | $dateFields = array('end_date', 'start_date'); | |
237 | ||
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'; | |
244 | } | |
245 | } | |
246 | else{ | |
247 | $relationship->$defaultField = $params[$defaultField]; | |
248 | } | |
249 | } | |
49f8272d | 250 | elseif(!$relationshipId){ |
6a488035 TO |
251 | $relationship->$defaultField = $defaultValue; |
252 | } | |
253 | } | |
254 | ||
255 | $relationship->save(); | |
256 | ||
257 | // add custom field values | |
a7488080 | 258 | if (!empty($params['custom'])) { |
6a488035 TO |
259 | CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_relationship', $relationship->id); |
260 | } | |
261 | ||
262 | $relationship->free(); | |
263 | ||
49f8272d | 264 | CRM_Utils_Hook::post($hook, 'Relationship', $relationshipId, $relationship); |
6a488035 TO |
265 | |
266 | return $relationship; | |
267 | } | |
268 | /** | |
269 | * Specifiy defaults for creating a relationship | |
270 | * | |
271 | * @return array $defaults array of defaults for creating relationship | |
272 | * @access public | |
273 | * @static | |
274 | */ | |
275 | static function getdefaults() { | |
276 | return array( | |
277 | 'is_active' => 0, | |
278 | 'is_permission_a_b' => 0, | |
279 | 'is_permission_b_a' => 0, | |
280 | 'description' => '', | |
281 | 'start_date' => 'NULL', | |
282 | 'case_id' => NULL, | |
283 | 'end_date' => 'NULL', | |
284 | ); | |
285 | } | |
286 | ||
287 | ||
288 | /** | |
289 | * Check if there is data to create the object | |
290 | * | |
291 | * @param array $params (reference ) an assoc array of name/value pairs | |
292 | * | |
293 | * @return boolean | |
294 | * @access public | |
295 | * @static | |
296 | */ | |
297 | static function dataExists(&$params) { | |
298 | // return if no data present | |
299 | if (!is_array(CRM_Utils_Array::value('contact_check', $params))) { | |
300 | return FALSE; | |
301 | } | |
302 | return TRUE; | |
303 | } | |
304 | ||
305 | /** | |
306 | * Function to get get list of relationship type based on the contact type. | |
307 | * | |
308 | * @param int $contactId this is the contact id of the current contact. | |
309 | * @param string $strContact this value is currently ignored, keeping it there for legacy reasons | |
310 | * @param string $relationshipId the id of the existing relationship if any | |
311 | * @param string $contactType contact type | |
312 | * @param boolean $all if true returns relationship types in both the direction | |
313 | * @param string $column name/label that going to retrieve from db. | |
314 | * | |
315 | * | |
316 | * @param string $contactSubType includes relationshiptypes between this subtype | |
317 | * | |
318 | * @param boolean $onlySubTypeRelationTypes if set only subtype which is passed by $contactSubType | |
319 | * related relationshiptypes get return | |
320 | * @access public | |
321 | * @static | |
322 | * | |
323 | * @return array - array reference of all relationship types with context to current contact. | |
324 | */ | |
325 | static function getContactRelationshipType($contactId = NULL, | |
326 | $contactSuffix = NULL, | |
327 | $relationshipId = NULL, | |
328 | $contactType = NULL, | |
329 | $all = FALSE, | |
330 | $column = 'label', | |
331 | $biDirectional = TRUE, | |
332 | $contactSubType = NULL, | |
333 | $onlySubTypeRelationTypes = FALSE | |
334 | ) { | |
335 | $allRelationshipType = array(); | |
336 | $relationshipType = array(); | |
337 | $allRelationshipType = CRM_Core_PseudoConstant::relationshipType($column); | |
338 | ||
339 | $otherContactType = NULL; | |
340 | if ($relationshipId) { | |
341 | $relationship = new CRM_Contact_DAO_Relationship(); | |
342 | $relationship->id = $relationshipId; | |
343 | if ($relationship->find(TRUE)) { | |
344 | $contact = new CRM_Contact_DAO_Contact(); | |
345 | $contact->id = ($relationship->contact_id_a === $contactId) ? $relationship->contact_id_b : $relationship->contact_id_a; | |
346 | ||
347 | if ($contact->find(TRUE)) { | |
348 | $otherContactType = $contact->contact_type; | |
349 | //CRM-5125 for contact subtype specific relationshiptypes | |
350 | if ($contact->contact_sub_type) { | |
351 | $otherContactSubType = $contact->contact_sub_type; | |
352 | } | |
353 | } | |
354 | } | |
355 | } | |
356 | ||
357 | $contactSubType = array(); | |
358 | if ($contactId) { | |
359 | $contactType = CRM_Contact_BAO_Contact::getContactType($contactId); | |
360 | $contactSubType = CRM_Contact_BAO_Contact::getContactSubType($contactId); | |
361 | } | |
362 | ||
363 | foreach ($allRelationshipType as $key => $value) { | |
364 | // the contact type is required or matches | |
365 | if (((!$value['contact_type_a']) || | |
366 | $value['contact_type_a'] == $contactType | |
367 | ) && | |
368 | // the other contact type is required or present or matches | |
369 | ((!$value['contact_type_b']) || | |
370 | (!$otherContactType) || | |
371 | $value['contact_type_b'] == $otherContactType | |
372 | ) && | |
373 | (!$contactSubType || | |
374 | (in_array($value['contact_sub_type_a'], $contactSubType) || | |
375 | ((!$value['contact_sub_type_b'] && | |
376 | !$value['contact_sub_type_a'] | |
377 | ) && | |
378 | !$onlySubTypeRelationTypes | |
379 | ) | |
380 | ) | |
381 | ) | |
382 | ) { | |
383 | $relationshipType[$key . '_a_b'] = $value["{$column}_a_b"]; | |
384 | } | |
6a488035 TO |
385 | |
386 | if (((!$value['contact_type_b']) || | |
387 | $value['contact_type_b'] == $contactType | |
388 | ) && | |
389 | ((!$value['contact_type_a']) || | |
390 | (!$otherContactType) || | |
391 | $value['contact_type_a'] == $otherContactType | |
392 | ) && | |
393 | (!$contactSubType || | |
394 | (in_array($value['contact_sub_type_b'], $contactSubType) || | |
395 | ((!$value['contact_sub_type_a'] && | |
396 | !$value['contact_sub_type_b'] | |
397 | ) && | |
398 | !$onlySubTypeRelationTypes | |
399 | ) | |
400 | ) | |
401 | ) | |
402 | ) { | |
403 | $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"]; | |
404 | } | |
6a488035 TO |
405 | |
406 | if ($all) { | |
407 | $relationshipType[$key . '_a_b'] = $value["{$column}_a_b"]; | |
408 | $relationshipType[$key . '_b_a'] = $value["{$column}_b_a"]; | |
409 | } | |
410 | } | |
411 | ||
412 | if ($biDirectional) { | |
413 | // lets clean up the data and eliminate all duplicate values | |
414 | // (i.e. the relationship is bi-directional) | |
415 | $relationshipType = array_unique($relationshipType); | |
416 | } | |
417 | ||
418 | // sort the relationshipType in ascending order CRM-7736 | |
419 | asort($relationshipType); | |
420 | return $relationshipType; | |
421 | } | |
422 | ||
423 | static function clearCurrentEmployer($id, $action) { | |
424 | $relationship = new CRM_Contact_DAO_Relationship(); | |
425 | $relationship->id = $id; | |
426 | $relationship->find(TRUE); | |
427 | ||
428 | //to delete relationship between household and individual \ | |
429 | //or between individual and orgnization | |
430 | if (($action & CRM_Core_Action::DISABLE) || ($action & CRM_Core_Action::DELETE)) { | |
05802b8e DG |
431 | $relTypes = CRM_Utils_Array::index(array('name_a_b'), CRM_Core_PseudoConstant::relationshipType('name')); |
432 | if ($relationship->relationship_type_id == $relTypes['Employee of']['id'] || | |
433 | $relationship->relationship_type_id == $relTypes['Household Member of']['id']) { | |
434 | $sharedContact = new CRM_Contact_DAO_Contact(); | |
435 | $sharedContact->id = $relationship->contact_id_a; | |
436 | $sharedContact->find(TRUE); | |
437 | ||
438 | if ($relationship->relationship_type_id == 4 && $relationship->contact_id_b == $sharedContact->employer_id) { | |
439 | CRM_Contact_BAO_Contact_Utils::clearCurrentEmployer($relationship->contact_id_a); | |
440 | } | |
6a488035 TO |
441 | } |
442 | } | |
6a488035 TO |
443 | return $relationship; |
444 | } | |
445 | ||
446 | /** | |
447 | * Function to delete the relationship | |
448 | * | |
449 | * @param int $id relationship id | |
450 | * | |
451 | * @return null | |
452 | * @access public | |
453 | * | |
454 | * @static | |
455 | */ | |
456 | static function del($id) { | |
457 | // delete from relationship table | |
458 | CRM_Utils_Hook::pre('delete', 'Relationship', $id, CRM_Core_DAO::$_nullArray); | |
459 | ||
460 | $relationship = self::clearCurrentEmployer($id, CRM_Core_Action::DELETE); | |
461 | if (CRM_Core_Permission::access('CiviMember')) { | |
462 | // create $params array which isrequired to delete memberships | |
463 | // of the related contacts. | |
464 | $params = array( | |
465 | 'relationship_type_id' => "{$relationship->relationship_type_id}_a_b", | |
466 | 'contact_check' => array($relationship->contact_id_b => 1), | |
467 | ); | |
468 | ||
469 | $ids = array(); | |
470 | // calling relatedMemberships to delete the memberships of | |
471 | // related contacts. | |
472 | self::relatedMemberships($relationship->contact_id_a, | |
473 | $params, | |
474 | $ids, | |
475 | CRM_Core_Action::DELETE, | |
476 | FALSE | |
477 | ); | |
478 | } | |
479 | ||
480 | $relationship->delete(); | |
481 | CRM_Core_Session::setStatus(ts('Selected relationship has been deleted successfully.'), ts('Record Deleted'), 'success'); | |
482 | ||
483 | CRM_Utils_Hook::post('delete', 'Relationship', $relationship->id, $relationship); | |
484 | ||
485 | // delete the recently created Relationship | |
486 | $relationshipRecent = array( | |
487 | 'id' => $id, | |
488 | 'type' => 'Relationship', | |
489 | ); | |
490 | CRM_Utils_Recent::del($relationshipRecent); | |
491 | ||
492 | return $relationship; | |
493 | } | |
494 | ||
495 | /** | |
496 | * Function to disable/enable the relationship | |
497 | * | |
498 | * @param int $id relationship id | |
499 | * | |
500 | * @return null | |
501 | * @access public | |
502 | ||
503 | * @static | |
504 | */ | |
505 | static function disableEnableRelationship($id, $action) { | |
506 | $relationship = self::clearCurrentEmployer($id, $action); | |
507 | if (CRM_Core_Permission::access('CiviMember')) { | |
508 | // create $params array which isrequired to delete memberships | |
509 | // of the related contacts. | |
510 | $params = array( | |
511 | 'relationship_type_id' => "{$relationship->relationship_type_id}_a_b", | |
512 | 'contact_check' => array($relationship->contact_id_b => 1), | |
513 | ); | |
514 | ||
515 | $ids = array(); | |
516 | // calling relatedMemberships to delete/add the memberships of | |
517 | // related contacts. | |
518 | if ($action & CRM_Core_Action::DISABLE) { | |
519 | CRM_Contact_BAO_Relationship::relatedMemberships($relationship->contact_id_a, | |
520 | $params, | |
521 | $ids, | |
522 | CRM_Core_Action::DELETE, | |
523 | FALSE | |
524 | ); | |
525 | } | |
526 | elseif ($action & CRM_Core_Action::ENABLE) { | |
527 | $ids['contact'] = $relationship->contact_id_a; | |
528 | CRM_Contact_BAO_Relationship::relatedMemberships($relationship->contact_id_a, | |
529 | $params, | |
530 | $ids, | |
531 | CRM_Core_Action::ADD, | |
532 | FALSE | |
533 | ); | |
534 | } | |
535 | } | |
536 | } | |
537 | ||
538 | /** | |
539 | * Delete the object records that are associated with this contact | |
540 | * | |
541 | * @param int $contactId id of the contact to delete | |
542 | * | |
543 | * @return void | |
544 | * @access public | |
545 | * @static | |
546 | */ | |
547 | static function deleteContact($contactId) { | |
548 | $relationship = new CRM_Contact_DAO_Relationship(); | |
549 | $relationship->contact_id_a = $contactId; | |
550 | $relationship->delete(); | |
551 | ||
552 | $relationship = new CRM_Contact_DAO_Relationship(); | |
553 | $relationship->contact_id_b = $contactId; | |
554 | $relationship->delete(); | |
555 | ||
556 | CRM_Contact_BAO_Household::updatePrimaryContact(NULL, $contactId); | |
557 | } | |
558 | ||
559 | /** | |
560 | * Function to get the other contact in a relationship | |
561 | * | |
562 | * @param int $id relationship id | |
563 | * | |
564 | * $returns returns the contact ids in the realtionship | |
565 | * @access public | |
566 | * @static | |
567 | */ | |
568 | static function getContactIds($id) { | |
569 | $relationship = new CRM_Contact_DAO_Relationship(); | |
570 | ||
571 | $relationship->id = $id; | |
572 | $relationship->selectAdd(); | |
573 | $relationship->selectAdd('contact_id_a, contact_id_b'); | |
574 | $relationship->find(TRUE); | |
575 | ||
576 | return $relationship; | |
577 | } | |
578 | ||
579 | /** | |
580 | * Function to check if the relationship type selected between two contacts is correct | |
581 | * | |
582 | * @param int $contact_a 1st contact id | |
583 | * @param int $contact_b 2nd contact id | |
584 | * @param int $relationshipTypeId relationship type id | |
585 | * | |
586 | * @return boolean true if it is valid relationship else false | |
587 | * @access public | |
588 | * @static | |
589 | */ | |
590 | static function checkRelationshipType($contact_a, $contact_b, $relationshipTypeId) { | |
591 | $relationshipType = new CRM_Contact_DAO_RelationshipType(); | |
592 | $relationshipType->id = $relationshipTypeId; | |
593 | $relationshipType->selectAdd(); | |
594 | $relationshipType->selectAdd('contact_type_a, contact_type_b, contact_sub_type_a, contact_sub_type_b'); | |
595 | if ($relationshipType->find(TRUE)) { | |
596 | $contact_type_a = CRM_Contact_BAO_Contact::getContactType($contact_a); | |
597 | $contact_type_b = CRM_Contact_BAO_Contact::getContactType($contact_b); | |
598 | ||
599 | $contact_sub_type_a = CRM_Contact_BAO_Contact::getContactSubType($contact_a); | |
600 | $contact_sub_type_b = CRM_Contact_BAO_Contact::getContactSubType($contact_b); | |
601 | ||
602 | if (((!$relationshipType->contact_type_a) || ($relationshipType->contact_type_a == $contact_type_a)) && | |
603 | ((!$relationshipType->contact_type_b) || ($relationshipType->contact_type_b == $contact_type_b)) && | |
604 | ((!$relationshipType->contact_sub_type_a) || (in_array($relationshipType->contact_sub_type_a, | |
605 | $contact_sub_type_a | |
606 | ))) && | |
607 | ((!$relationshipType->contact_sub_type_b) || (in_array($relationshipType->contact_sub_type_b, | |
608 | $contact_sub_type_b | |
609 | ))) | |
610 | ) { | |
611 | return TRUE; | |
612 | } | |
613 | else { | |
614 | return FALSE; | |
615 | } | |
616 | } | |
617 | return FALSE; | |
618 | } | |
619 | ||
620 | /** | |
621 | * this function does the validtion for valid relationship | |
622 | * | |
623 | * @param array $params this array contains the values there are subitted by the form | |
624 | * @param array $ids the array that holds all the db ids | |
625 | * @param integer $contactId this is contact id for adding relationship | |
626 | * | |
627 | * @return | |
628 | * @access public | |
629 | * @static | |
630 | */ | |
631 | static function checkValidRelationship(&$params, &$ids, $contactId) { | |
632 | $errors = ''; | |
633 | ||
634 | // get the string of relationship type | |
635 | $relationshipTypes = CRM_Utils_Array::value('relationship_type_id', $params); | |
636 | list($type, $first, $second) = explode('_', $relationshipTypes); | |
637 | ${'contact_' . $first} = CRM_Utils_Array::value('contact', $ids); | |
638 | ${'contact_' . $second} = $contactId; | |
639 | // function to check if the relationship selected is correct | |
640 | // i.e. employer relationship can exit between Individual and Organization (not between Individual and Individual) | |
641 | if (!CRM_Contact_BAO_Relationship::checkRelationshipType($contact_a, $contact_b, $type)) { | |
642 | $errors = 'Please select valid relationship between these two contacts.'; | |
643 | } | |
644 | return $errors; | |
645 | } | |
646 | ||
647 | /** | |
648 | * this function checks for duplicate relationship | |
649 | * | |
650 | * @param array $params (reference ) an assoc array of name/value pairs | |
651 | * @param integer $id this the id of the contact whom we are adding relationship | |
652 | * @param integer $contactId this is contact id for adding relationship | |
653 | * @param integer $relationshipId this is relationship id for the contact | |
654 | * | |
655 | * @return boolean true if record exists else false | |
656 | * @access public | |
657 | * @static | |
658 | */ | |
659 | static function checkDuplicateRelationship(&$params, $id, $contactId = 0, $relationshipId = 0) { | |
660 | $relationshipTypeId = CRM_Utils_Array::value('relationship_type_id', $params); | |
661 | list($type, $first, $second) = explode('_', $relationshipTypeId); | |
662 | ||
f0fc26a5 DL |
663 | $queryString = " |
664 | SELECT id | |
665 | FROM civicrm_relationship | |
666 | WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); | |
6a488035 TO |
667 | |
668 | /* | |
f0fc26a5 DL |
669 | * CRM-11792 - date fields from API are in ISO format, but this function |
670 | * supports date arrays BAO has increasingly standardised to ISO format | |
671 | * so I believe this function should support ISO rather than make API | |
672 | * format it - however, need to support array format for now to avoid breakage | |
6a488035 TO |
673 | * @ time of writing this function is called from Relationship::create (twice) |
674 | * CRM_BAO_Contact_Utils::clearCurrentEmployer (seemingly without dates) | |
675 | * CRM_Contact_Form_Task_AddToOrganization::postProcess & | |
676 | * CRM_Contact_Form_Task_AddToHousehold::postProcess | |
677 | * (I don't think the last 2 support dates but not sure | |
678 | */ | |
679 | ||
680 | $dateFields = array('end_date', 'start_date'); | |
681 | foreach ($dateFields as $dateField){ | |
682 | if(array_key_exists($dateField, $params)) { | |
683 | if (empty($params[$dateField]) || $params[$dateField] == 'null'){ | |
f0fc26a5 DL |
684 | //this is most likely coming from an api call & probably loaded |
685 | // from the DB to deal with some of the | |
686 | // other myriad of excessive checks still in place both in | |
687 | // the api & the create functions | |
6a488035 TO |
688 | $queryString .= " AND $dateField IS NULL"; |
689 | continue; | |
690 | } | |
691 | elseif (is_array($params[$dateField])){ | |
f0fc26a5 DL |
692 | $queryString .= " AND $dateField = " . |
693 | CRM_Utils_Type::escape(CRM_Utils_Date::format($params[$dateField]), 'Date'); | |
6a488035 | 694 | } |
f0fc26a5 DL |
695 | else { |
696 | $queryString .= " AND $dateField = " . | |
697 | CRM_Utils_Type::escape($params[$dateField], 'Date'); | |
6a488035 TO |
698 | } |
699 | } | |
700 | } | |
701 | ||
702 | $queryString .= | |
703 | " AND ( ( contact_id_a = " . CRM_Utils_Type::escape($id, 'Integer') . | |
704 | " AND contact_id_b = " . CRM_Utils_Type::escape($contactId, 'Integer') . | |
705 | " ) OR ( contact_id_a = " . CRM_Utils_Type::escape($contactId, 'Integer') . | |
706 | " AND contact_id_b = " . CRM_Utils_Type::escape($id, 'Integer') . " ) ) "; | |
707 | ||
708 | //if caseId is provided, include it duplicate checking. | |
709 | if ($caseId = CRM_Utils_Array::value('case_id', $params)) { | |
710 | $queryString .= " AND case_id = " . CRM_Utils_Type::escape($caseId, 'Integer'); | |
711 | } | |
712 | ||
713 | if ($relationshipId) { | |
714 | $queryString .= " AND id !=" . CRM_Utils_Type::escape($relationshipId, 'Integer'); | |
715 | } | |
716 | ||
717 | $relationship = new CRM_Contact_BAO_Relationship(); | |
718 | $relationship->query($queryString); | |
719 | $relationship->fetch(); | |
720 | $relationship->free(); | |
721 | return ($relationship->id) ? TRUE : FALSE; | |
722 | } | |
723 | ||
724 | /** | |
725 | * update the is_active flag in the db | |
726 | * | |
727 | * @param int $id id of the database record | |
728 | * @param boolean $is_active value we want to set the is_active field | |
729 | * | |
730 | * @return Object DAO object on success, null otherwise | |
731 | * @static | |
732 | */ | |
733 | static function setIsActive($id, $is_active) { | |
49f8272d E |
734 | // as both the create & add functions have a bunch of logic in them that |
735 | // doesn't seem to cope with a normal update we will call the api which | |
736 | // has tested handling for this | |
737 | // however, a longer term solution would be to simplify the add, create & api functions | |
738 | // to be more standard. It is debatable @ that point whether it's better to call the BAO | |
739 | // direct as the api is more tested. | |
740 | civicrm_api3('relationship', 'create', array('id' => $id, 'is_active' => $is_active)); | |
741 | ||
742 | // call (undocumented possibly deprecated) hook | |
6a488035 TO |
743 | CRM_Utils_Hook::enableDisable('CRM_Contact_BAO_Relationship', $id, $is_active); |
744 | ||
745 | return TRUE; | |
746 | } | |
747 | ||
748 | /** | |
749 | * Given the list of params in the params array, fetch the object | |
750 | * and store the values in the values array | |
751 | * | |
752 | * @param array $params input parameters to find object | |
753 | * @param array $values output values of the object | |
754 | * @param array $ids the array that holds all the db ids | |
755 | * | |
756 | * @return array (reference) the values that could be potentially assigned to smarty | |
757 | * @access public | |
758 | * @static | |
759 | */ | |
760 | static function &getValues(&$params, &$values) { | |
761 | if (empty($params)) { | |
762 | return NULL; | |
763 | } | |
764 | $v = array(); | |
765 | ||
766 | // get the specific number of relationship or all relationships. | |
a7488080 | 767 | if (!empty($params['numRelationship'])) { |
6a488035 TO |
768 | $v['data'] = &CRM_Contact_BAO_Relationship::getRelationship($params['contact_id'], NULL, $params['numRelationship']); |
769 | } | |
770 | else { | |
771 | $v['data'] = CRM_Contact_BAO_Relationship::getRelationship($params['contact_id']); | |
772 | } | |
773 | ||
774 | // get the total count of relationships | |
775 | $v['totalCount'] = CRM_Contact_BAO_Relationship::getRelationship($params['contact_id'], NULL, NULL, TRUE); | |
776 | ||
777 | $values['relationship']['data'] = &$v['data']; | |
778 | $values['relationship']['totalCount'] = &$v['totalCount']; | |
779 | ||
780 | return $v; | |
781 | } | |
782 | ||
783 | /** | |
784 | * helper function to form the sql for relationship retrieval | |
785 | * | |
786 | * @param int $contactId contact id | |
787 | * @param int $status (check const at top of file) | |
788 | * @param int $numRelationship no of relationships to display (limit) | |
789 | * @param int $count get the no of relationships | |
790 | * $param int $relationshipId relationship id | |
791 | * @param string $direction the direction we are interested in a_b or b_a | |
75638074 | 792 | * @param array $params array of extra values including relationship_type_id per api spec |
6a488035 TO |
793 | * |
794 | * return string the query for this diretion | |
795 | * @static | |
796 | * @access public | |
797 | */ | |
75638074 | 798 | static function makeURLClause($contactId, $status, $numRelationship, $count, $relationshipId, $direction, $params = array()) { |
6a488035 TO |
799 | $select = $from = $where = ''; |
800 | ||
801 | $select = '( '; | |
802 | if ($count) { | |
803 | if ($direction == 'a_b') { | |
804 | $select .= ' SELECT count(DISTINCT civicrm_relationship.id) as cnt1, 0 as cnt2 '; | |
805 | } | |
806 | else { | |
807 | $select .= ' SELECT 0 as cnt1, count(DISTINCT civicrm_relationship.id) as cnt2 '; | |
808 | } | |
809 | } | |
810 | else { | |
811 | $select .= ' SELECT civicrm_relationship.id as civicrm_relationship_id, | |
812 | civicrm_contact.sort_name as sort_name, | |
813 | civicrm_contact.display_name as display_name, | |
814 | civicrm_contact.job_title as job_title, | |
815 | civicrm_contact.employer_id as employer_id, | |
816 | civicrm_contact.organization_name as organization_name, | |
817 | civicrm_address.street_address as street_address, | |
818 | civicrm_address.city as city, | |
819 | civicrm_address.postal_code as postal_code, | |
820 | civicrm_state_province.abbreviation as state, | |
821 | civicrm_country.name as country, | |
822 | civicrm_email.email as email, | |
823 | civicrm_phone.phone as phone, | |
824 | civicrm_contact.id as civicrm_contact_id, | |
825 | civicrm_contact.contact_type as contact_type, | |
826 | civicrm_relationship.contact_id_b as contact_id_b, | |
827 | civicrm_relationship.contact_id_a as contact_id_a, | |
828 | civicrm_relationship_type.id as civicrm_relationship_type_id, | |
829 | civicrm_relationship.start_date as start_date, | |
830 | civicrm_relationship.end_date as end_date, | |
831 | civicrm_relationship.description as description, | |
832 | civicrm_relationship.is_active as is_active, | |
833 | civicrm_relationship.is_permission_a_b as is_permission_a_b, | |
834 | civicrm_relationship.is_permission_b_a as is_permission_b_a, | |
835 | civicrm_relationship.case_id as case_id'; | |
836 | ||
837 | if ($direction == 'a_b') { | |
838 | $select .= ', civicrm_relationship_type.label_a_b as label_a_b, | |
839 | civicrm_relationship_type.label_b_a as relation '; | |
840 | } | |
841 | else { | |
842 | $select .= ', civicrm_relationship_type.label_a_b as label_a_b, | |
843 | civicrm_relationship_type.label_a_b as relation '; | |
844 | } | |
845 | } | |
846 | ||
847 | $from = " | |
848 | FROM civicrm_relationship | |
849 | INNER JOIN civicrm_relationship_type ON ( civicrm_relationship.relationship_type_id = civicrm_relationship_type.id ) | |
850 | INNER JOIN civicrm_contact "; | |
851 | if ($direction == 'a_b') { | |
852 | $from .= 'ON ( civicrm_contact.id = civicrm_relationship.contact_id_a ) '; | |
853 | } | |
854 | else { | |
855 | $from .= 'ON ( civicrm_contact.id = civicrm_relationship.contact_id_b ) '; | |
856 | } | |
857 | $from .= " | |
858 | LEFT JOIN civicrm_address ON (civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1) | |
859 | LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = civicrm_contact.id AND civicrm_phone.is_primary = 1) | |
860 | LEFT JOIN civicrm_email ON (civicrm_email.contact_id = civicrm_contact.id AND civicrm_email.is_primary = 1) | |
861 | LEFT JOIN civicrm_state_province ON (civicrm_address.state_province_id = civicrm_state_province.id) | |
862 | LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) | |
863 | "; | |
864 | $where = 'WHERE ( 1 )'; | |
865 | if ($contactId) { | |
866 | if ($direction == 'a_b') { | |
867 | $where .= ' AND civicrm_relationship.contact_id_b = ' . CRM_Utils_Type::escape($contactId, 'Positive'); | |
868 | } | |
869 | else { | |
075fa74e | 870 | $where .= ' AND civicrm_relationship.contact_id_a = ' . CRM_Utils_Type::escape($contactId, 'Positive') . ' |
871 | AND civicrm_relationship.contact_id_a != civicrm_relationship.contact_id_b '; | |
6a488035 TO |
872 | } |
873 | } | |
874 | if ($relationshipId) { | |
875 | $where .= ' AND civicrm_relationship.id = ' . CRM_Utils_Type::escape($relationshipId, 'Positive'); | |
876 | } | |
877 | ||
878 | $date = date('Y-m-d'); | |
879 | if ($status == self::PAST) { | |
880 | //this case for showing past relationship | |
881 | $where .= ' AND civicrm_relationship.is_active = 1 '; | |
882 | $where .= " AND civicrm_relationship.end_date < '" . $date . "'"; | |
883 | } | |
884 | elseif ($status == self::DISABLED) { | |
885 | // this case for showing disabled relationship | |
886 | $where .= ' AND civicrm_relationship.is_active = 0 '; | |
887 | } | |
888 | elseif ($status == self::CURRENT) { | |
889 | //this case for showing current relationship | |
890 | $where .= ' AND civicrm_relationship.is_active = 1 '; | |
891 | $where .= " AND (civicrm_relationship.end_date >= '" . $date . "' OR civicrm_relationship.end_date IS NULL) "; | |
892 | } | |
893 | elseif ($status == self::INACTIVE) { | |
894 | //this case for showing inactive relationships | |
895 | $where .= " AND (civicrm_relationship.end_date < '" . $date . "'"; | |
896 | $where .= ' OR civicrm_relationship.is_active = 0 )'; | |
897 | } | |
898 | ||
899 | // CRM-6181 | |
900 | $where .= ' AND civicrm_contact.is_deleted = 0'; | |
c9c41397 | 901 | if(!empty($params['membership_type_id']) && empty($params['relationship_type_id'])) { |
902 | $where .= self::membershipTypeToRelationshipTypes($params, $direction); | |
903 | } | |
75638074 | 904 | if(!empty($params['relationship_type_id'])) { |
905 | if(is_array($params['relationship_type_id'])) { | |
faf8c53b | 906 | $where .= " AND " . CRM_Core_DAO::createSQLFilter('relationship_type_id', $params['relationship_type_id'], 'Integer'); |
75638074 | 907 | } |
908 | else { | |
909 | $where .= ' AND relationship_type_id = ' . CRM_Utils_Type::escape($params['relationship_type_id'], 'Positive'); | |
910 | } | |
911 | } | |
6a488035 TO |
912 | if ($direction == 'a_b') { |
913 | $where .= ' ) UNION '; | |
914 | } | |
915 | else { | |
916 | $where .= ' ) '; | |
917 | } | |
918 | ||
919 | return array($select, $from, $where); | |
920 | } | |
921 | ||
922 | /** | |
923 | * This is the function to get the list of relationships | |
924 | * | |
925 | * @param int $contactId contact id | |
926 | * @param int $status 1: Past 2: Disabled 3: Current | |
927 | * @param int $numRelationship no of relationships to display (limit) | |
928 | * @param int $count get the no of relationships | |
929 | * $param int $relationshipId relationship id | |
930 | * $param array $links the list of links to display | |
931 | * $param int $permissionMask the permission mask to be applied for the actions | |
932 | * $param boolean $permissionedContact to return only permissioned Contact | |
75638074 | 933 | * $param array $params array of variables consistent with filters supported by the api |
6a488035 TO |
934 | * return array $values relationship records |
935 | * @static | |
936 | * @access public | |
937 | */ | |
938 | static function getRelationship($contactId = NULL, | |
939 | $status = 0, $numRelationship = 0, | |
940 | $count = 0, $relationshipId = 0, | |
941 | $links = NULL, $permissionMask = NULL, | |
75638074 | 942 | $permissionedContact = FALSE, |
943 | $params = array() | |
6a488035 TO |
944 | ) { |
945 | $values = array(); | |
946 | if (!$contactId && !$relationshipId) { | |
947 | return $values; | |
948 | } | |
949 | ||
950 | list($select1, $from1, $where1) = self::makeURLClause($contactId, $status, $numRelationship, | |
75638074 | 951 | $count, $relationshipId, 'a_b', $params |
6a488035 TO |
952 | ); |
953 | list($select2, $from2, $where2) = self::makeURLClause($contactId, $status, $numRelationship, | |
75638074 | 954 | $count, $relationshipId, 'b_a', $params |
6a488035 TO |
955 | ); |
956 | ||
957 | $order = $limit = ''; | |
958 | if (!$count) { | |
40458f6c | 959 | if (empty($params['sort'])) { |
960 | $order = ' ORDER BY civicrm_relationship_type_id, sort_name '; | |
961 | } | |
962 | else { | |
963 | $order = " ORDER BY {$params['sort']} "; | |
964 | } | |
965 | ||
966 | $offset = 0; | |
630d1aaa | 967 | if (!empty($params['offset']) && $params['offset'] > 0) { |
40458f6c | 968 | $offset = $params['offset']; |
969 | } | |
6a488035 TO |
970 | |
971 | if ($numRelationship) { | |
40458f6c | 972 | $limit = " LIMIT {$offset}, $numRelationship"; |
6a488035 TO |
973 | } |
974 | } | |
975 | ||
976 | // building the query string | |
6a488035 TO |
977 | $queryString = $select1 . $from1 . $where1 . $select2 . $from2 . $where2 . $order . $limit; |
978 | ||
979 | $relationship = new CRM_Contact_DAO_Relationship(); | |
980 | ||
981 | $relationship->query($queryString); | |
982 | $row = array(); | |
983 | if ($count) { | |
984 | $relationshipCount = 0; | |
985 | while ($relationship->fetch()) { | |
986 | $relationshipCount += $relationship->cnt1 + $relationship->cnt2; | |
987 | } | |
988 | return $relationshipCount; | |
989 | } | |
990 | else { | |
991 | ||
992 | $mask = NULL; | |
993 | if ($status != self::INACTIVE) { | |
994 | if ($links) { | |
995 | $mask = array_sum(array_keys($links)); | |
996 | if ($mask & CRM_Core_Action::DISABLE) { | |
997 | $mask -= CRM_Core_Action::DISABLE; | |
998 | } | |
999 | if ($mask & CRM_Core_Action::ENABLE) { | |
1000 | $mask -= CRM_Core_Action::ENABLE; | |
1001 | } | |
1002 | ||
1003 | if ($status == self::CURRENT) { | |
1004 | $mask |= CRM_Core_Action::DISABLE; | |
1005 | } | |
1006 | elseif ($status == self::DISABLED) { | |
1007 | $mask |= CRM_Core_Action::ENABLE; | |
1008 | } | |
1009 | $mask = $mask & $permissionMask; | |
1010 | } | |
1011 | } | |
1012 | while ($relationship->fetch()) { | |
1013 | $rid = $relationship->civicrm_relationship_id; | |
1014 | $cid = $relationship->civicrm_contact_id; | |
1015 | if (($permissionedContact) && | |
1016 | (!CRM_Contact_BAO_Contact_Permission::relationship($cid, $contactId)) | |
1017 | ) { | |
1018 | continue; | |
1019 | } | |
1020 | $values[$rid]['id'] = $rid; | |
1021 | $values[$rid]['cid'] = $cid; | |
1022 | $values[$rid]['contact_id_a'] = $relationship->contact_id_a; | |
1023 | $values[$rid]['contact_id_b'] = $relationship->contact_id_b; | |
1024 | $values[$rid]['relationship_type_id'] = $relationship->civicrm_relationship_type_id; | |
1025 | $values[$rid]['relation'] = $relationship->relation; | |
1026 | $values[$rid]['name'] = $relationship->sort_name; | |
1027 | $values[$rid]['display_name'] = $relationship->display_name; | |
1028 | $values[$rid]['job_title'] = $relationship->job_title; | |
1029 | $values[$rid]['email'] = $relationship->email; | |
1030 | $values[$rid]['phone'] = $relationship->phone; | |
1031 | $values[$rid]['employer_id'] = $relationship->employer_id; | |
1032 | $values[$rid]['organization_name'] = $relationship->organization_name; | |
1033 | $values[$rid]['country'] = $relationship->country; | |
1034 | $values[$rid]['city'] = $relationship->city; | |
1035 | $values[$rid]['state'] = $relationship->state; | |
1036 | $values[$rid]['start_date'] = $relationship->start_date; | |
1037 | $values[$rid]['end_date'] = $relationship->end_date; | |
1038 | $values[$rid]['description'] = $relationship->description; | |
1039 | $values[$rid]['is_active'] = $relationship->is_active; | |
1040 | $values[$rid]['is_permission_a_b'] = $relationship->is_permission_a_b; | |
1041 | $values[$rid]['is_permission_b_a'] = $relationship->is_permission_b_a; | |
1042 | $values[$rid]['case_id'] = $relationship->case_id; | |
1043 | ||
1044 | if ($status) { | |
1045 | $values[$rid]['status'] = $status; | |
1046 | } | |
1047 | ||
1048 | $values[$rid]['civicrm_relationship_type_id'] = $relationship->civicrm_relationship_type_id; | |
1049 | ||
1050 | if ($relationship->contact_id_a == $contactId) { | |
1051 | $values[$rid]['rtype'] = 'a_b'; | |
1052 | } | |
1053 | else { | |
1054 | $values[$rid]['rtype'] = 'b_a'; | |
1055 | } | |
1056 | ||
1057 | if ($links) { | |
1058 | $replace = array( | |
1059 | 'id' => $rid, | |
1060 | 'rtype' => $values[$rid]['rtype'], | |
1061 | 'cid' => $contactId, | |
1062 | 'cbid' => $values[$rid]['cid'], | |
1063 | 'caseid' => $values[$rid]['case_id'], | |
1064 | 'clientid' => $contactId, | |
1065 | ); | |
1066 | ||
1067 | if ($status == self::INACTIVE) { | |
1068 | // setting links for inactive relationships | |
1069 | $mask = array_sum(array_keys($links)); | |
1070 | if (!$values[$rid]['is_active']) { | |
1071 | $mask -= CRM_Core_Action::DISABLE; | |
1072 | } | |
1073 | else { | |
1074 | $mask -= CRM_Core_Action::ENABLE; | |
1075 | $mask -= CRM_Core_Action::DISABLE; | |
1076 | } | |
1077 | } | |
1078 | ||
1079 | // Give access to manage case link by copying to MAX_ACTION index temporarily, depending on case permission of user. | |
1080 | if ($values[$rid]['case_id']) { | |
1081 | // Borrowed logic from CRM_Case_Page_Tab | |
1082 | $hasCaseAccess = FALSE; | |
1083 | if (CRM_Core_Permission::check('access all cases and activities')) { | |
1084 | $hasCaseAccess = TRUE; | |
1085 | } | |
1086 | else { | |
1087 | $userCases = CRM_Case_BAO_Case::getCases(FALSE); | |
1088 | if (array_key_exists($values[$rid]['case_id'], $userCases)) { | |
1089 | $hasCaseAccess = TRUE; | |
1090 | } | |
1091 | } | |
1092 | ||
1093 | if ($hasCaseAccess) { | |
1094 | // give access by copying to MAX_ACTION temporarily, otherwise leave at NONE which won't display | |
1095 | $links[CRM_Core_Action::MAX_ACTION] = $links[CRM_Core_Action::NONE]; | |
1096 | $links[CRM_Core_Action::MAX_ACTION]['name'] = ts('Manage Case #%1', array(1 => $values[$rid]['case_id'])); | |
f89f2102 | 1097 | $links[CRM_Core_Action::MAX_ACTION]['class'] = 'no-popup'; |
6a488035 TO |
1098 | |
1099 | // Also make sure we have the right client cid since can get here from multiple relationship tabs. | |
1100 | if ($values[$rid]['rtype'] == 'b_a') { | |
1101 | $replace['clientid'] = $values[$rid]['cid']; | |
1102 | } | |
1103 | } | |
1104 | } | |
1105 | ||
87dab4a4 AH |
1106 | $values[$rid]['action'] = CRM_Core_Action::formLink( |
1107 | $links, | |
1108 | $mask, | |
1109 | $replace, | |
1110 | ts('more'), | |
1111 | FALSE, | |
1112 | 'relationship.selector.row', | |
1113 | 'Relationship', | |
1114 | $rid); | |
6a488035 TO |
1115 | unset($links[CRM_Core_Action::MAX_ACTION]); |
1116 | } | |
1117 | } | |
1118 | ||
1119 | $relationship->free(); | |
1120 | return $values; | |
1121 | } | |
1122 | } | |
1123 | ||
1124 | /** | |
1125 | * Function to get get list of relationship type based on the target contact type. | |
1126 | * | |
1127 | * @param string $targetContactType it's valid contact tpye(may be Individual , Organization , Household) | |
1128 | * | |
1129 | * @return array - array reference of all relationship types with context to current contact type . | |
1130 | * | |
1131 | */ | |
1132 | function getRelationType($targetContactType) { | |
1133 | $relationshipType = array(); | |
1134 | $allRelationshipType = CRM_Core_PseudoConstant::relationshipType(); | |
1135 | ||
1136 | foreach ($allRelationshipType as $key => $type) { | |
1137 | if ($type['contact_type_b'] == $targetContactType) { | |
1138 | $relationshipType[$key . '_a_b'] = $type['label_a_b']; | |
1139 | } | |
1140 | } | |
1141 | ||
1142 | return $relationshipType; | |
1143 | } | |
1144 | ||
1145 | /** | |
1146 | * Function to create / update / delete membership for related contacts. | |
1147 | * | |
1148 | * This function will create/update/delete membership for related | |
1149 | * contact based on 1) contact have active membership 2) that | |
1150 | * membership is is extedned by the same relationship type to that | |
1151 | * of the existing relationship. | |
1152 | * | |
1153 | * @param $contactId Int contact id | |
1154 | * @param $params array array of values submitted by POST | |
1155 | * @param $ids array array of ids | |
1156 | * @param $action which action called this function | |
1157 | * | |
1158 | * @static | |
1159 | * | |
1160 | */ | |
1161 | static function relatedMemberships($contactId, &$params, $ids, $action = CRM_Core_Action::ADD, $active = TRUE) { | |
1162 | // Check the end date and set the status of the relationship | |
1163 | // accrodingly. | |
1164 | $status = self::CURRENT; | |
1165 | ||
1166 | if (!empty($params['end_date'])) { | |
1167 | $endDate = CRM_Utils_Date::setDateDefaults(CRM_Utils_Date::format($params['end_date']), NULL, 'Ymd'); | |
1168 | $today = date('Ymd'); | |
1169 | ||
1170 | if ($today > $endDate) { | |
1171 | $status = self::PAST; | |
1172 | } | |
1173 | } | |
1174 | ||
1175 | if (($action & CRM_Core_Action::ADD) && | |
1176 | ($status & self::PAST) | |
1177 | ) { | |
1178 | // if relationship is PAST and action is ADD, no qustion | |
1179 | // of creating RELATED membership and return back to | |
1180 | // calling method | |
1181 | return; | |
1182 | } | |
1183 | ||
1184 | $rel = explode('_', $params['relationship_type_id']); | |
1185 | ||
1186 | $relTypeId = $rel[0]; | |
1187 | $relDirection = "_{$rel[1]}_{$rel[2]}"; | |
1188 | $targetContact = array(); | |
1189 | if (($action & CRM_Core_Action::ADD) || | |
1190 | ($action & CRM_Core_Action::DELETE) | |
1191 | ) { | |
1192 | $contact = $contactId; | |
1193 | $targetContact = CRM_Utils_Array::value('contact_check', $params); | |
1194 | } | |
1195 | elseif ($action & CRM_Core_Action::UPDATE) { | |
1196 | $contact = $ids['contact']; | |
1197 | $targetContact = array($ids['contactTarget'] => 1); | |
1198 | } | |
1199 | ||
1200 | // Build the 'values' array for | |
1201 | // 1. ContactA | |
1202 | // 2. ContactB | |
1203 | // This will allow us to check if either of the contacts in | |
1204 | // relationship have active memberships. | |
1205 | ||
1206 | $values = array(); | |
1207 | ||
1208 | // 1. ContactA | |
1209 | $values[$contact] = array( | |
1210 | 'relatedContacts' => $targetContact, | |
1211 | 'relationshipTypeId' => $relTypeId, | |
1212 | 'relationshipTypeDirection' => $relDirection, | |
1213 | ); | |
1214 | // 2. ContactB | |
1215 | if (!empty($targetContact)) { | |
1216 | foreach ($targetContact as $cid => $donCare) { | |
1217 | $values[$cid] = array( | |
1218 | 'relatedContacts' => array($contact => 1), | |
1219 | 'relationshipTypeId' => $relTypeId, | |
1220 | ); | |
1221 | ||
1222 | $relTypeParams = array('id' => $relTypeId); | |
1223 | $relTypeValues = array(); | |
1224 | CRM_Contact_BAO_RelationshipType::retrieve($relTypeParams, $relTypeValues); | |
1225 | ||
1226 | if (CRM_Utils_Array::value('name_a_b', $relTypeValues) == CRM_Utils_Array::value('name_b_a', $relTypeValues)) { | |
1227 | $values[$cid]['relationshipTypeDirection'] = '_a_b'; | |
1228 | } | |
1229 | else { | |
1230 | $values[$cid]['relationshipTypeDirection'] = ($relDirection == '_a_b') ? '_b_a' : '_a_b'; | |
1231 | } | |
1232 | } | |
1233 | } | |
1234 | ||
1235 | // Now get the active memberships for all the contacts. | |
1236 | // If contact have any valid membership(s), then add it to | |
1237 | // 'values' array. | |
1238 | foreach ($values as $cid => $subValues) { | |
1239 | $memParams = array('contact_id' => $cid); | |
1240 | $memberships = array(); | |
1241 | ||
1242 | CRM_Member_BAO_Membership::getValues($memParams, $memberships, $active); | |
1243 | ||
1244 | if (empty($memberships)) { | |
1245 | continue; | |
1246 | } | |
1247 | ||
1248 | $values[$cid]['memberships'] = $memberships; | |
1249 | } | |
1250 | $deceasedStatusId = array_search('Deceased', CRM_Member_PseudoConstant::membershipStatus()); | |
1251 | ||
1252 | // done with 'values' array. | |
1253 | // Finally add / edit / delete memberships for the related contacts | |
1254 | foreach ($values as $cid => $details) { | |
1255 | if (!array_key_exists('memberships', $details)) { | |
1256 | continue; | |
1257 | } | |
1258 | ||
1259 | $mainRelatedContactId = key(CRM_Utils_Array::value('relatedContacts', $details, array())); | |
1260 | ||
1261 | foreach ($details['memberships'] as $membershipId => $membershipValues) { | |
1262 | $relTypeIds = array(); | |
1263 | if ($action & CRM_Core_Action::DELETE) { | |
1264 | // Delete memberships of the related contacts only if relationship type exists for membership type | |
1265 | $query = " | |
1266 | SELECT relationship_type_id, relationship_direction | |
1267 | FROM civicrm_membership_type | |
1268 | WHERE id = {$membershipValues['membership_type_id']}"; | |
1269 | $dao = CRM_Core_DAO::executeQuery($query); | |
1270 | $relTypeDirs = array(); | |
1271 | while ($dao->fetch()) { | |
1272 | $relTypeId = $dao->relationship_type_id; | |
1273 | $relDirection = $dao->relationship_direction; | |
1274 | } | |
1275 | $relTypeIds = explode(CRM_Core_DAO::VALUE_SEPARATOR, $relTypeId); | |
1276 | if (in_array($values[$cid]['relationshipTypeId'], $relTypeIds)) { | |
1277 | CRM_Member_BAO_Membership::deleteRelatedMemberships($membershipId, $mainRelatedContactId); | |
1278 | } | |
1279 | continue; | |
1280 | } | |
1281 | if (($action & CRM_Core_Action::UPDATE) && | |
1282 | ($status & self::PAST) && | |
1283 | ($membershipValues['owner_membership_id']) | |
1284 | ) { | |
1285 | // If relationship is PAST and action is UPDATE | |
1286 | // then delete the RELATED membership | |
1287 | CRM_Member_BAO_Membership::deleteRelatedMemberships($membershipValues['owner_membership_id'], | |
1288 | $membershipValues['membership_contact_id'] | |
1289 | ); | |
1290 | continue; | |
1291 | } | |
1292 | ||
1293 | // add / edit the memberships for related | |
1294 | // contacts. | |
1295 | ||
1296 | // Get the Membership Type Details. | |
1297 | $membershipType = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($membershipValues['membership_type_id']); | |
1298 | // Check if contact's relationship type exists in membership type | |
1299 | $relTypeDirs = array(); | |
a7488080 | 1300 | if (!empty($membershipType['relationship_type_id'])) { |
6a488035 TO |
1301 | $relTypeIds = explode(CRM_Core_DAO::VALUE_SEPARATOR, $membershipType['relationship_type_id']); |
1302 | } | |
a7488080 | 1303 | if (!empty($membershipType['relationship_direction'])) { |
6a488035 TO |
1304 | $relDirections = explode(CRM_Core_DAO::VALUE_SEPARATOR, $membershipType['relationship_direction']); |
1305 | } | |
1306 | foreach ($relTypeIds as $key => $value) { | |
1307 | $relTypeDirs[] = $value . '_' . $relDirections[$key]; | |
1308 | } | |
1309 | $relTypeDir = $details['relationshipTypeId'] . $details['relationshipTypeDirection']; | |
1310 | if (in_array($relTypeDir, $relTypeDirs)) { | |
1311 | // Check if relationship being created/updated is | |
1312 | // similar to that of membership type's | |
1313 | // relationship. | |
1314 | ||
1315 | $membershipValues['owner_membership_id'] = $membershipId; | |
1316 | unset($membershipValues['id']); | |
1317 | unset($membershipValues['membership_contact_id']); | |
1318 | unset($membershipValues['contact_id']); | |
1319 | unset($membershipValues['membership_id']); | |
1320 | foreach ($details['relatedContacts'] as $relatedContactId => $donCare) { | |
1321 | $membershipValues['contact_id'] = $relatedContactId; | |
1322 | if ($deceasedStatusId && | |
1323 | CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $relatedContactId, 'is_deceased') | |
1324 | ) { | |
1325 | $membershipValues['status_id'] = $deceasedStatusId; | |
1326 | $membershipValues['skipStatusCal'] = TRUE; | |
1327 | } | |
1328 | foreach (array( | |
1329 | 'join_date', 'start_date', 'end_date') as $dateField) { | |
a7488080 | 1330 | if (!empty($membershipValues[$dateField])) { |
6a488035 TO |
1331 | $membershipValues[$dateField] = CRM_Utils_Date::processDate($membershipValues[$dateField]); |
1332 | } | |
1333 | } | |
1334 | ||
1335 | if ($action & CRM_Core_Action::UPDATE) { | |
1336 | //delete the membership record for related | |
1337 | //contact before creating new membership record. | |
1338 | CRM_Member_BAO_Membership::deleteRelatedMemberships($membershipId, $relatedContactId); | |
1339 | } | |
1340 | ||
1341 | // check whether we have some related memberships still available | |
1342 | $query = " | |
1343 | SELECT count(*) | |
1344 | FROM civicrm_membership | |
1345 | LEFT JOIN civicrm_membership_status ON (civicrm_membership_status.id = civicrm_membership.status_id) | |
1346 | WHERE membership_type_id = {$membershipValues['membership_type_id']} AND owner_membership_id = {$membershipValues['owner_membership_id']} | |
1347 | AND is_current_member = 1"; | |
1348 | $result = CRM_Core_DAO::singleValueQuery($query); | |
1349 | if ($result < CRM_Utils_Array::value('max_related', $membershipValues, PHP_INT_MAX)) { | |
43291913 | 1350 | CRM_Member_BAO_Membership::create($membershipValues, CRM_Core_DAO::$_nullArray); |
6a488035 TO |
1351 | } |
1352 | } | |
1353 | } | |
1354 | elseif ($action & CRM_Core_Action::UPDATE) { | |
1355 | // if action is update and updated relationship do | |
1356 | // not match with the existing | |
1357 | // membership=>relationship then we need to | |
1358 | // delete the membership record created for | |
1359 | // previous relationship. | |
1360 | ||
1361 | if (self::isDeleteRelatedMembership($relTypeIds, $contactId, $mainRelatedContactId, $relTypeId, CRM_Utils_Array::value('relationship_ids', $params))) { | |
1362 | CRM_Member_BAO_Membership::deleteRelatedMemberships($membershipId, $mainRelatedContactId); | |
1363 | } | |
1364 | } | |
1365 | } | |
1366 | } | |
1367 | } | |
1368 | ||
1369 | /** | |
1370 | * Helper function to check whether to delete the membership or | |
1371 | * not. | |
1372 | * | |
e9dfde0c DG |
1373 | * @static |
1374 | * | |
6a488035 | 1375 | */ |
e9dfde0c | 1376 | static function isDeleteRelatedMembership($relTypeIds, $contactId, $mainRelatedContactId, $relTypeId, $relIds) { |
6a488035 TO |
1377 | if (in_array($relTypeId, $relTypeIds)) { |
1378 | return TRUE; | |
1379 | } | |
1380 | ||
1381 | if (empty($relIds)) { | |
1382 | return FALSE; | |
1383 | } | |
1384 | ||
1385 | $relParamas = array(1 => array($contactId, 'Integer'), | |
1386 | 2 => array($mainRelatedContactId, 'Integer'), | |
1387 | ); | |
1388 | ||
1389 | if ($contactId == $mainRelatedContactId) { | |
1390 | $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); | |
1391 | if ($recordsFound) { | |
1392 | return FALSE; | |
1393 | } | |
1394 | return TRUE; | |
1395 | } | |
1396 | ||
1397 | $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); | |
1398 | ||
1399 | if ($recordsFound) { | |
1400 | return FALSE; | |
1401 | } | |
1402 | ||
1403 | return TRUE; | |
1404 | } | |
1405 | ||
1406 | /** | |
1407 | * Function to get Current Employer for Contact | |
1408 | * | |
1409 | * @param $contactIds Contact Ids | |
1410 | * | |
1411 | * @return $currentEmployer array of the current employer | |
1412 | * | |
1413 | * @static | |
1414 | * | |
1415 | */ | |
1416 | static function getCurrentEmployer($contactIds) { | |
1417 | $contacts = implode(',', $contactIds); | |
1418 | ||
1419 | $query = " | |
1420 | SELECT organization_name, id, employer_id | |
1421 | FROM civicrm_contact | |
1422 | WHERE id IN ( {$contacts} ) | |
1423 | "; | |
1424 | ||
1425 | $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray); | |
1426 | $currentEmployer = array(); | |
1427 | while ($dao->fetch()) { | |
1428 | $currentEmployer[$dao->id]['org_id'] = $dao->employer_id; | |
1429 | $currentEmployer[$dao->id]['org_name'] = $dao->organization_name; | |
1430 | } | |
1431 | ||
1432 | return $currentEmployer; | |
1433 | } | |
1434 | ||
1435 | /** | |
1436 | * Function to return list of permissioned employer for a given contact. | |
1437 | * | |
1438 | * @param $contactID int contact id whose employers | |
1439 | * are to be found. | |
1440 | * @param $name string employers sort name | |
1441 | * | |
1442 | * @static | |
1443 | * | |
1444 | * @return array array of employers. | |
1445 | * | |
1446 | */ | |
51e89def | 1447 | static function getPermissionedEmployer($contactID, $name = NULL) { |
6a488035 TO |
1448 | //get the relationship id |
1449 | $relTypeId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_RelationshipType', | |
1450 | 'Employee of', 'id', 'name_a_b' | |
1451 | ); | |
1452 | ||
51e89def DS |
1453 | return self::getPermissionedContacts($contactID, $relTypeId, $name); |
1454 | } | |
1455 | ||
1456 | ||
1457 | /** | |
1458 | * Function to return list of permissioned contacts for a given contact and relationship type | |
1459 | * | |
1460 | * @param $contactID int contact id whose permissioned contacts are to be found. | |
f9f0eff9 | 1461 | * @param $relTypeId string one or more relationship type id's |
51e89def DS |
1462 | * @param $name string |
1463 | * | |
1464 | * @static | |
1465 | * | |
1466 | * @return array of contacts | |
1467 | */ | |
1468 | static function getPermissionedContacts($contactID, $relTypeId, $name = NULL) { | |
1469 | $contacts = array(); | |
1470 | ||
6a488035 TO |
1471 | if ($relTypeId) { |
1472 | $query = " | |
1473 | SELECT cc.id as id, cc.sort_name as name | |
1474 | FROM civicrm_relationship cr, civicrm_contact cc | |
49f8272d | 1475 | WHERE |
51e89def | 1476 | cr.contact_id_a = %1 AND |
f9f0eff9 | 1477 | cr.relationship_type_id IN (%2) AND |
51e89def | 1478 | cr.is_permission_a_b = 1 AND |
6a488035 TO |
1479 | IF(cr.end_date IS NULL, 1, (DATEDIFF( CURDATE( ), cr.end_date ) <= 0)) AND |
1480 | cr.is_active = 1 AND | |
51e89def DS |
1481 | cc.id = cr.contact_id_b"; |
1482 | ||
1483 | if (!empty($name)) { | |
1484 | $name = CRM_Utils_Type::escape($name, 'String'); | |
1485 | $query .= " | |
49f8272d | 1486 | AND cc.sort_name LIKE '%$name%'"; |
51e89def | 1487 | } |
6a488035 | 1488 | |
f9f0eff9 | 1489 | $args = array(1 => array($contactID, 'Integer'), 2 => array($relTypeId, 'String')); |
51e89def | 1490 | $dao = CRM_Core_DAO::executeQuery($query, $args); |
6a488035 TO |
1491 | |
1492 | while ($dao->fetch()) { | |
51e89def | 1493 | $contacts[$dao->id] = array( |
6a488035 TO |
1494 | 'name' => $dao->name, |
1495 | 'value' => $dao->id, | |
1496 | ); | |
1497 | } | |
1498 | } | |
51e89def | 1499 | return $contacts; |
6a488035 TO |
1500 | } |
1501 | ||
6a488035 TO |
1502 | /** |
1503 | * Merge relationships from otherContact to mainContact | |
1504 | * Called during contact merge operation | |
1505 | * | |
1506 | * @param int $mainId contact id of main contact record. | |
1507 | * @param int $otherId contact id of record which is going to merge. | |
1508 | * @param array $sqls (reference) array of sql statements to append to. | |
1509 | * | |
1510 | * @see CRM_Dedupe_Merger::cpTables() | |
1511 | * | |
1512 | * @static | |
1513 | */ | |
1514 | static function mergeRelationships($mainId, $otherId, &$sqls) { | |
1515 | // Delete circular relationships | |
1516 | $sqls[] = "DELETE FROM civicrm_relationship | |
1517 | WHERE (contact_id_a = $mainId AND contact_id_b = $otherId) | |
1518 | OR (contact_id_b = $mainId AND contact_id_a = $otherId)"; | |
1519 | ||
1520 | // Delete relationship from other contact if main contact already has that relationship | |
1521 | $sqls[] = "DELETE r2 | |
1522 | FROM civicrm_relationship r1, civicrm_relationship r2 | |
1523 | WHERE r1.relationship_type_id = r2.relationship_type_id | |
1524 | AND r1.id <> r2.id | |
1525 | AND ( | |
1526 | r1.contact_id_a = $mainId AND r2.contact_id_a = $otherId AND r1.contact_id_b = r2.contact_id_b | |
1527 | OR r1.contact_id_b = $mainId AND r2.contact_id_b = $otherId AND r1.contact_id_a = r2.contact_id_a | |
1528 | OR ( | |
1529 | (r1.contact_id_a = $mainId AND r2.contact_id_b = $otherId AND r1.contact_id_b = r2.contact_id_a | |
1530 | OR r1.contact_id_b = $mainId AND r2.contact_id_a = $otherId AND r1.contact_id_a = r2.contact_id_b) | |
1531 | AND r1.relationship_type_id IN (SELECT id FROM civicrm_relationship_type WHERE name_b_a = name_a_b) | |
1532 | ) | |
1533 | )"; | |
1534 | ||
1535 | // Move relationships | |
1536 | $sqls[] = "UPDATE IGNORE civicrm_relationship SET contact_id_a = $mainId WHERE contact_id_a = $otherId"; | |
1537 | $sqls[] = "UPDATE IGNORE civicrm_relationship SET contact_id_b = $mainId WHERE contact_id_b = $otherId"; | |
1538 | ||
1539 | // Move current employer id (name will get updated later) | |
1540 | $sqls[] = "UPDATE civicrm_contact SET employer_id = $mainId WHERE employer_id = $otherId"; | |
1541 | } | |
1542 | ||
1543 | /** | |
1544 | * Set 'is_valid' field to false for all relationships whose end date is in the past, ie. are expired. | |
1545 | * | |
1546 | * @return True on success, false if error is encountered. | |
1547 | */ | |
1548 | static function disableExpiredRelationships() { | |
1549 | $query = "SELECT id FROM civicrm_relationship WHERE is_active = 1 AND end_date < CURDATE()"; | |
1550 | ||
1551 | $dao = CRM_Core_DAO::executeQuery($query); | |
1552 | while ($dao->fetch()) { | |
1553 | $result = CRM_Contact_BAO_Relationship::setIsActive($dao->id, FALSE); | |
1554 | // Result will be NULL if error occurred. We abort early if error detected. | |
1555 | if ($result == NULL) { | |
1556 | return FALSE; | |
1557 | } | |
1558 | } | |
1559 | return TRUE; | |
1560 | } | |
c9c41397 | 1561 | |
1562 | /** | |
1563 | * Function filters the query by possible relationships for the membership type | |
1564 | * It is intended to be called when constructing queries for the api (reciprocal & non-reciprocal) | |
1565 | * and to add clauses to limit the return to those relationships which COULD inherit a membership type | |
1566 | * (as opposed to those who inherit a particular membership | |
1567 | * | |
1568 | * @param array $params api input array | |
1569 | */ | |
1570 | static function membershipTypeToRelationshipTypes(&$params, $direction = NULL) { | |
1571 | $membershipType = civicrm_api3('membership_type', 'getsingle', array('id' => $params['membership_type_id'], 'return' => 'relationship_type_id, relationship_direction')); | |
1572 | $relationshipTypes = $membershipType['relationship_type_id']; | |
f201289d | 1573 | if(empty($relationshipTypes)) { |
1574 | return; | |
1575 | } | |
c9c41397 | 1576 | // if we don't have any contact data we can only filter on type |
1577 | if(empty($params['contact_id']) && empty($params['contact_id_a']) && empty($params['contact_id_a'])) { | |
1578 | $params['relationship_type_id'] = array('IN' => $relationshipTypes); | |
1579 | return; | |
1580 | } | |
1581 | else { | |
1a9b2ee8 | 1582 | $relationshipDirections = (array) $membershipType['relationship_direction']; |
c9c41397 | 1583 | // if we have contact_id_a OR contact_id_b we can make a call here |
1584 | // if we have contact?? | |
1585 | foreach ($relationshipDirections as $index => $mtdirection) { | |
1586 | if(isset($params['contact_id_a']) && $mtdirection == 'a_b' || $direction == 'a_b') { | |
1587 | $types[] = $relationshipTypes[$index]; | |
1588 | } | |
1589 | if(isset($params['contact_id_b']) && $mtdirection == 'b_a' || $direction == 'b_a') { | |
1590 | $types[] = $relationshipTypes[$index]; | |
1591 | } | |
1592 | } | |
1593 | if(!empty($types)) { | |
1594 | $params['relationship_type_id'] = array('IN' => $types); | |
1595 | } | |
1596 | elseif(!empty($clauses)) { | |
1597 | return explode(' OR ', $clauses); | |
1598 | } | |
1599 | else{ | |
1600 | // effectively setting it to return no results | |
1601 | $params['relationship_type_id'] = 0; | |
1602 | } | |
1603 | } | |
1604 | } | |
40458f6c | 1605 | |
1606 | ||
1607 | /** | |
1608 | * This function is a wrapper for contact relationship selector | |
1609 | * | |
1610 | * @param array $params associated array for params record id. | |
1611 | * | |
1612 | * @return array $contactRelationships associated array of contact relationships | |
1613 | * @access public | |
1614 | */ | |
1615 | public static function getContactRelationshipSelector(&$params) { | |
1616 | // format the params | |
1617 | $params['offset'] = ($params['page'] - 1) * $params['rp']; | |
1618 | $params['sort'] = CRM_Utils_Array::value('sortBy', $params); | |
1619 | ||
1620 | if ($params['context'] == 'past') { | |
1621 | $relationshipStatus = CRM_Contact_BAO_Relationship::INACTIVE; | |
1622 | } | |
1623 | else { | |
1624 | $relationshipStatus = CRM_Contact_BAO_Relationship::CURRENT; | |
1625 | } | |
1626 | ||
1627 | // check logged in user for permission | |
1628 | $page = new CRM_Core_Page(); | |
1629 | CRM_Contact_Page_View::checkUserPermission($page, $params['contact_id']); | |
1630 | $permissions = array($page->_permission); | |
1631 | if ($page->_permission == CRM_Core_Permission::EDIT) { | |
1632 | $permissions[] = CRM_Core_Permission::DELETE; | |
1633 | } | |
1634 | $mask = CRM_Core_Action::mask($permissions); | |
1635 | ||
d0592c3d | 1636 | if ($params['context'] != 'user') { |
1637 | $links = CRM_Contact_Page_View_Relationship::links(); | |
1638 | $permissionedContacts = FALSE; | |
1639 | } | |
1640 | else { | |
1641 | $links = CRM_Contact_Page_View_UserDashBoard::links(); | |
1642 | $permissionedContacts = TRUE; | |
1643 | $mask = NULL; | |
1644 | } | |
40458f6c | 1645 | // get contact relationships |
1646 | $relationships = CRM_Contact_BAO_Relationship::getRelationship($params['contact_id'], | |
1647 | $relationshipStatus, | |
1648 | $params['rp'], 0, 0, | |
d0592c3d | 1649 | $links, $mask, |
1650 | $permissionedContacts, | |
40458f6c | 1651 | $params |
1652 | ); | |
1653 | ||
1654 | $contactRelationships = array(); | |
d0592c3d | 1655 | $params['total'] = 0; |
40458f6c | 1656 | if (!empty($relationships)) { |
d0592c3d | 1657 | // get the total relationships |
1658 | if ($params['context'] != 'user') { | |
1659 | $params['total'] = CRM_Contact_BAO_Relationship::getRelationship($params['contact_id'], | |
1660 | $relationshipStatus, 0, 1, 0, NULL, NULL, $permissionedContacts); | |
1661 | } | |
1662 | else { | |
1663 | // FIX ME: we cannot directly determine total permissioned relationship, hence re-fire query | |
1664 | $permissionedRelationships = CRM_Contact_BAO_Relationship::getRelationship($params['contact_id'], | |
1665 | $relationshipStatus, | |
1666 | 0, 0, 0, | |
1667 | NULL, NULL, TRUE | |
1668 | ); | |
1669 | $params['total'] = count($permissionedRelationships); | |
1670 | } | |
40458f6c | 1671 | |
1672 | // format params | |
1673 | foreach ($relationships as $relationshipId => $values) { | |
1674 | $contactRelationships[$relationshipId]['name'] = CRM_Utils_System::href( | |
1675 | $values['name'], | |
1676 | 'civicrm/contact/view', | |
1677 | "reset=1&cid={$values['contact_id_b']}"); | |
1678 | ||
1679 | $contactRelationships[$relationshipId]['relation'] = CRM_Utils_System::href( | |
1680 | $values['relation'], | |
1681 | 'civicrm/contact/view/rel', | |
1682 | "action=view&reset=1&cid={$values['contact_id_a']}&id={$values['id']}&rtype={$values['rtype']}"); | |
1683 | ||
d0592c3d | 1684 | if ($params['context'] == 'current') { |
40458f6c | 1685 | if (($params['contact_id'] == $values['contact_id_a'] AND $values['is_permission_a_b'] == 1) OR |
1686 | ($params['contact_id'] == $values['contact_id_b'] AND $values['is_permission_b_a'] == 1) | |
1687 | ) { | |
1688 | $contactRelationships[$relationshipId]['name'] .= '<span id="permission-a-b" class="crm-marker permission-relationship"> *</span>'; | |
1689 | } | |
1690 | ||
1691 | if (($values['cid'] == $values['contact_id_a'] AND $values['is_permission_a_b'] == 1) OR | |
1692 | ($values['cid'] == $values['contact_id_b'] AND $values['is_permission_b_a'] == 1) | |
1693 | ) { | |
1694 | $contactRelationships[$relationshipId]['relation'] .= '<span id="permission-b-a" class="crm-marker permission-relationship"> *</span>'; | |
1695 | } | |
1696 | } | |
1697 | ||
1698 | if (!empty($values['description'])) { | |
1699 | $contactRelationships[$relationshipId]['relation'] .= "<p class='description'>{$values['description']}</p>"; | |
1700 | } | |
1701 | ||
1702 | $contactRelationships[$relationshipId]['start_date'] = CRM_Utils_Date::customFormat($values['start_date']); | |
1703 | $contactRelationships[$relationshipId]['end_date'] = CRM_Utils_Date::customFormat($values['end_date']); | |
1704 | $contactRelationships[$relationshipId]['city'] = $values['city']; | |
1705 | $contactRelationships[$relationshipId]['state'] = $values['state']; | |
1706 | $contactRelationships[$relationshipId]['email'] = $values['email']; | |
1707 | $contactRelationships[$relationshipId]['phone'] = $values['phone']; | |
1708 | $contactRelationships[$relationshipId]['links'] = $values['action']; | |
e1cad725 | 1709 | $contactRelationships[$relationshipId]['id'] = $values['id']; |
f1321272 | 1710 | $contactRelationships[$relationshipId]['is_active'] = $values['is_active']; |
40458f6c | 1711 | } |
1712 | } | |
1713 | return $contactRelationships; | |
1714 | } | |
1715 | ||
6a488035 TO |
1716 | } |
1717 |