Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
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 | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 TO |
32 | */ |
33 | class CRM_Core_OptionGroup { | |
34 | static $_values = array(); | |
35 | static $_cache = array(); | |
36 | ||
d424ffde | 37 | /** |
6a488035 TO |
38 | * $_domainIDGroups array maintains the list of option groups for whom |
39 | * domainID is to be considered. | |
6a488035 TO |
40 | */ |
41 | static $_domainIDGroups = array( | |
42 | 'from_email_address', | |
43 | 'grant_type', | |
44 | ); | |
45 | ||
a0ee3941 | 46 | /** |
c490a46a | 47 | * @param CRM_Core_DAO $dao |
a0ee3941 EM |
48 | * @param bool $flip |
49 | * @param bool $grouping | |
50 | * @param bool $localize | |
51 | * @param string $valueColumnName | |
52 | * | |
53 | * @return array | |
54 | */ | |
2da40d21 | 55 | public static function &valuesCommon( |
6a488035 TO |
56 | $dao, $flip = FALSE, $grouping = FALSE, |
57 | $localize = FALSE, $valueColumnName = 'label' | |
58 | ) { | |
59 | self::$_values = array(); | |
60 | ||
61 | while ($dao->fetch()) { | |
62 | if ($flip) { | |
63 | if ($grouping) { | |
64 | self::$_values[$dao->value] = $dao->grouping; | |
65 | } | |
66 | else { | |
67 | self::$_values[$dao->{$valueColumnName}] = $dao->value; | |
68 | } | |
69 | } | |
70 | else { | |
71 | if ($grouping) { | |
72 | self::$_values[$dao->{$valueColumnName}] = $dao->grouping; | |
73 | } | |
74 | else { | |
75 | self::$_values[$dao->value] = $dao->{$valueColumnName}; | |
76 | } | |
77 | } | |
78 | } | |
79 | if ($localize) { | |
80 | $i18n = CRM_Core_I18n::singleton(); | |
81 | $i18n->localizeArray(self::$_values); | |
82 | } | |
83 | return self::$_values; | |
84 | } | |
85 | ||
86 | /** | |
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 | |
b44e3f84 | 90 | * 'label' in the label column and the 'id' or 'name' in the value column |
6a488035 | 91 | * |
5a4f6742 CW |
92 | * @param string $name |
93 | * name of the option group. | |
94 | * @param bool $flip | |
95 | * results are return in id => label format if false. | |
6a488035 | 96 | * if true, the results are reversed |
5a4f6742 CW |
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. | |
107 | * @param bool $fresh | |
108 | * ignore cache entries and go back to DB. | |
109 | * @param string $keyColumnName | |
110 | * the column to use for 'key'. | |
bf48aa29 | 111 | * @param string $orderBy |
03ba3ef1 | 112 | * the column to use for ordering. |
6a488035 | 113 | * |
a6c01b45 | 114 | * @return array |
bf48aa29 | 115 | * The values as specified by the params |
6a488035 | 116 | */ |
2da40d21 | 117 | public static function &values( |
6a488035 TO |
118 | $name, $flip = FALSE, $grouping = FALSE, |
119 | $localize = FALSE, $condition = NULL, | |
148136ae PN |
120 | $labelColumnName = 'label', $onlyActive = TRUE, $fresh = FALSE, $keyColumnName = 'value', |
121 | $orderBy = 'weight' | |
6a488035 | 122 | ) { |
be80e977 | 123 | $cache = CRM_Utils_Cache::singleton(); |
370d56eb | 124 | $cacheKey = self::createCacheKey($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName, $orderBy); |
6a488035 | 125 | |
c0c9cd82 CW |
126 | if (!$fresh) { |
127 | // Fetch from static var | |
128 | if (array_key_exists($cacheKey, self::$_cache)) { | |
129 | return self::$_cache[$cacheKey]; | |
130 | } | |
131 | // Fetch from main cache | |
c0c9cd82 CW |
132 | $var = $cache->get($cacheKey); |
133 | if ($var) { | |
134 | return $var; | |
135 | } | |
6a488035 TO |
136 | } |
137 | ||
138 | $query = " | |
c0c9cd82 | 139 | SELECT v.{$labelColumnName} as {$labelColumnName} ,v.{$keyColumnName} as value, v.grouping as grouping |
6a488035 TO |
140 | FROM civicrm_option_value v, |
141 | civicrm_option_group g | |
142 | WHERE v.option_group_id = g.id | |
143 | AND g.name = %1 | |
144 | AND g.is_active = 1 "; | |
145 | ||
146 | if ($onlyActive) { | |
147 | $query .= " AND v.is_active = 1 "; | |
98d41b7d CW |
148 | // Only show options for enabled components |
149 | $componentClause = ' v.component_id IS NULL '; | |
150 | $enabledComponents = CRM_Core_Config::singleton()->enableComponents; | |
151 | if ($enabledComponents) { | |
152 | $enabledComponents = '"' . implode('","', $enabledComponents) . '"'; | |
153 | $componentClause .= " OR v.component_id IN (SELECT id FROM civicrm_component WHERE name IN ($enabledComponents)) "; | |
154 | } | |
155 | $query .= " AND ($componentClause) "; | |
6a488035 TO |
156 | } |
157 | if (in_array($name, self::$_domainIDGroups)) { | |
158 | $query .= " AND v.domain_id = " . CRM_Core_Config::domainID(); | |
159 | } | |
160 | ||
161 | if ($condition) { | |
162 | $query .= $condition; | |
163 | } | |
164 | ||
148136ae | 165 | $query .= " ORDER BY v.{$orderBy}"; |
6a488035 TO |
166 | |
167 | $p = array(1 => array($name, 'String')); | |
168 | $dao = CRM_Core_DAO::executeQuery($query, $p); | |
169 | ||
170 | $var = self::valuesCommon($dao, $flip, $grouping, $localize, $labelColumnName); | |
171 | ||
172 | // call option value hook | |
173 | CRM_Utils_Hook::optionValues($var, $name); | |
174 | ||
175 | self::$_cache[$cacheKey] = $var; | |
176 | $cache->set($cacheKey, $var); | |
177 | ||
178 | return $var; | |
179 | } | |
180 | ||
181 | /** | |
182 | * Counterpart to values() which removes the item from the cache | |
183 | * | |
100fef9d | 184 | * @param string $name |
6a488035 TO |
185 | * @param $flip |
186 | * @param $grouping | |
187 | * @param $localize | |
188 | * @param $condition | |
100fef9d | 189 | * @param string $labelColumnName |
6a488035 | 190 | * @param $onlyActive |
da6b46f4 | 191 | * @param string $keyColumnName |
6a488035 | 192 | */ |
c0c9cd82 CW |
193 | protected static function flushValues($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName = 'value') { |
194 | $cacheKey = self::createCacheKey($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName); | |
6a488035 TO |
195 | $cache = CRM_Utils_Cache::singleton(); |
196 | $cache->delete($cacheKey); | |
197 | unset(self::$_cache[$cacheKey]); | |
198 | } | |
199 | ||
a0ee3941 EM |
200 | /** |
201 | * @return string | |
202 | */ | |
c0c9cd82 CW |
203 | protected static function createCacheKey() { |
204 | $cacheKey = "CRM_OG_" . serialize(func_get_args()); | |
6a488035 TO |
205 | return $cacheKey; |
206 | } | |
207 | ||
208 | /** | |
fe482240 | 209 | * This function retrieves all the values for the specific option group by id. |
6a488035 TO |
210 | * this is primarily used to create various html based form elements |
211 | * (radio, select, checkbox etc). OptionGroups for most cases have the | |
b44e3f84 | 212 | * 'label' in the label column and the 'id' or 'name' in the value column |
6a488035 | 213 | * |
5a4f6742 CW |
214 | * @param int $id |
215 | * id of the option group. | |
216 | * @param bool $flip | |
217 | * results are return in id => label format if false. | |
218 | * if true, the results are reversed | |
219 | * @param bool $grouping | |
220 | * if true, return the value in 'grouping' column. | |
221 | * @param bool $localize | |
222 | * if true, localize the results before returning. | |
223 | * @param string $labelColumnName | |
224 | * the column to use for 'label'. | |
da6b46f4 EM |
225 | * @param bool $onlyActive |
226 | * @param bool $fresh | |
227 | * | |
a6c01b45 | 228 | * @return array |
16b10e64 | 229 | * Array of values as specified by the above params |
6a488035 TO |
230 | * @void |
231 | */ | |
00be9182 | 232 | public static function &valuesByID($id, $flip = FALSE, $grouping = FALSE, $localize = FALSE, $labelColumnName = 'label', $onlyActive = TRUE, $fresh = FALSE) { |
786ad6e1 | 233 | $cacheKey = self::createCacheKey($id, $flip, $grouping, $localize, $labelColumnName, $onlyActive); |
6a488035 TO |
234 | |
235 | $cache = CRM_Utils_Cache::singleton(); | |
786ad6e1 CW |
236 | if (!$fresh) { |
237 | $var = $cache->get($cacheKey); | |
238 | if ($var) { | |
239 | return $var; | |
240 | } | |
6a488035 TO |
241 | } |
242 | $query = " | |
243 | SELECT v.{$labelColumnName} as {$labelColumnName} ,v.value as value, v.grouping as grouping | |
244 | FROM civicrm_option_value v, | |
245 | civicrm_option_group g | |
246 | WHERE v.option_group_id = g.id | |
247 | AND g.id = %1 | |
6a488035 | 248 | AND g.is_active = 1 |
6a488035 | 249 | "; |
786ad6e1 CW |
250 | if ($onlyActive) { |
251 | $query .= " AND v.is_active = 1 "; | |
252 | } | |
253 | $query .= " ORDER BY v.weight, v.label"; | |
254 | ||
6a488035 TO |
255 | $p = array(1 => array($id, 'Integer')); |
256 | $dao = CRM_Core_DAO::executeQuery($query, $p); | |
257 | ||
258 | $var = self::valuesCommon($dao, $flip, $grouping, $localize, $labelColumnName); | |
259 | $cache->set($cacheKey, $var); | |
260 | ||
261 | return $var; | |
262 | } | |
263 | ||
264 | /** | |
59cba00c J |
265 | * Lookup titles OR ids for a set of option_value populated fields. The |
266 | * retrieved value is assigned a new field name by id or id's by title | |
267 | * (each within a specified option_group). | |
6a488035 | 268 | * |
6a0b768e TO |
269 | * @param array $params |
270 | * Reference array of values submitted by the form. Based on. | |
5a4f6742 CW |
271 | * $flip, creates new elements in $params for each field in |
272 | * the $names array. | |
273 | * If $flip = false, adds root field name => title | |
274 | * If $flip = true, adds actual field name => id | |
6a488035 | 275 | * |
6a0b768e | 276 | * @param array $names |
59cba00c | 277 | * Array of field names we want transformed. |
5a4f6742 CW |
278 | * Array key = 'postName' (field name submitted by form in $params). |
279 | * Array value = array('newName' => $newName, 'groupName' => $groupName). | |
6a488035 | 280 | * |
2aa397bc | 281 | * @param bool $flip |
6a488035 | 282 | */ |
f2e3129e | 283 | public static function lookupValues(&$params, $names, $flip = FALSE) { |
6a488035 TO |
284 | foreach ($names as $postName => $value) { |
285 | // See if $params field is in $names array (i.e. is a value that we need to lookup) | |
286 | if ($postalName = CRM_Utils_Array::value($postName, $params)) { | |
287 | $postValues = array(); | |
288 | // params[$postName] may be a Ctrl+A separated value list | |
289 | if (is_string($postalName) && | |
290 | strpos($postalName, CRM_Core_DAO::VALUE_SEPARATOR) == FALSE | |
291 | ) { | |
292 | // eliminate the ^A frm the beginning and end if present | |
293 | if (substr($postalName, 0, 1) == CRM_Core_DAO::VALUE_SEPARATOR) { | |
294 | $params[$postName] = substr($params[$postName], 1, -1); | |
295 | } | |
296 | $postValues = explode(CRM_Core_DAO::VALUE_SEPARATOR, $params[$postName]); | |
297 | } | |
298 | elseif (is_array($postalName)) { | |
299 | $postValues = $postalName; | |
300 | } | |
301 | $newValue = array(); | |
302 | foreach ($postValues as $postValue) { | |
303 | if (!$postValue) { | |
304 | continue; | |
305 | } | |
306 | ||
307 | if ($flip) { | |
353ffa53 | 308 | $p = array(1 => array($postValue, 'String')); |
6a488035 | 309 | $lookupBy = 'v.label= %1'; |
353ffa53 | 310 | $select = "v.value"; |
6a488035 TO |
311 | } |
312 | else { | |
353ffa53 | 313 | $p = array(1 => array($postValue, 'Integer')); |
6a488035 | 314 | $lookupBy = 'v.value = %1'; |
353ffa53 | 315 | $select = "v.label"; |
6a488035 TO |
316 | } |
317 | ||
318 | $p[2] = array($value['groupName'], 'String'); | |
319 | $query = " | |
320 | SELECT $select | |
321 | FROM civicrm_option_value v, | |
322 | civicrm_option_group g | |
323 | WHERE v.option_group_id = g.id | |
324 | AND g.name = %2 | |
325 | AND $lookupBy"; | |
326 | ||
327 | $newValue[] = CRM_Core_DAO::singleValueQuery($query, $p); | |
328 | $newValue = str_replace(',', '_', $newValue); | |
329 | } | |
330 | $params[$value['newName']] = implode(', ', $newValue); | |
331 | } | |
332 | } | |
333 | } | |
334 | ||
a0ee3941 | 335 | /** |
d6f7dc03 | 336 | * @deprecated - use CRM_Core_Pseudoconstant::getLabel |
337 | * | |
100fef9d | 338 | * @param string $groupName |
a0ee3941 EM |
339 | * @param $value |
340 | * @param bool $onlyActiveValue | |
341 | * | |
342 | * @return null | |
343 | */ | |
00be9182 | 344 | public static function getLabel($groupName, $value, $onlyActiveValue = TRUE) { |
6a59e510 | 345 | Civi::log()->warning('Deprecated function, use CRM_Core_PseudoConstant::getLabel', array('civi.tag' => 'deprecated')); |
6a488035 TO |
346 | if (empty($groupName) || |
347 | empty($value) | |
348 | ) { | |
349 | return NULL; | |
350 | } | |
351 | ||
352 | $query = " | |
353 | SELECT v.label as label ,v.value as value | |
354 | FROM civicrm_option_value v, | |
355 | civicrm_option_group g | |
356 | WHERE v.option_group_id = g.id | |
357 | AND g.name = %1 | |
358 | AND g.is_active = 1 | |
359 | AND v.value = %2 | |
360 | "; | |
361 | if ($onlyActiveValue) { | |
362 | $query .= " AND v.is_active = 1 "; | |
363 | } | |
2aa397bc | 364 | $p = array( |
353ffa53 | 365 | 1 => array($groupName, 'String'), |
6a488035 TO |
366 | 2 => array($value, 'Integer'), |
367 | ); | |
368 | $dao = CRM_Core_DAO::executeQuery($query, $p); | |
369 | if ($dao->fetch()) { | |
370 | return $dao->label; | |
371 | } | |
372 | return NULL; | |
373 | } | |
374 | ||
a0ee3941 | 375 | /** |
76c28c8d DG |
376 | * @deprecated |
377 | * | |
378 | * This function is not cached. | |
379 | * | |
100fef9d | 380 | * @param string $groupName |
a0ee3941 EM |
381 | * @param $label |
382 | * @param string $labelField | |
383 | * @param string $labelType | |
384 | * @param string $valueField | |
385 | * | |
386 | * @return null | |
387 | */ | |
2da40d21 | 388 | public static function getValue( |
f9f40af3 | 389 | $groupName, |
6a488035 TO |
390 | $label, |
391 | $labelField = 'label', | |
2aa397bc | 392 | $labelType = 'String', |
6a488035 TO |
393 | $valueField = 'value' |
394 | ) { | |
395 | if (empty($label)) { | |
396 | return NULL; | |
397 | } | |
398 | ||
6a59e510 | 399 | Civi::log()->warning('Deprecated function, use CRM_Core_PseudoConstant::getKey', array('civi.tag' => 'deprecated')); |
400 | ||
6a488035 TO |
401 | $query = " |
402 | SELECT v.label as label ,v.{$valueField} as value | |
403 | FROM civicrm_option_value v, | |
404 | civicrm_option_group g | |
405 | WHERE v.option_group_id = g.id | |
406 | AND g.name = %1 | |
407 | AND v.is_active = 1 | |
408 | AND g.is_active = 1 | |
409 | AND v.$labelField = %2 | |
410 | "; | |
411 | ||
2aa397bc | 412 | $p = array( |
353ffa53 | 413 | 1 => array($groupName, 'String'), |
6a488035 TO |
414 | 2 => array($label, $labelType), |
415 | ); | |
416 | $dao = CRM_Core_DAO::executeQuery($query, $p); | |
417 | if ($dao->fetch()) { | |
418 | $dao->free(); | |
419 | return $dao->value; | |
420 | } | |
421 | $dao->free(); | |
422 | return NULL; | |
423 | } | |
424 | ||
343d84fa DG |
425 | /** |
426 | * Get option_value.value from default option_value row for an option group | |
427 | * | |
6a0b768e TO |
428 | * @param string $groupName |
429 | * The name of the option group. | |
343d84fa | 430 | * |
343d84fa | 431 | * |
a6c01b45 CW |
432 | * @return string |
433 | * the value from the row where is_default = true | |
8ef12e64 | 434 | */ |
00be9182 | 435 | public static function getDefaultValue($groupName) { |
343d84fa DG |
436 | if (empty($groupName)) { |
437 | return NULL; | |
438 | } | |
439 | $query = " | |
440 | SELECT v.value | |
441 | FROM civicrm_option_value v, | |
442 | civicrm_option_group g | |
443 | WHERE v.option_group_id = g.id | |
444 | AND g.name = %1 | |
445 | AND v.is_active = 1 | |
446 | AND g.is_active = 1 | |
447 | AND v.is_default = 1 | |
448 | "; | |
449 | if (in_array($groupName, self::$_domainIDGroups)) { | |
450 | $query .= " AND v.domain_id = " . CRM_Core_Config::domainID(); | |
451 | } | |
452 | ||
453 | $p = array(1 => array($groupName, 'String')); | |
454 | return CRM_Core_DAO::singleValueQuery($query, $p); | |
455 | } | |
8ef12e64 | 456 | |
6a488035 | 457 | /** |
d09edf64 | 458 | * Creates a new option group with the passed in values. |
6a488035 TO |
459 | * @TODO: Should update the group if it already exists intelligently, so multi-lingual is |
460 | * not messed up. Currently deletes the old group | |
461 | * | |
6a0b768e TO |
462 | * @param string $groupName |
463 | * The name of the option group - make sure there is no conflict. | |
464 | * @param array $values | |
465 | * The associative array that has information on the option values. | |
6a488035 TO |
466 | * the keys of this array are: |
467 | * string 'title' (required) | |
468 | * string 'value' (required) | |
469 | * string 'name' (optional) | |
470 | * string 'description' (optional) | |
471 | * int 'weight' (optional) - the order in which the value are displayed | |
472 | * bool 'is_default' (optional) - is this the default one to display when rendered in form | |
473 | * bool 'is_active' (optional) - should this element be rendered | |
6a0b768e TO |
474 | * @param int $defaultID |
475 | * (reference) - the option value ID of the default element (if set) is returned else 'null'. | |
476 | * @param null $groupTitle | |
477 | * The optional label of the option group else set to group name. | |
6a488035 | 478 | * |
6a488035 | 479 | * |
a6c01b45 CW |
480 | * @return int |
481 | * the option group ID | |
6a488035 | 482 | */ |
00be9182 | 483 | public static function createAssoc($groupName, &$values, &$defaultID, $groupTitle = NULL) { |
6a488035 TO |
484 | self::deleteAssoc($groupName); |
485 | if (!empty($values)) { | |
353ffa53 TO |
486 | $group = new CRM_Core_DAO_OptionGroup(); |
487 | $group->name = $groupName; | |
488 | $group->title = empty($groupTitle) ? $groupName : $groupTitle; | |
6a488035 | 489 | $group->is_reserved = 1; |
353ffa53 | 490 | $group->is_active = 1; |
6a488035 TO |
491 | $group->save(); |
492 | ||
493 | foreach ($values as $v) { | |
494 | $value = new CRM_Core_DAO_OptionValue(); | |
495 | $value->option_group_id = $group->id; | |
496 | $value->label = $v['label']; | |
497 | $value->value = $v['value']; | |
498 | $value->name = CRM_Utils_Array::value('name', $v); | |
499 | $value->description = CRM_Utils_Array::value('description', $v); | |
500 | $value->weight = CRM_Utils_Array::value('weight', $v); | |
501 | $value->is_default = CRM_Utils_Array::value('is_default', $v); | |
502 | $value->is_active = CRM_Utils_Array::value('is_active', $v); | |
503 | $value->save(); | |
504 | ||
505 | if ($value->is_default) { | |
506 | $defaultID = $value->id; | |
507 | } | |
508 | } | |
509 | } | |
510 | else { | |
511 | return $defaultID = 'null'; | |
512 | } | |
513 | ||
514 | return $group->id; | |
515 | } | |
516 | ||
a0ee3941 | 517 | /** |
100fef9d | 518 | * @param string $groupName |
a0ee3941 EM |
519 | * @param $values |
520 | * @param bool $flip | |
521 | * @param string $field | |
522 | */ | |
00be9182 | 523 | public static function getAssoc($groupName, &$values, $flip = FALSE, $field = 'name') { |
6a488035 TO |
524 | $query = " |
525 | SELECT v.id as amount_id, v.value, v.label, v.name, v.description, v.weight | |
526 | FROM civicrm_option_group g, | |
527 | civicrm_option_value v | |
528 | WHERE g.id = v.option_group_id | |
529 | AND g.$field = %1 | |
530 | ORDER BY v.weight | |
531 | "; | |
532 | $params = array(1 => array($groupName, 'String')); | |
533 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
534 | ||
535 | $fields = array('value', 'label', 'name', 'description', 'amount_id', 'weight'); | |
536 | if ($flip) { | |
537 | $values = array(); | |
538 | } | |
539 | else { | |
540 | foreach ($fields as $field) { | |
541 | $values[$field] = array(); | |
542 | } | |
543 | } | |
544 | $index = 1; | |
545 | ||
546 | while ($dao->fetch()) { | |
547 | if ($flip) { | |
548 | $value = array(); | |
549 | foreach ($fields as $field) { | |
550 | $value[$field] = $dao->$field; | |
551 | } | |
552 | $values[$dao->amount_id] = $value; | |
553 | } | |
554 | else { | |
555 | foreach ($fields as $field) { | |
556 | $values[$field][$index] = $dao->$field; | |
557 | } | |
558 | $index++; | |
559 | } | |
560 | } | |
561 | } | |
562 | ||
a0ee3941 | 563 | /** |
100fef9d | 564 | * @param string $groupName |
a0ee3941 EM |
565 | * @param string $operator |
566 | */ | |
00be9182 | 567 | public static function deleteAssoc($groupName, $operator = "=") { |
6a488035 TO |
568 | $query = " |
569 | DELETE g, v | |
570 | FROM civicrm_option_group g, | |
571 | civicrm_option_value v | |
572 | WHERE g.id = v.option_group_id | |
573 | AND g.name {$operator} %1"; | |
574 | ||
575 | $params = array(1 => array($groupName, 'String')); | |
576 | ||
577 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
578 | } | |
579 | ||
a0ee3941 | 580 | /** |
100fef9d | 581 | * @param string $groupName |
a0ee3941 EM |
582 | * @param $fieldValue |
583 | * @param string $field | |
584 | * @param string $fieldType | |
585 | * @param bool $active | |
bc3364a9 ML |
586 | * @param bool $localize |
587 | * if true, localize the results before returning. | |
a0ee3941 EM |
588 | * |
589 | * @return array | |
590 | */ | |
2da40d21 | 591 | public static function getRowValues( |
f9f40af3 | 592 | $groupName, $fieldValue, $field = 'name', |
bc3364a9 | 593 | $fieldType = 'String', $active = TRUE, $localize = FALSE |
6a488035 TO |
594 | ) { |
595 | $query = " | |
596 | SELECT v.id, v.label, v.value, v.name, v.weight, v.description | |
597 | FROM civicrm_option_value v, | |
598 | civicrm_option_group g | |
599 | WHERE v.option_group_id = g.id | |
600 | AND g.name = %1 | |
601 | AND g.is_active = 1 | |
602 | AND v.$field = %2 | |
603 | "; | |
604 | ||
605 | if ($active) { | |
606 | $query .= " AND v.is_active = 1"; | |
607 | } | |
608 | ||
2aa397bc | 609 | $p = array( |
353ffa53 | 610 | 1 => array($groupName, 'String'), |
6a488035 TO |
611 | 2 => array($fieldValue, $fieldType), |
612 | ); | |
613 | $dao = CRM_Core_DAO::executeQuery($query, $p); | |
614 | $row = array(); | |
615 | ||
616 | if ($dao->fetch()) { | |
617 | foreach (array( | |
353ffa53 TO |
618 | 'id', |
619 | 'name', | |
620 | 'value', | |
621 | 'label', | |
622 | 'weight', | |
af9b09df | 623 | 'description', |
353ffa53 | 624 | ) as $fld) { |
6a488035 | 625 | $row[$fld] = $dao->$fld; |
f623b0e8 | 626 | if ($localize && in_array($fld, array('label', 'description'))) { |
03c70eeb | 627 | $row[$fld] = ts($row[$fld]); |
628 | } | |
bc3364a9 ML |
629 | } |
630 | } | |
631 | ||
6a488035 TO |
632 | return $row; |
633 | } | |
634 | ||
d424ffde | 635 | /** |
d09edf64 | 636 | * Wrapper for calling values with fresh set to true to empty the given value. |
6a488035 TO |
637 | * |
638 | * Since there appears to be some inconsistency | |
639 | * (@todo remove inconsistency) around the pseudoconstant operations | |
640 | * (for example CRM_Contribution_Pseudoconstant::paymentInstrument doesn't specify isActive | |
641 | * which is part of the cache key | |
642 | * will do a couple of variations & aspire to someone cleaning it up later | |
d424ffde CW |
643 | * |
644 | * @param string $name | |
a0ee3941 EM |
645 | * @param array $params |
646 | */ | |
9b873358 | 647 | public static function flush($name, $params = array()) { |
6a488035 TO |
648 | $defaults = array( |
649 | 'flip' => FALSE, | |
650 | 'grouping' => FALSE, | |
651 | 'localize' => FALSE, | |
652 | 'condition' => NULL, | |
653 | 'labelColumnName' => 'label', | |
654 | ); | |
655 | ||
656 | $params = array_merge($defaults, $params); | |
657 | self::flushValues( | |
658 | $name, | |
659 | $params['flip'], | |
660 | $params['grouping'], | |
661 | $params['localize'], | |
662 | $params['condition'], | |
663 | $params['labelColumnName'], | |
664 | TRUE, | |
665 | TRUE | |
666 | ); | |
667 | self::flushValues( | |
668 | $name, | |
669 | $params['flip'], | |
670 | $params['grouping'], | |
671 | $params['localize'], | |
672 | $params['condition'], | |
673 | $params['labelColumnName'], | |
674 | FALSE, | |
675 | TRUE | |
676 | ); | |
677 | } | |
678 | ||
00be9182 | 679 | public static function flushAll() { |
6a488035 TO |
680 | self::$_values = array(); |
681 | self::$_cache = array(); | |
a4a33486 | 682 | CRM_Utils_Cache::singleton()->flush(); |
6a488035 | 683 | } |
96025800 | 684 | |
6a488035 | 685 | } |