3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
30 * Stores all constants and pseudo constants for CRM application.
32 * examples of constants are "Contact Type" which will always be either
33 * 'Individual', 'Household', 'Organization'.
35 * pseudo constants are entities from the database whose values rarely
36 * change. examples are list of countries, states, location types,
39 * currently we're getting the data from the underlying database. this
40 * will be reworked to use caching.
42 * Note: All pseudoconstants should be uninitialized or default to NULL.
43 * This provides greater consistency/predictability after flushing.
46 * @copyright CiviCRM LLC (c) 2004-2014
50 class CRM_Core_PseudoConstant
{
53 * static cache for pseudoconstant arrays
57 private static $cache;
60 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
66 private static $activityType;
73 private static $stateProvince;
80 private static $county;
83 * states/provinces abbreviations
87 private static $stateProvinceAbbreviation;
94 private static $country;
101 private static $countryIsoCode;
104 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
110 private static $group;
117 private static $groupIterator;
124 private static $relationshipType;
127 * civicrm groups that are not smart groups
131 private static $staticGroup;
138 private static $currencyCode;
145 private static $paymentProcessor;
148 * payment processor types
152 private static $paymentProcessorType;
159 private static $worldRegions;
162 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
168 private static $activityStatus;
175 private static $visibility;
182 private static $greeting;
189 private static $greetingDefaults;
192 * Extensions of type module
196 private static $extensions;
199 * Financial Account Type
203 private static $accountOptionValues;
206 * Low-level option getter, rarely accessed directly.
207 * NOTE: Rather than calling this function directly use CRM_*_BAO_*::buildOptions()
208 * @see http://wiki.civicrm.org/confluence/display/CRMDOC/Pseudoconstant+%28option+list%29+Reference
210 * @param String $daoName
211 * @param String $fieldName
212 * @param Array $params
213 * - name string name of the option group
214 * - flip boolean results are return in id => label format if false
215 * if true, the results are reversed
216 * - grouping boolean if true, return the value in 'grouping' column (currently unsupported for tables other than option_value)
217 * - localize boolean if true, localize the results before returning
218 * - condition string|array add condition(s) to the sql query - will be concatenated using 'AND'
219 * - keyColumn string the column to use for 'id'
220 * - labelColumn string the column to use for 'label'
221 * - orderColumn string the column to use for sorting, defaults to 'weight' column if one exists, else defaults to labelColumn
222 * - onlyActive boolean return only the action option values
223 * - fresh boolean ignore cache entries and go back to DB
224 * @param String $context: Context string
226 * @return Array|bool - array on success, FALSE on error.
230 public static function get($daoName, $fieldName, $params = array(), $context = NULL) {
231 CRM_Core_DAO
::buildOptionsContext($context);
232 $flip = !empty($params['flip']);
233 // Merge params with defaults
237 'onlyActive' => ($context == 'validate' ||
$context == 'get') ?
FALSE : TRUE,
241 // Custom fields are not in the schema
242 if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
243 $customField = new CRM_Core_DAO_CustomField();
244 $customField->id
= (int) substr($fieldName, 7);
245 $customField->find(TRUE);
248 if (!empty($customField->option_group_id
)) {
249 $options = CRM_Core_OptionGroup
::valuesByID($customField->option_group_id
,
253 // Note: for custom fields the 'name' column is NULL
254 CRM_Utils_Array
::value('labelColumn', $params, 'label'),
255 $params['onlyActive'],
260 if ($customField->data_type
=== 'StateProvince') {
261 $options = self
::stateProvince();
263 elseif ($customField->data_type
=== 'Country') {
264 $options = $context == 'validate' ? self
::countryIsoCode() : self
::country();
266 elseif ($customField->data_type
=== 'Boolean') {
267 $options = $context == 'validate' ?
array(0, 1) : array(1 => ts('Yes'), 0 => ts('No'));
270 CRM_Utils_Hook
::customFieldOptions($customField->id
, $options, FALSE);
271 if ($options && $flip) {
272 $options = array_flip($options);
274 $customField->free();
278 // Core field: load schema
280 $fieldSpec = $dao->getFieldSpec($fieldName);
282 // If neither worked then this field doesn't exist. Return false.
283 if (empty($fieldSpec)) {
287 elseif (!empty($fieldSpec['pseudoconstant'])) {
288 $pseudoconstant = $fieldSpec['pseudoconstant'];
290 // if callback is specified..
291 if(!empty($pseudoconstant['callback'])) {
292 list($className, $fnName) = explode('::', $pseudoconstant['callback']);
293 if (method_exists($className, $fnName)) {
294 return call_user_func(array($className, $fnName));
298 // Merge params with schema defaults
300 'condition' => CRM_Utils_Array
::value('condition', $pseudoconstant, array()),
301 'keyColumn' => CRM_Utils_Array
::value('keyColumn', $pseudoconstant),
302 'labelColumn' => CRM_Utils_Array
::value('labelColumn', $pseudoconstant),
305 // Fetch option group from option_value table
306 if(!empty($pseudoconstant['optionGroupName'])) {
307 if ($context == 'validate') {
308 $params['labelColumn'] = 'name';
310 // Call our generic fn for retrieving from the option_value table
311 return CRM_Core_OptionGroup
::values(
312 $pseudoconstant['optionGroupName'],
316 $params['condition'] ?
' AND ' . implode(' AND ', (array) $params['condition']) : NULL,
317 $params['labelColumn'] ?
$params['labelColumn'] : 'label',
318 $params['onlyActive'],
320 $params['keyColumn'] ?
$params['keyColumn'] : 'value'
324 // Fetch options from other tables
325 if (!empty($pseudoconstant['table'])) {
326 // Normalize params so the serialized cache string will be consistent.
327 CRM_Utils_Array
::remove($params, 'flip', 'fresh');
329 $cacheKey = $daoName . $fieldName . serialize($params);
331 // Retrieve cached options
332 if (isset(self
::$cache[$cacheKey]) && empty($params['fresh'])) {
333 $output = self
::$cache[$cacheKey];
336 $daoName = CRM_Core_DAO_AllCoreTables
::getClassForTable($pseudoconstant['table']);
337 if (!class_exists($daoName)) {
340 // Get list of fields for the option table
342 $availableFields = array_keys($dao->fieldKeys());
345 $select = "SELECT %1 AS id, %2 AS label";
348 $order = "ORDER BY %2";
350 // Use machine name instead of label in validate context
351 if ($context == 'validate') {
352 if (!empty($pseudoconstant['nameColumn'])) {
353 $params['labelColumn'] = $pseudoconstant['nameColumn'];
355 elseif (in_array('name', $availableFields)) {
356 $params['labelColumn'] = 'name';
359 // Condition param can be passed as an sql clause string or an array of clauses
360 if (!empty($params['condition'])) {
361 $wheres[] = implode(' AND ', (array) $params['condition']);
363 // onlyActive param will automatically filter on common flags
364 if (!empty($params['onlyActive'])) {
365 foreach (array('is_active' => 1, 'is_deleted' => 0, 'is_test' => 0) as $flag => $val) {
366 if (in_array($flag, $availableFields)) {
367 $wheres[] = "$flag = $val";
371 // Filter domain specific options
372 if (in_array('domain_id', $availableFields)) {
373 $wheres[] = 'domain_id = ' . CRM_Core_Config
::domainID();
375 $queryParams = array(
376 1 => array($params['keyColumn'], 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
),
377 2 => array($params['labelColumn'], 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
),
378 3 => array($pseudoconstant['table'], 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
),
380 // Add orderColumn param
381 if (!empty($params['orderColumn'])) {
382 $queryParams[4] = array($params['orderColumn'], 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
);
383 $order = "ORDER BY %4";
385 // Support no sorting if $params[orderColumn] is FALSE
386 elseif (isset($params['orderColumn']) && $params['orderColumn'] === FALSE) {
389 // Default to 'weight' if that column exists
390 elseif (in_array('weight', $availableFields)) {
391 $order = "ORDER BY weight";
395 $query = "$select $from";
397 $query .= " WHERE " . implode($wheres, ' AND ');
399 $query .= ' ' . $order;
400 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
401 while ($dao->fetch()) {
402 $output[$dao->id
] = $dao->label
;
406 if (!empty($params['localize']) ||
$pseudoconstant['table'] == 'civicrm_country' ||
$pseudoconstant['table'] == 'civicrm_state_province') {
407 $I18nParams = array();
408 if ($pseudoconstant['table'] == 'civicrm_country') {
409 $I18nParams['context'] = 'country';
411 if ($pseudoconstant['table'] == 'civicrm_state_province') {
412 $I18nParams['context'] = 'province';
414 $i18n = CRM_Core_I18n
::singleton();
415 $i18n->localizeArray($output, $I18nParams);
416 // Maintain sort by label
417 if ($order == "ORDER BY %2") {
418 CRM_Utils_Array
::asort($output);
421 self
::$cache[$cacheKey] = $output;
423 return $flip ?
array_flip($output) : $output;
427 // Return "Yes" and "No" for boolean fields
428 elseif (CRM_Utils_Array
::value('type', $fieldSpec) === CRM_Utils_Type
::T_BOOLEAN
) {
429 $output = $context == 'validate' ?
array(0, 1) : array(1 => ts('Yes'), 0 => ts('No'));
430 return $flip ?
array_flip($output) : $output;
432 // If we're still here, it's an error. Return FALSE.
437 * Fetch the translated label for a field given its key
439 * @param String $baoName
440 * @param String $fieldName
441 * @param String|Int $key
443 * TODO: Accept multivalued input?
445 * @return bool|null|string
446 * FALSE if the given field has no associated option list
447 * NULL if the given key has no corresponding option
448 * String if label is found
450 static function getLabel($baoName, $fieldName, $key) {
451 $values = $baoName::buildOptions($fieldName, 'get');
452 if ($values === FALSE) {
455 return CRM_Utils_Array
::value($key, $values);
459 * Fetch the machine name for a field given its key
461 * @param String $baoName
462 * @param String $fieldName
463 * @param String|Int $key
465 * @return bool|null|string
466 * FALSE if the given field has no associated option list
467 * NULL if the given key has no corresponding option
468 * String if label is found
470 static function getName($baoName, $fieldName, $key) {
471 $values = $baoName::buildOptions($fieldName, 'validate');
472 if ($values === FALSE) {
475 return CRM_Utils_Array
::value($key, $values);
479 * Fetch the key for a field option given its name
481 * @param String $baoName
482 * @param String $fieldName
483 * @param String|Int $value
485 * @return bool|null|string|number
486 * FALSE if the given field has no associated option list
487 * NULL if the given key has no corresponding option
488 * String|Number if key is found
490 static function getKey($baoName, $fieldName, $value) {
491 $values = $baoName::buildOptions($fieldName, 'validate');
492 if ($values === FALSE) {
495 return CRM_Utils_Array
::key($value, $values);
499 * Lookup the admin page at which a field's option list can be edited
501 * @return string|null
503 static function getOptionEditUrl($fieldSpec) {
504 // If it's an option group, that's easy
505 if (!empty($fieldSpec['pseudoconstant']['optionGroupName'])) {
506 return 'civicrm/admin/options/' . $fieldSpec['pseudoconstant']['optionGroupName'];
508 // For everything else...
509 elseif (!empty($fieldSpec['pseudoconstant']['table'])) {
510 $daoName = CRM_Core_DAO_AllCoreTables
::getClassForTable($fieldSpec['pseudoconstant']['table']);
514 // We don't have good mapping so have to do a bit of guesswork from the menu
515 list(, $parent, , $child) = explode('_', $daoName);
516 $sql = "SELECT path FROM civicrm_menu
517 WHERE page_callback LIKE '%CRM_Admin_Page_$child%' OR page_callback LIKE '%CRM_{$parent}_Page_$child%'
518 ORDER BY page_callback
520 return CRM_Core_Dao
::singleValueQuery($sql);
526 * DEPRECATED generic populate method
527 * All pseudoconstant functions that use this method are also deprecated.
529 * The static array $var is populated from the db
530 * using the <b>$name DAO</b>.
532 * Note: any database errors will be trapped by the DAO.
534 * @param array $var the associative array we will fill
535 * @param string $name the name of the DAO
536 * @param boolean $all get all objects. default is to get only active ones.
537 * @param string $retrieve the field that we are interested in (normally name, differs in some objects)
538 * @param string $filter the field that we want to filter the result set with
539 * @param string $condition the condition that gets passed to the final query as the WHERE clause
541 * @param null $orderby
549 public static function populate(
554 $filter = 'is_active',
560 $cacheKey = "CRM_PC_{$name}_{$all}_{$key}_{$retrieve}_{$filter}_{$condition}_{$orderby}";
561 $cache = CRM_Utils_Cache
::singleton();
562 $var = $cache->get($cacheKey);
563 if ($var && empty($force)) {
567 $object = new $name ( );
569 $object->selectAdd();
570 $object->selectAdd("$key, $retrieve");
572 $object->whereAdd($condition);
576 $object->orderBy($retrieve);
579 $object->orderBy($orderby);
583 $object->$filter = 1;
588 while ($object->fetch()) {
589 $var[$object->$key] = $object->$retrieve;
592 $cache->set($cacheKey, $var);
596 * Flush given pseudoconstant so it can be reread from db
597 * nex time it's requested.
602 * @param bool|string $name pseudoconstant to be flushed
604 public static function flush($name = 'cache') {
605 if (isset(self
::$
$name)) {
608 if ($name == 'cache') {
609 CRM_Core_OptionGroup
::flushAll();
614 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
616 * Get all Activty types.
618 * The static array activityType is returned
620 * @internal param bool $all - get All Activity types - default is to get only active ones.
625 * @return array - array reference of all activity types.
627 public static function &activityType() {
628 $args = func_get_args();
629 $all = CRM_Utils_Array
::value(0, $args, TRUE);
630 $includeCaseActivities = CRM_Utils_Array
::value(1, $args, FALSE);
631 $reset = CRM_Utils_Array
::value(2, $args, FALSE);
632 $returnColumn = CRM_Utils_Array
::value(3, $args, 'label');
633 $includeCampaignActivities = CRM_Utils_Array
::value(4, $args, FALSE);
634 $onlyComponentActivities = CRM_Utils_Array
::value(5, $args, FALSE);
635 $index = (int) $all . '_' . $returnColumn . '_' . (int) $includeCaseActivities;
636 $index .= '_' . (int) $includeCampaignActivities;
637 $index .= '_' . (int) $onlyComponentActivities;
639 if (NULL === self
::$activityType) {
640 self
::$activityType = array();
643 if (!isset(self
::$activityType[$index]) ||
$reset) {
646 $condition = 'AND filter = 0';
648 $componentClause = " v.component_id IS NULL";
649 if ($onlyComponentActivities) {
650 $componentClause = " v.component_id IS NOT NULL";
653 $componentIds = array();
654 $compInfo = CRM_Core_Component
::getEnabledComponents();
656 // build filter for listing activity types only if their
657 // respective components are enabled
658 foreach ($compInfo as $compName => $compObj) {
659 if ($compName == 'CiviCase') {
660 if ($includeCaseActivities) {
661 $componentIds[] = $compObj->componentID
;
664 elseif ($compName == 'CiviCampaign') {
665 if ($includeCampaignActivities) {
666 $componentIds[] = $compObj->componentID
;
670 $componentIds[] = $compObj->componentID
;
674 if (count($componentIds)) {
675 $componentIds = implode(',', $componentIds);
676 $componentClause = " ($componentClause OR v.component_id IN ($componentIds))";
677 if ($onlyComponentActivities) {
678 $componentClause = " ( v.component_id IN ($componentIds ) )";
681 $condition = $condition . ' AND ' . $componentClause;
683 self
::$activityType[$index] = CRM_Core_OptionGroup
::values('activity_type', FALSE, FALSE, FALSE, $condition, $returnColumn);
685 return self
::$activityType[$index];
689 * Get all the State/Province from database.
691 * The static array stateProvince is returned, and if it's
692 * called the first time, the <b>State Province DAO</b> is used
693 * to get all the States.
695 * Note: any database errors will be trapped by the DAO.
700 * @param bool|int $id - Optional id to return
704 * @return array - array reference of all State/Provinces.
706 public static function &stateProvince($id = FALSE, $limit = TRUE) {
707 if (($id && !CRM_Utils_Array
::value($id, self
::$stateProvince)) ||
!self
::$stateProvince ||
!$id) {
708 $whereClause = FALSE;
709 $config = CRM_Core_Config
::singleton();
711 $countryIsoCodes = self
::countryIsoCode();
712 $limitCodes = $config->provinceLimit();
714 foreach ($limitCodes as $code) {
715 $limitIds = array_merge($limitIds, array_keys($countryIsoCodes, $code));
717 if (!empty($limitIds)) {
718 $whereClause = 'country_id IN (' . implode(', ', $limitIds) . ')';
721 $whereClause = FALSE;
724 self
::populate(self
::$stateProvince, 'CRM_Core_DAO_StateProvince', TRUE, 'name', 'is_active', $whereClause);
726 // localise the province names if in an non-en_US locale
728 if ($tsLocale != '' and $tsLocale != 'en_US') {
729 $i18n = CRM_Core_I18n
::singleton();
730 $i18n->localizeArray(self
::$stateProvince, array(
731 'context' => 'province',
733 self
::$stateProvince = CRM_Utils_Array
::asort(self
::$stateProvince);
737 if (array_key_exists($id, self
::$stateProvince)) {
738 return self
::$stateProvince[$id];
745 return self
::$stateProvince;
749 * Get all the State/Province abbreviations from the database.
751 * Same as above, except gets the abbreviations instead of the names.
756 * @param bool|int $id - Optional id to return
760 * @return array - array reference of all State/Province abbreviations.
762 public static function &stateProvinceAbbreviation($id = FALSE, $limit = TRUE) {
766 FROM civicrm_state_province
774 return CRM_Core_DAO
::singleValueQuery($query, $params);
777 if (!self
::$stateProvinceAbbreviation ||
!$id) {
779 $whereClause = FALSE;
782 $config = CRM_Core_Config
::singleton();
783 $countryIsoCodes = self
::countryIsoCode();
784 $limitCodes = $config->provinceLimit();
786 foreach ($limitCodes as $code) {
787 $tmpArray = array_keys($countryIsoCodes, $code);
789 if (!empty($tmpArray)) {
790 $limitIds[] = array_shift($tmpArray);
793 if (!empty($limitIds)) {
794 $whereClause = 'country_id IN (' . implode(', ', $limitIds) . ')';
797 self
::populate(self
::$stateProvinceAbbreviation, 'CRM_Core_DAO_StateProvince', TRUE, 'abbreviation', 'is_active', $whereClause);
801 if (array_key_exists($id, self
::$stateProvinceAbbreviation)) {
802 return self
::$stateProvinceAbbreviation[$id];
809 return self
::$stateProvinceAbbreviation;
813 * Get all the countries from database.
815 * The static array country is returned, and if it's
816 * called the first time, the <b>Country DAO</b> is used
817 * to get all the countries.
819 * Note: any database errors will be trapped by the DAO.
824 * @param bool|int $id - Optional id to return
826 * @param bool $applyLimit
828 * @return array - array reference of all countries.
830 public static function country($id = FALSE, $applyLimit = TRUE) {
831 if (($id && !CRM_Utils_Array
::value($id, self
::$country)) ||
!self
::$country ||
!$id) {
833 $config = CRM_Core_Config
::singleton();
834 $limitCodes = array();
837 // limit the country list to the countries specified in CIVICRM_COUNTRY_LIMIT
838 // (ensuring it's a subset of the legal values)
839 // K/P: We need to fix this, i dont think it works with new setting files
840 $limitCodes = $config->countryLimit();
841 if (!is_array($limitCodes)) {
843 $config->countryLimit
=> 1,
847 $limitCodes = array_intersect(self
::countryIsoCode(), $limitCodes);
850 if (count($limitCodes)) {
851 $whereClause = "iso_code IN ('" . implode("', '", $limitCodes) . "')";
857 self
::populate(self
::$country, 'CRM_Core_DAO_Country', TRUE, 'name', 'is_active', $whereClause);
859 // if default country is set, percolate it to the top
860 if ($config->defaultContactCountry()) {
861 $countryIsoCodes = self
::countryIsoCode();
862 $defaultID = array_search($config->defaultContactCountry(), $countryIsoCodes);
863 if ($defaultID !== FALSE) {
864 $default[$defaultID] = CRM_Utils_Array
::value($defaultID, self
::$country);
865 self
::$country = $default + self
::$country;
869 // localise the country names if in an non-en_US locale
871 if ($tsLocale != '' and $tsLocale != 'en_US') {
872 $i18n = CRM_Core_I18n
::singleton();
873 $i18n->localizeArray(self
::$country, array(
874 'context' => 'country',
876 self
::$country = CRM_Utils_Array
::asort(self
::$country);
880 if (array_key_exists($id, self
::$country)) {
881 return self
::$country[$id];
884 return CRM_Core_DAO
::$_nullObject;
887 return self
::$country;
891 * Get all the country ISO Code abbreviations from the database.
893 * The static array countryIsoCode is returned, and if it's
894 * called the first time, the <b>Country DAO</b> is used
895 * to get all the countries' ISO codes.
897 * Note: any database errors will be trapped by the DAO.
904 * @return array - array reference of all country ISO codes.
906 public static function &countryIsoCode($id = FALSE) {
907 if (!self
::$countryIsoCode) {
908 self
::populate(self
::$countryIsoCode, 'CRM_Core_DAO_Country', TRUE, 'iso_code');
911 if (array_key_exists($id, self
::$countryIsoCode)) {
912 return self
::$countryIsoCode[$id];
915 return CRM_Core_DAO
::$_nullObject;
918 return self
::$countryIsoCode;
922 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
924 * Get all groups from database
926 * The static array group is returned, and if it's
927 * called the first time, the <b>Group DAO</b> is used
928 * to get all the groups.
930 * Note: any database errors will be trapped by the DAO.
932 * @param string $groupType type of group(Access/Mailing)
933 * @param bool|\boolen $excludeHidden exclude hidden groups.
938 * @return array - array reference of all groups.
940 public static function &allGroup($groupType = NULL, $excludeHidden = TRUE) {
941 $condition = CRM_Contact_BAO_Group
::groupTypeCondition($groupType, $excludeHidden);
944 self
::$group = array();
947 $groupKey = $groupType ?
$groupType : 'null';
949 if (!isset(self
::$group[$groupKey])) {
950 self
::$group[$groupKey] = NULL;
951 self
::populate(self
::$group[$groupKey], 'CRM_Contact_DAO_Group', FALSE, 'title', 'is_active', $condition);
953 return self
::$group[$groupKey];
957 * Create or get groups iterator (iterates over nested groups in a
960 * The GroupNesting instance is returned; it's created if this is being
961 * called for the first time
967 * @param bool $styledLabels
969 * @return mixed - instance of CRM_Contact_BAO_GroupNesting
971 public static function &groupIterator($styledLabels = FALSE) {
972 if (!self
::$groupIterator) {
974 When used as an object, GroupNesting implements Iterator
975 and iterates nested groups in a logical manner for us
977 self
::$groupIterator = new CRM_Contact_BAO_GroupNesting($styledLabels);
979 return self
::$groupIterator;
983 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
985 * Get all permissioned groups from database
987 * The static array group is returned, and if it's
988 * called the first time, the <b>Group DAO</b> is used
989 * to get all the groups.
991 * Note: any database errors will be trapped by the DAO.
993 * @param string $groupType type of group(Access/Mailing)
994 * @param bool|\boolen $excludeHidden exclude hidden groups.
999 * @return array - array reference of all groups.
1001 public static function group($groupType = NULL, $excludeHidden = TRUE) {
1002 return CRM_Core_Permission
::group($groupType, $excludeHidden);
1006 * Get all permissioned groups from database
1008 * The static array group is returned, and if it's
1009 * called the first time, the <b>Group DAO</b> is used
1010 * to get all the groups.
1012 * Note: any database errors will be trapped by the DAO.
1017 * @param bool $onlyPublic
1018 * @param null $groupType
1019 * @param bool $excludeHidden
1021 * @return array - array reference of all groups.
1023 public static function &staticGroup($onlyPublic = FALSE, $groupType = NULL, $excludeHidden = TRUE) {
1024 if (!self
::$staticGroup) {
1025 $condition = 'saved_search_id = 0 OR saved_search_id IS NULL';
1027 $condition .= " AND visibility != 'User and User Admin Only'";
1031 $condition .= ' AND ' . CRM_Contact_BAO_Group
::groupTypeCondition($groupType);
1034 if ($excludeHidden) {
1035 $condition .= ' AND is_hidden != 1 ';
1038 self
::populate(self
::$staticGroup, 'CRM_Contact_DAO_Group', FALSE, 'title', 'is_active', $condition, 'title');
1041 return self
::$staticGroup;
1045 * Get all Relationship Types from database.
1047 * The static array group is returned, and if it's
1048 * called the first time, the <b>RelationshipType DAO</b> is used
1049 * to get all the relationship types.
1051 * Note: any database errors will be trapped by the DAO.
1053 * @param string $valueColumnName db column name/label.
1054 * @param boolean $reset reset relationship types if true
1059 * @return array - array reference of all relationship types.
1061 public static function &relationshipType($valueColumnName = 'label', $reset = FALSE) {
1062 if (!CRM_Utils_Array
::value($valueColumnName, self
::$relationshipType) ||
$reset) {
1063 self
::$relationshipType[$valueColumnName] = array();
1065 //now we have name/label columns CRM-3336
1066 $column_a_b = "{$valueColumnName}_a_b";
1067 $column_b_a = "{$valueColumnName}_b_a";
1069 $relationshipTypeDAO = new CRM_Contact_DAO_RelationshipType();
1070 $relationshipTypeDAO->selectAdd();
1071 $relationshipTypeDAO->selectAdd("id, {$column_a_b}, {$column_b_a}, contact_type_a, contact_type_b, contact_sub_type_a, contact_sub_type_b");
1072 $relationshipTypeDAO->is_active
= 1;
1073 $relationshipTypeDAO->find();
1074 while ($relationshipTypeDAO->fetch()) {
1076 self
::$relationshipType[$valueColumnName][$relationshipTypeDAO->id
] = array(
1077 'id' => $relationshipTypeDAO->id
,
1078 $column_a_b => $relationshipTypeDAO->$column_a_b,
1079 $column_b_a => $relationshipTypeDAO->$column_b_a,
1080 'contact_type_a' => "$relationshipTypeDAO->contact_type_a",
1081 'contact_type_b' => "$relationshipTypeDAO->contact_type_b",
1082 'contact_sub_type_a' => "$relationshipTypeDAO->contact_sub_type_a",
1083 'contact_sub_type_b' => "$relationshipTypeDAO->contact_sub_type_b",
1088 return self
::$relationshipType[$valueColumnName];
1092 * get all the ISO 4217 currency codes
1094 * so far, we use this for validation only, so there's no point of putting this into the database
1098 * @return array - array reference of all currency codes
1101 public static function ¤cyCode() {
1102 if (!self
::$currencyCode) {
1103 self
::$currencyCode = array(
1373 return self
::$currencyCode;
1377 * Get all the County from database.
1379 * The static array county is returned, and if it's
1380 * called the first time, the <b>County DAO</b> is used
1381 * to get all the Counties.
1383 * Note: any database errors will be trapped by the DAO.
1388 * @param bool|int $id - Optional id to return
1390 * @return array - array reference of all Counties
1392 public static function &county($id = FALSE) {
1393 if (!self
::$county) {
1395 $config = CRM_Core_Config
::singleton();
1396 // order by id so users who populate civicrm_county can have more control over sort by the order they load the counties
1397 self
::populate(self
::$county, 'CRM_Core_DAO_County', TRUE, 'name', NULL, NULL, 'id');
1400 if (array_key_exists($id, self
::$county)) {
1401 return self
::$county[$id];
1404 return CRM_Core_DAO
::$_nullObject;
1407 return self
::$county;
1411 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
1412 * Get all active payment processors
1414 * The static array paymentProcessor is returned
1419 * @param boolean $all - get payment processors - default is to get only active ones.
1420 * @param boolean $test - get test payment processors
1422 * @param null $additionalCond
1424 * @return array - array of all payment processors
1426 public static function &paymentProcessor($all = FALSE, $test = FALSE, $additionalCond = NULL) {
1427 $condition = "is_test = ";
1428 $condition .= ($test) ?
'1' : '0';
1430 if ($additionalCond) {
1431 $condition .= " AND ( $additionalCond ) ";
1434 // CRM-7178. Make sure we only include payment processors valid in ths
1436 $condition .= " AND domain_id = " . CRM_Core_Config
::domainID();
1438 $cacheKey = $condition . '_' . (int) $all;
1439 if (!isset(self
::$paymentProcessor[$cacheKey])) {
1440 self
::populate(self
::$paymentProcessor[$cacheKey], 'CRM_Financial_DAO_PaymentProcessor', $all, 'name', 'is_active', $condition, 'is_default desc, name');
1443 return self
::$paymentProcessor[$cacheKey];
1447 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
1449 * The static array paymentProcessorType is returned
1454 * @param boolean $all - get payment processors - default is to get only active ones.
1457 * @param string $return
1459 * @return array - array of all payment processor types
1461 public static function &paymentProcessorType($all = FALSE, $id = NULL, $return = 'title') {
1462 $cacheKey = $id . '_' .$return;
1463 if (empty(self
::$paymentProcessorType[$cacheKey])) {
1464 self
::populate(self
::$paymentProcessorType[$cacheKey], 'CRM_Financial_DAO_PaymentProcessorType', $all, $return, 'is_active', NULL, "is_default, $return", 'id');
1466 if ($id && CRM_Utils_Array
::value($id, self
::$paymentProcessorType[$cacheKey])) {
1467 return self
::$paymentProcessorType[$cacheKey][$id];
1469 return self
::$paymentProcessorType[$cacheKey];
1473 * Get all the World Regions from Database
1479 * @return array - array reference of all World Regions
1482 public static function &worldRegion($id = FALSE) {
1483 if (!self
::$worldRegions) {
1484 self
::populate(self
::$worldRegions, 'CRM_Core_DAO_Worldregion', TRUE, 'name', NULL, NULL, 'id');
1488 if (array_key_exists($id, self
::$worldRegions)) {
1489 return self
::$worldRegions[$id];
1492 return CRM_Core_DAO
::$_nullObject;
1496 return self
::$worldRegions;
1500 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
1502 * Get all Activity Statuses.
1504 * The static array activityStatus is returned
1509 * @param string $column
1511 * @return array - array reference of all activity statuses
1513 public static function &activityStatus($column = 'label') {
1514 if (NULL === self
::$activityStatus) {
1515 self
::$activityStatus = array();
1517 if (!array_key_exists($column, self
::$activityStatus)) {
1518 self
::$activityStatus[$column] = array();
1520 self
::$activityStatus[$column] = CRM_Core_OptionGroup
::values('activity_status', FALSE, FALSE, FALSE, NULL, $column);
1523 return self
::$activityStatus[$column];
1527 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
1529 * Get all Visibility levels.
1531 * The static array visibility is returned
1536 * @param string $column
1538 * @return array - array reference of all Visibility levels.
1540 public static function &visibility($column = 'label') {
1541 if (!isset(self
::$visibility)) {
1542 self
::$visibility = array( );
1545 if (!isset(self
::$visibility[$column])) {
1546 self
::$visibility[$column] = CRM_Core_OptionGroup
::values('visibility', FALSE, FALSE, FALSE, NULL, $column);
1549 return self
::$visibility[$column];
1554 * @param string $field
1558 public static function &stateProvinceForCountry($countryID, $field = 'name') {
1559 static $_cache = NULL;
1561 $cacheKey = "{$countryID}_{$field}";
1566 if (!empty($_cache[$cacheKey])) {
1567 return $_cache[$cacheKey];
1571 SELECT civicrm_state_province.{$field} name, civicrm_state_province.id id
1572 FROM civicrm_state_province
1573 WHERE country_id = %1
1582 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1585 while ($dao->fetch()) {
1586 $result[$dao->id
] = $dao->name
;
1589 // localise the stateProvince names if in an non-en_US locale
1590 $config = CRM_Core_Config
::singleton();
1592 if ($tsLocale != '' and $tsLocale != 'en_US') {
1593 $i18n = CRM_Core_I18n
::singleton();
1594 $i18n->localizeArray($result, array(
1595 'context' => 'province',
1597 $result = CRM_Utils_Array
::asort($result);
1600 $_cache[$cacheKey] = $result;
1602 CRM_Utils_Hook
::buildStateProvinceForCountry($countryID, $result);
1612 public static function &countyForState($stateID) {
1613 if (is_array($stateID)) {
1614 $states = implode(", ", $stateID);
1616 SELECT civicrm_county.name name, civicrm_county.id id, civicrm_state_province.abbreviation abbreviation
1618 LEFT JOIN civicrm_state_province ON civicrm_county.state_province_id = civicrm_state_province.id
1619 WHERE civicrm_county.state_province_id in ( $states )
1620 ORDER BY civicrm_state_province.abbreviation, civicrm_county.name";
1622 $dao = CRM_Core_DAO
::executeQuery($query);
1625 while ($dao->fetch()) {
1626 $result[$dao->id
] = $dao->abbreviation
. ': ' . $dao->name
;
1631 static $_cache = NULL;
1633 $cacheKey = "{$stateID}_name";
1638 if (!empty($_cache[$cacheKey])) {
1639 return $_cache[$cacheKey];
1643 SELECT civicrm_county.name name, civicrm_county.id id
1645 WHERE state_province_id = %1
1654 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1657 while ($dao->fetch()) {
1658 $result[$dao->id
] = $dao->name
;
1666 * Given a state ID return the country ID, this allows
1667 * us to populate forms and values for downstream code
1669 * @param $stateID int
1671 * @return int the country id that the state belongs to
1675 static function countryIDForStateID($stateID) {
1676 if (empty($stateID)) {
1677 return CRM_Core_DAO
::$_nullObject;
1682 FROM civicrm_state_province
1685 $params = array(1 => array($stateID, 'Integer'));
1687 return CRM_Core_DAO
::singleValueQuery($query, $params);
1691 * Get all types of Greetings.
1693 * The static array of greeting is returned
1698 * @param $filter - get All Email Greetings - default is to get only active ones.
1700 * @param string $columnName
1702 * @return array - array reference of all greetings.
1704 public static function greeting($filter, $columnName = 'label') {
1705 $index = $filter['greeting_type'] . '_' . $columnName;
1707 // also add contactType to the array
1708 $contactType = CRM_Utils_Array
::value('contact_type', $filter);
1710 $index .= '_' . $contactType;
1713 if (NULL === self
::$greeting) {
1714 self
::$greeting = array();
1717 if (!CRM_Utils_Array
::value($index, self
::$greeting)) {
1718 $filterCondition = NULL;
1720 $filterVal = 'v.filter =';
1721 switch ($contactType) {
1730 case 'Organization':
1734 $filterCondition .= "AND (v.filter = 0 OR {$filterVal}) ";
1737 self
::$greeting[$index] = CRM_Core_OptionGroup
::values($filter['greeting_type'], NULL, NULL, NULL, $filterCondition, $columnName);
1740 return self
::$greeting[$index];
1744 * Construct array of default greeting values for contact type
1749 * @return array - array reference of default greetings.
1752 public static function &greetingDefaults() {
1753 if (!self
::$greetingDefaults) {
1754 $defaultGreetings = array();
1755 $contactTypes = self
::get('CRM_Contact_DAO_Contact', 'contact_type', array('keyColumn' => 'id', 'labelColumn' => 'name'));
1757 foreach ($contactTypes as $filter => $contactType) {
1758 $filterCondition = " AND (v.filter = 0 OR v.filter = $filter) AND v.is_default = 1 ";
1760 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
1761 $tokenVal = CRM_Core_OptionGroup
::values($greeting, NULL, NULL, NULL, $filterCondition, 'label');
1762 $defaultGreetings[$contactType][$greeting] = $tokenVal;
1766 self
::$greetingDefaults = $defaultGreetings;
1769 return self
::$greetingDefaults;
1773 * Get all extensions
1775 * The static array extensions
1777 * FIXME: This is called by civix but not by any core code. We
1778 * should provide an API call which civix can use instead.
1783 * @return array - array($fullyQualifiedName => $label) list of extensions
1785 public static function &getExtensions() {
1786 if (!self
::$extensions) {
1787 self
::$extensions = array();
1789 SELECT full_name, label
1790 FROM civicrm_extension
1793 $dao = CRM_Core_DAO
::executeQuery($sql);
1794 while ($dao->fetch()) {
1795 self
::$extensions[$dao->full_name
] = $dao->label
;
1799 return self
::$extensions;
1803 * Get all options values
1805 * The static array option values is returned
1810 * @param boolean $optionGroupName - get All Option Group values- default is to get only active ones.
1813 * @param null $condition
1815 * @return array - array reference of all Option Group Name
1817 public static function accountOptionValues($optionGroupName, $id = null, $condition = null) {
1818 $cacheKey = $optionGroupName . '_' . $condition;
1819 if (empty(self
::$accountOptionValues[$cacheKey])) {
1820 self
::$accountOptionValues[$cacheKey] = CRM_Core_OptionGroup
::values($optionGroupName, false, false, false, $condition);
1823 return CRM_Utils_Array
::value($id, self
::$accountOptionValues[$cacheKey]);
1826 return self
::$accountOptionValues[$cacheKey];
1830 * Fetch the list of active extensions of type 'module'
1832 * @param $fresh bool whether to forcibly reload extensions list from canonical store
1836 * @return array - array(array('prefix' => $, 'file' => $))
1838 public static function getModuleExtensions($fresh = FALSE) {
1839 return CRM_Extension_System
::singleton()->getMapper()->getActiveModuleFiles($fresh);