CRM/Core/PseudoConstant.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * Stores all constants and pseudo constants for CRM application.
  31  *
  32  * examples of constants are "Contact Type" which will always be either
  33  * 'Individual', 'Household', 'Organization'.
  34  *
  35  * pseudo constants are entities from the database whose values rarely
  36  * change. examples are list of countries, states, location types,
  37  * relationship types.
  38  *
  39  * currently we're getting the data from the underlying database. this
  40  * will be reworked to use caching.
  41  *
  42  * Note: All pseudoconstants should be uninitialized or default to NULL.
  43  * This provides greater consistency/predictability after flushing.
  44  *
  45  * @package CRM
  46  * @copyright CiviCRM LLC (c) 2004-2017
  47  */
  48 class CRM_Core_PseudoConstant {
  49
  50   /**
  51    * Static cache for pseudoconstant arrays.
  52    * @var array
  53    */
  54   private static $cache;
  55
  56   /**
  57    * @deprecated Please use the buildOptions() method in the appropriate BAO object.
  58    *
  59    * activity type
  60    * @var array
  61    */
  62   private static $activityType;
  63
  64   /**
  65    * States, provinces
  66    * @var array
  67    */
  68   private static $stateProvince;
  69
  70   /**
  71    * Counties.
  72    * @var array
  73    */
  74   private static $county;
  75
  76   /**
  77    * States/provinces abbreviations
  78    * @var array
  79    */
  80   private static $stateProvinceAbbreviation = array();
  81
  82   /**
  83    * Country.
  84    * @var array
  85    */
  86   private static $country;
  87
  88   /**
  89    * CountryIsoCode.
  90    * @var array
  91    */
  92   private static $countryIsoCode;
  93
  94   /**
  95    * @deprecated Please use the buildOptions() method in the appropriate BAO object.
  96    *
  97    * group
  98    * @var array
  99    */
 100   private static $group;
 101
 102   /**
 103    * RelationshipType
 104    * @var array
 105    */
 106   private static $relationshipType;
 107
 108   /**
 109    * Civicrm groups that are not smart groups
 110    * @var array
 111    */
 112   private static $staticGroup;
 113
 114   /**
 115    * Currency codes
 116    * @var array
 117    */
 118   private static $currencyCode;
 119
 120   /**
 121    * Payment processor
 122    * @var array
 123    */
 124   private static $paymentProcessor;
 125
 126   /**
 127    * Payment processor types
 128    * @var array
 129    */
 130   private static $paymentProcessorType;
 131
 132   /**
 133    * World Region
 134    * @var array
 135    */
 136   private static $worldRegions;
 137
 138   /**
 139    * @deprecated Please use the buildOptions() method in the appropriate BAO object.
 140    *
 141    * activity status
 142    * @var array
 143    */
 144   private static $activityStatus;
 145
 146   /**
 147    * Visibility
 148    * @var array
 149    */
 150   private static $visibility;
 151
 152   /**
 153    * Greetings
 154    * @var array
 155    */
 156   private static $greeting;
 157
 158   /**
 159    * Extensions of type module
 160    * @var array
 161    */
 162   private static $extensions;
 163
 164   /**
 165    * Financial Account Type
 166    * @var array
 167    */
 168   private static $accountOptionValues;
 169
 170   /**
 171    * Low-level option getter, rarely accessed directly.
 172    * NOTE: Rather than calling this function directly use CRM_*_BAO_*::buildOptions()
 173    * @see http://wiki.civicrm.org/confluence/display/CRMDOC/Pseudoconstant+%28option+list%29+Reference
 174    *
 175    * NOTE: If someone undertakes a refactoring of this, please consider the use-case of
 176    * the Setting.getoptions API. There is no DAO/field, but it would be nice to use the
 177    * same 'pseudoconstant' struct in *.settings.php. This means loosening the coupling
 178    * between $field lookup and the $pseudoconstant evaluation.
 179    *
 180    * @param string $daoName
 181    * @param string $fieldName
 182    * @param array $params
 183    * - name       string  name of the option group
 184    * - flip       boolean results are return in id => label format if false
 185    *                            if true, the results are reversed
 186    * - grouping   boolean if true, return the value in 'grouping' column (currently unsupported for tables other than option_value)
 187    * - localize   boolean if true, localize the results before returning
 188    * - condition  string|array add condition(s) to the sql query - will be concatenated using 'AND'
 189    * - keyColumn  string the column to use for 'id'
 190    * - labelColumn string the column to use for 'label'
 191    * - orderColumn string the column to use for sorting, defaults to 'weight' column if one exists, else defaults to labelColumn
 192    * - onlyActive boolean return only the action option values
 193    * - fresh      boolean ignore cache entries and go back to DB
 194    * @param string $context : Context string
 195    *
 196    * @return array|bool
 197    *   array on success, FALSE on error.
 198    *
 199    */
 200   public static function get($daoName, $fieldName, $params = array(), $context = NULL) {
 201     CRM_Core_DAO::buildOptionsContext($context);
 202     $flip = !empty($params['flip']);
 203     // Merge params with defaults
 204     $params += array(
 205       'grouping' => FALSE,
 206       'localize' => FALSE,
 207       'onlyActive' => ($context == 'validate' || $context == 'get') ? FALSE : TRUE,
 208       'fresh' => FALSE,
 209       'context' => $context,
 210     );
 211     $entity = CRM_Core_DAO_AllCoreTables::getBriefName(CRM_Core_DAO_AllCoreTables::getCanonicalClassName($daoName));
 212
 213     // Custom fields are not in the schema
 214     if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
 215       $customField = new CRM_Core_BAO_CustomField();
 216       $customField->id = (int) substr($fieldName, 7);
 217       $options = $customField->getOptions($context);
 218       if ($options && $flip) {
 219         $options = array_flip($options);
 220       }
 221       $customField->free();
 222       return $options;
 223     }
 224
 225     // Core field: load schema
 226     $dao = new $daoName();
 227     $fieldSpec = $dao->getFieldSpec($fieldName);
 228     $dao->free();
 229
 230     // Ensure we have the canonical name for this field
 231     $fieldName = CRM_Utils_Array::value('name', $fieldSpec, $fieldName);
 232
 233     // Return false if field doesn't exist.
 234     if (empty($fieldSpec)) {
 235       return FALSE;
 236     }
 237
 238     elseif (!empty($fieldSpec['pseudoconstant'])) {
 239       $pseudoconstant = $fieldSpec['pseudoconstant'];
 240
 241       // if callback is specified..
 242       if (!empty($pseudoconstant['callback'])) {
 243         $fieldOptions = call_user_func(Civi\Core\Resolver::singleton()->get($pseudoconstant['callback']), $context);
 244         //CRM-18223: Allow additions to field options via hook.
 245         CRM_Utils_Hook::fieldOptions($entity, $fieldName, $fieldOptions, $params);
 246         return $fieldOptions;
 247       }
 248
 249       // Merge params with schema defaults
 250       $params += array(
 251         'condition' => CRM_Utils_Array::value('condition', $pseudoconstant, array()),
 252         'keyColumn' => CRM_Utils_Array::value('keyColumn', $pseudoconstant),
 253         'labelColumn' => CRM_Utils_Array::value('labelColumn', $pseudoconstant),
 254       );
 255
 256       if ($context == 'abbreviate') {
 257         switch ($fieldName) {
 258           case 'state_province_id':
 259             $params['labelColumn'] = 'abbreviation';
 260             break;
 261
 262           case 'country_id':
 263             $params['labelColumn'] = 'iso_code';
 264             break;
 265
 266           default:
 267         }
 268       }
 269
 270       // Fetch option group from option_value table
 271       if (!empty($pseudoconstant['optionGroupName'])) {
 272         if ($context == 'validate') {
 273           $params['labelColumn'] = 'name';
 274         }
 275         if ($context == 'match') {
 276           $params['keyColumn'] = 'name';
 277         }
 278         // Call our generic fn for retrieving from the option_value table
 279         $options = CRM_Core_OptionGroup::values(
 280           $pseudoconstant['optionGroupName'],
 281           $flip,
 282           $params['grouping'],
 283           $params['localize'],
 284           $params['condition'] ? ' AND ' . implode(' AND ', (array) $params['condition']) : NULL,
 285           $params['labelColumn'] ? $params['labelColumn'] : 'label',
 286           $params['onlyActive'],
 287           $params['fresh'],
 288           $params['keyColumn'] ? $params['keyColumn'] : 'value',
 289           !empty($params['orderColumn']) ? $params['orderColumn'] : 'weight'
 290         );
 291         CRM_Utils_Hook::fieldOptions($entity, $fieldName, $options, $params);
 292         return $options;
 293       }
 294
 295       // Fetch options from other tables
 296       if (!empty($pseudoconstant['table'])) {
 297         // Normalize params so the serialized cache string will be consistent.
 298         CRM_Utils_Array::remove($params, 'flip', 'fresh');
 299         ksort($params);
 300         $cacheKey = $daoName . $fieldName . serialize($params);
 301
 302         // Retrieve cached options
 303         if (isset(self::$cache[$cacheKey]) && empty($params['fresh'])) {
 304           $output = self::$cache[$cacheKey];
 305         }
 306         else {
 307           $daoName = CRM_Core_DAO_AllCoreTables::getClassForTable($pseudoconstant['table']);
 308           if (!class_exists($daoName)) {
 309             return FALSE;
 310           }
 311           // Get list of fields for the option table
 312           $dao = new $daoName();
 313           $availableFields = array_keys($dao->fieldKeys());
 314           $dao->free();
 315
 316           $select = "SELECT %1 AS id, %2 AS label";
 317           $from = "FROM %3";
 318           $wheres = array();
 319           $order = "ORDER BY %2";
 320
 321           // Use machine name in certain contexts
 322           if ($context == 'validate' || $context == 'match') {
 323             $nameField = $context == 'validate' ? 'labelColumn' : 'keyColumn';
 324             if (!empty($pseudoconstant['nameColumn'])) {
 325               $params[$nameField] = $pseudoconstant['nameColumn'];
 326             }
 327             elseif (in_array('name', $availableFields)) {
 328               $params[$nameField] = 'name';
 329             }
 330           }
 331           // Condition param can be passed as an sql clause string or an array of clauses
 332           if (!empty($params['condition'])) {
 333             $wheres[] = implode(' AND ', (array) $params['condition']);
 334           }
 335           // onlyActive param will automatically filter on common flags
 336           if (!empty($params['onlyActive'])) {
 337             foreach (array('is_active' => 1, 'is_deleted' => 0, 'is_test' => 0, 'is_hidden' => 0) as $flag => $val) {
 338               if (in_array($flag, $availableFields)) {
 339                 $wheres[] = "$flag = $val";
 340               }
 341             }
 342           }
 343           // Filter domain specific options
 344           if (in_array('domain_id', $availableFields)) {
 345             $wheres[] = 'domain_id = ' . CRM_Core_Config::domainID();
 346           }
 347           $queryParams = array(
 348             1 => array($params['keyColumn'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES),
 349             2 => array($params['labelColumn'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES),
 350             3 => array($pseudoconstant['table'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES),
 351           );
 352           // Add orderColumn param
 353           if (!empty($params['orderColumn'])) {
 354             $queryParams[4] = array($params['orderColumn'], 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES);
 355             $order = "ORDER BY %4";
 356           }
 357           // Support no sorting if $params[orderColumn] is FALSE
 358           elseif (isset($params['orderColumn']) && $params['orderColumn'] === FALSE) {
 359             $order = '';
 360           }
 361           // Default to 'weight' if that column exists
 362           elseif (in_array('weight', $availableFields)) {
 363             $order = "ORDER BY weight";
 364           }
 365
 366           $output = array();
 367           $query = "$select $from";
 368           if ($wheres) {
 369             $query .= " WHERE " . implode($wheres, ' AND ');
 370           }
 371           $query .= ' ' . $order;
 372           $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
 373           while ($dao->fetch()) {
 374             $output[$dao->id] = $dao->label;
 375           }
 376           $dao->free();
 377           // Localize results
 378           if (!empty($params['localize']) || $pseudoconstant['table'] == 'civicrm_country' || $pseudoconstant['table'] == 'civicrm_state_province') {
 379             $I18nParams = array();
 380             if ($pseudoconstant['table'] == 'civicrm_country') {
 381               $I18nParams['context'] = 'country';
 382             }
 383             if ($pseudoconstant['table'] == 'civicrm_state_province') {
 384               $I18nParams['context'] = 'province';
 385             }
 386             $i18n = CRM_Core_I18n::singleton();
 387             $i18n->localizeArray($output, $I18nParams);
 388             // Maintain sort by label
 389             if ($order == "ORDER BY %2") {
 390               CRM_Utils_Array::asort($output);
 391             }
 392           }
 393           CRM_Utils_Hook::fieldOptions($entity, $fieldName, $output, $params);
 394           self::$cache[$cacheKey] = $output;
 395         }
 396         return $flip ? array_flip($output) : $output;
 397       }
 398     }
 399
 400     // Return "Yes" and "No" for boolean fields
 401     elseif (CRM_Utils_Array::value('type', $fieldSpec) === CRM_Utils_Type::T_BOOLEAN) {
 402       $output = $context == 'validate' ? array(0, 1) : CRM_Core_SelectValues::boolean();
 403       CRM_Utils_Hook::fieldOptions($entity, $fieldName, $output, $params);
 404       return $flip ? array_flip($output) : $output;
 405     }
 406     // If we're still here, it's an error. Return FALSE.
 407     return FALSE;
 408   }
 409
 410   /**
 411    * Fetch the translated label for a field given its key.
 412    *
 413    * @param string $baoName
 414    * @param string $fieldName
 415    * @param string|Int $key
 416    *
 417    * TODO: Accept multivalued input?
 418    *
 419    * @return bool|null|string
 420    *   FALSE if the given field has no associated option list
 421    *   NULL if the given key has no corresponding option
 422    *   String if label is found
 423    */
 424   public static function getLabel($baoName, $fieldName, $key) {
 425     $values = $baoName::buildOptions($fieldName, 'get');
 426     if ($values === FALSE) {
 427       return FALSE;
 428     }
 429     return CRM_Utils_Array::value($key, $values);
 430   }
 431
 432   /**
 433    * Fetch the machine name for a field given its key.
 434    *
 435    * @param string $baoName
 436    * @param string $fieldName
 437    * @param string|Int $key
 438    *
 439    * @return bool|null|string
 440    *   FALSE if the given field has no associated option list
 441    *   NULL if the given key has no corresponding option
 442    *   String if label is found
 443    */
 444   public static function getName($baoName, $fieldName, $key) {
 445     $values = $baoName::buildOptions($fieldName, 'validate');
 446     if ($values === FALSE) {
 447       return FALSE;
 448     }
 449     return CRM_Utils_Array::value($key, $values);
 450   }
 451
 452   /**
 453    * Fetch the key for a field option given its name.
 454    *
 455    * @param string $baoName
 456    * @param string $fieldName
 457    * @param string|Int $value
 458    *
 459    * @return bool|null|string|int
 460    *   FALSE if the given field has no associated option list
 461    *   NULL if the given key has no corresponding option
 462    *   String|Number if key is found
 463    */
 464   public static function getKey($baoName, $fieldName, $value) {
 465     $values = $baoName::buildOptions($fieldName, 'validate');
 466     if ($values === FALSE) {
 467       return FALSE;
 468     }
 469     return CRM_Utils_Array::key($value, $values);
 470   }
 471
 472   /**
 473    * Lookup the admin page at which a field's option list can be edited
 474    * @param $fieldSpec
 475    * @return string|null
 476    */
 477   public static function getOptionEditUrl($fieldSpec) {
 478     // If it's an option group, that's easy
 479     if (!empty($fieldSpec['pseudoconstant']['optionGroupName'])) {
 480       return 'civicrm/admin/options/' . $fieldSpec['pseudoconstant']['optionGroupName'];
 481     }
 482     // For everything else...
 483     elseif (!empty($fieldSpec['pseudoconstant']['table'])) {
 484       $daoName = CRM_Core_DAO_AllCoreTables::getClassForTable($fieldSpec['pseudoconstant']['table']);
 485       if (!$daoName) {
 486         return NULL;
 487       }
 488       // We don't have good mapping so have to do a bit of guesswork from the menu
 489       list(, $parent, , $child) = explode('_', $daoName);
 490       $sql = "SELECT path FROM civicrm_menu
 491         WHERE page_callback LIKE '%CRM_Admin_Page_$child%' OR page_callback LIKE '%CRM_{$parent}_Page_$child%'
 492         ORDER BY page_callback
 493         LIMIT 1";
 494       return CRM_Core_Dao::singleValueQuery($sql);
 495     }
 496     return NULL;
 497   }
 498
 499   /**
 500    * DEPRECATED generic populate method.
 501    * All pseudoconstant functions that use this method are also @deprecated
 502    *
 503    * The static array $var is populated from the db
 504    * using the <b>$name DAO</b>.
 505    *
 506    * Note: any database errors will be trapped by the DAO.
 507    *
 508    * @param array $var
 509    *   The associative array we will fill.
 510    * @param string $name
 511    *   The name of the DAO.
 512    * @param bool $all
 513    *   Get all objects. default is to get only active ones.
 514    * @param string $retrieve
 515    *   The field that we are interested in (normally name, differs in some objects).
 516    * @param string $filter
 517    *   The field that we want to filter the result set with.
 518    * @param string $condition
 519    *   The condition that gets passed to the final query as the WHERE clause.
 520    *
 521    * @param bool $orderby
 522    * @param string $key
 523    * @param bool $force
 524    *
 525    * @return array
 526    */
 527   public static function populate(
 528     &$var,
 529     $name,
 530     $all = FALSE,
 531     $retrieve = 'name',
 532     $filter = 'is_active',
 533     $condition = NULL,
 534     $orderby = NULL,
 535     $key = 'id',
 536     $force = NULL
 537   ) {
 538     $cacheKey = "CRM_PC_{$name}_{$all}_{$key}_{$retrieve}_{$filter}_{$condition}_{$orderby}";
 539     $cache = CRM_Utils_Cache::singleton();
 540     $var = $cache->get($cacheKey);
 541     if ($var && empty($force)) {
 542       return $var;
 543     }
 544
 545     /* @var CRM_Core_DAO $object */
 546     $object = new $name();
 547
 548     $object->selectAdd();
 549     $object->selectAdd("$key, $retrieve");
 550     if ($condition) {
 551       $object->whereAdd($condition);
 552     }
 553
 554     if (!$orderby) {
 555       $object->orderBy($retrieve);
 556     }
 557     else {
 558       $object->orderBy($orderby);
 559     }
 560
 561     if (!$all) {
 562       $object->$filter = 1;
 563       $aclClauses = array_filter($name::getSelectWhereClause());
 564       foreach ($aclClauses as $clause) {
 565         $object->whereAdd($clause);
 566       }
 567     }
 568
 569     $object->find();
 570     $var = array();
 571     while ($object->fetch()) {
 572       $var[$object->$key] = $object->$retrieve;
 573     }
 574
 575     $cache->set($cacheKey, $var);
 576   }
 577
 578   /**
 579    * Flush given pseudoconstant so it can be reread from db.
 580    * nex time it's requested.
 581    *
 582    *
 583    * @param bool|string $name pseudoconstant to be flushed
 584    */
 585   public static function flush($name = 'cache') {
 586     if (isset(self::$$name)) {
 587       self::$$name = NULL;
 588     }
 589     if ($name == 'cache') {
 590       CRM_Core_OptionGroup::flushAll();
 591       if (isset(\Civi::$statics[__CLASS__])) {
 592         unset(\Civi::$statics[__CLASS__]);
 593       }
 594     }
 595   }
 596
 597   /**
 598    * @deprecated Please use the buildOptions() method in the appropriate BAO object.
 599    *
 600    * Get all Activty types.
 601    *
 602    * The static array activityType is returned
 603    *
 604    *
 605    * @return array
 606    *   array reference of all activity types.
 607    */
 608   public static function &activityType() {
 609     $args = func_get_args();
 610     $all = CRM_Utils_Array::value(0, $args, TRUE);
 611     $includeCaseActivities = CRM_Utils_Array::value(1, $args, FALSE);
 612     $reset = CRM_Utils_Array::value(2, $args, FALSE);
 613     $returnColumn = CRM_Utils_Array::value(3, $args, 'label');
 614     $includeCampaignActivities = CRM_Utils_Array::value(4, $args, FALSE);
 615     $onlyComponentActivities = CRM_Utils_Array::value(5, $args, FALSE);
 616     $index = (int) $all . '_' . $returnColumn . '_' . (int) $includeCaseActivities;
 617     $index .= '_' . (int) $includeCampaignActivities;
 618     $index .= '_' . (int) $onlyComponentActivities;
 619
 620     if (NULL === self::$activityType) {
 621       self::$activityType = array();
 622     }
 623
 624     if (!isset(self::$activityType[$index]) || $reset) {
 625       $condition = NULL;
 626       if (!$all) {
 627         $condition = 'AND filter = 0';
 628       }
 629       $componentClause = " v.component_id IS NULL";
 630       if ($onlyComponentActivities) {
 631         $componentClause = " v.component_id IS NOT NULL";
 632       }
 633
 634       $componentIds = array();
 635       $compInfo = CRM_Core_Component::getEnabledComponents();
 636
 637       // build filter for listing activity types only if their
 638       // respective components are enabled
 639       foreach ($compInfo as $compName => $compObj) {
 640         if ($compName == 'CiviCase') {
 641           if ($includeCaseActivities) {
 642             $componentIds[] = $compObj->componentID;
 643           }
 644         }
 645         elseif ($compName == 'CiviCampaign') {
 646           if ($includeCampaignActivities) {
 647             $componentIds[] = $compObj->componentID;
 648           }
 649         }
 650         else {
 651           $componentIds[] = $compObj->componentID;
 652         }
 653       }
 654
 655       if (count($componentIds)) {
 656         $componentIds = implode(',', $componentIds);
 657         $componentClause = " ($componentClause OR v.component_id IN ($componentIds))";
 658         if ($onlyComponentActivities) {
 659           $componentClause = " ( v.component_id IN ($componentIds ) )";
 660         }
 661       }
 662       $condition = $condition . ' AND ' . $componentClause;
 663
 664       self::$activityType[$index] = CRM_Core_OptionGroup::values('activity_type', FALSE, FALSE, FALSE, $condition, $returnColumn);
 665     }
 666     return self::$activityType[$index];
 667   }
 668
 669   /**
 670    * Get all the State/Province from database.
 671    *
 672    * The static array stateProvince is returned, and if it's
 673    * called the first time, the <b>State Province DAO</b> is used
 674    * to get all the States.
 675    *
 676    * Note: any database errors will be trapped by the DAO.
 677    *
 678    *
 679    * @param bool|int $id - Optional id to return
 680    *
 681    * @param bool $limit
 682    *
 683    * @return array
 684    *   array reference of all State/Provinces.
 685    */
 686   public static function &stateProvince($id = FALSE, $limit = TRUE) {
 687     if (($id && !CRM_Utils_Array::value($id, self::$stateProvince)) || !self::$stateProvince || !$id) {
 688       $whereClause = FALSE;
 689       if ($limit) {
 690         $countryIsoCodes = self::countryIsoCode();
 691         $limitCodes = CRM_Core_BAO_Country::provinceLimit();
 692         $limitIds = array();
 693         foreach ($limitCodes as $code) {
 694           $limitIds = array_merge($limitIds, array_keys($countryIsoCodes, $code));
 695         }
 696         if (!empty($limitIds)) {
 697           $whereClause = 'country_id IN (' . implode(', ', $limitIds) . ')';
 698         }
 699         else {
 700           $whereClause = FALSE;
 701         }
 702       }
 703       self::populate(self::$stateProvince, 'CRM_Core_DAO_StateProvince', TRUE, 'name', 'is_active', $whereClause);
 704
 705       // localise the province names if in an non-en_US locale
 706       $tsLocale = CRM_Core_I18n::getLocale();
 707       if ($tsLocale != '' and $tsLocale != 'en_US') {
 708         $i18n = CRM_Core_I18n::singleton();
 709         $i18n->localizeArray(self::$stateProvince, array(
 710           'context' => 'province',
 711         ));
 712         self::$stateProvince = CRM_Utils_Array::asort(self::$stateProvince);
 713       }
 714     }
 715     if ($id) {
 716       if (array_key_exists($id, self::$stateProvince)) {
 717         return self::$stateProvince[$id];
 718       }
 719       else {
 720         $result = NULL;
 721         return $result;
 722       }
 723     }
 724     return self::$stateProvince;
 725   }
 726
 727   /**
 728    * Get all the State/Province abbreviations from the database.
 729    *
 730    * Same as above, except gets the abbreviations instead of the names.
 731    *
 732    *
 733    * @param bool|int $id - Optional id to return
 734    *
 735    * @param bool $limit
 736    *
 737    * @return array
 738    *   array reference of all State/Province abbreviations.
 739    */
 740   public static function stateProvinceAbbreviation($id = FALSE, $limit = TRUE) {
 741     if ($id && is_numeric($id)) {
 742       if (!array_key_exists($id, (array) self::$stateProvinceAbbreviation)) {
 743         $query = "SELECT abbreviation
 744 FROM   civicrm_state_province
 745 WHERE  id = %1";
 746         $params = array(
 747           1 => array(
 748             $id,
 749             'Integer',
 750           ),
 751         );
 752         self::$stateProvinceAbbreviation[$id] = CRM_Core_DAO::singleValueQuery($query, $params);
 753       }
 754       return self::$stateProvinceAbbreviation[$id];
 755     }
 756     else {
 757       $whereClause = FALSE;
 758
 759       if ($limit) {
 760         $countryIsoCodes = self::countryIsoCode();
 761         $limitCodes = CRM_Core_BAO_Country::provinceLimit();
 762         $limitIds = array();
 763         foreach ($limitCodes as $code) {
 764           $tmpArray = array_keys($countryIsoCodes, $code);
 765
 766           if (!empty($tmpArray)) {
 767             $limitIds[] = array_shift($tmpArray);
 768           }
 769         }
 770         if (!empty($limitIds)) {
 771           $whereClause = 'country_id IN (' . implode(', ', $limitIds) . ')';
 772         }
 773       }
 774       self::populate(self::$stateProvinceAbbreviation, 'CRM_Core_DAO_StateProvince', TRUE, 'abbreviation', 'is_active', $whereClause);
 775     }
 776
 777     return self::$stateProvinceAbbreviation;
 778   }
 779
 780   /**
 781    * Get all the State/Province abbreviations from the database for the specified country.
 782    *
 783    * @param int $countryID
 784    *
 785    * @return array
 786    *   array of all State/Province abbreviations for the given country.
 787    */
 788   public static function stateProvinceAbbreviationForCountry($countryID) {
 789     if (!isset(\Civi::$statics[__CLASS__]['stateProvinceAbbreviationForCountry'][$countryID])) {
 790       \Civi::$statics[__CLASS__]['stateProvinceAbbreviationForCountry'][$countryID] = array();
 791     }
 792     self::populate(\Civi::$statics[__CLASS__]['stateProvinceAbbreviationForCountry'][$countryID], 'CRM_Core_DAO_StateProvince', TRUE, 'abbreviation', 'is_active', "country_id = " . (int) $countryID, 'abbreviation');
 793     return \Civi::$statics[__CLASS__]['stateProvinceAbbreviationForCountry'][$countryID];
 794   }
 795
 796   /**
 797    * Get all the State/Province abbreviations from the database for the default country.
 798    *
 799    * @return array
 800    *   array of all State/Province abbreviations for the given country.
 801    */
 802   public static function stateProvinceAbbreviationForDefaultCountry() {
 803     return CRM_Core_PseudoConstant::stateProvinceAbbreviationForCountry(Civi::settings()->get('defaultContactCountry'));
 804   }
 805
 806   /**
 807    * Get all the countries from database.
 808    *
 809    * The static array country is returned, and if it's
 810    * called the first time, the <b>Country DAO</b> is used
 811    * to get all the countries.
 812    *
 813    * Note: any database errors will be trapped by the DAO.
 814    *
 815    *
 816    * @param bool|int $id - Optional id to return
 817    *
 818    * @param bool $applyLimit
 819    *
 820    * @return array|null
 821    *   array reference of all countries.
 822    */
 823   public static function country($id = FALSE, $applyLimit = TRUE) {
 824     if (($id && !CRM_Utils_Array::value($id, self::$country)) || !self::$country || !$id) {
 825
 826       $config = CRM_Core_Config::singleton();
 827       $limitCodes = array();
 828
 829       if ($applyLimit) {
 830         // limit the country list to the countries specified in CIVICRM_COUNTRY_LIMIT
 831         // (ensuring it's a subset of the legal values)
 832         // K/P: We need to fix this, i dont think it works with new setting files
 833         $limitCodes = CRM_Core_BAO_Country::countryLimit();
 834         if (!is_array($limitCodes)) {
 835           $limitCodes = array(
 836             $config->countryLimit => 1,
 837           );
 838         }
 839
 840         $limitCodes = array_intersect(self::countryIsoCode(), $limitCodes);
 841       }
 842
 843       if (count($limitCodes)) {
 844         $whereClause = "iso_code IN ('" . implode("', '", $limitCodes) . "')";
 845       }
 846       else {
 847         $whereClause = NULL;
 848       }
 849
 850       self::populate(self::$country, 'CRM_Core_DAO_Country', TRUE, 'name', 'is_active', $whereClause);
 851
 852       // if default country is set, percolate it to the top
 853       if ($config->defaultContactCountry()) {
 854         $countryIsoCodes = self::countryIsoCode();
 855         $defaultID = array_search($config->defaultContactCountry(), $countryIsoCodes);
 856         if ($defaultID !== FALSE) {
 857           $default[$defaultID] = CRM_Utils_Array::value($defaultID, self::$country);
 858           self::$country = $default + self::$country;
 859         }
 860       }
 861
 862       // localise the country names if in an non-en_US locale
 863       $tsLocale = CRM_Core_I18n::getLocale();
 864       if ($tsLocale != '' and $tsLocale != 'en_US') {
 865         $i18n = CRM_Core_I18n::singleton();
 866         $i18n->localizeArray(self::$country, array(
 867           'context' => 'country',
 868         ));
 869         self::$country = CRM_Utils_Array::asort(self::$country);
 870       }
 871     }
 872     if ($id) {
 873       if (array_key_exists($id, self::$country)) {
 874         return self::$country[$id];
 875       }
 876       else {
 877         return NULL;
 878       }
 879     }
 880     return self::$country;
 881   }
 882
 883   /**
 884    * Get all the country ISO Code abbreviations from the database.
 885    *
 886    * The static array countryIsoCode is returned, and if it's
 887    * called the first time, the <b>Country DAO</b> is used
 888    * to get all the countries' ISO codes.
 889    *
 890    * Note: any database errors will be trapped by the DAO.
 891    *
 892    *
 893    * @param bool $id
 894    *
 895    * @return array
 896    *   array reference of all country ISO codes.
 897    */
 898   public static function &countryIsoCode($id = FALSE) {
 899     if (!self::$countryIsoCode) {
 900       self::populate(self::$countryIsoCode, 'CRM_Core_DAO_Country', TRUE, 'iso_code');
 901     }
 902     if ($id) {
 903       if (array_key_exists($id, self::$countryIsoCode)) {
 904         return self::$countryIsoCode[$id];
 905       }
 906       else {
 907         return CRM_Core_DAO::$_nullObject;
 908       }
 909     }
 910     return self::$countryIsoCode;
 911   }
 912
 913   /**
 914    * @deprecated Please use the buildOptions() method in the appropriate BAO object.
 915    *
 916    * Get all groups from database
 917    *
 918    * The static array group is returned, and if it's
 919    * called the first time, the <b>Group DAO</b> is used
 920    * to get all the groups.
 921    *
 922    * Note: any database errors will be trapped by the DAO.
 923    *
 924    * @param string $groupType
 925    *   Type of group(Access/Mailing).
 926    * @param bool $excludeHidden
 927    *   Exclude hidden groups.
 928    *
 929    *
 930    * @return array
 931    *   array reference of all groups.
 932    */
 933   public static function allGroup($groupType = NULL, $excludeHidden = TRUE) {
 934     $condition = CRM_Contact_BAO_Group::groupTypeCondition($groupType, $excludeHidden);
 935     $groupKey = ($groupType ? $groupType : 'null') . !empty($excludeHidden);
 936
 937     if (!isset(Civi::$statics[__CLASS__]['groups']['allGroup'][$groupKey])) {
 938       self::populate(Civi::$statics[__CLASS__]['groups']['allGroup'][$groupKey], 'CRM_Contact_DAO_Group', FALSE, 'title', 'is_active', $condition);
 939     }
 940     return Civi::$statics[__CLASS__]['groups']['allGroup'][$groupKey];
 941   }
 942
 943   /**
 944    * Get all permissioned groups from database.
 945    *
 946    * The static array group is returned, and if it's
 947    * called the first time, the <b>Group DAO</b> is used
 948    * to get all the groups.
 949    *
 950    * Note: any database errors will be trapped by the DAO.
 951    *
 952    * @param string $groupType
 953    *   Type of group(Access/Mailing).
 954    * @param bool $excludeHidden
 955    *   Exclude hidden groups.
 956    *
 957    *
 958    * @return array
 959    *   array reference of all groups.
 960    */
 961   public static function group($groupType = NULL, $excludeHidden = TRUE) {
 962     return CRM_Core_Permission::group($groupType, $excludeHidden);
 963   }
 964
 965   /**
 966    * Fetch groups in a nested format suitable for use in select form element.
 967    * @param bool $checkPermissions
 968    * @param string|null $groupType
 969    * @param bool $excludeHidden
 970    * @return array
 971    */
 972   public static function nestedGroup($checkPermissions = TRUE, $groupType = NULL, $excludeHidden = TRUE) {
 973     $groups = $checkPermissions ? self::group($groupType, $excludeHidden) : self::allGroup($groupType, $excludeHidden);
 974     return CRM_Contact_BAO_Group::getGroupsHierarchy($groups, NULL, '&nbsp;&nbsp;', TRUE);
 975   }
 976
 977   /**
 978    * Get all permissioned groups from database.
 979    *
 980    * The static array group is returned, and if it's
 981    * called the first time, the <b>Group DAO</b> is used
 982    * to get all the groups.
 983    *
 984    * Note: any database errors will be trapped by the DAO.
 985    *
 986    *
 987    * @param bool $onlyPublic
 988    * @param null $groupType
 989    * @param bool $excludeHidden
 990    *
 991    * @return array
 992    *   array reference of all groups.
 993    */
 994   public static function &staticGroup($onlyPublic = FALSE, $groupType = NULL, $excludeHidden = TRUE) {
 995     if (!self::$staticGroup) {
 996       $condition = 'saved_search_id = 0 OR saved_search_id IS NULL';
 997       if ($onlyPublic) {
 998         $condition .= " AND visibility != 'User and User Admin Only'";
 999       }
1000
1001       if ($groupType) {
1002         $condition .= ' AND ' . CRM_Contact_BAO_Group::groupTypeCondition($groupType);
1003       }
1004
1005       if ($excludeHidden) {
1006         $condition .= ' AND is_hidden != 1 ';
1007       }
1008
1009       self::populate(self::$staticGroup, 'CRM_Contact_DAO_Group', FALSE, 'title', 'is_active', $condition, 'title');
1010     }
1011
1012     return self::$staticGroup;
1013   }
1014
1015   /**
1016    * Get all Relationship Types  from database.
1017    *
1018    * The static array group is returned, and if it's
1019    * called the first time, the <b>RelationshipType DAO</b> is used
1020    * to get all the relationship types.
1021    *
1022    * Note: any database errors will be trapped by the DAO.
1023    *
1024    * @param string $valueColumnName
1025    *   Db column name/label.
1026    * @param bool $reset
1027    *   Reset relationship types if true.
1028    * @param bool $isActive
1029    *   Filter by is_active. NULL to disable.
1030    *
1031    * @return array
1032    *   array reference of all relationship types.
1033    */
1034   public static function &relationshipType($valueColumnName = 'label', $reset = FALSE, $isActive = 1) {
1035     $cacheKey = $valueColumnName . '::' . $isActive;
1036     if (!CRM_Utils_Array::value($cacheKey, self::$relationshipType) || $reset) {
1037       self::$relationshipType[$cacheKey] = array();
1038
1039       //now we have name/label columns CRM-3336
1040       $column_a_b = "{$valueColumnName}_a_b";
1041       $column_b_a = "{$valueColumnName}_b_a";
1042
1043       $relationshipTypeDAO = new CRM_Contact_DAO_RelationshipType();
1044       $relationshipTypeDAO->selectAdd();
1045       $relationshipTypeDAO->selectAdd("id, {$column_a_b}, {$column_b_a}, contact_type_a, contact_type_b, contact_sub_type_a, contact_sub_type_b");
1046       if ($isActive !== NULL) {
1047         $relationshipTypeDAO->is_active = $isActive;
1048       }
1049       $relationshipTypeDAO->find();
1050       while ($relationshipTypeDAO->fetch()) {
1051
1052         self::$relationshipType[$cacheKey][$relationshipTypeDAO->id] = array(
1053           'id' => $relationshipTypeDAO->id,
1054           $column_a_b => $relationshipTypeDAO->$column_a_b,
1055           $column_b_a => $relationshipTypeDAO->$column_b_a,
1056           'contact_type_a' => "$relationshipTypeDAO->contact_type_a",
1057           'contact_type_b' => "$relationshipTypeDAO->contact_type_b",
1058           'contact_sub_type_a' => "$relationshipTypeDAO->contact_sub_type_a",
1059           'contact_sub_type_b' => "$relationshipTypeDAO->contact_sub_type_b",
1060         );
1061       }
1062     }
1063
1064     return self::$relationshipType[$cacheKey];
1065   }
1066
1067   /**
1068    * Get all the ISO 4217 currency codes
1069    *
1070    * so far, we use this for validation only, so there's no point of putting this into the database
1071    *
1072    *
1073    * @return array
1074    *   array reference of all currency codes
1075    */
1076   public static function &currencyCode() {
1077     if (!self::$currencyCode) {
1078
1079       $query = "SELECT name FROM civicrm_currency";
1080       $dao = CRM_Core_DAO::executeQuery($query);
1081       $currencyCode = array();
1082       while ($dao->fetch()) {
1083         self::$currencyCode[] = $dao->name;
1084       }
1085     }
1086     return self::$currencyCode;
1087   }
1088
1089   /**
1090    * Get all the County from database.
1091    *
1092    * The static array county is returned, and if it's
1093    * called the first time, the <b>County DAO</b> is used
1094    * to get all the Counties.
1095    *
1096    * Note: any database errors will be trapped by the DAO.
1097    *
1098    *
1099    * @param bool|int $id - Optional id to return
1100    *
1101    * @return array
1102    *   array reference of all Counties
1103    */
1104   public static function &county($id = FALSE) {
1105     if (!self::$county) {
1106
1107       $config = CRM_Core_Config::singleton();
1108       // order by id so users who populate civicrm_county can have more control over sort by the order they load the counties
1109       self::populate(self::$county, 'CRM_Core_DAO_County', TRUE, 'name', NULL, NULL, 'id');
1110     }
1111     if ($id) {
1112       if (array_key_exists($id, self::$county)) {
1113         return self::$county[$id];
1114       }
1115       else {
1116         return CRM_Core_DAO::$_nullObject;
1117       }
1118     }
1119     return self::$county;
1120   }
1121
1122   /**
1123    * @deprecated Please use the buildOptions() method in the appropriate BAO object.
1124    * Get all active payment processors
1125    *
1126    * The static array paymentProcessor is returned
1127    *
1128    *
1129    * @param bool $all
1130    *   Get payment processors - default is to get only active ones.
1131    * @param bool $test
1132    *   Get test payment processors.
1133    *
1134    * @param null $additionalCond
1135    *
1136    * @return array
1137    *   array of all payment processors
1138    */
1139   public static function paymentProcessor($all = FALSE, $test = FALSE, $additionalCond = NULL) {
1140     $condition = "is_test = ";
1141     $condition .= ($test) ? '1' : '0';
1142
1143     if ($additionalCond) {
1144       $condition .= " AND ( $additionalCond ) ";
1145     }
1146
1147     // CRM-7178. Make sure we only include payment processors valid in this
1148     // domain
1149     $condition .= " AND domain_id = " . CRM_Core_Config::domainID();
1150
1151     $cacheKey = $condition . '_' . (int) $all;
1152     if (!isset(self::$paymentProcessor[$cacheKey])) {
1153       self::populate(self::$paymentProcessor[$cacheKey], 'CRM_Financial_DAO_PaymentProcessor', $all, 'name', 'is_active', $condition, 'is_default desc, name');
1154     }
1155
1156     return self::$paymentProcessor[$cacheKey];
1157   }
1158
1159   /**
1160    * @deprecated Please use the buildOptions() method in the appropriate BAO object.
1161    *
1162    * The static array paymentProcessorType is returned
1163    *
1164    *
1165    * @param bool $all
1166    *   Get payment processors - default is to get only active ones.
1167    *
1168    * @param int $id
1169    * @param string $return
1170    *
1171    * @return array
1172    *   array of all payment processor types
1173    */
1174   public static function &paymentProcessorType($all = FALSE, $id = NULL, $return = 'title') {
1175     $cacheKey = $id . '_' . $return;
1176     if (empty(self::$paymentProcessorType[$cacheKey])) {
1177       self::populate(self::$paymentProcessorType[$cacheKey], 'CRM_Financial_DAO_PaymentProcessorType', $all, $return, 'is_active', NULL, "is_default, $return", 'id');
1178     }
1179     if ($id && CRM_Utils_Array::value($id, self::$paymentProcessorType[$cacheKey])) {
1180       return self::$paymentProcessorType[$cacheKey][$id];
1181     }
1182     return self::$paymentProcessorType[$cacheKey];
1183   }
1184
1185   /**
1186    * Get all the World Regions from Database.
1187    *
1188    *
1189    * @param bool $id
1190    *
1191    * @return array
1192    *   array reference of all World Regions
1193    */
1194   public static function &worldRegion($id = FALSE) {
1195     if (!self::$worldRegions) {
1196       self::populate(self::$worldRegions, 'CRM_Core_DAO_Worldregion', TRUE, 'name', NULL, NULL, 'id');
1197     }
1198
1199     if ($id) {
1200       if (array_key_exists($id, self::$worldRegions)) {
1201         return self::$worldRegions[$id];
1202       }
1203       else {
1204         return CRM_Core_DAO::$_nullObject;
1205       }
1206     }
1207
1208     return self::$worldRegions;
1209   }
1210
1211   /**
1212    * @deprecated Please use the buildOptions() method in the appropriate BAO object.
1213    *
1214    * Get all Activity Statuses.
1215    *
1216    * The static array activityStatus is returned
1217    *
1218    *
1219    * @param string $column
1220    *
1221    * @return array
1222    *   array reference of all activity statuses
1223    */
1224   public static function &activityStatus($column = 'label') {
1225     if (NULL === self::$activityStatus) {
1226       self::$activityStatus = array();
1227     }
1228     if (!array_key_exists($column, self::$activityStatus)) {
1229       self::$activityStatus[$column] = array();
1230
1231       self::$activityStatus[$column] = CRM_Core_OptionGroup::values('activity_status', FALSE, FALSE, FALSE, NULL, $column);
1232     }
1233
1234     return self::$activityStatus[$column];
1235   }
1236
1237   /**
1238    * @deprecated Please use the buildOptions() method in the appropriate BAO object.
1239    *
1240    * Get all Visibility levels.
1241    *
1242    * The static array visibility is returned
1243    *
1244    *
1245    * @param string $column
1246    *
1247    * @return array
1248    *   array reference of all Visibility levels.
1249    */
1250   public static function &visibility($column = 'label') {
1251     if (!isset(self::$visibility)) {
1252       self::$visibility = array();
1253     }
1254
1255     if (!isset(self::$visibility[$column])) {
1256       self::$visibility[$column] = CRM_Core_OptionGroup::values('visibility', FALSE, FALSE, FALSE, NULL, $column);
1257     }
1258
1259     return self::$visibility[$column];
1260   }
1261
1262   /**
1263    * @param int $countryID
1264    * @param string $field
1265    *
1266    * @return array
1267    */
1268   public static function &stateProvinceForCountry($countryID, $field = 'name') {
1269     static $_cache = NULL;
1270
1271     $cacheKey = "{$countryID}_{$field}";
1272     if (!$_cache) {
1273       $_cache = array();
1274     }
1275
1276     if (!empty($_cache[$cacheKey])) {
1277       return $_cache[$cacheKey];
1278     }
1279
1280     $query = "
1281 SELECT civicrm_state_province.{$field} name, civicrm_state_province.id id
1282   FROM civicrm_state_province
1283 WHERE country_id = %1
1284 ORDER BY name";
1285     $params = array(
1286       1 => array(
1287         $countryID,
1288         'Integer',
1289       ),
1290     );
1291
1292     $dao = CRM_Core_DAO::executeQuery($query, $params);
1293
1294     $result = array();
1295     while ($dao->fetch()) {
1296       $result[$dao->id] = $dao->name;
1297     }
1298
1299     // localise the stateProvince names if in an non-en_US locale
1300     $config = CRM_Core_Config::singleton();
1301     $tsLocale = CRM_Core_I18n::getLocale();
1302     if ($tsLocale != '' and $tsLocale != 'en_US') {
1303       $i18n = CRM_Core_I18n::singleton();
1304       $i18n->localizeArray($result, array(
1305         'context' => 'province',
1306       ));
1307       $result = CRM_Utils_Array::asort($result);
1308     }
1309
1310     $_cache[$cacheKey] = $result;
1311
1312     CRM_Utils_Hook::buildStateProvinceForCountry($countryID, $result);
1313
1314     return $result;
1315   }
1316
1317   /**
1318    * @param int $stateID
1319    *
1320    * @return array
1321    */
1322   public static function &countyForState($stateID) {
1323     if (is_array($stateID)) {
1324       $states = implode(", ", $stateID);
1325       $query = "
1326     SELECT civicrm_county.name name, civicrm_county.id id, civicrm_state_province.abbreviation abbreviation
1327       FROM civicrm_county
1328       LEFT JOIN civicrm_state_province ON civicrm_county.state_province_id = civicrm_state_province.id
1329     WHERE civicrm_county.state_province_id in ( $states )
1330     ORDER BY civicrm_state_province.abbreviation, civicrm_county.name";
1331
1332       $dao = CRM_Core_DAO::executeQuery($query);
1333
1334       $result = array();
1335       while ($dao->fetch()) {
1336         $result[$dao->id] = $dao->abbreviation . ': ' . $dao->name;
1337       }
1338     }
1339     else {
1340
1341       static $_cache = NULL;
1342
1343       $cacheKey = "{$stateID}_name";
1344       if (!$_cache) {
1345         $_cache = array();
1346       }
1347
1348       if (!empty($_cache[$cacheKey])) {
1349         return $_cache[$cacheKey];
1350       }
1351
1352       $query = "
1353     SELECT civicrm_county.name name, civicrm_county.id id
1354       FROM civicrm_county
1355     WHERE state_province_id = %1
1356     ORDER BY name";
1357       $params = array(
1358         1 => array(
1359           $stateID,
1360           'Integer',
1361         ),
1362       );
1363
1364       $dao = CRM_Core_DAO::executeQuery($query, $params);
1365
1366       $result = array();
1367       while ($dao->fetch()) {
1368         $result[$dao->id] = $dao->name;
1369       }
1370     }
1371
1372     return $result;
1373   }
1374
1375   /**
1376    * Given a state ID return the country ID, this allows
1377    * us to populate forms and values for downstream code
1378    *
1379    * @param int $stateID
1380    *
1381    * @return int|null
1382    *   the country id that the state belongs to
1383    */
1384   public static function countryIDForStateID($stateID) {
1385     if (empty($stateID)) {
1386       return NULL;
1387     }
1388
1389     $query = "
1390 SELECT country_id
1391 FROM   civicrm_state_province
1392 WHERE  id = %1
1393 ";
1394     $params = array(1 => array($stateID, 'Integer'));
1395
1396     return CRM_Core_DAO::singleValueQuery($query, $params);
1397   }
1398
1399   /**
1400    * Get all types of Greetings.
1401    *
1402    * The static array of greeting is returned
1403    *
1404    *
1405    * @param $filter
1406    *   Get All Email Greetings - default is to get only active ones.
1407    *
1408    * @param string $columnName
1409    *
1410    * @return array
1411    *   array reference of all greetings.
1412    */
1413   public static function greeting($filter, $columnName = 'label') {
1414     if (!isset(Civi::$statics[__CLASS__]['greeting'])) {
1415       Civi::$statics[__CLASS__]['greeting'] = array();
1416     }
1417
1418     $index = $filter['greeting_type'] . '_' . $columnName;
1419
1420     // also add contactType to the array
1421     $contactType = CRM_Utils_Array::value('contact_type', $filter);
1422     if ($contactType) {
1423       $index .= '_' . $contactType;
1424     }
1425
1426     if (!CRM_Utils_Array::value($index, Civi::$statics[__CLASS__]['greeting'])) {
1427       $filterCondition = NULL;
1428       if ($contactType) {
1429         $filterVal = 'v.filter =';
1430         switch ($contactType) {
1431           case 'Individual':
1432             $filterVal .= "1";
1433             break;
1434
1435           case 'Household':
1436             $filterVal .= "2";
1437             break;
1438
1439           case 'Organization':
1440             $filterVal .= "3";
1441             break;
1442         }
1443         $filterCondition .= "AND (v.filter = 0 OR {$filterVal}) ";
1444       }
1445
1446       Civi::$statics[__CLASS__]['greeting'][$index] = CRM_Core_OptionGroup::values($filter['greeting_type'], NULL, NULL, NULL, $filterCondition, $columnName);
1447     }
1448
1449     return Civi::$statics[__CLASS__]['greeting'][$index];
1450   }
1451
1452   /**
1453    * Get all extensions.
1454    *
1455    * The static array extensions
1456    *
1457    * FIXME: This is called by civix but not by any core code. We
1458    * should provide an API call which civix can use instead.
1459    *
1460    *
1461    * @return array
1462    *   array($fullyQualifiedName => $label) list of extensions
1463    */
1464   public static function &getExtensions() {
1465     if (!self::$extensions) {
1466       self::$extensions = array();
1467       $sql = '
1468         SELECT full_name, label
1469         FROM civicrm_extension
1470         WHERE is_active = 1
1471       ';
1472       $dao = CRM_Core_DAO::executeQuery($sql);
1473       while ($dao->fetch()) {
1474         self::$extensions[$dao->full_name] = $dao->label;
1475       }
1476     }
1477
1478     return self::$extensions;
1479   }
1480
1481   /**
1482    * Get all options values.
1483    *
1484    * The static array option values is returned
1485    *
1486    *
1487    * @param bool $optionGroupName
1488    *   Get All Option Group values- default is to get only active ones.
1489    *
1490    * @param int $id
1491    * @param null $condition
1492    *
1493    * @return array
1494    *   array reference of all Option Group Name
1495    */
1496   public static function accountOptionValues($optionGroupName, $id = NULL, $condition = NULL) {
1497     $cacheKey = $optionGroupName . '_' . $condition;
1498     if (empty(self::$accountOptionValues[$cacheKey])) {
1499       self::$accountOptionValues[$cacheKey] = CRM_Core_OptionGroup::values($optionGroupName, FALSE, FALSE, FALSE, $condition);
1500     }
1501     if ($id) {
1502       return CRM_Utils_Array::value($id, self::$accountOptionValues[$cacheKey]);
1503     }
1504
1505     return self::$accountOptionValues[$cacheKey];
1506   }
1507
1508   /**
1509    * Fetch the list of active extensions of type 'module'
1510    *
1511    * @param bool $fresh
1512    *   Whether to forcibly reload extensions list from canonical store.
1513    *
1514    * @return array
1515    *   array(array('prefix' => $, 'file' => $))
1516    */
1517   public static function getModuleExtensions($fresh = FALSE) {
1518     return CRM_Extension_System::singleton()->getMapper()->getActiveModuleFiles($fresh);
1519   }
1520
1521
1522   /**
1523    * Get all tax rates.
1524    *
1525    * The static array tax rates is returned
1526    *
1527    * @return array
1528    *   array list of tax rates with the financial type
1529    */
1530   public static function getTaxRates() {
1531     if (!isset(Civi::$statics[__CLASS__]['taxRates'])) {
1532       Civi::$statics[__CLASS__]['taxRates'] = array();
1533       $option = civicrm_api3('option_value', 'get', array(
1534         'sequential' => 1,
1535         'option_group_id' => 'account_relationship',
1536         'name' => 'Sales Tax Account is',
1537       ));
1538       $value = array();
1539       if ($option['count'] !== 0) {
1540         if ($option['count'] > 1) {
1541           foreach ($option['values'] as $opt) {
1542             $value[] = $opt['value'];
1543           }
1544         }
1545         else {
1546           $value[] = $option['values'][0]['value'];
1547         }
1548         $where = 'AND efa.account_relationship IN (' . implode(', ', $value)  . ' )';
1549       }
1550       else {
1551         $where = '';
1552       }
1553       $sql = "
1554         SELECT fa.tax_rate, efa.entity_id
1555         FROM civicrm_entity_financial_account efa
1556         INNER JOIN civicrm_financial_account fa ON fa.id = efa.financial_account_id
1557         WHERE efa.entity_table = 'civicrm_financial_type'
1558         {$where}
1559         AND fa.is_active = 1";
1560       $dao = CRM_Core_DAO::executeQuery($sql);
1561       while ($dao->fetch()) {
1562         Civi::$statics[__CLASS__]['taxRates'][$dao->entity_id] = $dao->tax_rate;
1563       }
1564     }
1565
1566     return Civi::$statics[__CLASS__]['taxRates'];
1567   }
1568
1569 }