Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
8c9251b3 | 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 TO |
32 | */ |
33 | class CRM_Core_OptionValue { | |
34 | ||
35 | /** | |
d09edf64 | 36 | * Static field for all the option value information that we can potentially export. |
6a488035 TO |
37 | * |
38 | * @var array | |
6a488035 TO |
39 | */ |
40 | static $_exportableFields = NULL; | |
41 | ||
42 | /** | |
d09edf64 | 43 | * Static field for all the option value information that we can potentially export. |
6a488035 TO |
44 | * |
45 | * @var array | |
6a488035 TO |
46 | */ |
47 | static $_importableFields = NULL; | |
48 | ||
49 | /** | |
d09edf64 | 50 | * Static field for all the option value information that we can potentially export. |
6a488035 TO |
51 | * |
52 | * @var array | |
6a488035 TO |
53 | */ |
54 | static $_fields = NULL; | |
55 | ||
56 | /** | |
100fef9d | 57 | * Return option-values of a particular group |
6a488035 | 58 | * |
6a0b768e TO |
59 | * @param array $groupParams |
60 | * Array containing group fields whose option-values is to retrieved. | |
6a0b768e TO |
61 | * @param array $links |
62 | * Has links like edit, delete, disable ..etc. | |
8d7a9d07 CB |
63 | * @param string $orderBy |
64 | * For orderBy clause. | |
91484e0a | 65 | * @param bool $skipEmptyComponents |
4d669903 | 66 | * Whether to skip OptionValue rows with empty Component name |
67 | * (i.e. when Extension providing the Component is disabled) | |
6a488035 | 68 | * |
a6c01b45 | 69 | * @return array |
16b10e64 | 70 | * Array of option-values |
6a488035 | 71 | * |
6a488035 | 72 | */ |
4d669903 | 73 | public static function getRows($groupParams, $links, $orderBy = 'weight', $skipEmptyComponents = TRUE) { |
6a488035 | 74 | $optionValue = array(); |
6a488035 | 75 | $optionGroupID = NULL; |
b249a148 MD |
76 | $isGroupLocked = FALSE; |
77 | ||
6a488035 TO |
78 | if (!isset($groupParams['id']) || !$groupParams['id']) { |
79 | if ($groupParams['name']) { | |
6a488035 TO |
80 | $optionGroup = CRM_Core_BAO_OptionGroup::retrieve($groupParams, $dnc); |
81 | $optionGroupID = $optionGroup->id; | |
b249a148 | 82 | $isGroupLocked = (bool) $optionGroup->is_locked; |
6a488035 TO |
83 | } |
84 | } | |
85 | else { | |
86 | $optionGroupID = $groupParams['id']; | |
87 | } | |
88 | ||
89 | $groupName = CRM_Utils_Array::value('name', $groupParams); | |
90 | if (!$groupName && $optionGroupID) { | |
91 | $groupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', | |
92 | $optionGroupID, 'name', 'id' | |
93 | ); | |
94 | } | |
95 | ||
96 | $dao = new CRM_Core_DAO_OptionValue(); | |
97 | ||
98 | if ($optionGroupID) { | |
99 | $dao->option_group_id = $optionGroupID; | |
100 | ||
101 | if (in_array($groupName, CRM_Core_OptionGroup::$_domainIDGroups)) { | |
102 | $dao->domain_id = CRM_Core_Config::domainID(); | |
103 | } | |
104 | ||
105 | $dao->orderBy($orderBy); | |
106 | $dao->find(); | |
107 | } | |
108 | ||
109 | if ($groupName == 'case_type') { | |
110 | $caseTypeIds = CRM_Case_BAO_Case::getUsedCaseType(); | |
111 | } | |
112 | elseif ($groupName == 'case_status') { | |
113 | $caseStatusIds = CRM_Case_BAO_Case::getUsedCaseStatuses(); | |
114 | } | |
115 | ||
116 | $componentNames = CRM_Core_Component::getNames(); | |
117 | $visibilityLabels = CRM_Core_PseudoConstant::visibility(); | |
118 | while ($dao->fetch()) { | |
119 | $optionValue[$dao->id] = array(); | |
120 | CRM_Core_DAO::storeValues($dao, $optionValue[$dao->id]); | |
4d669903 | 121 | if (!empty($optionValue[$dao->id]['component_id']) && |
122 | empty($componentNames[$optionValue[$dao->id]['component_id']]) && | |
123 | $skipEmptyComponents | |
124 | ) { | |
125 | unset($optionValue[$dao->id]); | |
126 | continue; | |
127 | } | |
6a488035 TO |
128 | // form all action links |
129 | $action = array_sum(array_keys($links)); | |
130 | ||
131 | // update enable/disable links depending on if it is is_reserved or is_active | |
132 | if ($dao->is_reserved) { | |
133 | $action = CRM_Core_Action::UPDATE; | |
134 | } | |
135 | else { | |
136 | if ($dao->is_active) { | |
137 | $action -= CRM_Core_Action::ENABLE; | |
138 | } | |
139 | else { | |
140 | $action -= CRM_Core_Action::DISABLE; | |
141 | } | |
142 | if ((($groupName == 'case_type') && in_array($dao->value, $caseTypeIds)) || | |
143 | (($groupName == 'case_status') && in_array($dao->value, $caseStatusIds)) | |
144 | ) { | |
145 | $action -= CRM_Core_Action::DELETE; | |
146 | } | |
147 | } | |
148 | ||
b249a148 | 149 | // disallow deletion of option values for locked groups |
218d9fd2 | 150 | if (($action & CRM_Core_Action::DELETE) && $isGroupLocked) { |
b249a148 MD |
151 | $action -= CRM_Core_Action::DELETE; |
152 | } | |
153 | ||
6a488035 TO |
154 | $optionValue[$dao->id]['label'] = htmlspecialchars($optionValue[$dao->id]['label']); |
155 | $optionValue[$dao->id]['order'] = $optionValue[$dao->id]['weight']; | |
00c2ff9e | 156 | $optionValue[$dao->id]['icon'] = CRM_Utils_Array::value('icon', $optionValue[$dao->id], ''); |
6a488035 TO |
157 | $optionValue[$dao->id]['action'] = CRM_Core_Action::formLink($links, $action, |
158 | array( | |
159 | 'id' => $dao->id, | |
160 | 'gid' => $optionGroupID, | |
161 | 'value' => $dao->value, | |
87dab4a4 AH |
162 | ), |
163 | ts('more'), | |
164 | FALSE, | |
165 | 'optionValue.row.actions', | |
166 | 'optionValue', | |
167 | $dao->id | |
6a488035 TO |
168 | ); |
169 | ||
a7488080 | 170 | if (!empty($optionValue[$dao->id]['component_id'])) { |
6a488035 TO |
171 | $optionValue[$dao->id]['component_name'] = $componentNames[$optionValue[$dao->id]['component_id']]; |
172 | } | |
173 | else { | |
174 | $optionValue[$dao->id]['component_name'] = 'Contact'; | |
175 | } | |
176 | ||
a7488080 | 177 | if (!empty($optionValue[$dao->id]['visibility_id'])) { |
6a488035 TO |
178 | $optionValue[$dao->id]['visibility_label'] = $visibilityLabels[$optionValue[$dao->id]['visibility_id']]; |
179 | } | |
180 | } | |
181 | ||
182 | return $optionValue; | |
183 | } | |
184 | ||
185 | /** | |
100fef9d | 186 | * Add/edit option-value of a particular group |
6a488035 | 187 | * |
6a0b768e TO |
188 | * @param array $params |
189 | * Array containing exported values from the invoking form. | |
190 | * @param array $groupParams | |
191 | * Array containing group fields whose option-values is to retrieved/saved. | |
fd31fa4c | 192 | * @param $action |
8d7a9d07 | 193 | * @param int $optionValueID Has the id of the optionValue being edited, disabled ..etc. |
6a0b768e | 194 | * Has the id of the optionValue being edited, disabled ..etc. |
6a488035 | 195 | * |
7c285037 | 196 | * @return CRM_Core_DAO_OptionValue |
6a488035 | 197 | * |
6a488035 | 198 | */ |
00be9182 | 199 | public static function addOptionValue(&$params, &$groupParams, &$action, &$optionValueID) { |
0be95659 | 200 | $ids = array(); |
6a488035 TO |
201 | $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE); |
202 | // checking if the group name with the given id or name (in $groupParams) exists | |
203 | if (!empty($groupParams)) { | |
204 | $config = CRM_Core_Config::singleton(); | |
205 | $groupParams['is_active'] = 1; | |
206 | $optionGroup = CRM_Core_BAO_OptionGroup::retrieve($groupParams, $defaults); | |
207 | } | |
208 | ||
209 | // if the corresponding group doesn't exist, create one, provided $groupParams has 'name' in it. | |
210 | if (!$optionGroup->id) { | |
211 | if ($groupParams['name']) { | |
353ffa53 | 212 | $newOptionGroup = CRM_Core_BAO_OptionGroup::add($groupParams, $defaults); |
6a488035 | 213 | $params['weight'] = 1; |
353ffa53 | 214 | $optionGroupID = $newOptionGroup->id; |
6a488035 TO |
215 | } |
216 | } | |
217 | else { | |
218 | $optionGroupID = $optionGroup->id; | |
219 | $oldWeight = NULL; | |
220 | if ($optionValueID) { | |
221 | $oldWeight = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'weight', 'id'); | |
222 | } | |
223 | $fieldValues = array('option_group_id' => $optionGroupID); | |
fc161185 | 224 | $params['weight'] = CRM_Utils_Weight::updateOtherWeights('CRM_Core_DAO_OptionValue', $oldWeight, CRM_Utils_Array::value('weight', $params), $fieldValues); |
6a488035 TO |
225 | } |
226 | $params['option_group_id'] = $optionGroupID; | |
227 | ||
8cc574cf | 228 | if (($action & CRM_Core_Action::ADD) && empty($params['value'])) { |
6a488035 TO |
229 | $fieldValues = array('option_group_id' => $optionGroupID); |
230 | // use the next available value | |
231 | /* CONVERT(value, DECIMAL) is used to convert varchar | |
e70a7fc0 | 232 | field 'value' to decimal->integer */ |
6a488035 TO |
233 | |
234 | $params['value'] = (int) CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', | |
235 | $fieldValues, | |
236 | 'CONVERT(value, DECIMAL)' | |
237 | ); | |
238 | } | |
239 | if (!$params['label'] && $params['name']) { | |
240 | $params['label'] = $params['name']; | |
241 | } | |
242 | ||
243 | // set name to label if it's not set - but *only* for ADD action (CRM-3522) | |
8cc574cf | 244 | if (($action & CRM_Core_Action::ADD) && empty($params['name']) && $params['label']) { |
6a488035 TO |
245 | $params['name'] = $params['label']; |
246 | } | |
247 | if ($action & CRM_Core_Action::UPDATE) { | |
248 | $ids['optionValue'] = $optionValueID; | |
249 | } | |
250 | $optionValue = CRM_Core_BAO_OptionValue::add($params, $ids); | |
251 | return $optionValue; | |
252 | } | |
253 | ||
254 | /** | |
d09edf64 | 255 | * Check if there is a record with the same name in the db. |
6a488035 | 256 | * |
6a0b768e TO |
257 | * @param string $value |
258 | * The value of the field we are checking. | |
259 | * @param string $daoName | |
260 | * The dao object name. | |
261 | * @param string $daoID | |
262 | * The id of the object being updated. u can change your name. | |
6a488035 | 263 | * as long as there is no conflict |
100fef9d | 264 | * @param int $optionGroupID |
6a0b768e TO |
265 | * @param string $fieldName |
266 | * The name of the field in the DAO. | |
e6101f17 | 267 | * @param bool $domainSpecific |
0c1e1321 SL |
268 | * Filter this check to the current domain. |
269 | * Some optionGroups allow for same labels or same names but | |
270 | * they must be in different domains, so filter the check to | |
271 | * the current domain. | |
6a488035 | 272 | * |
8d7a9d07 | 273 | * @return bool |
a6c01b45 | 274 | * true if object exists |
6a488035 | 275 | */ |
e6101f17 | 276 | public static function optionExists($value, $daoName, $daoID, $optionGroupID, $fieldName = 'name', $domainSpecific) { |
4d5c2eb5 | 277 | $object = new $daoName(); |
6a488035 TO |
278 | $object->$fieldName = $value; |
279 | $object->option_group_id = $optionGroupID; | |
280 | ||
e6101f17 SL |
281 | if ($domainSpecific) { |
282 | $object->domain_id = CRM_Core_Config::domainID(); | |
283 | } | |
284 | ||
6a488035 TO |
285 | if ($object->find(TRUE)) { |
286 | return ($daoID && $object->id == $daoID) ? TRUE : FALSE; | |
287 | } | |
288 | else { | |
289 | return TRUE; | |
290 | } | |
291 | } | |
292 | ||
293 | /** | |
d09edf64 | 294 | * Check if there is a record with the same name in the db. |
6a488035 | 295 | * |
da6b46f4 EM |
296 | * @param string $mode |
297 | * @param string $contactType | |
298 | * | |
3058f4d9 | 299 | * @return array |
6a488035 | 300 | */ |
00be9182 | 301 | public static function getFields($mode = '', $contactType = 'Individual') { |
6a488035 TO |
302 | $key = "$mode $contactType"; |
303 | if (empty(self::$_fields[$key]) || !self::$_fields[$key]) { | |
304 | self::$_fields[$key] = array(); | |
305 | ||
306 | $option = CRM_Core_DAO_OptionValue::import(); | |
307 | ||
308 | foreach (array_keys($option) as $id) { | |
309 | $optionName = $option[$id]; | |
310 | } | |
311 | ||
312 | $nameTitle = array(); | |
313 | if ($mode == 'contribute') { | |
8f165fa5 | 314 | // This is part of a move towards standardising option values but we |
315 | // should derive them from the fields array so am deprecating it again... | |
316 | // note that the reason this was needed was that payment_instrument_id was | |
317 | // not set to exportable. | |
6a488035 TO |
318 | $nameTitle = array( |
319 | 'payment_instrument' => array( | |
320 | 'name' => 'payment_instrument', | |
536f0e02 | 321 | 'title' => ts('Payment Method'), |
6a488035 TO |
322 | 'headerPattern' => '/^payment|(p(ayment\s)?instrument)$/i', |
323 | ), | |
324 | ); | |
325 | } | |
326 | elseif ($mode == '') { | |
327 | //the fields email greeting and postal greeting are meant only for Individual and Household | |
328 | //the field addressee is meant for all contact types, CRM-4575 | |
329 | if (in_array($contactType, array( | |
353ffa53 TO |
330 | 'Individual', |
331 | 'Household', | |
332 | 'Organization', | |
8d7a9d07 | 333 | 'All', |
353ffa53 | 334 | ))) { |
6a488035 | 335 | $nameTitle = array( |
1071730c DL |
336 | 'addressee' => array( |
337 | 'name' => 'addressee', | |
6a488035 TO |
338 | 'title' => ts('Addressee'), |
339 | 'headerPattern' => '/^addressee$/i', | |
340 | ), | |
341 | ); | |
342 | $title = array( | |
1071730c DL |
343 | 'email_greeting' => array( |
344 | 'name' => 'email_greeting', | |
6a488035 TO |
345 | 'title' => ts('Email Greeting'), |
346 | 'headerPattern' => '/^email_greeting$/i', | |
347 | ), | |
348 | 'postal_greeting' => array( | |
349 | 'name' => 'postal_greeting', | |
350 | 'title' => ts('Postal Greeting'), | |
351 | 'headerPattern' => '/^postal_greeting$/i', | |
352 | ), | |
353 | ); | |
354 | $nameTitle = array_merge($nameTitle, $title); | |
355 | } | |
0c145cc0 | 356 | } |
6a488035 TO |
357 | |
358 | if (is_array($nameTitle)) { | |
359 | foreach ($nameTitle as $name => $attribs) { | |
360 | self::$_fields[$key][$name] = $optionName; | |
361 | list($tableName, $fieldName) = explode('.', $optionName['where']); | |
6a488035 TO |
362 | self::$_fields[$key][$name]['where'] = "{$name}.label"; |
363 | foreach ($attribs as $k => $val) { | |
364 | self::$_fields[$key][$name][$k] = $val; | |
365 | } | |
366 | } | |
367 | } | |
368 | } | |
369 | ||
370 | return self::$_fields[$key]; | |
371 | } | |
372 | ||
373 | /** | |
100fef9d | 374 | * Build select query in case of option-values |
6a488035 | 375 | * |
2a6da8d7 | 376 | * @param $query |
6a488035 | 377 | */ |
00be9182 | 378 | public static function select(&$query) { |
6a488035 TO |
379 | if (!empty($query->_params) || !empty($query->_returnProperties)) { |
380 | $field = self::getFields(); | |
314dbef8 | 381 | foreach ($field as $name => $values) { |
a7488080 | 382 | if (!empty($values['pseudoconstant'])) { |
314dbef8 DL |
383 | continue; |
384 | } | |
385 | list($tableName, $fieldName) = explode('.', $values['where']); | |
a7488080 | 386 | if (!empty($query->_returnProperties[$name])) { |
6a488035 TO |
387 | $query->_select["{$name}_id"] = "{$name}.value as {$name}_id"; |
388 | $query->_element["{$name}_id"] = 1; | |
389 | $query->_select[$name] = "{$name}.{$fieldName} as $name"; | |
390 | $query->_tables[$tableName] = 1; | |
391 | $query->_element[$name] = 1; | |
392 | } | |
393 | } | |
394 | } | |
395 | } | |
396 | ||
397 | /** | |
100fef9d | 398 | * Return option-values of a particular group |
6a488035 | 399 | * |
6a0b768e TO |
400 | * @param array $groupParams |
401 | * Array containing group fields. | |
6a488035 | 402 | * whose option-values is to retrieved. |
6a0b768e TO |
403 | * @param array $values |
404 | * (reference) to the array which. | |
6a488035 | 405 | * will have the values for the group |
6a0b768e TO |
406 | * @param string $orderBy |
407 | * For orderBy clause. | |
6a488035 | 408 | * |
8d7a9d07 | 409 | * @param bool $isActive Do you want only active option values? |
6a488035 | 410 | * |
a6c01b45 | 411 | * @return array |
16b10e64 | 412 | * Array of option-values |
6a488035 | 413 | * |
6a488035 | 414 | */ |
00be9182 | 415 | public static function getValues($groupParams, &$values, $orderBy = 'weight', $isActive = FALSE) { |
6a488035 TO |
416 | if (empty($groupParams)) { |
417 | return NULL; | |
418 | } | |
419 | $select = " | |
420 | SELECT | |
421 | option_value.id as id, | |
422 | option_value.label as label, | |
423 | option_value.value as value, | |
424 | option_value.name as name, | |
425 | option_value.description as description, | |
426 | option_value.weight as weight, | |
427 | option_value.is_active as is_active, | |
428 | option_value.is_default as is_default"; | |
429 | ||
430 | $from = " | |
431 | FROM | |
432 | civicrm_option_value as option_value, | |
433 | civicrm_option_group as option_group "; | |
434 | ||
435 | $where = " WHERE option_group.id = option_value.option_group_id "; | |
436 | ||
437 | if ($isActive) { | |
438 | $where .= " AND option_value.is_active = " . $isActive; | |
439 | } | |
440 | ||
441 | $order = " ORDER BY " . $orderBy; | |
442 | ||
443 | $groupId = CRM_Utils_Array::value('id', $groupParams); | |
444 | $groupName = CRM_Utils_Array::value('name', $groupParams); | |
445 | ||
446 | if ($groupId) { | |
447 | $where .= " AND option_group.id = %1"; | |
448 | $params[1] = array($groupId, 'Integer'); | |
449 | if (!$groupName) { | |
450 | $groupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', | |
451 | $groupId, 'name', 'id' | |
452 | ); | |
453 | } | |
454 | } | |
455 | ||
456 | if ($groupName) { | |
457 | $where .= " AND option_group.name = %2"; | |
458 | $params[2] = array($groupName, 'String'); | |
459 | } | |
460 | ||
461 | if (in_array($groupName, CRM_Core_OptionGroup::$_domainIDGroups)) { | |
462 | $where .= " AND option_value.domain_id = " . CRM_Core_Config::domainID(); | |
463 | } | |
464 | ||
465 | $query = $select . $from . $where . $order; | |
466 | ||
467 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
468 | ||
469 | while ($dao->fetch()) { | |
470 | $values[$dao->id] = array( | |
471 | 'id' => $dao->id, | |
472 | 'label' => $dao->label, | |
473 | 'value' => $dao->value, | |
474 | 'name' => $dao->name, | |
475 | 'description' => $dao->description, | |
476 | 'weight' => $dao->weight, | |
477 | 'is_active' => $dao->is_active, | |
478 | 'is_default' => $dao->is_default, | |
479 | ); | |
480 | } | |
481 | } | |
96025800 | 482 | |
6a488035 | 483 | } |