3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 class CRM_Core_OptionValue
{
36 * Static field for all the option value information that we can potentially export.
40 public static $_exportableFields = NULL;
43 * Static field for all the option value information that we can potentially export.
47 public static $_importableFields = NULL;
50 * Static field for all the option value information that we can potentially export.
54 public static $_fields = NULL;
57 * Return option-values of a particular group
59 * @param array $groupParams
60 * Array containing group fields whose option-values is to retrieved.
62 * Has links like edit, delete, disable ..etc.
63 * @param string $orderBy
65 * @param bool $skipEmptyComponents
66 * Whether to skip OptionValue rows with empty Component name
67 * (i.e. when Extension providing the Component is disabled)
70 * Array of option-values
73 public static function getRows($groupParams, $links, $orderBy = 'weight', $skipEmptyComponents = TRUE) {
75 $optionGroupID = NULL;
76 $isGroupLocked = FALSE;
78 if (!isset($groupParams['id']) ||
!$groupParams['id']) {
79 if ($groupParams['name']) {
80 $optionGroup = CRM_Core_BAO_OptionGroup
::retrieve($groupParams, $dnc);
81 $optionGroupID = $optionGroup->id
;
82 $isGroupLocked = (bool) $optionGroup->is_locked
;
86 $optionGroupID = $groupParams['id'];
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'
96 $dao = new CRM_Core_DAO_OptionValue();
99 $dao->option_group_id
= $optionGroupID;
101 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
102 $dao->domain_id
= CRM_Core_Config
::domainID();
105 $dao->orderBy($orderBy);
109 if ($groupName == 'case_type') {
110 $caseTypeIds = CRM_Case_BAO_Case
::getUsedCaseType();
112 elseif ($groupName == 'case_status') {
113 $caseStatusIds = CRM_Case_BAO_Case
::getUsedCaseStatuses();
116 $componentNames = CRM_Core_Component
::getNames();
117 $visibilityLabels = CRM_Core_PseudoConstant
::visibility();
118 while ($dao->fetch()) {
119 $optionValue[$dao->id
] = [];
120 CRM_Core_DAO
::storeValues($dao, $optionValue[$dao->id
]);
121 if (!empty($optionValue[$dao->id
]['component_id']) &&
122 empty($componentNames[$optionValue[$dao->id
]['component_id']]) &&
125 unset($optionValue[$dao->id
]);
128 // form all action links
129 $action = array_sum(array_keys($links));
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
;
136 if ($dao->is_active
) {
137 $action -= CRM_Core_Action
::ENABLE
;
140 $action -= CRM_Core_Action
::DISABLE
;
142 if ((($groupName == 'case_type') && in_array($dao->value
, $caseTypeIds)) ||
143 (($groupName == 'case_status') && in_array($dao->value
, $caseStatusIds))
145 $action -= CRM_Core_Action
::DELETE
;
149 // disallow deletion of option values for locked groups
150 if (($action & CRM_Core_Action
::DELETE
) && $isGroupLocked) {
151 $action -= CRM_Core_Action
::DELETE
;
154 $optionValue[$dao->id
]['label'] = htmlspecialchars($optionValue[$dao->id
]['label']);
155 $optionValue[$dao->id
]['order'] = $optionValue[$dao->id
]['weight'];
156 $optionValue[$dao->id
]['icon'] = CRM_Utils_Array
::value('icon', $optionValue[$dao->id
], '');
157 $optionValue[$dao->id
]['action'] = CRM_Core_Action
::formLink($links, $action,
160 'gid' => $optionGroupID,
161 'value' => $dao->value
,
165 'optionValue.row.actions',
170 if (!empty($optionValue[$dao->id
]['component_id'])) {
171 $optionValue[$dao->id
]['component_name'] = $componentNames[$optionValue[$dao->id
]['component_id']];
174 $optionValue[$dao->id
]['component_name'] = 'Contact';
177 if (!empty($optionValue[$dao->id
]['visibility_id'])) {
178 $optionValue[$dao->id
]['visibility_label'] = $visibilityLabels[$optionValue[$dao->id
]['visibility_id']];
186 * Add/edit option-value of a particular group
188 * @param array $params
189 * Array containing exported values from the invoking form.
190 * @param string $optionGroupName
191 * Array containing group fields whose option-values is to retrieved/saved.
193 * @param int $optionValueID Has the id of the optionValue being edited, disabled ..etc.
194 * Has the id of the optionValue being edited, disabled ..etc.
196 * @return CRM_Core_DAO_OptionValue
199 public static function addOptionValue(&$params, $optionGroupName, $action, $optionValueID) {
200 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
201 // checking if the group name with the given id or name (in $groupParams) exists
202 $groupParams = ['name' => $optionGroupName, 'is_active' => 1];
203 $optionGroup = CRM_Core_BAO_OptionGroup
::retrieve($groupParams, $defaults);
205 // if the corresponding group doesn't exist, create one.
206 if (!$optionGroup->id
) {
207 $newOptionGroup = CRM_Core_BAO_OptionGroup
::add($groupParams);
208 $params['weight'] = 1;
209 $optionGroupID = $newOptionGroup->id
;
212 $optionGroupID = $optionGroup->id
;
214 if ($optionValueID) {
215 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'weight', 'id');
217 $fieldValues = ['option_group_id' => $optionGroupID];
218 $params['weight'] = CRM_Utils_Weight
::updateOtherWeights('CRM_Core_DAO_OptionValue', $oldWeight, CRM_Utils_Array
::value('weight', $params), $fieldValues);
220 $params['option_group_id'] = $optionGroupID;
222 if (($action & CRM_Core_Action
::ADD
) && !isset($params['value'])) {
223 $fieldValues = ['option_group_id' => $optionGroupID];
224 // use the next available value
225 /* CONVERT(value, DECIMAL) is used to convert varchar
226 field 'value' to decimal->integer */
228 $params['value'] = (int) CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue',
230 'CONVERT(value, DECIMAL)'
233 if (!$params['label'] && $params['name']) {
234 $params['label'] = $params['name'];
237 // set name to label if it's not set - but *only* for ADD action (CRM-3522)
238 if (($action & CRM_Core_Action
::ADD
) && empty($params['name']) && $params['label']) {
239 $params['name'] = $params['label'];
241 if ($action & CRM_Core_Action
::UPDATE
) {
242 $params['id'] = $optionValueID;
244 $optionValue = CRM_Core_BAO_OptionValue
::add($params);
249 * Check if there is a record with the same name in the db.
251 * @param string $value
252 * The value of the field we are checking.
253 * @param string $daoName
254 * The dao object name.
255 * @param string $daoID
256 * The id of the object being updated. u can change your name.
257 * as long as there is no conflict
258 * @param int $optionGroupID
259 * @param string $fieldName
260 * The name of the field in the DAO.
261 * @param bool $domainSpecific
262 * Filter this check to the current domain.
263 * Some optionGroups allow for same labels or same names but
264 * they must be in different domains, so filter the check to
265 * the current domain.
268 * true if object exists
270 public static function optionExists($value, $daoName, $daoID, $optionGroupID, $fieldName = 'name', $domainSpecific) {
271 $object = new $daoName();
272 $object->$fieldName = $value;
273 $object->option_group_id
= $optionGroupID;
275 if ($domainSpecific) {
276 $object->domain_id
= CRM_Core_Config
::domainID();
279 if ($object->find(TRUE)) {
280 return ($daoID && $object->id
== $daoID) ?
TRUE : FALSE;
288 * Check if there is a record with the same name in the db.
290 * @param string $mode
291 * @param string $contactType
295 public static function getFields($mode = '', $contactType = 'Individual') {
296 $key = "$mode $contactType";
297 if (empty(self
::$_fields[$key]) ||
!self
::$_fields[$key]) {
298 self
::$_fields[$key] = [];
300 $option = CRM_Core_DAO_OptionValue
::import();
302 foreach (array_keys($option) as $id) {
303 $optionName = $option[$id];
307 if ($mode == 'contribute') {
308 // This is part of a move towards standardising option values but we
309 // should derive them from the fields array so am deprecating it again...
310 // note that the reason this was needed was that payment_instrument_id was
311 // not set to exportable.
313 'payment_instrument' => [
314 'name' => 'payment_instrument',
315 'title' => ts('Payment Method'),
316 'headerPattern' => '/^payment|(p(ayment\s)?instrument)$/i',
320 elseif ($mode == '') {
321 //the fields email greeting and postal greeting are meant only for Individual and Household
322 //the field addressee is meant for all contact types, CRM-4575
323 if (in_array($contactType, [
331 'name' => 'addressee',
332 'title' => ts('Addressee'),
333 'headerPattern' => '/^addressee$/i',
337 'email_greeting' => [
338 'name' => 'email_greeting',
339 'title' => ts('Email Greeting'),
340 'headerPattern' => '/^email_greeting$/i',
342 'postal_greeting' => [
343 'name' => 'postal_greeting',
344 'title' => ts('Postal Greeting'),
345 'headerPattern' => '/^postal_greeting$/i',
348 $nameTitle = array_merge($nameTitle, $title);
352 if (is_array($nameTitle)) {
353 foreach ($nameTitle as $name => $attribs) {
354 self
::$_fields[$key][$name] = $optionName;
355 list($tableName, $fieldName) = explode('.', $optionName['where']);
356 self
::$_fields[$key][$name]['where'] = "{$name}.label";
357 foreach ($attribs as $k => $val) {
358 self
::$_fields[$key][$name][$k] = $val;
364 return self
::$_fields[$key];
368 * Build select query in case of option-values
372 public static function select(&$query) {
373 if (!empty($query->_params
) ||
!empty($query->_returnProperties
)) {
374 $field = self
::getFields();
375 foreach ($field as $name => $values) {
376 if (!empty($values['pseudoconstant'])) {
379 list($tableName, $fieldName) = explode('.', $values['where']);
380 if (!empty($query->_returnProperties
[$name])) {
381 $query->_select
["{$name}_id"] = "{$name}.value as {$name}_id";
382 $query->_element
["{$name}_id"] = 1;
383 $query->_select
[$name] = "{$name}.{$fieldName} as $name";
384 $query->_tables
[$tableName] = 1;
385 $query->_element
[$name] = 1;
392 * Return option-values of a particular group
394 * @param array $groupParams
395 * Array containing group fields.
396 * whose option-values is to retrieved.
397 * @param array $values
398 * (reference) to the array which.
399 * will have the values for the group
400 * @param string $orderBy
401 * For orderBy clause.
403 * @param bool $isActive Do you want only active option values?
406 * Array of option-values
409 public static function getValues($groupParams, &$values, $orderBy = 'weight', $isActive = FALSE) {
410 if (empty($groupParams)) {
415 option_value.id as id,
416 option_value.label as label,
417 option_value.value as value,
418 option_value.name as name,
419 option_value.description as description,
420 option_value.weight as weight,
421 option_value.is_active as is_active,
422 option_value.is_default as is_default";
426 civicrm_option_value as option_value,
427 civicrm_option_group as option_group ";
429 $where = " WHERE option_group.id = option_value.option_group_id ";
432 $where .= " AND option_value.is_active = " . $isActive;
435 $order = " ORDER BY " . $orderBy;
437 $groupId = CRM_Utils_Array
::value('id', $groupParams);
438 $groupName = CRM_Utils_Array
::value('name', $groupParams);
441 $where .= " AND option_group.id = %1";
442 $params[1] = [$groupId, 'Integer'];
444 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
445 $groupId, 'name', 'id'
451 $where .= " AND option_group.name = %2";
452 $params[2] = [$groupName, 'String'];
455 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
456 $where .= " AND option_value.domain_id = " . CRM_Core_Config
::domainID();
459 $query = $select . $from . $where . $order;
461 $dao = CRM_Core_DAO
::executeQuery($query, $params);
463 while ($dao->fetch()) {
464 $values[$dao->id
] = [
466 'label' => $dao->label
,
467 'value' => $dao->value
,
468 'name' => $dao->name
,
469 'description' => $dao->description
,
470 'weight' => $dao->weight
,
471 'is_active' => $dao->is_active
,
472 'is_default' => $dao->is_default
,