3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
33 class CRM_Core_OptionGroup
{
34 static $_values = array();
35 static $_cache = array();
38 * $_domainIDGroups array maintains the list of option groups for whom
39 * domainID is to be considered.
41 static $_domainIDGroups = array(
47 * @param CRM_Core_DAO $dao
49 * @param bool $grouping
50 * @param bool $localize
51 * @param string $valueColumnName
55 public static function &valuesCommon(
56 $dao, $flip = FALSE, $grouping = FALSE,
57 $localize = FALSE, $valueColumnName = 'label'
59 self
::$_values = array();
61 while ($dao->fetch()) {
64 self
::$_values[$dao->value
] = $dao->grouping
;
67 self
::$_values[$dao->{$valueColumnName}] = $dao->value
;
72 self
::$_values[$dao->{$valueColumnName}] = $dao->grouping
;
75 self
::$_values[$dao->value
] = $dao->{$valueColumnName};
80 $i18n = CRM_Core_I18n
::singleton();
81 $i18n->localizeArray(self
::$_values);
83 return self
::$_values;
87 * This function retrieves all the values for the specific option group by name
88 * this is primarily used to create various html based form elements
89 * (radio, select, checkbox etc). OptionGroups for most cases have the
90 * 'label' in the label column and the 'id' or 'name' in the value column
93 * name of the option group.
95 * results are return in id => label format if false.
96 * if true, the results are reversed
97 * @param bool $grouping
98 * if true, return the value in 'grouping' column.
99 * @param bool $localize
100 * if true, localize the results before returning.
101 * @param string $condition
102 * add another condition to the sql query.
103 * @param string $labelColumnName
104 * the column to use for 'label'.
105 * @param bool $onlyActive
106 * return only the action option values.
108 * ignore cache entries and go back to DB.
109 * @param string $keyColumnName
110 * the column to use for 'key'.
113 * the values as specified by the above params
116 public static function &values(
117 $name, $flip = FALSE, $grouping = FALSE,
118 $localize = FALSE, $condition = NULL,
119 $labelColumnName = 'label', $onlyActive = TRUE, $fresh = FALSE, $keyColumnName = 'value',
122 $cache = CRM_Utils_Cache
::singleton();
123 $cacheKey = self
::createCacheKey($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName);
126 // Fetch from static var
127 if (array_key_exists($cacheKey, self
::$_cache)) {
128 return self
::$_cache[$cacheKey];
130 // Fetch from main cache
131 $var = $cache->get($cacheKey);
138 SELECT v.{$labelColumnName} as {$labelColumnName} ,v.{$keyColumnName} as value, v.grouping as grouping
139 FROM civicrm_option_value v,
140 civicrm_option_group g
141 WHERE v.option_group_id = g.id
143 AND g.is_active = 1 ";
146 $query .= " AND v.is_active = 1 ";
148 if (in_array($name, self
::$_domainIDGroups)) {
149 $query .= " AND v.domain_id = " . CRM_Core_Config
::domainID();
153 $query .= $condition;
156 $query .= " ORDER BY v.{$orderBy}";
158 $p = array(1 => array($name, 'String'));
159 $dao = CRM_Core_DAO
::executeQuery($query, $p);
161 $var = self
::valuesCommon($dao, $flip, $grouping, $localize, $labelColumnName);
163 // call option value hook
164 CRM_Utils_Hook
::optionValues($var, $name);
166 self
::$_cache[$cacheKey] = $var;
167 $cache->set($cacheKey, $var);
173 * Counterpart to values() which removes the item from the cache
175 * @param string $name
180 * @param string $labelColumnName
182 * @param string $keyColumnName
184 protected static function flushValues($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName = 'value') {
185 $cacheKey = self
::createCacheKey($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName);
186 $cache = CRM_Utils_Cache
::singleton();
187 $cache->delete($cacheKey);
188 unset(self
::$_cache[$cacheKey]);
194 protected static function createCacheKey() {
195 $cacheKey = "CRM_OG_" . serialize(func_get_args());
200 * This function retrieves all the values for the specific option group by id.
201 * this is primarily used to create various html based form elements
202 * (radio, select, checkbox etc). OptionGroups for most cases have the
203 * 'label' in the label column and the 'id' or 'name' in the value column
206 * id of the option group.
208 * results are return in id => label format if false.
209 * if true, the results are reversed
210 * @param bool $grouping
211 * if true, return the value in 'grouping' column.
212 * @param bool $localize
213 * if true, localize the results before returning.
214 * @param string $labelColumnName
215 * the column to use for 'label'.
216 * @param bool $onlyActive
220 * Array of values as specified by the above params
223 public static function &valuesByID($id, $flip = FALSE, $grouping = FALSE, $localize = FALSE, $labelColumnName = 'label', $onlyActive = TRUE, $fresh = FALSE) {
224 $cacheKey = self
::createCacheKey($id, $flip, $grouping, $localize, $labelColumnName, $onlyActive);
226 $cache = CRM_Utils_Cache
::singleton();
228 $var = $cache->get($cacheKey);
234 SELECT v.{$labelColumnName} as {$labelColumnName} ,v.value as value, v.grouping as grouping
235 FROM civicrm_option_value v,
236 civicrm_option_group g
237 WHERE v.option_group_id = g.id
242 $query .= " AND v.is_active = 1 ";
244 $query .= " ORDER BY v.weight, v.label";
246 $p = array(1 => array($id, 'Integer'));
247 $dao = CRM_Core_DAO
::executeQuery($query, $p);
249 $var = self
::valuesCommon($dao, $flip, $grouping, $localize, $labelColumnName);
250 $cache->set($cacheKey, $var);
256 * Lookup titles OR ids for a set of option_value populated fields. The retrieved value
257 * is assigned a new fieldname by id or id's by title
258 * (each within a specificied option_group)
260 * @param array $params
261 * Reference array of values submitted by the form. Based on.
262 * $flip, creates new elements in $params for each field in
264 * If $flip = false, adds root field name => title
265 * If $flip = true, adds actual field name => id
267 * @param array $names
268 * Reference array of fieldnames we want transformed.
269 * Array key = 'postName' (field name submitted by form in $params).
270 * Array value = array('newName' => $newName, 'groupName' => $groupName).
275 public static function lookupValues(&$params, &$names, $flip = FALSE) {
276 foreach ($names as $postName => $value) {
277 // See if $params field is in $names array (i.e. is a value that we need to lookup)
278 if ($postalName = CRM_Utils_Array
::value($postName, $params)) {
279 $postValues = array();
280 // params[$postName] may be a Ctrl+A separated value list
281 if (is_string($postalName) &&
282 strpos($postalName, CRM_Core_DAO
::VALUE_SEPARATOR
) == FALSE
284 // eliminate the ^A frm the beginning and end if present
285 if (substr($postalName, 0, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
) {
286 $params[$postName] = substr($params[$postName], 1, -1);
288 $postValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $params[$postName]);
290 elseif (is_array($postalName)) {
291 $postValues = $postalName;
294 foreach ($postValues as $postValue) {
300 $p = array(1 => array($postValue, 'String'));
301 $lookupBy = 'v.label= %1';
305 $p = array(1 => array($postValue, 'Integer'));
306 $lookupBy = 'v.value = %1';
310 $p[2] = array($value['groupName'], 'String');
313 FROM civicrm_option_value v,
314 civicrm_option_group g
315 WHERE v.option_group_id = g.id
319 $newValue[] = CRM_Core_DAO
::singleValueQuery($query, $p);
320 $newValue = str_replace(',', '_', $newValue);
322 $params[$value['newName']] = implode(', ', $newValue);
328 * @deprecated - use CRM_Core_Pseudoconstant::getLabel
330 * @param string $groupName
332 * @param bool $onlyActiveValue
336 public static function getLabel($groupName, $value, $onlyActiveValue = TRUE) {
337 if (empty($groupName) ||
344 SELECT v.label as label ,v.value as value
345 FROM civicrm_option_value v,
346 civicrm_option_group g
347 WHERE v.option_group_id = g.id
352 if ($onlyActiveValue) {
353 $query .= " AND v.is_active = 1 ";
356 1 => array($groupName, 'String'),
357 2 => array($value, 'Integer'),
359 $dao = CRM_Core_DAO
::executeQuery($query, $p);
369 * This function is not cached.
371 * @param string $groupName
373 * @param string $labelField
374 * @param string $labelType
375 * @param string $valueField
379 public static function getValue(
382 $labelField = 'label',
383 $labelType = 'String',
384 $valueField = 'value'
391 SELECT v.label as label ,v.{$valueField} as value
392 FROM civicrm_option_value v,
393 civicrm_option_group g
394 WHERE v.option_group_id = g.id
398 AND v.$labelField = %2
402 1 => array($groupName, 'String'),
403 2 => array($label, $labelType),
405 $dao = CRM_Core_DAO
::executeQuery($query, $p);
415 * Get option_value.value from default option_value row for an option group
417 * @param string $groupName
418 * The name of the option group.
422 * the value from the row where is_default = true
424 public static function getDefaultValue($groupName) {
425 if (empty($groupName)) {
430 FROM civicrm_option_value v,
431 civicrm_option_group g
432 WHERE v.option_group_id = g.id
438 if (in_array($groupName, self
::$_domainIDGroups)) {
439 $query .= " AND v.domain_id = " . CRM_Core_Config
::domainID();
442 $p = array(1 => array($groupName, 'String'));
443 return CRM_Core_DAO
::singleValueQuery($query, $p);
447 * Creates a new option group with the passed in values.
448 * @TODO: Should update the group if it already exists intelligently, so multi-lingual is
449 * not messed up. Currently deletes the old group
451 * @param string $groupName
452 * The name of the option group - make sure there is no conflict.
453 * @param array $values
454 * The associative array that has information on the option values.
455 * the keys of this array are:
456 * string 'title' (required)
457 * string 'value' (required)
458 * string 'name' (optional)
459 * string 'description' (optional)
460 * int 'weight' (optional) - the order in which the value are displayed
461 * bool 'is_default' (optional) - is this the default one to display when rendered in form
462 * bool 'is_active' (optional) - should this element be rendered
463 * @param int $defaultID
464 * (reference) - the option value ID of the default element (if set) is returned else 'null'.
465 * @param null $groupTitle
466 * The optional label of the option group else set to group name.
470 * the option group ID
472 public static function createAssoc($groupName, &$values, &$defaultID, $groupTitle = NULL) {
473 self
::deleteAssoc($groupName);
474 if (!empty($values)) {
475 $group = new CRM_Core_DAO_OptionGroup();
476 $group->name
= $groupName;
477 $group->title
= empty($groupTitle) ?
$groupName : $groupTitle;
478 $group->is_reserved
= 1;
479 $group->is_active
= 1;
482 foreach ($values as $v) {
483 $value = new CRM_Core_DAO_OptionValue();
484 $value->option_group_id
= $group->id
;
485 $value->label
= $v['label'];
486 $value->value
= $v['value'];
487 $value->name
= CRM_Utils_Array
::value('name', $v);
488 $value->description
= CRM_Utils_Array
::value('description', $v);
489 $value->weight
= CRM_Utils_Array
::value('weight', $v);
490 $value->is_default
= CRM_Utils_Array
::value('is_default', $v);
491 $value->is_active
= CRM_Utils_Array
::value('is_active', $v);
494 if ($value->is_default
) {
495 $defaultID = $value->id
;
500 return $defaultID = 'null';
507 * @param string $groupName
510 * @param string $field
512 public static function getAssoc($groupName, &$values, $flip = FALSE, $field = 'name') {
514 SELECT v.id as amount_id, v.value, v.label, v.name, v.description, v.weight
515 FROM civicrm_option_group g,
516 civicrm_option_value v
517 WHERE g.id = v.option_group_id
521 $params = array(1 => array($groupName, 'String'));
522 $dao = CRM_Core_DAO
::executeQuery($query, $params);
524 $fields = array('value', 'label', 'name', 'description', 'amount_id', 'weight');
529 foreach ($fields as $field) {
530 $values[$field] = array();
535 while ($dao->fetch()) {
538 foreach ($fields as $field) {
539 $value[$field] = $dao->$field;
541 $values[$dao->amount_id
] = $value;
544 foreach ($fields as $field) {
545 $values[$field][$index] = $dao->$field;
553 * @param string $groupName
554 * @param string $operator
556 public static function deleteAssoc($groupName, $operator = "=") {
559 FROM civicrm_option_group g,
560 civicrm_option_value v
561 WHERE g.id = v.option_group_id
562 AND g.name {$operator} %1";
564 $params = array(1 => array($groupName, 'String'));
566 $dao = CRM_Core_DAO
::executeQuery($query, $params);
570 * @param string $groupName
572 * @param string $field
573 * @param string $fieldType
574 * @param bool $active
575 * @param bool $localize
576 * if true, localize the results before returning.
580 public static function getRowValues(
581 $groupName, $fieldValue, $field = 'name',
582 $fieldType = 'String', $active = TRUE, $localize = FALSE
585 SELECT v.id, v.label, v.value, v.name, v.weight, v.description
586 FROM civicrm_option_value v,
587 civicrm_option_group g
588 WHERE v.option_group_id = g.id
595 $query .= " AND v.is_active = 1";
599 1 => array($groupName, 'String'),
600 2 => array($fieldValue, $fieldType),
602 $dao = CRM_Core_DAO
::executeQuery($query, $p);
614 $row[$fld] = $dao->$fld;
615 if ($localize && in_array($fld, array('label', 'description'))) {
616 $row[$fld] = ts($row[$fld]);
625 * Wrapper for calling values with fresh set to true to empty the given value.
627 * Since there appears to be some inconsistency
628 * (@todo remove inconsistency) around the pseudoconstant operations
629 * (for example CRM_Contribution_Pseudoconstant::paymentInstrument doesn't specify isActive
630 * which is part of the cache key
631 * will do a couple of variations & aspire to someone cleaning it up later
633 * @param string $name
634 * @param array $params
636 public static function flush($name, $params = array()) {
642 'labelColumnName' => 'label',
645 $params = array_merge($defaults, $params);
651 $params['condition'],
652 $params['labelColumnName'],
661 $params['condition'],
662 $params['labelColumnName'],
668 public static function flushAll() {
669 self
::$_values = array();
670 self
::$_cache = array();
671 CRM_Utils_Cache
::singleton()->flush();