3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
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'
121 $cache = CRM_Utils_Cache
::singleton();
122 $cacheKey = self
::createCacheKey($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName);
125 // Fetch from static var
126 if (array_key_exists($cacheKey, self
::$_cache)) {
127 return self
::$_cache[$cacheKey];
129 // Fetch from main cache
130 $var = $cache->get($cacheKey);
137 SELECT v.{$labelColumnName} as {$labelColumnName} ,v.{$keyColumnName} as value, v.grouping as grouping
138 FROM civicrm_option_value v,
139 civicrm_option_group g
140 WHERE v.option_group_id = g.id
142 AND g.is_active = 1 ";
145 $query .= " AND v.is_active = 1 ";
147 if (in_array($name, self
::$_domainIDGroups)) {
148 $query .= " AND v.domain_id = " . CRM_Core_Config
::domainID();
152 $query .= $condition;
155 $query .= " ORDER BY v.weight";
157 $p = array(1 => array($name, 'String'));
158 $dao = CRM_Core_DAO
::executeQuery($query, $p);
160 $var = self
::valuesCommon($dao, $flip, $grouping, $localize, $labelColumnName);
162 // call option value hook
163 CRM_Utils_Hook
::optionValues($var, $name);
165 self
::$_cache[$cacheKey] = $var;
166 $cache->set($cacheKey, $var);
172 * Counterpart to values() which removes the item from the cache
174 * @param string $name
179 * @param string $labelColumnName
181 * @param string $keyColumnName
183 protected static function flushValues($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName = 'value') {
184 $cacheKey = self
::createCacheKey($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName);
185 $cache = CRM_Utils_Cache
::singleton();
186 $cache->delete($cacheKey);
187 unset(self
::$_cache[$cacheKey]);
193 protected static function createCacheKey() {
194 $cacheKey = "CRM_OG_" . serialize(func_get_args());
199 * This function retrieves all the values for the specific option group by id.
200 * this is primarily used to create various html based form elements
201 * (radio, select, checkbox etc). OptionGroups for most cases have the
202 * 'label' in the label column and the 'id' or 'name' in the value column
205 * id of the option group.
207 * results are return in id => label format if false.
208 * if true, the results are reversed
209 * @param bool $grouping
210 * if true, return the value in 'grouping' column.
211 * @param bool $localize
212 * if true, localize the results before returning.
213 * @param string $labelColumnName
214 * the column to use for 'label'.
215 * @param bool $onlyActive
219 * Array of values as specified by the above params
222 public static function &valuesByID($id, $flip = FALSE, $grouping = FALSE, $localize = FALSE, $labelColumnName = 'label', $onlyActive = TRUE, $fresh = FALSE) {
223 $cacheKey = self
::createCacheKey($id, $flip, $grouping, $localize, $labelColumnName, $onlyActive);
225 $cache = CRM_Utils_Cache
::singleton();
227 $var = $cache->get($cacheKey);
233 SELECT v.{$labelColumnName} as {$labelColumnName} ,v.value as value, v.grouping as grouping
234 FROM civicrm_option_value v,
235 civicrm_option_group g
236 WHERE v.option_group_id = g.id
241 $query .= " AND v.is_active = 1 ";
243 $query .= " ORDER BY v.weight, v.label";
245 $p = array(1 => array($id, 'Integer'));
246 $dao = CRM_Core_DAO
::executeQuery($query, $p);
248 $var = self
::valuesCommon($dao, $flip, $grouping, $localize, $labelColumnName);
249 $cache->set($cacheKey, $var);
255 * Lookup titles OR ids for a set of option_value populated fields. The retrieved value
256 * is assigned a new fieldname by id or id's by title
257 * (each within a specificied option_group)
259 * @param array $params
260 * Reference array of values submitted by the form. Based on.
261 * $flip, creates new elements in $params for each field in
263 * If $flip = false, adds root field name => title
264 * If $flip = true, adds actual field name => id
266 * @param array $names
267 * Reference array of fieldnames we want transformed.
268 * Array key = 'postName' (field name submitted by form in $params).
269 * Array value = array('newName' => $newName, 'groupName' => $groupName).
274 public static function lookupValues(&$params, &$names, $flip = FALSE) {
275 foreach ($names as $postName => $value) {
276 // See if $params field is in $names array (i.e. is a value that we need to lookup)
277 if ($postalName = CRM_Utils_Array
::value($postName, $params)) {
278 $postValues = array();
279 // params[$postName] may be a Ctrl+A separated value list
280 if (is_string($postalName) &&
281 strpos($postalName, CRM_Core_DAO
::VALUE_SEPARATOR
) == FALSE
283 // eliminate the ^A frm the beginning and end if present
284 if (substr($postalName, 0, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
) {
285 $params[$postName] = substr($params[$postName], 1, -1);
287 $postValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $params[$postName]);
289 elseif (is_array($postalName)) {
290 $postValues = $postalName;
293 foreach ($postValues as $postValue) {
299 $p = array(1 => array($postValue, 'String'));
300 $lookupBy = 'v.label= %1';
304 $p = array(1 => array($postValue, 'Integer'));
305 $lookupBy = 'v.value = %1';
309 $p[2] = array($value['groupName'], 'String');
312 FROM civicrm_option_value v,
313 civicrm_option_group g
314 WHERE v.option_group_id = g.id
318 $newValue[] = CRM_Core_DAO
::singleValueQuery($query, $p);
319 $newValue = str_replace(',', '_', $newValue);
321 $params[$value['newName']] = implode(', ', $newValue);
327 * @deprecated - use CRM_Core_Pseudoconstant::getLabel
329 * @param string $groupName
331 * @param bool $onlyActiveValue
335 public static function getLabel($groupName, $value, $onlyActiveValue = TRUE) {
336 if (empty($groupName) ||
343 SELECT v.label as label ,v.value as value
344 FROM civicrm_option_value v,
345 civicrm_option_group g
346 WHERE v.option_group_id = g.id
351 if ($onlyActiveValue) {
352 $query .= " AND v.is_active = 1 ";
355 1 => array($groupName, 'String'),
356 2 => array($value, 'Integer'),
358 $dao = CRM_Core_DAO
::executeQuery($query, $p);
368 * This function is not cached.
370 * @param string $groupName
372 * @param string $labelField
373 * @param string $labelType
374 * @param string $valueField
378 public static function getValue(
381 $labelField = 'label',
382 $labelType = 'String',
383 $valueField = 'value'
390 SELECT v.label as label ,v.{$valueField} as value
391 FROM civicrm_option_value v,
392 civicrm_option_group g
393 WHERE v.option_group_id = g.id
397 AND v.$labelField = %2
401 1 => array($groupName, 'String'),
402 2 => array($label, $labelType),
404 $dao = CRM_Core_DAO
::executeQuery($query, $p);
414 * Get option_value.value from default option_value row for an option group
416 * @param string $groupName
417 * The name of the option group.
421 * the value from the row where is_default = true
423 public static function getDefaultValue($groupName) {
424 if (empty($groupName)) {
429 FROM civicrm_option_value v,
430 civicrm_option_group g
431 WHERE v.option_group_id = g.id
437 if (in_array($groupName, self
::$_domainIDGroups)) {
438 $query .= " AND v.domain_id = " . CRM_Core_Config
::domainID();
441 $p = array(1 => array($groupName, 'String'));
442 return CRM_Core_DAO
::singleValueQuery($query, $p);
446 * Creates a new option group with the passed in values.
447 * @TODO: Should update the group if it already exists intelligently, so multi-lingual is
448 * not messed up. Currently deletes the old group
450 * @param string $groupName
451 * The name of the option group - make sure there is no conflict.
452 * @param array $values
453 * The associative array that has information on the option values.
454 * the keys of this array are:
455 * string 'title' (required)
456 * string 'value' (required)
457 * string 'name' (optional)
458 * string 'description' (optional)
459 * int 'weight' (optional) - the order in which the value are displayed
460 * bool 'is_default' (optional) - is this the default one to display when rendered in form
461 * bool 'is_active' (optional) - should this element be rendered
462 * @param int $defaultID
463 * (reference) - the option value ID of the default element (if set) is returned else 'null'.
464 * @param null $groupTitle
465 * The optional label of the option group else set to group name.
469 * the option group ID
471 public static function createAssoc($groupName, &$values, &$defaultID, $groupTitle = NULL) {
472 self
::deleteAssoc($groupName);
473 if (!empty($values)) {
474 $group = new CRM_Core_DAO_OptionGroup();
475 $group->name
= $groupName;
476 $group->title
= empty($groupTitle) ?
$groupName : $groupTitle;
477 $group->is_reserved
= 1;
478 $group->is_active
= 1;
481 foreach ($values as $v) {
482 $value = new CRM_Core_DAO_OptionValue();
483 $value->option_group_id
= $group->id
;
484 $value->label
= $v['label'];
485 $value->value
= $v['value'];
486 $value->name
= CRM_Utils_Array
::value('name', $v);
487 $value->description
= CRM_Utils_Array
::value('description', $v);
488 $value->weight
= CRM_Utils_Array
::value('weight', $v);
489 $value->is_default
= CRM_Utils_Array
::value('is_default', $v);
490 $value->is_active
= CRM_Utils_Array
::value('is_active', $v);
493 if ($value->is_default
) {
494 $defaultID = $value->id
;
499 return $defaultID = 'null';
506 * @param string $groupName
509 * @param string $field
511 public static function getAssoc($groupName, &$values, $flip = FALSE, $field = 'name') {
513 SELECT v.id as amount_id, v.value, v.label, v.name, v.description, v.weight
514 FROM civicrm_option_group g,
515 civicrm_option_value v
516 WHERE g.id = v.option_group_id
520 $params = array(1 => array($groupName, 'String'));
521 $dao = CRM_Core_DAO
::executeQuery($query, $params);
523 $fields = array('value', 'label', 'name', 'description', 'amount_id', 'weight');
528 foreach ($fields as $field) {
529 $values[$field] = array();
534 while ($dao->fetch()) {
537 foreach ($fields as $field) {
538 $value[$field] = $dao->$field;
540 $values[$dao->amount_id
] = $value;
543 foreach ($fields as $field) {
544 $values[$field][$index] = $dao->$field;
552 * @param string $groupName
553 * @param string $operator
555 public static function deleteAssoc($groupName, $operator = "=") {
558 FROM civicrm_option_group g,
559 civicrm_option_value v
560 WHERE g.id = v.option_group_id
561 AND g.name {$operator} %1";
563 $params = array(1 => array($groupName, 'String'));
565 $dao = CRM_Core_DAO
::executeQuery($query, $params);
569 * @param string $groupName
571 * @param string $field
572 * @param string $fieldType
573 * @param bool $active
574 * @param bool $localize
575 * if true, localize the results before returning.
579 public static function getRowValues(
580 $groupName, $fieldValue, $field = 'name',
581 $fieldType = 'String', $active = TRUE, $localize = FALSE
584 SELECT v.id, v.label, v.value, v.name, v.weight, v.description
585 FROM civicrm_option_value v,
586 civicrm_option_group g
587 WHERE v.option_group_id = g.id
594 $query .= " AND v.is_active = 1";
598 1 => array($groupName, 'String'),
599 2 => array($fieldValue, $fieldType),
601 $dao = CRM_Core_DAO
::executeQuery($query, $p);
613 $row[$fld] = $dao->$fld;
614 if ($localize && in_array($fld, array('label', 'description'))) {
615 $row[$fld] = ts($row[$fld]);
624 * Wrapper for calling values with fresh set to true to empty the given value.
626 * Since there appears to be some inconsistency
627 * (@todo remove inconsistency) around the pseudoconstant operations
628 * (for example CRM_Contribution_Pseudoconstant::paymentInstrument doesn't specify isActive
629 * which is part of the cache key
630 * will do a couple of variations & aspire to someone cleaning it up later
632 * @param string $name
633 * @param array $params
635 public static function flush($name, $params = array()) {
641 'labelColumnName' => 'label',
644 $params = array_merge($defaults, $params);
650 $params['condition'],
651 $params['labelColumnName'],
660 $params['condition'],
661 $params['labelColumnName'],
667 public static function flushAll() {
668 self
::$_values = array();
669 self
::$_cache = array();
670 CRM_Utils_Cache
::singleton()->flush();