3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
14 * Stores all constants and pseudo constants for CRM application.
16 * examples of constants are "Contact Type" which will always be either
17 * 'Individual', 'Household', 'Organization'.
19 * pseudo constants are entities from the database whose values rarely
20 * change. examples are list of countries, states, location types,
23 * currently we're getting the data from the underlying database. this
24 * will be reworked to use caching.
26 * Note: All pseudoconstants should be uninitialized or default to NULL.
27 * This provides greater consistency/predictability after flushing.
30 * @copyright CiviCRM LLC https://civicrm.org/licensing
32 class CRM_Core_PseudoConstant
{
35 * Static cache for pseudoconstant arrays.
38 private static $cache;
43 * @deprecated Please use the buildOptions() method in the appropriate BAO object.
45 private static $activityType;
51 private static $stateProvince;
57 private static $county;
60 * States/provinces abbreviations
63 private static $stateProvinceAbbreviation = [];
69 private static $country;
75 private static $countryIsoCode;
80 * @deprecated Please use the buildOptions() method in the appropriate BAO object.
82 private static $group;
88 private static $relationshipType = [];
91 * Civicrm groups that are not smart groups
94 private static $staticGroup;
100 private static $currencyCode;
106 private static $paymentProcessor;
109 * Payment processor types
112 private static $paymentProcessorType;
118 private static $worldRegions;
123 * @deprecated Please use the buildOptions() method in the appropriate BAO object.
125 private static $activityStatus;
131 private static $visibility;
137 private static $greeting;
140 * Extensions of type module
143 private static $extensions;
146 * Financial Account Type
149 private static $accountOptionValues;
152 * Low-level option getter, rarely accessed directly.
153 * NOTE: Rather than calling this function directly use CRM_*_BAO_*::buildOptions()
154 * @see https://docs.civicrm.org/dev/en/latest/framework/pseudoconstant/
156 * NOTE: If someone undertakes a refactoring of this, please consider the use-case of
157 * the Setting.getoptions API. There is no DAO/field, but it would be nice to use the
158 * same 'pseudoconstant' struct in *.settings.php. This means loosening the coupling
159 * between $field lookup and the $pseudoconstant evaluation.
161 * @param string $daoName
162 * @param string $fieldName
163 * @param array $params
164 * - name string name of the option group
165 * - flip boolean results are return in id => label format if false
166 * if true, the results are reversed
167 * - grouping boolean if true, return the value in 'grouping' column (currently unsupported for tables other than option_value)
168 * - localize boolean if true, localize the results before returning
169 * - condition string|array add condition(s) to the sql query - will be concatenated using 'AND'
170 * - keyColumn string the column to use for 'id'
171 * - labelColumn string the column to use for 'label'
172 * - orderColumn string the column to use for sorting, defaults to 'weight' column if one exists, else defaults to labelColumn
173 * - onlyActive boolean return only the action option values
174 * - fresh boolean ignore cache entries and go back to DB
175 * @param string $context : Context string
176 * @see CRM_Core_DAO::buildOptionsContext
179 * array on success, FALSE on error.
182 public static function get($daoName, $fieldName, $params = [], $context = NULL) {
183 CRM_Core_DAO
::buildOptionsContext($context);
184 $flip = !empty($params['flip']);
185 // Historically this was 'false' but according to the notes in
186 // CRM_Core_DAO::buildOptionsContext it should be context dependent.
187 // timidly changing for 'search' only to fix world_region in search options.
188 $localizeDefault = in_array($context, ['search']);
189 // Merge params with defaults
192 'localize' => $localizeDefault,
193 'onlyActive' => !($context == 'validate' ||
$context == 'get'),
195 'context' => $context,
197 $entity = CRM_Core_DAO_AllCoreTables
::getBriefName($daoName);
199 // Custom fields are not in the schema
200 if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
201 $customField = new CRM_Core_BAO_CustomField();
202 $customField->id
= (int) substr($fieldName, 7);
203 $options = $customField->getOptions($context);
204 if ($options && $flip) {
205 $options = array_flip($options);
210 // Core field: load schema
211 $dao = new $daoName();
212 $fieldSpec = $dao->getFieldSpec($fieldName);
214 // Return false if field doesn't exist.
215 if (empty($fieldSpec)) {
219 // Ensure we have the canonical name for this field
220 $fieldName = $fieldSpec['name'] ??
$fieldName;
222 if (!empty($fieldSpec['pseudoconstant'])) {
223 $pseudoconstant = $fieldSpec['pseudoconstant'];
225 // if callback is specified..
226 if (!empty($pseudoconstant['callback'])) {
227 $fieldOptions = call_user_func(Civi\Core\Resolver
::singleton()->get($pseudoconstant['callback']), $context, $params);
228 //CRM-18223: Allow additions to field options via hook.
229 CRM_Utils_Hook
::fieldOptions($entity, $fieldName, $fieldOptions, $params);
230 return $fieldOptions;
233 // Merge params with schema defaults
235 'condition' => $pseudoconstant['condition'] ??
[],
236 'keyColumn' => $pseudoconstant['keyColumn'] ??
NULL,
237 'labelColumn' => $pseudoconstant['labelColumn'] ??
NULL,
240 // Fetch option group from option_value table
241 if (!empty($pseudoconstant['optionGroupName'])) {
242 if ($context == 'validate') {
243 $params['labelColumn'] = 'name';
245 if ($context == 'match') {
246 $params['keyColumn'] = 'name';
248 // Call our generic fn for retrieving from the option_value table
249 $options = CRM_Core_OptionGroup
::values(
250 $pseudoconstant['optionGroupName'],
254 $params['condition'] ?
' AND ' . implode(' AND ', (array) $params['condition']) : NULL,
255 $params['labelColumn'] ?
$params['labelColumn'] : 'label',
256 $params['onlyActive'],
258 $params['keyColumn'] ?
$params['keyColumn'] : 'value',
259 !empty($params['orderColumn']) ?
$params['orderColumn'] : 'weight'
261 CRM_Utils_Hook
::fieldOptions($entity, $fieldName, $options, $params);
265 // Fetch options from other tables
266 if (!empty($pseudoconstant['table'])) {
267 CRM_Utils_Array
::remove($params, 'flip', 'fresh');
268 // Normalize params so the serialized cache string will be consistent.
270 $cacheKey = $daoName . $fieldName . serialize($params);
271 // Retrieve cached options
272 if (isset(\Civi
::$statics[__CLASS__
][$cacheKey]) && empty($params['fresh'])) {
273 $output = \Civi
::$statics[__CLASS__
][$cacheKey];
276 $output = self
::renderOptionsFromTablePseudoconstant($pseudoconstant, $params, ($fieldSpec['localize_context'] ??
NULL), $context);
277 CRM_Utils_Hook
::fieldOptions($entity, $fieldName, $output, $params);
278 \Civi
::$statics[__CLASS__
][$cacheKey] = $output;
280 return $flip ?
array_flip($output) : $output;
284 // Return "Yes" and "No" for boolean fields
285 elseif (CRM_Utils_Array
::value('type', $fieldSpec) === CRM_Utils_Type
::T_BOOLEAN
) {
286 $output = $context == 'validate' ?
[0, 1] : CRM_Core_SelectValues
::boolean();
287 CRM_Utils_Hook
::fieldOptions($entity, $fieldName, $output, $params);
288 return $flip ?
array_flip($output) : $output;
290 // If we're still here, it's an error. Return FALSE.
295 * Fetch the translated label for a field given its key.
297 * @param string $baoName
298 * @param string $fieldName
299 * @param string|int $key
301 * TODO: Accept multivalued input?
303 * @return bool|null|string
304 * FALSE if the given field has no associated option list
305 * NULL if the given key has no corresponding option
306 * String if label is found
308 public static function getLabel($baoName, $fieldName, $key) {
309 $values = $baoName::buildOptions($fieldName, 'get');
310 if ($values === FALSE) {
313 return $values[$key] ??
NULL;
317 * Fetch the machine name for a field given its key.
319 * @param string $baoName
320 * @param string $fieldName
321 * @param string|int $key
323 * @return bool|null|string
324 * FALSE if the given field has no associated option list
325 * NULL if the given key has no corresponding option
326 * String if label is found
328 public static function getName($baoName, $fieldName, $key) {
329 $values = $baoName::buildOptions($fieldName, 'validate');
330 if ($values === FALSE) {
333 return $values[$key] ??
NULL;
337 * Fetch the key for a field option given its name.
339 * @param string $baoName
340 * @param string $fieldName
341 * @param string|int $value
343 * @return bool|null|string|int
344 * FALSE if the given field has no associated option list
345 * NULL if the given key has no corresponding option
346 * String|Number if key is found
348 public static function getKey($baoName, $fieldName, $value) {
349 $values = $baoName::buildOptions($fieldName, 'validate');
350 if ($values === FALSE) {
353 return CRM_Utils_Array
::key($value, $values);
357 * Lookup the admin page at which a field's option list can be edited
359 * @return string|null
361 public static function getOptionEditUrl($fieldSpec) {
362 // If it's an option group, that's easy
363 if (!empty($fieldSpec['pseudoconstant']['optionGroupName'])) {
364 return 'civicrm/admin/options/' . $fieldSpec['pseudoconstant']['optionGroupName'];
366 // For everything else...
367 elseif (!empty($fieldSpec['pseudoconstant']['table'])) {
368 $daoName = CRM_Core_DAO_AllCoreTables
::getClassForTable($fieldSpec['pseudoconstant']['table']);
372 // We don't have good mapping so have to do a bit of guesswork from the menu
373 list(, $parent, , $child) = explode('_', $daoName);
374 $sql = "SELECT path FROM civicrm_menu
375 WHERE page_callback LIKE '%CRM_Admin_Page_$child%' OR page_callback LIKE '%CRM_{$parent}_Page_$child%'
376 ORDER BY page_callback
378 return CRM_Core_DAO
::singleValueQuery($sql);
384 * @deprecated generic populate method.
385 * All pseudoconstant functions that use this method are also @deprecated
387 * The static array $var is populated from the db
388 * using the <b>$name DAO</b>.
390 * Note: any database errors will be trapped by the DAO.
393 * The associative array we will fill.
394 * @param string $name
395 * The name of the DAO.
397 * Get all objects. default is to get only active ones.
398 * @param string $retrieve
399 * The field that we are interested in (normally name, differs in some objects).
400 * @param string $filter
401 * The field that we want to filter the result set with.
402 * @param string $condition
403 * The condition that gets passed to the final query as the WHERE clause.
405 * @param bool $orderby
411 public static function populate(
416 $filter = 'is_active',
422 $cacheKey = CRM_Utils_Cache
::cleanKey("CRM_PC_{$name}_{$all}_{$key}_{$retrieve}_{$filter}_{$condition}_{$orderby}");
423 $cache = CRM_Utils_Cache
::singleton();
424 $var = $cache->get($cacheKey);
425 if ($var !== NULL && empty($force)) {
429 /* @var CRM_Core_DAO $object */
430 $object = new $name();
432 $object->selectAdd();
433 $object->selectAdd("$key, $retrieve");
435 $object->whereAdd($condition);
439 $object->orderBy($retrieve);
442 $object->orderBy($orderby);
446 $object->$filter = 1;
447 $aclClauses = array_filter($name::getSelectWhereClause());
448 foreach ($aclClauses as $clause) {
449 $object->whereAdd($clause);
455 while ($object->fetch()) {
456 $var[$object->$key] = $object->$retrieve;
459 $cache->set($cacheKey, $var);
463 * Flush given pseudoconstant so it can be reread from db.
464 * nex time it's requested.
466 * @param bool|string $name pseudoconstant to be flushed
468 public static function flush($name = 'cache') {
469 if (isset(self
::$
$name)) {
472 if ($name == 'cache') {
473 CRM_Core_OptionGroup
::flushAll();
474 if (isset(\Civi
::$statics[__CLASS__
])) {
475 unset(\Civi
::$statics[__CLASS__
]);
481 * @deprecated Please use the buildOptions() method in the appropriate BAO object.
483 * Get all Activty types.
485 * The static array activityType is returned
489 * array reference of all activity types.
491 public static function &activityType() {
492 $args = func_get_args();
493 $all = CRM_Utils_Array
::value(0, $args, TRUE);
494 $includeCaseActivities = CRM_Utils_Array
::value(1, $args, FALSE);
495 $reset = CRM_Utils_Array
::value(2, $args, FALSE);
496 $returnColumn = CRM_Utils_Array
::value(3, $args, 'label');
497 $includeCampaignActivities = CRM_Utils_Array
::value(4, $args, FALSE);
498 $onlyComponentActivities = CRM_Utils_Array
::value(5, $args, FALSE);
499 $index = (int) $all . '_' . $returnColumn . '_' . (int) $includeCaseActivities;
500 $index .= '_' . (int) $includeCampaignActivities;
501 $index .= '_' . (int) $onlyComponentActivities;
503 if (NULL === self
::$activityType) {
504 self
::$activityType = [];
507 if (!isset(self
::$activityType[$index]) ||
$reset) {
510 $condition = 'AND filter = 0';
512 $componentClause = " v.component_id IS NULL";
513 if ($onlyComponentActivities) {
514 $componentClause = " v.component_id IS NOT NULL";
518 $compInfo = CRM_Core_Component
::getEnabledComponents();
520 // build filter for listing activity types only if their
521 // respective components are enabled
522 foreach ($compInfo as $compName => $compObj) {
523 if ($compName == 'CiviCase') {
524 if ($includeCaseActivities) {
525 $componentIds[] = $compObj->componentID
;
528 elseif ($compName == 'CiviCampaign') {
529 if ($includeCampaignActivities) {
530 $componentIds[] = $compObj->componentID
;
534 $componentIds[] = $compObj->componentID
;
538 if (count($componentIds)) {
539 $componentIds = implode(',', $componentIds);
540 $componentClause = " ($componentClause OR v.component_id IN ($componentIds))";
541 if ($onlyComponentActivities) {
542 $componentClause = " ( v.component_id IN ($componentIds ) )";
545 $condition = $condition . ' AND ' . $componentClause;
547 self
::$activityType[$index] = CRM_Core_OptionGroup
::values('activity_type', FALSE, FALSE, FALSE, $condition, $returnColumn);
549 return self
::$activityType[$index];
553 * Get all the State/Province from database.
555 * The static array stateProvince is returned, and if it's
556 * called the first time, the <b>State Province DAO</b> is used
557 * to get all the States.
559 * Note: any database errors will be trapped by the DAO.
562 * @param bool|int $id - Optional id to return
567 * array reference of all State/Provinces.
569 public static function &stateProvince($id = FALSE, $limit = TRUE) {
570 if (($id && empty(self
::$stateProvince[$id])) ||
!self
::$stateProvince ||
!$id) {
571 $whereClause = FALSE;
573 $countryIsoCodes = self
::countryIsoCode();
574 $limitCodes = CRM_Core_BAO_Country
::provinceLimit();
576 foreach ($limitCodes as $code) {
577 $limitIds = array_merge($limitIds, array_keys($countryIsoCodes, $code));
579 if (!empty($limitIds)) {
580 $whereClause = 'country_id IN (' . implode(', ', $limitIds) . ')';
583 $whereClause = FALSE;
586 self
::populate(self
::$stateProvince, 'CRM_Core_DAO_StateProvince', TRUE, 'name', 'is_active', $whereClause);
588 // localise the province names if in an non-en_US locale
589 $tsLocale = CRM_Core_I18n
::getLocale();
590 if ($tsLocale != '' and $tsLocale != 'en_US') {
591 $i18n = CRM_Core_I18n
::singleton();
592 $i18n->localizeArray(self
::$stateProvince, [
593 'context' => 'province',
595 self
::$stateProvince = CRM_Utils_Array
::asort(self
::$stateProvince);
599 if (array_key_exists($id, self
::$stateProvince)) {
600 return self
::$stateProvince[$id];
607 return self
::$stateProvince;
611 * Get all the State/Province abbreviations from the database.
613 * Same as above, except gets the abbreviations instead of the names.
616 * @param bool|int $id - Optional id to return
621 * array reference of all State/Province abbreviations.
623 public static function stateProvinceAbbreviation($id = FALSE, $limit = TRUE) {
624 if ($id && is_numeric($id)) {
625 if (!array_key_exists($id, (array) self
::$stateProvinceAbbreviation)) {
626 $query = "SELECT abbreviation
627 FROM civicrm_state_province
635 self
::$stateProvinceAbbreviation[$id] = CRM_Core_DAO
::singleValueQuery($query, $params);
637 return self
::$stateProvinceAbbreviation[$id];
640 $whereClause = FALSE;
643 $countryIsoCodes = self
::countryIsoCode();
644 $limitCodes = CRM_Core_BAO_Country
::provinceLimit();
646 foreach ($limitCodes as $code) {
647 $tmpArray = array_keys($countryIsoCodes, $code);
649 if (!empty($tmpArray)) {
650 $limitIds[] = array_shift($tmpArray);
653 if (!empty($limitIds)) {
654 $whereClause = 'country_id IN (' . implode(', ', $limitIds) . ')';
657 self
::populate(self
::$stateProvinceAbbreviation, 'CRM_Core_DAO_StateProvince', TRUE, 'abbreviation', 'is_active', $whereClause);
660 return self
::$stateProvinceAbbreviation;
664 * Get all the State/Province abbreviations from the database for the specified country.
666 * @param int $countryID
669 * array of all State/Province abbreviations for the given country.
671 public static function stateProvinceAbbreviationForCountry($countryID) {
672 if (!isset(\Civi
::$statics[__CLASS__
]['stateProvinceAbbreviationForCountry'][$countryID])) {
673 \Civi
::$statics[__CLASS__
]['stateProvinceAbbreviationForCountry'][$countryID] = [];
675 self
::populate(\Civi
::$statics[__CLASS__
]['stateProvinceAbbreviationForCountry'][$countryID], 'CRM_Core_DAO_StateProvince', TRUE, 'abbreviation', 'is_active', "country_id = " . (int) $countryID, 'abbreviation');
676 return \Civi
::$statics[__CLASS__
]['stateProvinceAbbreviationForCountry'][$countryID];
680 * Get all the State/Province abbreviations from the database for the default country.
683 * array of all State/Province abbreviations for the given country.
685 public static function stateProvinceAbbreviationForDefaultCountry() {
686 return CRM_Core_PseudoConstant
::stateProvinceAbbreviationForCountry(Civi
::settings()->get('defaultContactCountry'));
690 * Get all the countries from database.
692 * The static array country is returned, and if it's
693 * called the first time, the <b>Country DAO</b> is used
694 * to get all the countries.
696 * Note: any database errors will be trapped by the DAO.
699 * @param bool|int $id - Optional id to return
701 * @param bool $applyLimit
704 * array reference of all countries.
706 public static function country($id = FALSE, $applyLimit = TRUE) {
707 if (($id && empty(self
::$country[$id])) ||
!self
::$country ||
!$id) {
709 $config = CRM_Core_Config
::singleton();
713 // limit the country list to the countries specified in CIVICRM_COUNTRY_LIMIT
714 // (ensuring it's a subset of the legal values)
715 // K/P: We need to fix this, i dont think it works with new setting files
716 $limitCodes = CRM_Core_BAO_Country
::countryLimit();
717 if (!is_array($limitCodes)) {
719 $config->countryLimit
=> 1,
723 $limitCodes = array_intersect(self
::countryIsoCode(), $limitCodes);
726 if (count($limitCodes)) {
727 $whereClause = "iso_code IN ('" . implode("', '", $limitCodes) . "')";
733 self
::populate(self
::$country, 'CRM_Core_DAO_Country', TRUE, 'name', 'is_active', $whereClause);
735 self
::$country = CRM_Core_BAO_Country
::_defaultContactCountries(self
::$country);
738 if (array_key_exists($id, self
::$country)) {
739 return self
::$country[$id];
745 return self
::$country;
749 * Get all the country ISO Code abbreviations from the database.
751 * The static array countryIsoCode is returned, and if it's
752 * called the first time, the <b>Country DAO</b> is used
753 * to get all the countries' ISO codes.
755 * Note: any database errors will be trapped by the DAO.
761 * array reference of all country ISO codes.
763 public static function &countryIsoCode($id = FALSE) {
764 if (!self
::$countryIsoCode) {
765 self
::populate(self
::$countryIsoCode, 'CRM_Core_DAO_Country', TRUE, 'iso_code');
768 if (array_key_exists($id, self
::$countryIsoCode)) {
769 return self
::$countryIsoCode[$id];
772 return CRM_Core_DAO
::$_nullObject;
775 return self
::$countryIsoCode;
779 * @deprecated Please use the buildOptions() method in the appropriate BAO object.
781 * Get all groups from database
783 * The static array group is returned, and if it's
784 * called the first time, the <b>Group DAO</b> is used
785 * to get all the groups.
787 * Note: any database errors will be trapped by the DAO.
789 * @param string $groupType
790 * Type of group(Access/Mailing).
791 * @param bool $excludeHidden
792 * Exclude hidden groups.
796 * array reference of all groups.
798 public static function allGroup($groupType = NULL, $excludeHidden = TRUE) {
799 if ($groupType === 'validate') {
800 // validate gets passed through from getoptions. Handle in the deprecated
801 // fn rather than change the new pattern.
804 $condition = CRM_Contact_BAO_Group
::groupTypeCondition($groupType, $excludeHidden);
805 $groupKey = ($groupType ?
$groupType : 'null') . !empty($excludeHidden);
807 if (!isset(Civi
::$statics[__CLASS__
]['groups']['allGroup'][$groupKey])) {
808 self
::populate(Civi
::$statics[__CLASS__
]['groups']['allGroup'][$groupKey], 'CRM_Contact_DAO_Group', FALSE, 'title', 'is_active', $condition);
810 return Civi
::$statics[__CLASS__
]['groups']['allGroup'][$groupKey];
814 * Get all permissioned groups from database.
816 * The static array group is returned, and if it's
817 * called the first time, the <b>Group DAO</b> is used
818 * to get all the groups.
820 * Note: any database errors will be trapped by the DAO.
822 * @param string $groupType
823 * Type of group(Access/Mailing).
824 * @param bool $excludeHidden
825 * Exclude hidden groups.
829 * array reference of all groups.
831 public static function group($groupType = NULL, $excludeHidden = TRUE) {
832 return CRM_Core_Permission
::group($groupType, $excludeHidden);
836 * Fetch groups in a nested format suitable for use in select form element.
837 * @param bool $checkPermissions
838 * @param string|null $groupType
839 * @param bool $excludeHidden
842 public static function nestedGroup(bool $checkPermissions = TRUE, $groupType = NULL, bool $excludeHidden = TRUE) {
843 $groups = $checkPermissions ? self
::group($groupType, $excludeHidden) : self
::allGroup($groupType, $excludeHidden);
844 return CRM_Contact_BAO_Group
::getGroupsHierarchy($groups, NULL, ' ', TRUE);
848 * Get all permissioned groups from database.
850 * The static array group is returned, and if it's
851 * called the first time, the <b>Group DAO</b> is used
852 * to get all the groups.
854 * Note: any database errors will be trapped by the DAO.
857 * @param bool $onlyPublic
858 * @param null $groupType
859 * @param bool $excludeHidden
862 * array reference of all groups.
864 public static function &staticGroup($onlyPublic = FALSE, $groupType = NULL, $excludeHidden = TRUE) {
865 if (!self
::$staticGroup) {
866 $condition = 'saved_search_id = 0 OR saved_search_id IS NULL';
868 $condition .= " AND visibility != 'User and User Admin Only'";
872 $condition .= ' AND ' . CRM_Contact_BAO_Group
::groupTypeCondition($groupType);
875 if ($excludeHidden) {
876 $condition .= ' AND is_hidden != 1 ';
879 self
::populate(self
::$staticGroup, 'CRM_Contact_DAO_Group', FALSE, 'title', 'is_active', $condition, 'title');
882 return self
::$staticGroup;
886 * Get all Relationship Types from database.
888 * The static array group is returned, and if it's
889 * called the first time, the <b>RelationshipType DAO</b> is used
890 * to get all the relationship types.
892 * Note: any database errors will be trapped by the DAO.
894 * @param string $valueColumnName
895 * Db column name/label.
897 * Reset relationship types if true.
898 * @param bool $isActive
899 * Filter by is_active. NULL to disable.
902 * array reference of all relationship types.
904 public static function relationshipType($valueColumnName = 'label', $reset = FALSE, $isActive = 1) {
905 $cacheKey = $valueColumnName . '::' . $isActive;
906 if (!isset(self
::$relationshipType[$cacheKey]) ||
$reset) {
907 self
::$relationshipType[$cacheKey] = [];
909 //now we have name/label columns CRM-3336
910 $column_a_b = "{$valueColumnName}_a_b";
911 $column_b_a = "{$valueColumnName}_b_a";
913 $relationshipTypeDAO = new CRM_Contact_DAO_RelationshipType();
914 $relationshipTypeDAO->selectAdd();
915 $relationshipTypeDAO->selectAdd("id, {$column_a_b}, {$column_b_a}, contact_type_a, contact_type_b, contact_sub_type_a, contact_sub_type_b");
916 if ($isActive !== NULL) {
917 $relationshipTypeDAO->is_active
= $isActive;
919 $relationshipTypeDAO->find();
920 while ($relationshipTypeDAO->fetch()) {
922 self
::$relationshipType[$cacheKey][$relationshipTypeDAO->id
] = [
923 'id' => $relationshipTypeDAO->id
,
924 $column_a_b => $relationshipTypeDAO->$column_a_b,
925 $column_b_a => $relationshipTypeDAO->$column_b_a,
926 'contact_type_a' => "$relationshipTypeDAO->contact_type_a",
927 'contact_type_b' => "$relationshipTypeDAO->contact_type_b",
928 'contact_sub_type_a' => "$relationshipTypeDAO->contact_sub_type_a",
929 'contact_sub_type_b' => "$relationshipTypeDAO->contact_sub_type_b",
934 return self
::$relationshipType[$cacheKey];
938 * Name => Label pairs for all relationship types
942 public static function relationshipTypeOptions() {
943 $relationshipTypes = [];
944 $relationshipLabels = self
::relationshipType();
945 foreach (self
::relationshipType('name') as $id => $type) {
946 $relationshipTypes[$type['name_a_b']] = $relationshipLabels[$id]['label_a_b'];
947 if ($type['name_b_a'] && $type['name_b_a'] != $type['name_a_b']) {
948 $relationshipTypes[$type['name_b_a']] = $relationshipLabels[$id]['label_b_a'];
951 return $relationshipTypes;
955 * Get all the ISO 4217 currency codes
957 * so far, we use this for validation only, so there's no point of putting this into the database
961 * array reference of all currency codes
963 public static function ¤cyCode() {
964 if (!self
::$currencyCode) {
966 $query = "SELECT name FROM civicrm_currency";
967 $dao = CRM_Core_DAO
::executeQuery($query);
969 while ($dao->fetch()) {
970 self
::$currencyCode[] = $dao->name
;
973 return self
::$currencyCode;
977 * Get all the County from database.
979 * The static array county is returned, and if it's
980 * called the first time, the <b>County DAO</b> is used
981 * to get all the Counties.
983 * Note: any database errors will be trapped by the DAO.
986 * @param bool|int $id - Optional id to return
989 * array reference of all Counties
991 public static function &county($id = FALSE) {
992 if (!self
::$county) {
994 $config = CRM_Core_Config
::singleton();
995 // order by id so users who populate civicrm_county can have more control over sort by the order they load the counties
996 self
::populate(self
::$county, 'CRM_Core_DAO_County', TRUE, 'name', NULL, NULL, 'id');
999 if (array_key_exists($id, self
::$county)) {
1000 return self
::$county[$id];
1003 return CRM_Core_DAO
::$_nullObject;
1006 return self
::$county;
1010 * @deprecated Please use the buildOptions() method in the appropriate BAO object.
1011 * Get all active payment processors
1013 * The static array paymentProcessor is returned
1017 * Get payment processors - default is to get only active ones.
1019 * Get test payment processors.
1021 * @param null $additionalCond
1024 * array of all payment processors
1026 public static function paymentProcessor($all = FALSE, $test = FALSE, $additionalCond = NULL) {
1027 $condition = "is_test = ";
1028 $condition .= ($test) ?
'1' : '0';
1030 if ($additionalCond) {
1031 $condition .= " AND ( $additionalCond ) ";
1034 // CRM-7178. Make sure we only include payment processors valid in this
1036 $condition .= " AND domain_id = " . CRM_Core_Config
::domainID();
1038 $cacheKey = $condition . '_' . (int) $all;
1039 if (!isset(self
::$paymentProcessor[$cacheKey])) {
1040 self
::populate(self
::$paymentProcessor[$cacheKey], 'CRM_Financial_DAO_PaymentProcessor', $all, 'name', 'is_active', $condition, 'is_default desc, name');
1043 return self
::$paymentProcessor[$cacheKey];
1047 * @deprecated Please use the buildOptions() method in the appropriate BAO object.
1049 * The static array paymentProcessorType is returned
1053 * Get payment processors - default is to get only active ones.
1056 * @param string $return
1059 * array of all payment processor types
1061 public static function &paymentProcessorType($all = FALSE, $id = NULL, $return = 'title') {
1062 $cacheKey = $id . '_' . $return;
1063 if (empty(self
::$paymentProcessorType[$cacheKey])) {
1064 self
::populate(self
::$paymentProcessorType[$cacheKey], 'CRM_Financial_DAO_PaymentProcessorType', $all, $return, 'is_active', NULL, "is_default, $return", 'id');
1066 if ($id && !empty(self
::$paymentProcessorType[$cacheKey][$id])) {
1067 return self
::$paymentProcessorType[$cacheKey][$id];
1069 return self
::$paymentProcessorType[$cacheKey];
1073 * Get all the World Regions from Database.
1079 * array reference of all World Regions
1081 public static function &worldRegion($id = FALSE) {
1082 if (!self
::$worldRegions) {
1083 self
::populate(self
::$worldRegions, 'CRM_Core_DAO_Worldregion', TRUE, 'name', NULL, NULL, 'id');
1087 if (array_key_exists($id, self
::$worldRegions)) {
1088 return self
::$worldRegions[$id];
1091 return CRM_Core_DAO
::$_nullObject;
1095 return self
::$worldRegions;
1099 * @deprecated Please use the buildOptions() method in the appropriate BAO object.
1101 * Get all Activity Statuses.
1103 * The static array activityStatus is returned
1106 * @param string $column
1109 * array reference of all activity statuses
1111 public static function &activityStatus($column = 'label') {
1112 if (NULL === self
::$activityStatus) {
1113 self
::$activityStatus = [];
1115 if (!array_key_exists($column, self
::$activityStatus)) {
1116 self
::$activityStatus[$column] = [];
1118 self
::$activityStatus[$column] = CRM_Core_OptionGroup
::values('activity_status', FALSE, FALSE, FALSE, NULL, $column);
1121 return self
::$activityStatus[$column];
1125 * @deprecated Please use the buildOptions() method in the appropriate BAO object.
1127 * Get all Visibility levels.
1129 * The static array visibility is returned
1132 * @param string $column
1135 * array reference of all Visibility levels.
1137 public static function &visibility($column = 'label') {
1138 if (!isset(self
::$visibility)) {
1139 self
::$visibility = [];
1142 if (!isset(self
::$visibility[$column])) {
1143 self
::$visibility[$column] = CRM_Core_OptionGroup
::values('visibility', FALSE, FALSE, FALSE, NULL, $column);
1146 return self
::$visibility[$column];
1150 * @param int $countryID
1151 * @param string $field
1155 public static function &stateProvinceForCountry($countryID, $field = 'name') {
1156 static $_cache = NULL;
1158 $cacheKey = "{$countryID}_{$field}";
1163 if (!empty($_cache[$cacheKey])) {
1164 return $_cache[$cacheKey];
1168 SELECT civicrm_state_province.{$field} name, civicrm_state_province.id id
1169 FROM civicrm_state_province
1170 WHERE country_id = %1
1179 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1182 while ($dao->fetch()) {
1183 $result[$dao->id
] = $dao->name
;
1186 // localise the stateProvince names if in an non-en_US locale
1187 $config = CRM_Core_Config
::singleton();
1188 $tsLocale = CRM_Core_I18n
::getLocale();
1189 if ($tsLocale != '' and $tsLocale != 'en_US') {
1190 $i18n = CRM_Core_I18n
::singleton();
1191 $i18n->localizeArray($result, [
1192 'context' => 'province',
1194 $result = CRM_Utils_Array
::asort($result);
1197 $_cache[$cacheKey] = $result;
1199 CRM_Utils_Hook
::buildStateProvinceForCountry($countryID, $result);
1205 * @param int $stateID
1209 public static function &countyForState($stateID) {
1210 if (is_array($stateID)) {
1211 $states = implode(", ", $stateID);
1213 SELECT civicrm_county.name name, civicrm_county.id id, civicrm_state_province.abbreviation abbreviation
1215 LEFT JOIN civicrm_state_province ON civicrm_county.state_province_id = civicrm_state_province.id
1216 WHERE civicrm_county.state_province_id in ( $states )
1217 ORDER BY civicrm_state_province.abbreviation, civicrm_county.name";
1219 $dao = CRM_Core_DAO
::executeQuery($query);
1222 while ($dao->fetch()) {
1223 $result[$dao->id
] = $dao->abbreviation
. ': ' . $dao->name
;
1228 static $_cache = NULL;
1230 $cacheKey = "{$stateID}_name";
1235 if (!empty($_cache[$cacheKey])) {
1236 return $_cache[$cacheKey];
1240 SELECT civicrm_county.name name, civicrm_county.id id
1242 WHERE state_province_id = %1
1251 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1254 while ($dao->fetch()) {
1255 $result[$dao->id
] = $dao->name
;
1263 * Given a state ID return the country ID, this allows
1264 * us to populate forms and values for downstream code
1266 * @param int $stateID
1269 * the country id that the state belongs to
1271 public static function countryIDForStateID($stateID) {
1272 if (empty($stateID)) {
1278 FROM civicrm_state_province
1281 $params = [1 => [$stateID, 'Integer']];
1283 return CRM_Core_DAO
::singleValueQuery($query, $params);
1287 * Get all types of Greetings.
1289 * The static array of greeting is returned
1293 * Get All Email Greetings - default is to get only active ones.
1295 * @param string $columnName
1298 * array reference of all greetings.
1300 public static function greeting($filter, $columnName = 'label') {
1301 if (!isset(Civi
::$statics[__CLASS__
]['greeting'])) {
1302 Civi
::$statics[__CLASS__
]['greeting'] = [];
1305 $index = $filter['greeting_type'] . '_' . $columnName;
1307 // also add contactType to the array
1308 $contactType = $filter['contact_type'] ??
NULL;
1310 $index .= '_' . $contactType;
1313 if (empty(Civi
::$statics[__CLASS__
]['greeting'][$index])) {
1314 $filterCondition = NULL;
1316 $filterVal = 'v.filter =';
1317 switch ($contactType) {
1326 case 'Organization':
1330 $filterCondition .= "AND (v.filter = 0 OR {$filterVal}) ";
1333 Civi
::$statics[__CLASS__
]['greeting'][$index] = CRM_Core_OptionGroup
::values($filter['greeting_type'], NULL, NULL, NULL, $filterCondition, $columnName);
1336 return Civi
::$statics[__CLASS__
]['greeting'][$index];
1340 * Get all extensions.
1342 * The static array extensions
1344 * FIXME: This is called by civix but not by any core code. We
1345 * should provide an API call which civix can use instead.
1349 * array($fullyQualifiedName => $label) list of extensions
1351 public static function &getExtensions() {
1352 if (!self
::$extensions) {
1353 $compat = CRM_Extension_System
::getCompatibilityInfo();
1354 self
::$extensions = [];
1356 SELECT full_name, label
1357 FROM civicrm_extension
1360 $dao = CRM_Core_DAO
::executeQuery($sql);
1361 while ($dao->fetch()) {
1362 if (!empty($compat[$dao->full_name
]['force-uninstall'])) {
1365 self
::$extensions[$dao->full_name
] = $dao->label
;
1369 return self
::$extensions;
1373 * Get all options values.
1375 * The static array option values is returned
1378 * @param string $optionGroupName
1379 * Name of option group
1382 * @param string $condition
1383 * @param string $column
1384 * Whether to return 'name' or 'label'
1387 * array reference of all Option Values
1389 public static function accountOptionValues($optionGroupName, $id = NULL, $condition = NULL, $column = 'label') {
1390 $cacheKey = $optionGroupName . '_' . $condition . '_' . $column;
1391 if (empty(self
::$accountOptionValues[$cacheKey])) {
1392 self
::$accountOptionValues[$cacheKey] = CRM_Core_OptionGroup
::values($optionGroupName, FALSE, FALSE, FALSE, $condition, $column);
1395 return self
::$accountOptionValues[$cacheKey][$id] ??
NULL;
1398 return self
::$accountOptionValues[$cacheKey];
1402 * Fetch the list of active extensions of type 'module'
1404 * @param bool $fresh
1405 * Whether to forcibly reload extensions list from canonical store.
1408 * array(array('prefix' => $, 'file' => $))
1410 public static function getModuleExtensions($fresh = FALSE) {
1411 return CRM_Extension_System
::singleton()->getMapper()->getActiveModuleFiles($fresh);
1415 * Get all tax rates.
1417 * The static array tax rates is returned
1420 * array list of tax rates with the financial type
1422 public static function getTaxRates() {
1423 if (!isset(Civi
::$statics[__CLASS__
]['taxRates'])) {
1424 Civi
::$statics[__CLASS__
]['taxRates'] = [];
1425 $option = civicrm_api3('option_value', 'get', [
1427 'option_group_id' => 'account_relationship',
1428 'name' => 'Sales Tax Account is',
1431 if ($option['count'] !== 0) {
1432 if ($option['count'] > 1) {
1433 foreach ($option['values'] as $opt) {
1434 $value[] = $opt['value'];
1438 $value[] = $option['values'][0]['value'];
1440 $where = 'AND efa.account_relationship IN (' . implode(', ', $value) . ' )';
1446 SELECT fa.tax_rate, efa.entity_id
1447 FROM civicrm_entity_financial_account efa
1448 INNER JOIN civicrm_financial_account fa ON fa.id = efa.financial_account_id
1449 WHERE efa.entity_table = 'civicrm_financial_type'
1451 AND fa.is_active = 1";
1452 $dao = CRM_Core_DAO
::executeQuery($sql);
1453 while ($dao->fetch()) {
1454 Civi
::$statics[__CLASS__
]['taxRates'][$dao->entity_id
] = $dao->tax_rate
;
1458 return Civi
::$statics[__CLASS__
]['taxRates'];
1462 * Get participant status class options.
1466 public static function emailOnHoldOptions() {
1469 '1' => ts('On Hold Bounce'),
1470 '2' => ts('On Hold Opt Out'),
1475 * Render the field options from the available pseudoconstant.
1477 * Do not call this function directly or from untested code. Further cleanup is likely.
1479 * @param array $pseudoconstant
1480 * @param array $params
1481 * @param string|null $localizeContext
1482 * @param string $context
1484 * @return array|bool|mixed
1486 public static function renderOptionsFromTablePseudoconstant($pseudoconstant, &$params = [], $localizeContext = NULL, $context = '') {
1487 $daoName = CRM_Core_DAO_AllCoreTables
::getClassForTable($pseudoconstant['table']);
1488 if (!class_exists($daoName)) {
1491 // Get list of fields for the option table
1492 /* @var CRM_Core_DAO $dao * */
1493 $dao = new $daoName();
1494 $availableFields = array_keys($dao->fieldKeys());
1496 $select = 'SELECT %1 AS id, %2 AS label';
1499 $order = 'ORDER BY %2';
1501 // Use machine name in certain contexts
1502 if ($context === 'validate' ||
$context === 'match') {
1503 $nameField = $context === 'validate' ?
'labelColumn' : 'keyColumn';
1504 if (!empty($pseudoconstant['nameColumn'])) {
1505 $params[$nameField] = $pseudoconstant['nameColumn'];
1507 elseif (in_array('name', $availableFields)) {
1508 $params[$nameField] = 'name';
1512 // Use abbrColum if context is abbreviate
1513 if ($context === 'abbreviate' && (in_array('abbreviation', $availableFields) ||
!empty($pseudoconstant['abbrColumn']))) {
1514 $params['labelColumn'] = $pseudoconstant['abbrColumn'] ??
'abbreviation';
1517 // Condition param can be passed as an sql clause string or an array of clauses
1518 if (!empty($params['condition'])) {
1519 $wheres[] = implode(' AND ', (array) $params['condition']);
1521 // onlyActive param will automatically filter on common flags
1522 if (!empty($params['onlyActive'])) {
1523 foreach (['is_active' => 1, 'is_deleted' => 0, 'is_test' => 0, 'is_hidden' => 0] as $flag => $val) {
1524 if (in_array($flag, $availableFields)) {
1525 $wheres[] = "$flag = $val";
1529 // Filter domain specific options
1530 if (in_array('domain_id', $availableFields)) {
1531 $wheres[] = 'domain_id = ' . CRM_Core_Config
::domainID() . ' OR domain_id is NULL';
1534 1 => [$params['keyColumn'], 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
],
1535 2 => [$params['labelColumn'], 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
],
1536 3 => [$pseudoconstant['table'], 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
],
1538 // Add orderColumn param
1539 if (!empty($params['orderColumn'])) {
1540 $queryParams[4] = [$params['orderColumn'], 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
];
1541 $order = 'ORDER BY %4';
1543 // Support no sorting if $params[orderColumn] is FALSE
1544 elseif (isset($params['orderColumn']) && $params['orderColumn'] === FALSE) {
1547 // Default to 'weight' if that column exists
1548 elseif (in_array('weight', $availableFields)) {
1549 $order = "ORDER BY weight";
1553 $query = "$select $from";
1555 $query .= " WHERE " . implode(' AND ', $wheres);
1557 $query .= ' ' . $order;
1558 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
1559 while ($dao->fetch()) {
1560 $output[$dao->id
] = $dao->label
;
1563 if (!empty($params['localize']) ||
$pseudoconstant['table'] === 'civicrm_country' ||
$pseudoconstant['table'] === 'civicrm_state_province') {
1564 if ($pseudoconstant['table'] === 'civicrm_country') {
1565 $output = CRM_Core_BAO_Country
::_defaultContactCountries($output);
1566 // avoid further sorting
1571 if ($localizeContext) {
1572 $I18nParams['context'] = $localizeContext;
1574 $i18n = CRM_Core_I18n
::singleton();
1575 $i18n->localizeArray($output, $I18nParams);
1577 // Maintain sort by label
1578 if ($order === 'ORDER BY %2') {
1579 $output = CRM_Utils_Array
::asort($output);