Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType { | |
36 | ||
37 | /** | |
38 | * class constructor | |
39 | */ | |
40 | function __construct() { | |
41 | parent::__construct(); | |
42 | } | |
43 | ||
44 | /** | |
45 | * Takes a bunch of params that are needed to match certain criteria and | |
46 | * retrieves the relevant objects. Typically the valid params are only | |
47 | * contact_id. We'll tweak this function to be more full featured over a period | |
48 | * of time. This is the inverse function of create. It also stores all the retrieved | |
49 | * values in the default array | |
50 | * | |
51 | * @param array $params (reference ) an assoc array of name/value pairs | |
52 | * @param array $defaults (reference ) an assoc array to hold the flattened values | |
53 | * | |
54 | * @return object CRM_Contact_BAO_RelationshipType object | |
55 | * @access public | |
56 | * @static | |
57 | */ | |
58 | static function retrieve(&$params, &$defaults) { | |
59 | $relationshipType = new CRM_Contact_DAO_RelationshipType(); | |
60 | $relationshipType->copyValues($params); | |
61 | if ($relationshipType->find(TRUE)) { | |
62 | CRM_Core_DAO::storeValues($relationshipType, $defaults); | |
63 | $relationshipType->free(); | |
64 | return $relationshipType; | |
65 | } | |
66 | return NULL; | |
67 | } | |
68 | ||
69 | /** | |
70 | * update the is_active flag in the db | |
71 | * | |
72 | * @param int $id id of the database record | |
73 | * @param boolean $is_active value we want to set the is_active field | |
74 | * | |
75 | * @return Object DAO object on sucess, null otherwise | |
76 | * @static | |
77 | */ | |
78 | static function setIsActive($id, $is_active) { | |
79 | return CRM_Core_DAO::setFieldValue('CRM_Contact_DAO_RelationshipType', $id, 'is_active', $is_active); | |
80 | } | |
81 | ||
82 | /** | |
83 | * Function to add the relationship type in the db | |
84 | * | |
85 | * @param array $params (reference ) an assoc array of name/value pairs | |
86 | * @param array $ids the array that holds all the db ids | |
87 | * | |
88 | * @return object CRM_Contact_DAO_RelationshipType | |
89 | * @access public | |
90 | * @static | |
91 | * | |
92 | */ | |
93 | static function add(&$params, &$ids) { | |
94 | //to change name, CRM-3336 | |
8cc574cf | 95 | if (empty($params['label_a_b']) && !empty($params['name_a_b'])) { |
6a488035 TO |
96 | $params['label_a_b'] = $params['name_a_b']; |
97 | } | |
98 | ||
8cc574cf | 99 | if (empty($params['label_b_a']) && !empty($params['name_b_a'])) { |
6a488035 TO |
100 | $params['label_b_a'] = $params['name_b_a']; |
101 | } | |
102 | ||
103 | // set label to name if it's not set - but *only* for | |
104 | // ADD action. CRM-3336 as part from (CRM-3522) | |
a7488080 | 105 | if (empty($ids['relationshipType'])) { |
8cc574cf | 106 | if (empty($params['name_a_b']) && !empty($params['label_a_b'])) { |
6a488035 TO |
107 | $params['name_a_b'] = $params['label_a_b']; |
108 | } | |
8cc574cf | 109 | if (empty($params['name_b_a']) && !empty($params['label_b_a'])) { |
6a488035 TO |
110 | $params['name_b_a'] = $params['label_b_a']; |
111 | } | |
112 | } | |
113 | ||
114 | // action is taken depending upon the mode | |
115 | $relationshipType = new CRM_Contact_DAO_RelationshipType(); | |
116 | ||
117 | $relationshipType->copyValues($params); | |
118 | ||
119 | // if label B to A is blank, insert the value label A to B for it | |
120 | if (!strlen(trim($strName = CRM_Utils_Array::value('name_b_a', $params)))) { | |
121 | $relationshipType->name_b_a = CRM_Utils_Array::value('name_a_b', $params); | |
122 | } | |
123 | if (!strlen(trim($strName = CRM_Utils_Array::value('label_b_a', $params)))) { | |
124 | $relationshipType->label_b_a = CRM_Utils_Array::value('label_a_b', $params); | |
125 | } | |
126 | ||
127 | $relationshipType->id = CRM_Utils_Array::value('relationshipType', $ids); | |
128 | ||
4bc6c777 TO |
129 | $result = $relationshipType->save(); |
130 | ||
131 | CRM_Core_PseudoConstant::relationshipType('label', TRUE); | |
132 | CRM_Core_PseudoConstant::relationshipType('name', TRUE); | |
133 | CRM_Case_XMLProcessor::flushStaticCaches(); | |
134 | return $result; | |
6a488035 TO |
135 | } |
136 | ||
137 | /** | |
138 | * Function to delete Relationship Types | |
139 | * | |
140 | * @param int $relationshipTypeId | |
77b97be7 EM |
141 | * |
142 | * @throws CRM_Core_Exception | |
143 | * @return mixed | |
6a488035 TO |
144 | * @static |
145 | */ | |
146 | static function del($relationshipTypeId) { | |
147 | // make sure relationshipTypeId is an integer | |
b2402735 | 148 | // @todo review this as most delete functions rely on the api & form layer for this |
149 | // or do a find first & throw error if no find | |
6a488035 | 150 | if (!CRM_Utils_Rule::positiveInteger($relationshipTypeId)) { |
b2402735 | 151 | throw new CRM_Core_Exception(ts('Invalid relationship type')); |
6a488035 TO |
152 | } |
153 | ||
154 | ||
155 | //check dependencies | |
156 | ||
157 | // delete all relationships | |
158 | $relationship = new CRM_Contact_DAO_Relationship(); | |
159 | $relationship->relationship_type_id = $relationshipTypeId; | |
160 | $relationship->delete(); | |
161 | ||
162 | // set all membership_type to null | |
163 | $query = " | |
164 | UPDATE civicrm_membership_type | |
165 | SET relationship_type_id = NULL | |
166 | WHERE relationship_type_id = %1 | |
167 | "; | |
69d1466d | 168 | $params = array(1 => array(CRM_Core_DAO::VALUE_SEPARATOR . $relationshipTypeId . CRM_Core_DAO::VALUE_SEPARATOR, 'String')); |
6a488035 TO |
169 | CRM_Core_DAO::executeQuery($query, $params); |
170 | ||
171 | //fixed for CRM-3323 | |
172 | $mappingField = new CRM_Core_DAO_MappingField(); | |
173 | $mappingField->relationship_type_id = $relationshipTypeId; | |
174 | $mappingField->find(); | |
175 | while ($mappingField->fetch()) { | |
176 | $mappingField->delete(); | |
177 | } | |
178 | ||
179 | $relationshipType = new CRM_Contact_DAO_RelationshipType(); | |
180 | $relationshipType->id = $relationshipTypeId; | |
181 | return $relationshipType->delete(); | |
182 | } | |
183 | } | |
184 |