CRM/Core/DAO.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * Base Database Access Object class.
  14  *
  15  * All DAO classes should inherit from this class.
  16  *
  17  * @package CRM
  18  * @copyright CiviCRM LLC https://civicrm.org/licensing
  19  */
  20
  21 if (!defined('DB_DSN_MODE')) {
  22   define('DB_DSN_MODE', 'auto');
  23 }
  24
  25 require_once 'PEAR.php';
  26 require_once 'DB/DataObject.php';
  27
  28 require_once 'CRM/Core/I18n.php';
  29
  30 /**
  31  * Class CRM_Core_DAO
  32  */
  33 class CRM_Core_DAO extends DB_DataObject {
  34
  35   /**
  36    * How many times has this instance been cloned.
  37    *
  38    * @var int
  39    */
  40   protected $resultCopies = 0;
  41
  42   /**
  43    * @var null
  44    * @deprecated
  45    */
  46   public static $_nullObject = NULL;
  47
  48   /**
  49    * Icon associated with this entity.
  50    *
  51    * @var string
  52    */
  53   public static $_icon = NULL;
  54
  55   /**
  56    * Field to show when displaying a record.
  57    *
  58    * @var string
  59    */
  60   public static $_labelField = NULL;
  61
  62   /**
  63    * @var array
  64    * @deprecated
  65    */
  66   public static $_nullArray = [];
  67
  68   public static $_dbColumnValueCache = NULL;
  69   const NOT_NULL = 1, IS_NULL = 2,
  70     DB_DAO_NOTNULL = 128,
  71     VALUE_SEPARATOR = "\ 1",
  72     BULK_INSERT_COUNT = 200,
  73     BULK_INSERT_HIGH_COUNT = 200,
  74     QUERY_FORMAT_WILDCARD = 1,
  75     QUERY_FORMAT_NO_QUOTES = 2,
  76
  77     /**
  78      * Serialized string separated by and bookended with VALUE_SEPARATOR
  79      */
  80     SERIALIZE_SEPARATOR_BOOKEND = 1,
  81     /**
  82      * @deprecated format separated by VALUE_SEPARATOR
  83      */
  84     SERIALIZE_SEPARATOR_TRIMMED = 2,
  85     /**
  86      * Recommended serialization format
  87      */
  88     SERIALIZE_JSON = 3,
  89     /**
  90      * @deprecated format using php serialize()
  91      */
  92     SERIALIZE_PHP = 4,
  93     /**
  94      * Comma separated string, no quotes, no spaces
  95      */
  96     SERIALIZE_COMMA = 5;
  97
  98   /**
  99    * Define entities that shouldn't be created or deleted when creating/ deleting
 100    * test objects - this prevents world regions, countries etc from being added / deleted
 101    * @var array
 102    */
 103   public static $_testEntitiesToSkip = [];
 104   /**
 105    * The factory class for this application.
 106    * @var object
 107    */
 108   public static $_factory = NULL;
 109
 110   public static $_checkedSqlFunctionsExist = FALSE;
 111
 112   /**
 113    * https://issues.civicrm.org/jira/browse/CRM-17748
 114    * internal variable for DAO to hold per-query settings
 115    * @var array
 116    */
 117   protected $_options = [];
 118
 119   /**
 120    * Class constructor.
 121    *
 122    * @return \CRM_Core_DAO
 123    */
 124   public function __construct() {
 125     $this->initialize();
 126     $this->__table = $this->getTableName();
 127   }
 128
 129   /**
 130    * Returns localized title of this entity.
 131    *
 132    * @return string
 133    */
 134   public static function getEntityTitle() {
 135     $className = static::class;
 136     CRM_Core_Error::deprecatedWarning("$className needs to be regenerated. Missing getEntityTitle method.");
 137     return CRM_Core_DAO_AllCoreTables::getBriefName($className);
 138   }
 139
 140   public function __clone() {
 141     if (!empty($this->_DB_resultid)) {
 142       $this->resultCopies++;
 143     }
 144   }
 145
 146   /**
 147    * Class destructor.
 148    */
 149   public function __destruct() {
 150     if ($this->resultCopies === 0) {
 151       $this->free();
 152     }
 153     $this->resultCopies--;
 154   }
 155
 156   /**
 157    * Returns the name of this table
 158    *
 159    * @return string
 160    */
 161   public static function getTableName() {
 162     return self::getLocaleTableName(static::$_tableName ?? NULL);
 163   }
 164
 165   /**
 166    * Returns if this table needs to be logged
 167    *
 168    * @return bool
 169    */
 170   public function getLog() {
 171     return static::$_log ?? FALSE;
 172   }
 173
 174   /**
 175    * Initialize the DAO object.
 176    *
 177    * @param string $dsn
 178    *   The database connection string.
 179    */
 180   public static function init($dsn) {
 181     Civi::$statics[__CLASS__]['init'] = 1;
 182     $options = &PEAR::getStaticProperty('DB_DataObject', 'options');
 183     $dsn = CRM_Utils_SQL::autoSwitchDSN($dsn);
 184     $options['database'] = $dsn;
 185     $options['quote_identifiers'] = TRUE;
 186     if (CRM_Utils_SQL::isSSLDSN($dsn)) {
 187       // There are two different options arrays.
 188       $other_options = &PEAR::getStaticProperty('DB', 'options');
 189       $other_options['ssl'] = TRUE;
 190     }
 191     if (defined('CIVICRM_DAO_DEBUG')) {
 192       self::DebugLevel(CIVICRM_DAO_DEBUG);
 193     }
 194     $factory = new CRM_Contact_DAO_Factory();
 195     CRM_Core_DAO::setFactory($factory);
 196     CRM_Core_DAO::executeQuery('SET NAMES utf8mb4');
 197     CRM_Core_DAO::executeQuery('SET @uniqueID = %1', [1 => [CRM_Utils_Request::id(), 'String']]);
 198   }
 199
 200   /**
 201    * @return DB_common
 202    */
 203   public static function getConnection() {
 204     global $_DB_DATAOBJECT;
 205     $dao = new CRM_Core_DAO();
 206     return $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5];
 207   }
 208
 209   /**
 210    * Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary
 211    */
 212   public static function disableFullGroupByMode() {
 213     $currentModes = CRM_Utils_SQL::getSqlModes();
 214     if (in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL::isGroupByModeInDefault()) {
 215       $key = array_search('ONLY_FULL_GROUP_BY', $currentModes);
 216       unset($currentModes[$key]);
 217       CRM_Core_DAO::executeQuery("SET SESSION sql_mode = %1", [1 => [implode(',', $currentModes), 'String']]);
 218     }
 219   }
 220
 221   /**
 222    * Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary..
 223    */
 224   public static function reenableFullGroupByMode() {
 225     $currentModes = CRM_Utils_SQL::getSqlModes();
 226     if (!in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL::isGroupByModeInDefault()) {
 227       $currentModes[] = 'ONLY_FULL_GROUP_BY';
 228       CRM_Core_DAO::executeQuery("SET SESSION sql_mode = %1", [1 => [implode(',', $currentModes), 'String']]);
 229     }
 230   }
 231
 232   /**
 233    * @param string $fieldName
 234    * @param $fieldDef
 235    * @param array $params
 236    */
 237   protected function assignTestFK($fieldName, $fieldDef, $params) {
 238     $required = $fieldDef['required'] ?? NULL;
 239     $FKClassName = $fieldDef['FKClassName'] ?? NULL;
 240     $dbName = $fieldDef['name'];
 241     $daoName = str_replace('_BAO_', '_DAO_', get_class($this));
 242
 243     // skip the FK if it is not required
 244     // if it's contact id we should create even if not required
 245     // we'll have a go @ fetching first though
 246     // we WILL create campaigns though for so tests with a campaign pseudoconstant will complete
 247     if ($FKClassName === 'CRM_Campaign_DAO_Campaign' && $daoName != $FKClassName) {
 248       $required = TRUE;
 249     }
 250     if (!$required && $dbName != 'contact_id') {
 251       $fkDAO = new $FKClassName();
 252       if ($fkDAO->find(TRUE)) {
 253         $this->$dbName = $fkDAO->id;
 254       }
 255     }
 256
 257     elseif (in_array($FKClassName, CRM_Core_DAO::$_testEntitiesToSkip)) {
 258       $depObject = new $FKClassName();
 259       $depObject->find(TRUE);
 260       $this->$dbName = $depObject->id;
 261     }
 262     elseif ($daoName == 'CRM_Member_DAO_MembershipType' && $fieldName == 'member_of_contact_id') {
 263       // FIXME: the fields() metadata is not specific enough
 264       $depObject = CRM_Core_DAO::createTestObject($FKClassName, ['contact_type' => 'Organization']);
 265       $this->$dbName = $depObject->id;
 266     }
 267     else {
 268       //if it is required we need to generate the dependency object first
 269       $depObject = CRM_Core_DAO::createTestObject($FKClassName, CRM_Utils_Array::value($dbName, $params, 1));
 270       $this->$dbName = $depObject->id;
 271     }
 272   }
 273
 274   /**
 275    * Generate and assign an arbitrary value to a field of a test object.
 276    *
 277    * @param string $fieldName
 278    * @param array $fieldDef
 279    * @param int $counter
 280    *   The globally-unique ID of the test object.
 281    *
 282    * @throws \CRM_Core_Exception
 283    */
 284   protected function assignTestValue($fieldName, &$fieldDef, $counter) {
 285     $dbName = $fieldDef['name'];
 286     $daoName = get_class($this);
 287     $handled = FALSE;
 288
 289     if (!$handled && $dbName == 'contact_sub_type') {
 290       //coming up with a rule to set this is too complex let's not set it
 291       $handled = TRUE;
 292     }
 293
 294     // Pick an option value if needed
 295     if (!$handled && $fieldDef['type'] !== CRM_Utils_Type::T_BOOLEAN) {
 296       $options = $daoName::buildOptions($dbName, 'create');
 297       if ($options) {
 298         $this->$dbName = key($options);
 299         $handled = TRUE;
 300       }
 301     }
 302
 303     if (!$handled) {
 304       switch ($fieldDef['type']) {
 305         case CRM_Utils_Type::T_INT:
 306         case CRM_Utils_Type::T_FLOAT:
 307         case CRM_Utils_Type::T_MONEY:
 308           if (isset($fieldDef['precision'])) {
 309             // $object->$dbName = CRM_Utils_Number::createRandomDecimal($value['precision']);
 310             $this->$dbName = CRM_Utils_Number::createTruncatedDecimal($counter, $fieldDef['precision']);
 311           }
 312           else {
 313             $this->$dbName = $counter;
 314           }
 315           break;
 316
 317         case CRM_Utils_Type::T_BOOLEAN:
 318           if (isset($fieldDef['default'])) {
 319             $this->$dbName = $fieldDef['default'];
 320           }
 321           elseif ($fieldDef['name'] == 'is_deleted' || $fieldDef['name'] == 'is_test') {
 322             $this->$dbName = 0;
 323           }
 324           else {
 325             $this->$dbName = 1;
 326           }
 327           break;
 328
 329         case CRM_Utils_Type::T_DATE:
 330         case CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME:
 331           $this->$dbName = '19700101';
 332           if ($dbName == 'end_date') {
 333             // put this in the future
 334             $this->$dbName = '20200101';
 335           }
 336           break;
 337
 338         case CRM_Utils_Type::T_TIMESTAMP:
 339           $this->$dbName = '19700201000000';
 340           break;
 341
 342         case CRM_Utils_Type::T_TIME:
 343           throw new CRM_Core_Exception('T_TIME shouldn\'t be used.');
 344
 345         case CRM_Utils_Type::T_CCNUM:
 346           $this->$dbName = '4111 1111 1111 1111';
 347           break;
 348
 349         case CRM_Utils_Type::T_URL:
 350           $this->$dbName = 'http://www.civicrm.org';
 351           break;
 352
 353         case CRM_Utils_Type::T_STRING:
 354         case CRM_Utils_Type::T_BLOB:
 355         case CRM_Utils_Type::T_MEDIUMBLOB:
 356         case CRM_Utils_Type::T_TEXT:
 357         case CRM_Utils_Type::T_LONGTEXT:
 358         case CRM_Utils_Type::T_EMAIL:
 359         default:
 360           // WAS: if (isset($value['enumValues'])) {
 361           // TODO: see if this works with all pseudoconstants
 362           if (isset($fieldDef['pseudoconstant'], $fieldDef['pseudoconstant']['callback'])) {
 363             if (isset($fieldDef['default'])) {
 364               $this->$dbName = $fieldDef['default'];
 365             }
 366             else {
 367               $options = CRM_Core_PseudoConstant::get($daoName, $fieldName);
 368               if (is_array($options)) {
 369                 $this->$dbName = $options[0];
 370               }
 371               else {
 372                 $defaultValues = explode(',', $options);
 373                 $this->$dbName = $defaultValues[0];
 374               }
 375             }
 376           }
 377           else {
 378             $this->$dbName = $dbName . '_' . $counter;
 379             $maxlength = $fieldDef['maxlength'] ?? NULL;
 380             if ($maxlength > 0 && strlen($this->$dbName) > $maxlength) {
 381               $this->$dbName = substr($this->$dbName, 0, $fieldDef['maxlength']);
 382             }
 383           }
 384       }
 385     }
 386   }
 387
 388   /**
 389    * Reset the DAO object.
 390    *
 391    * DAO is kinda crappy in that there is an unwritten rule of one query per DAO.
 392    *
 393    * We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution
 394    */
 395   public function reset() {
 396
 397     foreach (array_keys($this->table()) as $field) {
 398       unset($this->$field);
 399     }
 400
 401     /**
 402      * reset the various DB_DAO structures manually
 403      */
 404     $this->_query = [];
 405     $this->whereAdd();
 406     $this->selectAdd();
 407     $this->joinAdd();
 408   }
 409
 410   /**
 411    * @param string $tableName
 412    *
 413    * @return string
 414    */
 415   public static function getLocaleTableName($tableName) {
 416     global $dbLocale;
 417     if ($dbLocale) {
 418       $tables = CRM_Core_I18n_Schema::schemaStructureTables();
 419       if (in_array($tableName, $tables)) {
 420         return $tableName . $dbLocale;
 421       }
 422     }
 423     return $tableName;
 424   }
 425
 426   /**
 427    * Execute a query by the current DAO, localizing it along the way (if needed).
 428    *
 429    * @param string $query
 430    *   The SQL query for execution.
 431    * @param bool $i18nRewrite
 432    *   Whether to rewrite the query.
 433    *
 434    * @return object
 435    *   the current DAO object after the query execution
 436    */
 437   public function query($query, $i18nRewrite = TRUE) {
 438     // rewrite queries that should use $dbLocale-based views for multi-language installs
 439     global $dbLocale, $_DB_DATAOBJECT;
 440
 441     if (empty($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) {
 442       // Will force connection to be populated per CRM-20541.
 443       new CRM_Core_DAO();
 444     }
 445
 446     $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
 447     $orig_options = $conn->options;
 448     $this->_setDBOptions($this->_options);
 449
 450     if ($i18nRewrite and $dbLocale) {
 451       $query = CRM_Core_I18n_Schema::rewriteQuery($query);
 452     }
 453
 454     $ret = parent::query($query);
 455
 456     $this->_setDBOptions($orig_options);
 457     return $ret;
 458   }
 459
 460   /**
 461    * Static function to set the factory instance for this class.
 462    *
 463    * @param object $factory
 464    *   The factory application object.
 465    */
 466   public static function setFactory(&$factory) {
 467     self::$_factory = &$factory;
 468   }
 469
 470   /**
 471    * Factory method to instantiate a new object from a table name.
 472    *
 473    * @param string $table
 474    * @return \DataObject|\PEAR_Error
 475    */
 476   public function factory($table = '') {
 477     if (!isset(self::$_factory)) {
 478       return parent::factory($table);
 479     }
 480
 481     return self::$_factory->create($table);
 482   }
 483
 484   /**
 485    * Initialization for all DAO objects. Since we access DB_DO programatically
 486    * we need to set the links manually.
 487    */
 488   public function initialize() {
 489     $this->_connect();
 490     if (empty(Civi::$statics[__CLASS__]['init'])) {
 491       // CRM_Core_DAO::init() must be called before CRM_Core_DAO->initialize().
 492       // This occurs very early in bootstrap - error handlers may not be wired up.
 493       echo "Inconsistent system initialization sequence. Premature access of (" . get_class($this) . ")";
 494       CRM_Utils_System::civiExit();
 495     }
 496   }
 497
 498   /**
 499    * Defines the default key as 'id'.
 500    *
 501    * @return array
 502    */
 503   public function keys() {
 504     static $keys;
 505     if (!isset($keys)) {
 506       $keys = ['id'];
 507     }
 508     return $keys;
 509   }
 510
 511   /**
 512    * Tells DB_DataObject which keys use autoincrement.
 513    * 'id' is autoincrementing by default.
 514    *
 515    *
 516    * @return array
 517    */
 518   public function sequenceKey() {
 519     static $sequenceKeys;
 520     if (!isset($sequenceKeys)) {
 521       $sequenceKeys = ['id', TRUE];
 522     }
 523     return $sequenceKeys;
 524   }
 525
 526   /**
 527    * Returns list of FK relationships.
 528    *
 529    *
 530    * @return CRM_Core_Reference_Basic[]
 531    */
 532   public static function getReferenceColumns() {
 533     return [];
 534   }
 535
 536   /**
 537    * Returns all the column names of this table.
 538    *
 539    *
 540    * @return array
 541    */
 542   public static function &fields() {
 543     $result = NULL;
 544     return $result;
 545   }
 546
 547   /**
 548    * Returns all usable fields, indexed by name.
 549    *
 550    * This function differs from fields() in that it indexes by name rather than unique_name.
 551    *
 552    * It excludes fields not added yet by pending upgrades.
 553    * This avoids problems with trying to SELECT a field that exists in code but has not yet been added to the db.
 554    *
 555    * @param bool $checkPermissions
 556    *   Filter by field permissions.
 557    * @return array
 558    */
 559   public static function getSupportedFields($checkPermissions = FALSE) {
 560     $fields = array_column((array) static::fields(), NULL, 'name');
 561
 562     // Exclude fields yet not added by pending upgrades
 563     $dbVer = \CRM_Core_BAO_Domain::version();
 564     $daoExt = defined(static::class . '::EXT') ? constant(static::class . '::EXT') : NULL;
 565     if ($fields && $daoExt === 'civicrm' && version_compare($dbVer, \CRM_Utils_System::version()) < 0) {
 566       $fields = array_filter($fields, function($field) use ($dbVer) {
 567         $add = $field['add'] ?? '1.0.0';
 568         if (substr_count($add, '.') < 2) {
 569           $add .= '.alpha1';
 570         }
 571         return version_compare($dbVer, $add, '>=');
 572       });
 573     }
 574
 575     // Exclude fields the user does not have permission for
 576     if ($checkPermissions) {
 577       $fields = array_filter($fields, function($field) {
 578         return empty($field['permission']) || CRM_Core_Permission::check($field['permission']);
 579       });
 580     }
 581
 582     return $fields;
 583   }
 584
 585   /**
 586    * Get/set an associative array of table columns
 587    *
 588    * @return array
 589    *   (associative)
 590    */
 591   public function table() {
 592     $fields = $this->fields();
 593
 594     $table = [];
 595     if ($fields) {
 596       foreach ($fields as $name => $value) {
 597         $table[$value['name']] = $value['type'];
 598         if (!empty($value['required'])) {
 599           $table[$value['name']] += self::DB_DAO_NOTNULL;
 600         }
 601       }
 602     }
 603
 604     return $table;
 605   }
 606
 607   /**
 608    * Save DAO object.
 609    *
 610    * @param bool $hook
 611    *
 612    * @return CRM_Core_DAO
 613    */
 614   public function save($hook = TRUE) {
 615     $eventID = uniqid();
 616     if (!empty($this->id)) {
 617       if ($hook) {
 618         $preEvent = new \Civi\Core\DAO\Event\PreUpdate($this);
 619         $preEvent->eventID = $eventID;
 620         \Civi::dispatcher()->dispatch("civi.dao.preUpdate", $preEvent);
 621       }
 622
 623       $result = $this->update();
 624
 625       if ($hook) {
 626         $event = new \Civi\Core\DAO\Event\PostUpdate($this, $result);
 627         $event->eventID = $eventID;
 628         \Civi::dispatcher()->dispatch("civi.dao.postUpdate", $event);
 629       }
 630       $this->clearDbColumnValueCache();
 631     }
 632     else {
 633       if ($hook) {
 634         $preEvent = new \Civi\Core\DAO\Event\PreUpdate($this);
 635         $preEvent->eventID = $eventID;
 636         \Civi::dispatcher()->dispatch("civi.dao.preInsert", $preEvent);
 637       }
 638
 639       $result = $this->insert();
 640
 641       if ($hook) {
 642         $event = new \Civi\Core\DAO\Event\PostUpdate($this, $result);
 643         $event->eventID = $eventID;
 644         \Civi::dispatcher()->dispatch("civi.dao.postInsert", $event);
 645       }
 646     }
 647     $this->free();
 648
 649     if ($hook) {
 650       CRM_Utils_Hook::postSave($this);
 651     }
 652
 653     return $this;
 654   }
 655
 656   /**
 657    * Deletes items from table which match current objects variables.
 658    *
 659    * Returns the true on success
 660    *
 661    * for example
 662    *
 663    * Designed to be extended
 664    *
 665    * $object = new mytable();
 666    * $object->ID=123;
 667    * echo $object->delete(); // builds a conditon
 668    *
 669    * $object = new mytable();
 670    * $object->whereAdd('age > 12');
 671    * $object->limit(1);
 672    * $object->orderBy('age DESC');
 673    * $object->delete(true); // dont use object vars, use the conditions, limit and order.
 674    *
 675    * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
 676    *             we will build the condition only using the whereAdd's.  Default is to
 677    *             build the condition only using the object parameters.
 678    *
 679    *     * @return mixed Int (No. of rows affected) on success, false on failure, 0 on no data affected
 680    */
 681   public function delete($useWhere = FALSE) {
 682     $preEvent = new \Civi\Core\DAO\Event\PreDelete($this);
 683     \Civi::dispatcher()->dispatch("civi.dao.preDelete", $preEvent);
 684
 685     $result = parent::delete($useWhere);
 686
 687     $event = new \Civi\Core\DAO\Event\PostDelete($this, $result);
 688     \Civi::dispatcher()->dispatch("civi.dao.postDelete", $event);
 689     $this->free();
 690
 691     $this->clearDbColumnValueCache();
 692
 693     return $result;
 694   }
 695
 696   /**
 697    * @param bool $created
 698    */
 699   public function log($created = FALSE) {
 700     static $cid = NULL;
 701
 702     if (!$this->getLog()) {
 703       return;
 704     }
 705
 706     if (!$cid) {
 707       $session = CRM_Core_Session::singleton();
 708       $cid = $session->get('userID');
 709     }
 710
 711     // return is we dont have handle to FK
 712     if (!$cid) {
 713       return;
 714     }
 715
 716     $dao = new CRM_Core_DAO_Log();
 717     $dao->entity_table = $this->getTableName();
 718     $dao->entity_id = $this->id;
 719     $dao->modified_id = $cid;
 720     $dao->modified_date = date("YmdHis");
 721     $dao->insert();
 722   }
 723
 724   /**
 725    * Given an associative array of name/value pairs, extract all the values
 726    * that belong to this object and initialize the object with said values
 727    *
 728    * @param array $params
 729    *   Array of name/value pairs to save.
 730    *
 731    * @return bool
 732    *   Did we copy all null values into the object
 733    */
 734   public function copyValues($params) {
 735     $allNull = TRUE;
 736     foreach ($this->fields() as $uniqueName => $field) {
 737       $dbName = $field['name'];
 738       if (array_key_exists($dbName, $params)) {
 739         $value = $params[$dbName];
 740         $exists = TRUE;
 741       }
 742       elseif (array_key_exists($uniqueName, $params)) {
 743         $value = $params[$uniqueName];
 744         $exists = TRUE;
 745       }
 746       else {
 747         $exists = FALSE;
 748       }
 749
 750       // if there is no value then make the variable NULL
 751       if ($exists) {
 752         if ($value === '') {
 753           $this->$dbName = 'null';
 754         }
 755         elseif (is_array($value) && !empty($field['serialize'])) {
 756           $this->$dbName = CRM_Core_DAO::serializeField($value, $field['serialize']);
 757           $allNull = FALSE;
 758         }
 759         else {
 760           $maxLength = $field['maxlength'] ?? NULL;
 761           if (!is_array($value) && $maxLength && mb_strlen($value) > $maxLength && empty($field['pseudoconstant'])) {
 762             // No ts() since this is a sysadmin-y string not seen by general users.
 763             Civi::log()->warning('A string for field {dbName} has been truncated. The original string was {value}.', ['dbName' => $dbName, 'value' => $value]);
 764             // The string is too long - what to do what to do? Well losing data is generally bad so let's truncate
 765             $value = CRM_Utils_String::ellipsify($value, $maxLength);
 766           }
 767           $this->$dbName = $value;
 768           $allNull = FALSE;
 769         }
 770       }
 771     }
 772     return $allNull;
 773   }
 774
 775   /**
 776    * Store all the values from this object in an associative array
 777    * this is a destructive store, calling function is responsible
 778    * for keeping sanity of id's.
 779    *
 780    * @param object $object
 781    *   The object that we are extracting data from.
 782    * @param array $values
 783    *   (reference ) associative array of name/value pairs.
 784    */
 785   public static function storeValues(&$object, &$values) {
 786     $fields = $object->fields();
 787     foreach ($fields as $name => $value) {
 788       $dbName = $value['name'];
 789       if (isset($object->$dbName) && $object->$dbName !== 'null') {
 790         $values[$dbName] = $object->$dbName;
 791         if ($name != $dbName) {
 792           $values[$name] = $object->$dbName;
 793         }
 794       }
 795     }
 796   }
 797
 798   /**
 799    * Create an attribute for this specific field. We only do this for strings and text
 800    *
 801    * @param array $field
 802    *   The field under task.
 803    *
 804    * @return array|null
 805    *   the attributes for the object
 806    */
 807   public static function makeAttribute($field) {
 808     if ($field) {
 809       if (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_STRING) {
 810         $maxLength = $field['maxlength'] ?? NULL;
 811         $size = $field['size'] ?? NULL;
 812         if ($maxLength || $size) {
 813           $attributes = [];
 814           if ($maxLength) {
 815             $attributes['maxlength'] = $maxLength;
 816           }
 817           if ($size) {
 818             $attributes['size'] = $size;
 819           }
 820           return $attributes;
 821         }
 822       }
 823       elseif (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_TEXT) {
 824         $rows = $field['rows'] ?? NULL;
 825         if (!isset($rows)) {
 826           $rows = 2;
 827         }
 828         $cols = $field['cols'] ?? NULL;
 829         if (!isset($cols)) {
 830           $cols = 80;
 831         }
 832
 833         $attributes = [];
 834         $attributes['rows'] = $rows;
 835         $attributes['cols'] = $cols;
 836         return $attributes;
 837       }
 838       elseif (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_INT || CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_FLOAT || CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_MONEY) {
 839         $attributes['size'] = 6;
 840         $attributes['maxlength'] = 14;
 841         return $attributes;
 842       }
 843     }
 844     return NULL;
 845   }
 846
 847   /**
 848    * Get the size and maxLength attributes for this text field.
 849    * (or for all text fields) in the DAO object.
 850    *
 851    * @param string $class
 852    *   Name of DAO class.
 853    * @param string $fieldName
 854    *   Field that i'm interested in or null if.
 855    *                          you want the attributes for all DAO text fields
 856    *
 857    * @return array
 858    *   assoc array of name => attribute pairs
 859    */
 860   public static function getAttribute($class, $fieldName = NULL) {
 861     $object = new $class();
 862     $fields = $object->fields();
 863     if ($fieldName != NULL) {
 864       $field = $fields[$fieldName] ?? NULL;
 865       return self::makeAttribute($field);
 866     }
 867     else {
 868       $attributes = [];
 869       foreach ($fields as $name => $field) {
 870         $attribute = self::makeAttribute($field);
 871         if ($attribute) {
 872           $attributes[$name] = $attribute;
 873         }
 874       }
 875
 876       if (!empty($attributes)) {
 877         return $attributes;
 878       }
 879     }
 880     return NULL;
 881   }
 882
 883   /**
 884    * Create or update a record from supplied params.
 885    *
 886    * If 'id' is supplied, an existing record will be updated
 887    * Otherwise a new record will be created.
 888    *
 889    * @param array $record
 890    * @return CRM_Core_DAO
 891    * @throws CRM_Core_Exception
 892    */
 893   public static function writeRecord(array $record) {
 894     $hook = empty($record['id']) ? 'create' : 'edit';
 895     $className = CRM_Core_DAO_AllCoreTables::getCanonicalClassName(static::class);
 896     if ($className === 'CRM_Core_DAO') {
 897       throw new CRM_Core_Exception('Function writeRecord must be called on a subclass of CRM_Core_DAO');
 898     }
 899     $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($className);
 900
 901     \CRM_Utils_Hook::pre($hook, $entityName, $record['id'] ?? NULL, $record);
 902     $instance = new $className();
 903     $instance->copyValues($record);
 904     $instance->save();
 905     \CRM_Utils_Hook::post($hook, $entityName, $instance->id, $instance);
 906
 907     return $instance;
 908   }
 909
 910   /**
 911    * Delete a record from supplied params.
 912    *
 913    * @param array $record
 914    *   'id' is required.
 915    * @return CRM_Core_DAO
 916    * @throws CRM_Core_Exception
 917    */
 918   public static function deleteRecord(array $record) {
 919     $className = CRM_Core_DAO_AllCoreTables::getCanonicalClassName(static::class);
 920     if ($className === 'CRM_Core_DAO') {
 921       throw new CRM_Core_Exception('Function deleteRecord must be called on a subclass of CRM_Core_DAO');
 922     }
 923     $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($className);
 924     if (empty($record['id'])) {
 925       throw new CRM_Core_Exception("Cannot delete {$entityName} with no id.");
 926     }
 927
 928     CRM_Utils_Hook::pre('delete', $entityName, $record['id'], $record);
 929     $instance = new $className();
 930     $instance->id = $record['id'];
 931     if (!$instance->delete()) {
 932       throw new CRM_Core_Exception("Could not delete {$entityName} id {$record['id']}");
 933     }
 934     CRM_Utils_Hook::post('delete', $entityName, $record['id'], $instance);
 935
 936     return $instance;
 937   }
 938
 939   /**
 940    * Check if there is a record with the same name in the db.
 941    *
 942    * @param string $value
 943    *   The value of the field we are checking.
 944    * @param string $daoName
 945    *   The dao object name.
 946    * @param string $daoID
 947    *   The id of the object being updated. u can change your name.
 948    *                          as long as there is no conflict
 949    * @param string $fieldName
 950    *   The name of the field in the DAO.
 951    *
 952    * @param string $domainID
 953    *   The id of the domain.  Object exists only for the given domain.
 954    *
 955    * @return bool
 956    *   true if object exists
 957    */
 958   public static function objectExists($value, $daoName, $daoID, $fieldName = 'name', $domainID = NULL) {
 959     $object = new $daoName();
 960     $object->$fieldName = $value;
 961     if ($domainID) {
 962       $object->domain_id = $domainID;
 963     }
 964
 965     if ($object->find(TRUE)) {
 966       return $daoID && $object->id == $daoID;
 967     }
 968     else {
 969       return TRUE;
 970     }
 971   }
 972
 973   /**
 974    * Check if there is a given column in a specific table.
 975    *
 976    * @deprecated
 977    * @see CRM_Core_BAO_SchemaHandler::checkIfFieldExists
 978    *
 979    * @param string $tableName
 980    * @param string $columnName
 981    * @param bool $i18nRewrite
 982    *   Whether to rewrite the query on multilingual setups.
 983    *
 984    * @return bool
 985    *   true if exists, else false
 986    */
 987   public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
 988     CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_SchemaHandler::checkIfFieldExists');
 989     return CRM_Core_BAO_SchemaHandler::checkIfFieldExists($tableName, $columnName, $i18nRewrite);
 990   }
 991
 992   /**
 993    * Scans all the tables using a slow query and table name.
 994    *
 995    * @return array
 996    */
 997   public static function getTableNames() {
 998     $dao = CRM_Core_DAO::executeQuery(
 999       "SELECT TABLE_NAME
1000        FROM information_schema.TABLES
1001        WHERE TABLE_SCHEMA = '" . CRM_Core_DAO::getDatabaseName() . "'
1002          AND TABLE_NAME LIKE 'civicrm_%'
1003          AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
1004          AND TABLE_NAME NOT LIKE '%_temp%'
1005       ");
1006
1007     while ($dao->fetch()) {
1008       $values[] = $dao->TABLE_NAME;
1009     }
1010     return $values;
1011   }
1012
1013   /**
1014    * @param int $maxTablesToCheck
1015    *
1016    * @return bool
1017    */
1018   public static function isDBMyISAM($maxTablesToCheck = 10) {
1019     return CRM_Core_DAO::singleValueQuery(
1020       "SELECT count(*)
1021        FROM information_schema.TABLES
1022        WHERE ENGINE = 'MyISAM'
1023          AND TABLE_SCHEMA = '" . CRM_Core_DAO::getDatabaseName() . "'
1024          AND TABLE_NAME LIKE 'civicrm_%'
1025          AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
1026          AND TABLE_NAME NOT LIKE '%_temp%'
1027          AND TABLE_NAME NOT LIKE 'civicrm_tmp_%'
1028       ");
1029   }
1030
1031   /**
1032    * Get the name of the CiviCRM database.
1033    *
1034    * @return string
1035    */
1036   public static function getDatabaseName() {
1037     $daoObj = new CRM_Core_DAO();
1038     return $daoObj->database();
1039   }
1040
1041   /**
1042    * Checks if a constraint exists for a specified table.
1043    *
1044    * @param string $tableName
1045    * @param string $constraint
1046    *
1047    * @return bool
1048    *   true if constraint exists, false otherwise
1049    *
1050    * @throws \CRM_Core_Exception
1051    */
1052   public static function checkConstraintExists($tableName, $constraint) {
1053     static $show = [];
1054
1055     if (!array_key_exists($tableName, $show)) {
1056       $query = "SHOW CREATE TABLE $tableName";
1057       $dao = CRM_Core_DAO::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
1058
1059       if (!$dao->fetch()) {
1060         throw new CRM_Core_Exception('query failed');
1061       }
1062
1063       $show[$tableName] = $dao->Create_Table;
1064     }
1065
1066     return (bool) preg_match("/\b$constraint\b/i", $show[$tableName]);
1067   }
1068
1069   /**
1070    * Checks if CONSTRAINT keyword exists for a specified table.
1071    *
1072    * @param array $tables
1073    *
1074    * @throws CRM_Core_Exception
1075    *
1076    * @return bool
1077    *   true if CONSTRAINT keyword exists, false otherwise
1078    */
1079   public static function schemaRequiresRebuilding($tables = ["civicrm_contact"]) {
1080     $show = [];
1081     foreach ($tables as $tableName) {
1082       if (!array_key_exists($tableName, $show)) {
1083         $query = "SHOW CREATE TABLE $tableName";
1084         $dao = CRM_Core_DAO::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
1085
1086         if (!$dao->fetch()) {
1087           throw new CRM_Core_Exception('Show create table failed.');
1088         }
1089
1090         $show[$tableName] = $dao->Create_Table;
1091       }
1092
1093       $result = (bool) preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]);
1094       if ($result == TRUE) {
1095         continue;
1096       }
1097       else {
1098         return FALSE;
1099       }
1100     }
1101     return TRUE;
1102   }
1103
1104   /**
1105    * Checks if the FK constraint name is in the format 'FK_tableName_columnName'
1106    * for a specified column of a table.
1107    *
1108    * @param string $tableName
1109    * @param string $columnName
1110    *
1111    * @return bool
1112    *   true if in format, false otherwise
1113    *
1114    * @throws \CRM_Core_Exception
1115    */
1116   public static function checkFKConstraintInFormat($tableName, $columnName) {
1117     static $show = [];
1118
1119     if (!array_key_exists($tableName, $show)) {
1120       $query = "SHOW CREATE TABLE $tableName";
1121       $dao = CRM_Core_DAO::executeQuery($query);
1122
1123       if (!$dao->fetch()) {
1124         throw new CRM_Core_Exception('query failed');
1125       }
1126
1127       $show[$tableName] = $dao->Create_Table;
1128     }
1129     $constraint = "`FK_{$tableName}_{$columnName}`";
1130     $pattern = "/\bCONSTRAINT\b\s+%s\s+\bFOREIGN\s+KEY\b\s/i";
1131     return (bool) preg_match(sprintf($pattern, $constraint), $show[$tableName]);
1132   }
1133
1134   /**
1135    * Check whether a specific column in a specific table has always the same value.
1136    *
1137    * @param string $tableName
1138    * @param string $columnName
1139    * @param string $columnValue
1140    *
1141    * @return bool
1142    *   true if the value is always $columnValue, false otherwise
1143    */
1144   public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
1145     $query = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'";
1146     $dao = CRM_Core_DAO::executeQuery($query);
1147     $result = $dao->fetch() ? FALSE : TRUE;
1148     return $result;
1149   }
1150
1151   /**
1152    * Check whether a specific column in a specific table is always NULL.
1153    *
1154    * @param string $tableName
1155    * @param string $columnName
1156    *
1157    * @return bool
1158    *   true if if the value is always NULL, false otherwise
1159    */
1160   public static function checkFieldIsAlwaysNull($tableName, $columnName) {
1161     $query = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL";
1162     $dao = CRM_Core_DAO::executeQuery($query);
1163     $result = $dao->fetch() ? FALSE : TRUE;
1164     return $result;
1165   }
1166
1167   /**
1168    * Checks if this DAO's table ought to exist.
1169    *
1170    * If there are pending DB updates, this function compares the CiviCRM version of the table to the current schema version.
1171    *
1172    * @return bool
1173    * @throws CRM_Core_Exception
1174    */
1175   public static function tableHasBeenAdded() {
1176     if (CRM_Utils_System::version() === CRM_Core_BAO_Domain::version()) {
1177       return TRUE;
1178     }
1179     $daoExt = defined(static::class . '::EXT') ? constant(static::class . '::EXT') : NULL;
1180     $daoVersion = defined(static::class . '::TABLE_ADDED') ? constant(static::class . '::TABLE_ADDED') : '1.0';
1181     return !($daoExt === 'civicrm' && version_compare(CRM_Core_BAO_Domain::version(), $daoVersion, '<'));
1182   }
1183
1184   /**
1185    * Check if there is a given table in the database.
1186    *
1187    * @param string $tableName
1188    *
1189    * @return bool
1190    *   true if exists, else false
1191    */
1192   public static function checkTableExists($tableName) {
1193     $query = "
1194 SHOW TABLES
1195 LIKE %1
1196 ";
1197     $params = [1 => [$tableName, 'String']];
1198
1199     $dao = CRM_Core_DAO::executeQuery($query, $params);
1200     return (bool) $dao->fetch();
1201   }
1202
1203   /**
1204    * Check if a given table has data.
1205    *
1206    * @param string $tableName
1207    * @return bool
1208    *   TRUE if $tableName has at least one record.
1209    */
1210   public static function checkTableHasData($tableName) {
1211     $c = CRM_Core_DAO::singleValueQuery(sprintf('SELECT count(*) c FROM `%s`', $tableName));
1212     return $c > 0;
1213   }
1214
1215   /**
1216    * @param $version
1217    * @deprecated
1218    * @return bool
1219    */
1220   public function checkVersion($version) {
1221     CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_Domain::version');
1222     $dbVersion = CRM_Core_BAO_Domain::version();
1223     return trim($version) == trim($dbVersion);
1224   }
1225
1226   /**
1227    * Find a DAO object for the given ID and return it.
1228    *
1229    * @param int $id
1230    *   Id of the DAO object being searched for.
1231    *
1232    * @return CRM_Core_DAO
1233    *   Object of the type of the class that called this function.
1234    *
1235    * @throws Exception
1236    */
1237   public static function findById($id) {
1238     $object = new static();
1239     $object->id = $id;
1240     if (!$object->find(TRUE)) {
1241       throw new Exception("Unable to find a " . get_called_class() . " with id {$id}.");
1242     }
1243     return $object;
1244   }
1245
1246   /**
1247    * Returns all results as array-encoded records.
1248    *
1249    * @return array
1250    */
1251   public function fetchAll($k = FALSE, $v = FALSE, $method = FALSE) {
1252     $result = [];
1253     while ($this->fetch()) {
1254       $result[] = $this->toArray();
1255     }
1256     return $result;
1257   }
1258
1259   /**
1260    * Return the results as PHP generator.
1261    *
1262    * @param string $type
1263    *   Whether the generator yields 'dao' objects or 'array's.
1264    */
1265   public function fetchGenerator($type = 'dao') {
1266     while ($this->fetch()) {
1267       switch ($type) {
1268         case 'dao':
1269           yield $this;
1270           break;
1271
1272         case 'array':
1273           yield $this->toArray();
1274           break;
1275
1276         default:
1277           throw new \RuntimeException("Invalid record type ($type)");
1278       }
1279     }
1280   }
1281
1282   /**
1283    * Returns a singular value.
1284    *
1285    * @return mixed|NULL
1286    */
1287   public function fetchValue() {
1288     $result = $this->getDatabaseResult();
1289     $row = $result->fetchRow();
1290     $ret = NULL;
1291     if ($row) {
1292       $ret = $row[0];
1293     }
1294     $this->free();
1295     return $ret;
1296   }
1297
1298   /**
1299    * Get all the result records as mapping between columns.
1300    *
1301    * @param string $keyColumn
1302    *   Ex: "name"
1303    * @param string $valueColumn
1304    *   Ex: "label"
1305    * @return array
1306    *   Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]
1307    */
1308   public function fetchMap($keyColumn, $valueColumn) {
1309     $result = [];
1310     while ($this->fetch()) {
1311       $result[$this->{$keyColumn}] = $this->{$valueColumn};
1312     }
1313     return $result;
1314   }
1315
1316   /**
1317    * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
1318    *
1319    * @param string $daoName
1320    *   Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1321    * @param int $searchValue
1322    *   Value of the column you want to search by.
1323    * @param string $returnColumn
1324    *   Name of the column you want to GET the value of.
1325    * @param string $searchColumn
1326    *   Name of the column you want to search by.
1327    * @param bool $force
1328    *   Skip use of the cache.
1329    *
1330    * @return string|int|null
1331    *   Value of $returnColumn in the retrieved record
1332    *
1333    * @throws \CRM_Core_Exception
1334    */
1335   public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
1336     if (
1337       empty($searchValue) ||
1338       trim(strtolower($searchValue)) == 'null'
1339     ) {
1340       // adding this here since developers forget to check for an id
1341       // or for the 'null' (which is a bad DAO kludge)
1342       // and hence we get the first value in the db
1343       throw new CRM_Core_Exception('getFieldValue failed');
1344     }
1345
1346     self::$_dbColumnValueCache = self::$_dbColumnValueCache ?? [];
1347
1348     while (strpos($daoName, '_BAO_') !== FALSE) {
1349       $daoName = get_parent_class($daoName);
1350     }
1351
1352     if ($force ||
1353       empty(self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue]) ||
1354       !array_key_exists($returnColumn, self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue])
1355     ) {
1356       $object = new $daoName();
1357       $object->$searchColumn = $searchValue;
1358       $object->selectAdd();
1359       $object->selectAdd($returnColumn);
1360
1361       $result = NULL;
1362       if ($object->find(TRUE)) {
1363         $result = $object->$returnColumn;
1364       }
1365
1366       self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn] = $result;
1367     }
1368     return self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn];
1369   }
1370
1371   /**
1372    * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
1373    *
1374    * @param string $daoName
1375    *   Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1376    * @param int $searchValue
1377    *   Value of the column you want to search by.
1378    * @param string $setColumn
1379    *   Name of the column you want to SET the value of.
1380    * @param string $setValue
1381    *   SET the setColumn to this value.
1382    * @param string $searchColumn
1383    *   Name of the column you want to search by.
1384    *
1385    * @return bool
1386    *   true if we found and updated the object, else false
1387    */
1388   public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
1389     $object = new $daoName();
1390     $object->selectAdd();
1391     $object->selectAdd("$searchColumn, $setColumn");
1392     $object->$searchColumn = $searchValue;
1393     $result = FALSE;
1394     if ($object->find(TRUE)) {
1395       $object->$setColumn = $setValue;
1396       if ($object->save()) {
1397         $result = TRUE;
1398       }
1399     }
1400     $object->free();
1401     return $result;
1402   }
1403
1404   /**
1405    * Get sort string.
1406    *
1407    * @param array|object $sort either array or CRM_Utils_Sort
1408    * @param string $default
1409    *   Default sort value.
1410    *
1411    * @return string
1412    */
1413   public static function getSortString($sort, $default = NULL) {
1414     // check if sort is of type CRM_Utils_Sort
1415     if (is_a($sort, 'CRM_Utils_Sort')) {
1416       return $sort->orderBy();
1417     }
1418
1419     $sortString = '';
1420
1421     // is it an array specified as $field => $sortDirection ?
1422     if ($sort) {
1423       foreach ($sort as $k => $v) {
1424         $sortString .= "$k $v,";
1425       }
1426       return rtrim($sortString, ',');
1427     }
1428     return $default;
1429   }
1430
1431   /**
1432    * Fetch object based on array of properties.
1433    *
1434    * @param string $daoName
1435    *   Name of the dao object.
1436    * @param array $params
1437    *   (reference ) an assoc array of name/value pairs.
1438    * @param array $defaults
1439    *   (reference ) an assoc array to hold the flattened values.
1440    * @param array $returnProperities
1441    *   An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1442    *
1443    * @return object
1444    *   an object of type referenced by daoName
1445    */
1446   public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
1447     $object = new $daoName();
1448     $object->copyValues($params);
1449
1450     // return only specific fields if returnproperties are sent
1451     if (!empty($returnProperities)) {
1452       $object->selectAdd();
1453       $object->selectAdd(implode(',', $returnProperities));
1454     }
1455
1456     if ($object->find(TRUE)) {
1457       self::storeValues($object, $defaults);
1458       return $object;
1459     }
1460     return NULL;
1461   }
1462
1463   /**
1464    * Delete the object records that are associated with this contact.
1465    *
1466    * @param string $daoName
1467    *   Name of the dao object.
1468    * @param int $contactId
1469    *   Id of the contact to delete.
1470    */
1471   public static function deleteEntityContact($daoName, $contactId) {
1472     $object = new $daoName();
1473
1474     $object->entity_table = 'civicrm_contact';
1475     $object->entity_id = $contactId;
1476     $object->delete();
1477   }
1478
1479   /**
1480    * Execute an unbuffered query.
1481    *
1482    * This is a wrapper around new functionality exposed with CRM-17748.
1483    *
1484    * @param string $query query to be executed
1485    *
1486    * @param array $params
1487    * @param bool $abort
1488    * @param null $daoName
1489    * @param bool $freeDAO
1490    * @param bool $i18nRewrite
1491    * @param bool $trapException
1492    *
1493    * @return CRM_Core_DAO
1494    *   Object that points to an unbuffered result set
1495    */
1496   public static function executeUnbufferedQuery(
1497     $query,
1498     $params = [],
1499     $abort = TRUE,
1500     $daoName = NULL,
1501     $freeDAO = FALSE,
1502     $i18nRewrite = TRUE,
1503     $trapException = FALSE
1504   ) {
1505
1506     return self::executeQuery(
1507       $query,
1508       $params,
1509       $abort,
1510       $daoName,
1511       $freeDAO,
1512       $i18nRewrite,
1513       $trapException,
1514       ['result_buffering' => 0]
1515     );
1516   }
1517
1518   /**
1519    * Execute a query.
1520    *
1521    * @param string $query
1522    *   Query to be executed.
1523    *
1524    * @param array $params
1525    * @param bool $abort
1526    * @param null $daoName
1527    * @param bool $freeDAO
1528    * @param bool $i18nRewrite
1529    * @param bool $trapException
1530    * @param array $options
1531    *
1532    * @return CRM_Core_DAO|object
1533    *   object that holds the results of the query
1534    *   NB - if this is defined as just returning a DAO phpstorm keeps pointing
1535    *   out all the properties that are not part of the DAO
1536    */
1537   public static function &executeQuery(
1538     $query,
1539     $params = [],
1540     $abort = TRUE,
1541     $daoName = NULL,
1542     $freeDAO = FALSE,
1543     $i18nRewrite = TRUE,
1544     $trapException = FALSE,
1545     $options = []
1546   ) {
1547     $queryStr = self::composeQuery($query, $params, $abort);
1548
1549     if (!$daoName) {
1550       $dao = new CRM_Core_DAO();
1551     }
1552     else {
1553       $dao = new $daoName();
1554     }
1555
1556     if ($trapException) {
1557       CRM_Core_Error::deprecatedFunctionWarning('calling functions should handle exceptions');
1558       $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
1559     }
1560
1561     if ($dao->isValidOption($options)) {
1562       $dao->setOptions($options);
1563     }
1564
1565     $result = $dao->query($queryStr, $i18nRewrite);
1566
1567     // since it is unbuffered, ($dao->N==0) is true.  This blocks the standard fetch() mechanism.
1568     if (CRM_Utils_Array::value('result_buffering', $options) === 0) {
1569       $dao->N = TRUE;
1570     }
1571
1572     if (is_a($result, 'DB_Error')) {
1573       CRM_Core_Error::deprecatedFunctionWarning('calling functions should handle exceptions');
1574       return $result;
1575     }
1576
1577     return $dao;
1578   }
1579
1580   /**
1581    * Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
1582    *
1583    * @param array $options
1584    *
1585    * @return bool
1586    *   Provided options are valid
1587    */
1588   public function isValidOption($options) {
1589     $isValid = FALSE;
1590     $validOptions = [
1591       'result_buffering',
1592       'persistent',
1593       'ssl',
1594       'portability',
1595     ];
1596
1597     if (empty($options)) {
1598       return $isValid;
1599     }
1600
1601     foreach (array_keys($options) as $option) {
1602       if (!in_array($option, $validOptions)) {
1603         return FALSE;
1604       }
1605       $isValid = TRUE;
1606     }
1607
1608     return $isValid;
1609   }
1610
1611   /**
1612    * Execute a query and get the single result.
1613    *
1614    * @param string $query
1615    *   Query to be executed.
1616    * @param array $params
1617    * @param bool $abort
1618    * @param bool $i18nRewrite
1619    * @return string|null
1620    *   the result of the query if any
1621    *
1622    */
1623   public static function &singleValueQuery(
1624     $query,
1625     $params = [],
1626     $abort = TRUE,
1627     $i18nRewrite = TRUE
1628   ) {
1629     $queryStr = self::composeQuery($query, $params, $abort);
1630
1631     static $_dao = NULL;
1632
1633     if (!$_dao) {
1634       $_dao = new CRM_Core_DAO();
1635     }
1636
1637     $_dao->query($queryStr, $i18nRewrite);
1638
1639     $result = $_dao->getDatabaseResult();
1640     $ret = NULL;
1641     if ($result) {
1642       $row = $result->fetchRow();
1643       if ($row) {
1644         $ret = $row[0];
1645       }
1646     }
1647     $_dao->free();
1648     return $ret;
1649   }
1650
1651   /**
1652    * Compose the query by merging the parameters into it.
1653    *
1654    * @param string $query
1655    * @param array $params
1656    * @param bool $abort
1657    *
1658    * @return string
1659    * @throws CRM_Core_Exception
1660    */
1661   public static function composeQuery($query, $params = [], $abort = TRUE) {
1662     $tr = [];
1663     foreach ($params as $key => $item) {
1664       if (is_numeric($key)) {
1665         if (CRM_Utils_Type::validate($item[0], $item[1]) !== NULL) {
1666           $item[0] = self::escapeString($item[0]);
1667           if ($item[1] == 'String' ||
1668             $item[1] == 'Memo' ||
1669             $item[1] == 'Link'
1670           ) {
1671             // Support class constants stipulating wildcard characters and/or
1672             // non-quoting of strings. Also support legacy code which may be
1673             // passing in TRUE or 1 for $item[2], which used to indicate the
1674             // use of wildcard characters.
1675             if (!empty($item[2])) {
1676               if ($item[2] & CRM_Core_DAO::QUERY_FORMAT_WILDCARD || $item[2] === TRUE) {
1677                 $item[0] = "'%{$item[0]}%'";
1678               }
1679               elseif (!($item[2] & CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES)) {
1680                 $item[0] = "'{$item[0]}'";
1681               }
1682             }
1683             else {
1684               $item[0] = "'{$item[0]}'";
1685             }
1686           }
1687
1688           if (($item[1] == 'Date' || $item[1] == 'Timestamp') &&
1689             strlen($item[0]) == 0
1690           ) {
1691             $item[0] = 'null';
1692           }
1693
1694           $tr['%' . $key] = $item[0];
1695         }
1696         elseif ($abort) {
1697           throw new CRM_Core_Exception("{$item[0]} is not of type {$item[1]}");
1698         }
1699       }
1700     }
1701
1702     return strtr($query, $tr);
1703   }
1704
1705   /**
1706    * @param null $ids
1707    */
1708   public static function freeResult($ids = NULL) {
1709     global $_DB_DATAOBJECT;
1710
1711     if (!$ids) {
1712       if (!$_DB_DATAOBJECT ||
1713         !isset($_DB_DATAOBJECT['RESULTS'])
1714       ) {
1715         return;
1716       }
1717       $ids = array_keys($_DB_DATAOBJECT['RESULTS']);
1718     }
1719
1720     foreach ($ids as $id) {
1721       if (isset($_DB_DATAOBJECT['RESULTS'][$id])) {
1722         $_DB_DATAOBJECT['RESULTS'][$id]->free();
1723         unset($_DB_DATAOBJECT['RESULTS'][$id]);
1724       }
1725
1726       if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$id])) {
1727         unset($_DB_DATAOBJECT['RESULTFIELDS'][$id]);
1728       }
1729     }
1730   }
1731
1732   /**
1733    * Make a shallow copy of an object and all the fields in the object.
1734    *
1735    * @param string $daoName
1736    *   Name of the dao.
1737    * @param array $criteria
1738    *   Array of all the fields & values.
1739    *   on which basis to copy
1740    * @param array $newData
1741    *   Array of all the fields & values.
1742    *   to be copied besides the other fields
1743    * @param string $fieldsFix
1744    *   Array of fields that you want to prefix/suffix/replace.
1745    * @param string $blockCopyOfDependencies
1746    *   Fields that you want to block from.
1747    *   getting copied
1748    * @param bool $blockCopyofCustomValues
1749    *   Case when you don't want to copy the custom values set in a
1750    *   template as it will override/ignore the submitted custom values
1751    *
1752    * @return CRM_Core_DAO|bool
1753    *   the newly created copy of the object. False if none created.
1754    */
1755   public static function copyGeneric($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL, $blockCopyofCustomValues = FALSE) {
1756     $object = new $daoName();
1757     $newObject = FALSE;
1758     if (!$newData) {
1759       $object->id = $criteria['id'];
1760     }
1761     else {
1762       foreach ($criteria as $key => $value) {
1763         $object->$key = $value;
1764       }
1765     }
1766
1767     $object->find();
1768     while ($object->fetch()) {
1769
1770       // all the objects except with $blockCopyOfDependencies set
1771       // be copied - addresses #CRM-1962
1772
1773       if ($blockCopyOfDependencies && $object->$blockCopyOfDependencies) {
1774         break;
1775       }
1776
1777       $newObject = new $daoName();
1778
1779       $fields = $object->fields();
1780       if (!is_array($fieldsFix)) {
1781         $fieldsToPrefix = [];
1782         $fieldsToSuffix = [];
1783         $fieldsToReplace = [];
1784       }
1785       if (!empty($fieldsFix['prefix'])) {
1786         $fieldsToPrefix = $fieldsFix['prefix'];
1787       }
1788       if (!empty($fieldsFix['suffix'])) {
1789         $fieldsToSuffix = $fieldsFix['suffix'];
1790       }
1791       if (!empty($fieldsFix['replace'])) {
1792         $fieldsToReplace = $fieldsFix['replace'];
1793       }
1794
1795       foreach ($fields as $name => $value) {
1796         if ($name == 'id' || $value['name'] == 'id') {
1797           // copy everything but the id!
1798           continue;
1799         }
1800
1801         $dbName = $value['name'];
1802         $type = CRM_Utils_Type::typeToString($value['type']);
1803         $newObject->$dbName = $object->$dbName;
1804         if (isset($fieldsToPrefix[$dbName])) {
1805           $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1806         }
1807         if (isset($fieldsToSuffix[$dbName])) {
1808           $newObject->$dbName .= $fieldsToSuffix[$dbName];
1809         }
1810         if (isset($fieldsToReplace[$dbName])) {
1811           $newObject->$dbName = $fieldsToReplace[$dbName];
1812         }
1813
1814         if ($type == 'Timestamp' || $type == 'Date') {
1815           $newObject->$dbName = CRM_Utils_Date::isoToMysql($newObject->$dbName);
1816         }
1817
1818         if ($newData) {
1819           $newObject->copyValues($newData);
1820         }
1821       }
1822       $newObject->save();
1823       if (!$blockCopyofCustomValues) {
1824         $newObject->copyCustomFields($object->id, $newObject->id);
1825       }
1826       CRM_Utils_Hook::post('create', CRM_Core_DAO_AllCoreTables::getBriefName($daoName), $newObject->id, $newObject);
1827     }
1828
1829     return $newObject;
1830   }
1831
1832   /**
1833    * Method that copies custom fields values from an old entity to a new one.
1834    *
1835    * Fixes bug CRM-19302,
1836    * where if a custom field of File type was present, left both events using the same file,
1837    * breaking download URL's for the old event.
1838    *
1839    * @todo the goal here is to clean this up so that it works for any entity. Copy Generic already DOES some custom field stuff
1840    * but it seems to be bypassed & perhaps less good than this (or this just duplicates it...)
1841    *
1842    * @param int $entityID
1843    * @param int $newEntityID
1844    */
1845   public function copyCustomFields($entityID, $newEntityID) {
1846     $entity = CRM_Core_DAO_AllCoreTables::getBriefName(get_class($this));
1847     $tableName = CRM_Core_DAO_AllCoreTables::getTableForClass(get_class($this));
1848     // Obtain custom values for old event
1849     $customParams = $htmlType = [];
1850     $customValues = CRM_Core_BAO_CustomValueTable::getEntityValues($entityID, $entity);
1851
1852     // If custom values present, we copy them
1853     if (!empty($customValues)) {
1854       // Get Field ID's and identify File type attributes, to handle file copying.
1855       $fieldIds = implode(', ', array_keys($customValues));
1856       $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
1857       $result = CRM_Core_DAO::executeQuery($sql);
1858
1859       // Build array of File type fields
1860       while ($result->fetch()) {
1861         $htmlType[] = $result->id;
1862       }
1863
1864       // Build params array of custom values
1865       foreach ($customValues as $field => $value) {
1866         if ($value !== NULL) {
1867           // Handle File type attributes
1868           if (in_array($field, $htmlType)) {
1869             $fileValues = CRM_Core_BAO_File::path($value, $entityID);
1870             $customParams["custom_{$field}_-1"] = [
1871               'name' => CRM_Utils_File::duplicate($fileValues[0]),
1872               'type' => $fileValues[1],
1873             ];
1874           }
1875           // Handle other types
1876           else {
1877             $customParams["custom_{$field}_-1"] = $value;
1878           }
1879         }
1880       }
1881
1882       // Save Custom Fields for new Event
1883       CRM_Core_BAO_CustomValueTable::postProcess($customParams, $tableName, $newEntityID, $entity);
1884     }
1885
1886     // copy activity attachments ( if any )
1887     CRM_Core_BAO_File::copyEntityFile($tableName, $entityID, $tableName, $newEntityID);
1888   }
1889
1890   /**
1891    * Cascade update through related entities.
1892    *
1893    * @param string $daoName
1894    * @param $fromId
1895    * @param $toId
1896    * @param array $newData
1897    *
1898    * @return CRM_Core_DAO|null
1899    */
1900   public static function cascadeUpdate($daoName, $fromId, $toId, $newData = []) {
1901     $object = new $daoName();
1902     $object->id = $fromId;
1903
1904     if ($object->find(TRUE)) {
1905       $newObject = new $daoName();
1906       $newObject->id = $toId;
1907
1908       if ($newObject->find(TRUE)) {
1909         $fields = $object->fields();
1910         foreach ($fields as $name => $value) {
1911           if ($name == 'id' || $value['name'] == 'id') {
1912             // copy everything but the id!
1913             continue;
1914           }
1915
1916           $colName = $value['name'];
1917           $newObject->$colName = $object->$colName;
1918
1919           if (substr($name, -5) == '_date' ||
1920             substr($name, -10) == '_date_time'
1921           ) {
1922             $newObject->$colName = CRM_Utils_Date::isoToMysql($newObject->$colName);
1923           }
1924         }
1925         foreach ($newData as $k => $v) {
1926           $newObject->$k = $v;
1927         }
1928         $newObject->save();
1929         return $newObject;
1930       }
1931     }
1932     return NULL;
1933   }
1934
1935   /**
1936    * Given the component id, compute the contact id
1937    * since its used for things like send email
1938    *
1939    * @param $componentIDs
1940    * @param string $tableName
1941    * @param string $idField
1942    *
1943    * @return array
1944    */
1945   public static function getContactIDsFromComponent($componentIDs, $tableName, $idField = 'id') {
1946     $contactIDs = [];
1947
1948     if (empty($componentIDs)) {
1949       return $contactIDs;
1950     }
1951
1952     $IDs = implode(',', $componentIDs);
1953     $query = "
1954 SELECT contact_id
1955   FROM $tableName
1956  WHERE $idField IN ( $IDs )
1957 ";
1958
1959     $dao = CRM_Core_DAO::executeQuery($query);
1960     while ($dao->fetch()) {
1961       $contactIDs[] = $dao->contact_id;
1962     }
1963     return $contactIDs;
1964   }
1965
1966   /**
1967    * Fetch object based on array of properties.
1968    *
1969    * @param string $daoName
1970    *   Name of the dao object.
1971    * @param string $fieldIdName
1972    * @param int $fieldId
1973    * @param $details
1974    * @param array $returnProperities
1975    *   An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1976    *
1977    * @return object
1978    *   an object of type referenced by daoName
1979    */
1980   public static function commonRetrieveAll($daoName, $fieldIdName = 'id', $fieldId, &$details, $returnProperities = NULL) {
1981     require_once str_replace('_', DIRECTORY_SEPARATOR, $daoName) . ".php";
1982     $object = new $daoName();
1983     $object->$fieldIdName = $fieldId;
1984
1985     // return only specific fields if returnproperties are sent
1986     if (!empty($returnProperities)) {
1987       $object->selectAdd();
1988       $object->selectAdd('id');
1989       $object->selectAdd(implode(',', $returnProperities));
1990     }
1991
1992     $object->find();
1993     while ($object->fetch()) {
1994       $defaults = [];
1995       self::storeValues($object, $defaults);
1996       $details[$object->id] = $defaults;
1997     }
1998
1999     return $details;
2000   }
2001
2002   /**
2003    * Drop all CiviCRM tables.
2004    *
2005    * @throws \CRM_Core_Exception
2006    */
2007   public static function dropAllTables() {
2008
2009     // first drop all the custom tables we've created
2010     CRM_Core_BAO_CustomGroup::dropAllTables();
2011
2012     // drop all multilingual views
2013     CRM_Core_I18n_Schema::dropAllViews();
2014
2015     CRM_Utils_File::sourceSQLFile(CIVICRM_DSN,
2016       dirname(__FILE__) . DIRECTORY_SEPARATOR .
2017       '..' . DIRECTORY_SEPARATOR .
2018       '..' . DIRECTORY_SEPARATOR .
2019       'sql' . DIRECTORY_SEPARATOR .
2020       'civicrm_drop.mysql'
2021     );
2022   }
2023
2024   /**
2025    * @param $string
2026    *
2027    * @return string
2028    */
2029   public static function escapeString($string) {
2030     static $_dao = NULL;
2031     if (!$_dao) {
2032       // If this is an atypical case (e.g. preparing .sql file before CiviCRM
2033       // has been installed), then we fallback DB-less str_replace escaping, as
2034       // we can't use mysqli_real_escape_string, as there is no DB connection.
2035       // Note: In typical usage, escapeString() will only check one conditional
2036       // ("if !$_dao") rather than two conditionals ("if !defined(DSN)")
2037       if (!defined('CIVICRM_DSN')) {
2038         // See http://php.net/manual/en/mysqli.real-escape-string.php for the
2039         // list of characters mysqli_real_escape_string escapes.
2040         $search = ["\\", "\x00", "\n", "\r", "'", '"', "\x1a"];
2041         $replace = ["\\\\", "\\0", "\\n", "\\r", "\'", '\"', "\\Z"];
2042         return str_replace($search, $replace, $string);
2043       }
2044       $_dao = new CRM_Core_DAO();
2045     }
2046     return $_dao->escape($string);
2047   }
2048
2049   /**
2050    * Escape a list of strings for use with "WHERE X IN (...)" queries.
2051    *
2052    * @param array $strings
2053    * @param string $default
2054    *   the value to use if $strings has no elements.
2055    * @return string
2056    *   eg "abc","def","ghi"
2057    */
2058   public static function escapeStrings($strings, $default = NULL) {
2059     static $_dao = NULL;
2060     if (!$_dao) {
2061       $_dao = new CRM_Core_DAO();
2062     }
2063
2064     if (empty($strings)) {
2065       return $default;
2066     }
2067
2068     $escapes = array_map([$_dao, 'escape'], $strings);
2069     return '"' . implode('","', $escapes) . '"';
2070   }
2071
2072   /**
2073    * @param $string
2074    *
2075    * @return string
2076    */
2077   public static function escapeWildCardString($string) {
2078     // CRM-9155
2079     // ensure we escape the single characters % and _ which are mysql wild
2080     // card characters and could come in via sortByCharacter
2081     // note that mysql does not escape these characters
2082     if ($string && in_array($string,
2083         ['%', '_', '%%', '_%']
2084       )
2085     ) {
2086       return '\\' . $string;
2087     }
2088
2089     return self::escapeString($string);
2090   }
2091
2092   /**
2093    * Creates a test object, including any required objects it needs via recursion
2094    * createOnly: only create in database, do not store or return the objects (useful for perf testing)
2095    * ONLY USE FOR TESTING
2096    *
2097    * @param string $daoName
2098    * @param array $params
2099    * @param int $numObjects
2100    * @param bool $createOnly
2101    *
2102    * @return object|array|NULL
2103    *   NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.
2104    */
2105   public static function createTestObject(
2106     $daoName,
2107     $params = [],
2108     $numObjects = 1,
2109     $createOnly = FALSE
2110   ) {
2111     //this is a test function  also backtrace is set for the test suite it sometimes unsets itself
2112     // so we re-set here in case
2113     $config = CRM_Core_Config::singleton();
2114     $config->backtrace = TRUE;
2115
2116     static $counter = 0;
2117     CRM_Core_DAO::$_testEntitiesToSkip = [
2118       'CRM_Core_DAO_Worldregion',
2119       'CRM_Core_DAO_StateProvince',
2120       'CRM_Core_DAO_Country',
2121       'CRM_Core_DAO_Domain',
2122       'CRM_Financial_DAO_FinancialType',
2123       //because valid ones exist & we use pick them due to pseudoconstant can't reliably create & delete these
2124     ];
2125
2126     // Prefer to instantiate BAO's instead of DAO's (when possible)
2127     // so that assignTestValue()/assignTestFK() can be overloaded.
2128     $baoName = str_replace('_DAO_', '_BAO_', $daoName);
2129     if ($baoName === 'CRM_Financial_BAO_FinancialTrxn') {
2130       // OMG OMG OMG this is so incredibly bad. The BAO is insanely named.
2131       // @todo create a new class called what the BAO SHOULD be
2132       // that extends BAO-crazy-name.... migrate.
2133       $baoName = 'CRM_Core_BAO_FinancialTrxn';
2134     }
2135     if (class_exists($baoName)) {
2136       $daoName = $baoName;
2137     }
2138
2139     for ($i = 0; $i < $numObjects; ++$i) {
2140
2141       ++$counter;
2142       /** @var CRM_Core_DAO $object */
2143       $object = new $daoName();
2144
2145       $fields = $object->fields();
2146       foreach ($fields as $fieldName => $fieldDef) {
2147         $dbName = $fieldDef['name'];
2148         $FKClassName = $fieldDef['FKClassName'] ?? NULL;
2149
2150         if (isset($params[$dbName]) && !is_array($params[$dbName])) {
2151           $object->$dbName = $params[$dbName];
2152         }
2153
2154         elseif ($dbName != 'id') {
2155           if ($FKClassName != NULL) {
2156             $object->assignTestFK($fieldName, $fieldDef, $params);
2157             continue;
2158           }
2159           else {
2160             $object->assignTestValue($fieldName, $fieldDef, $counter);
2161           }
2162         }
2163       }
2164
2165       $object->save();
2166
2167       if (!$createOnly) {
2168         $objects[$i] = $object;
2169       }
2170       else {
2171         unset($object);
2172       }
2173     }
2174
2175     if ($createOnly) {
2176       return NULL;
2177     }
2178     elseif ($numObjects == 1) {
2179       return $objects[0];
2180     }
2181     else {
2182       return $objects;
2183     }
2184   }
2185
2186   /**
2187    * Deletes the this object plus any dependent objects that are associated with it.
2188    * ONLY USE FOR TESTING
2189    *
2190    * @param string $daoName
2191    * @param array $params
2192    */
2193   public static function deleteTestObjects($daoName, $params = []) {
2194     //this is a test function  also backtrace is set for the test suite it sometimes unsets itself
2195     // so we re-set here in case
2196     $config = CRM_Core_Config::singleton();
2197     $config->backtrace = TRUE;
2198
2199     $object = new $daoName();
2200     $object->id = $params['id'] ?? NULL;
2201
2202     // array(array(0 => $daoName, 1 => $daoParams))
2203     $deletions = [];
2204     if ($object->find(TRUE)) {
2205
2206       $fields = $object->fields();
2207       foreach ($fields as $name => $value) {
2208
2209         $dbName = $value['name'];
2210
2211         $FKClassName = $value['FKClassName'] ?? NULL;
2212         $required = $value['required'] ?? NULL;
2213         if ($FKClassName != NULL
2214           && $object->$dbName
2215           && !in_array($FKClassName, CRM_Core_DAO::$_testEntitiesToSkip)
2216           && ($required || $dbName == 'contact_id')
2217           //I'm a bit stuck on this one - we might need to change the singleValueAlter so that the entities don't share a contact
2218           // to make this test process pass - line below makes pass for now
2219           && $dbName != 'member_of_contact_id'
2220         ) {
2221           // x
2222           $deletions[] = [$FKClassName, ['id' => $object->$dbName]];
2223         }
2224       }
2225     }
2226
2227     $object->delete();
2228
2229     foreach ($deletions as $deletion) {
2230       CRM_Core_DAO::deleteTestObjects($deletion[0], $deletion[1]);
2231     }
2232   }
2233
2234   /**
2235    * Set defaults when creating new entity.
2236    * (don't call this set defaults as already in use with different signature in some places)
2237    *
2238    * @param array $params
2239    * @param $defaults
2240    */
2241   public static function setCreateDefaults(&$params, $defaults) {
2242     if (!empty($params['id'])) {
2243       return;
2244     }
2245     foreach ($defaults as $key => $value) {
2246       if (!array_key_exists($key, $params) || $params[$key] === NULL) {
2247         $params[$key] = $value;
2248       }
2249     }
2250   }
2251
2252   /**
2253    * @param string $prefix
2254    * @param bool $addRandomString
2255    * @param null $string
2256    *
2257    * @return string
2258    * @deprecated
2259    * @see CRM_Utils_SQL_TempTable
2260    */
2261   public static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
2262     CRM_Core_Error::deprecatedFunctionWarning('Use CRM_Utils_SQL_TempTable interface to create temporary tables');
2263     $tableName = $prefix . "_temp";
2264
2265     if ($addRandomString) {
2266       if ($string) {
2267         $tableName .= "_" . $string;
2268       }
2269       else {
2270         $tableName .= "_" . md5(uniqid('', TRUE));
2271       }
2272     }
2273     return $tableName;
2274   }
2275
2276   /**
2277    * @param bool $view
2278    * @param bool $trigger
2279    *
2280    * @return bool
2281    */
2282   public static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
2283     if (\Civi::settings()->get('logging_no_trigger_permission')) {
2284       return TRUE;
2285     }
2286     // test for create view and trigger permissions and if allowed, add the option to go multilingual and logging
2287     $dao = new CRM_Core_DAO();
2288     try {
2289       if ($view) {
2290         $dao->query('CREATE OR REPLACE VIEW civicrm_domain_view AS SELECT * FROM civicrm_domain');
2291         $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2292       }
2293
2294       if ($trigger) {
2295         $dao->query('CREATE TRIGGER civicrm_domain_trigger BEFORE INSERT ON civicrm_domain FOR EACH ROW BEGIN END');
2296         $dao->query('DROP TRIGGER IF EXISTS civicrm_domain_trigger');
2297       }
2298     }
2299     catch (Exception $e) {
2300       return FALSE;
2301     }
2302
2303     return TRUE;
2304   }
2305
2306   /**
2307    * @param null $message
2308    * @param bool $printDAO
2309    */
2310   public static function debugPrint($message = NULL, $printDAO = TRUE) {
2311     CRM_Utils_System::xMemory("{$message}: ");
2312
2313     if ($printDAO) {
2314       global $_DB_DATAOBJECT;
2315       $q = [];
2316       foreach (array_keys($_DB_DATAOBJECT['RESULTS']) as $id) {
2317         $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query;
2318       }
2319       CRM_Core_Error::debug('_DB_DATAOBJECT', $q);
2320     }
2321   }
2322
2323   /**
2324    * Build a list of triggers via hook and add them to (err, reconcile them
2325    * with) the database.
2326    *
2327    * @param string $tableName
2328    *   the specific table requiring a rebuild; or NULL to rebuild all tables.
2329    * @param bool $force
2330    * @deprecated
2331    *
2332    * @see CRM-9716
2333    */
2334   public static function triggerRebuild($tableName = NULL, $force = FALSE) {
2335     Civi::service('sql_triggers')->rebuild($tableName, $force);
2336   }
2337
2338   /**
2339    * Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
2340    * @see http://issues.civicrm.org/jira/browse/CRM-13822
2341    * TODO: Alternative solutions might be
2342    *  * Stop using functions and find another way to strip numeric characters from phones
2343    *  * Give better error messages (currently a missing fn fatals with "unknown error")
2344    */
2345   public static function checkSqlFunctionsExist() {
2346     if (!self::$_checkedSqlFunctionsExist) {
2347       self::$_checkedSqlFunctionsExist = TRUE;
2348       $dao = CRM_Core_DAO::executeQuery("SHOW function status WHERE db = database() AND name = 'civicrm_strip_non_numeric'");
2349       if (!$dao->fetch()) {
2350         self::triggerRebuild();
2351       }
2352     }
2353   }
2354
2355   /**
2356    * Wrapper function to drop triggers.
2357    *
2358    * @param string $tableName
2359    *   the specific table requiring a rebuild; or NULL to rebuild all tables.
2360    * @deprecated
2361    */
2362   public static function dropTriggers($tableName = NULL) {
2363     Civi::service('sql_triggers')->dropTriggers($tableName);
2364   }
2365
2366   /**
2367    * @param array $info
2368    *   per hook_civicrm_triggerInfo.
2369    * @param string $onlyTableName
2370    *   the specific table requiring a rebuild; or NULL to rebuild all tables.
2371    * @deprecated
2372    */
2373   public static function createTriggers(&$info, $onlyTableName = NULL) {
2374     Civi::service('sql_triggers')->createTriggers($info, $onlyTableName);
2375   }
2376
2377   /**
2378    * Given a list of fields, create a list of references.
2379    *
2380    * @param string $className
2381    *   BAO/DAO class name.
2382    * @return array<CRM_Core_Reference_Interface>
2383    */
2384   public static function createReferenceColumns($className) {
2385     $result = [];
2386     $fields = $className::fields();
2387     foreach ($fields as $field) {
2388       if (isset($field['pseudoconstant'], $field['pseudoconstant']['optionGroupName'])) {
2389         $result[] = new CRM_Core_Reference_OptionValue(
2390           $className::getTableName(),
2391           $field['name'],
2392           'civicrm_option_value',
2393           CRM_Utils_Array::value('keyColumn', $field['pseudoconstant'], 'value'),
2394           $field['pseudoconstant']['optionGroupName']
2395         );
2396       }
2397     }
2398     return $result;
2399   }
2400
2401   /**
2402    * Find all records which refer to this entity.
2403    *
2404    * @return array
2405    *   Array of objects referencing this
2406    */
2407   public function findReferences() {
2408     $links = self::getReferencesToTable(static::getTableName());
2409
2410     $occurrences = [];
2411     foreach ($links as $refSpec) {
2412       /** @var $refSpec CRM_Core_Reference_Interface */
2413       $daoName = CRM_Core_DAO_AllCoreTables::getClassForTable($refSpec->getReferenceTable());
2414       $result = $refSpec->findReferences($this);
2415       if ($result) {
2416         while ($result->fetch()) {
2417           $obj = new $daoName();
2418           $obj->id = $result->id;
2419           $occurrences[] = $obj;
2420         }
2421       }
2422     }
2423
2424     return $occurrences;
2425   }
2426
2427   /**
2428    * @return array
2429    *   each item has keys:
2430    *   - name: string
2431    *   - type: string
2432    *   - count: int
2433    *   - table: string|null SQL table name
2434    *   - key: string|null SQL column name
2435    */
2436   public function getReferenceCounts() {
2437     $links = self::getReferencesToTable(static::getTableName());
2438
2439     $counts = [];
2440     foreach ($links as $refSpec) {
2441       /** @var $refSpec CRM_Core_Reference_Interface */
2442       $count = $refSpec->getReferenceCount($this);
2443       if ($count['count'] != 0) {
2444         $counts[] = $count;
2445       }
2446     }
2447
2448     foreach (CRM_Core_Component::getEnabledComponents() as $component) {
2449       /** @var $component CRM_Core_Component_Info */
2450       $counts = array_merge($counts, $component->getReferenceCounts($this));
2451     }
2452     CRM_Utils_Hook::referenceCounts($this, $counts);
2453
2454     return $counts;
2455   }
2456
2457   /**
2458    * List all tables which have hard foreign keys to this table.
2459    *
2460    * For now, this returns a description of every entity_id/entity_table
2461    * reference.
2462    * TODO: filter dynamic entity references on the $tableName, based on
2463    * schema metadata in dynamicForeignKey which enumerates a restricted
2464    * set of possible entity_table's.
2465    *
2466    * @param string $tableName
2467    *   Table referred to.
2468    *
2469    * @return array
2470    *   structure of table and column, listing every table with a
2471    *   foreign key reference to $tableName, and the column where the key appears.
2472    */
2473   public static function getReferencesToTable($tableName) {
2474     $refsFound = [];
2475     foreach (CRM_Core_DAO_AllCoreTables::getClasses() as $daoClassName) {
2476       $links = $daoClassName::getReferenceColumns();
2477
2478       foreach ($links as $refSpec) {
2479         /** @var $refSpec CRM_Core_Reference_Interface */
2480         if ($refSpec->matchesTargetTable($tableName)) {
2481           $refsFound[] = $refSpec;
2482         }
2483       }
2484     }
2485     return $refsFound;
2486   }
2487
2488   /**
2489    * Get all references to contact table.
2490    *
2491    * This includes core tables, custom group tables, tables added by the merge
2492    * hook and  the entity_tag table.
2493    *
2494    * Refer to CRM-17454 for information on the danger of querying the information
2495    * schema to derive this.
2496    *
2497    * @throws \CiviCRM_API3_Exception
2498    */
2499   public static function getReferencesToContactTable() {
2500     if (isset(\Civi::$statics[__CLASS__]) && isset(\Civi::$statics[__CLASS__]['contact_references'])) {
2501       return \Civi::$statics[__CLASS__]['contact_references'];
2502     }
2503     $contactReferences = [];
2504     $coreReferences = CRM_Core_DAO::getReferencesToTable('civicrm_contact');
2505     foreach ($coreReferences as $coreReference) {
2506       if (!is_a($coreReference, 'CRM_Core_Reference_Dynamic')) {
2507         $contactReferences[$coreReference->getReferenceTable()][] = $coreReference->getReferenceKey();
2508       }
2509     }
2510     self::appendCustomTablesExtendingContacts($contactReferences);
2511     self::appendCustomContactReferenceFields($contactReferences);
2512     \Civi::$statics[__CLASS__]['contact_references'] = $contactReferences;
2513     return \Civi::$statics[__CLASS__]['contact_references'];
2514   }
2515
2516   /**
2517    * Get all dynamic references to the given table.
2518    *
2519    * @param string $tableName
2520    *
2521    * @return array
2522    */
2523   public static function getDynamicReferencesToTable($tableName) {
2524     if (!isset(\Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName])) {
2525       \Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName] = [];
2526       $coreReferences = CRM_Core_DAO::getReferencesToTable($tableName);
2527       foreach ($coreReferences as $coreReference) {
2528         if ($coreReference instanceof \CRM_Core_Reference_Dynamic) {
2529           \Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName][$coreReference->getReferenceTable()][] = [$coreReference->getReferenceKey(), $coreReference->getTypeColumn()];
2530         }
2531       }
2532     }
2533     return \Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName];
2534   }
2535
2536   /**
2537    * Add custom tables that extend contacts to the list of contact references.
2538    *
2539    * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish
2540    * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples
2541    * - the down side is it is not cached.
2542    *
2543    * Further changes should be include tests in the CRM_Core_MergerTest class
2544    * to ensure that disabled, subtype, multiple etc groups are still captured.
2545    *
2546    * @param array $cidRefs
2547    */
2548   public static function appendCustomTablesExtendingContacts(&$cidRefs) {
2549     $customValueTables = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity('Contact');
2550     $customValueTables->find();
2551     while ($customValueTables->fetch()) {
2552       $cidRefs[$customValueTables->table_name][] = 'entity_id';
2553     }
2554   }
2555
2556   /**
2557    * Add custom ContactReference fields to the list of contact references
2558    *
2559    * This includes active and inactive fields/groups
2560    *
2561    * @param array $cidRefs
2562    *
2563    * @throws \CiviCRM_API3_Exception
2564    */
2565   public static function appendCustomContactReferenceFields(&$cidRefs) {
2566     $fields = civicrm_api3('CustomField', 'get', [
2567       'return'    => ['column_name', 'custom_group_id.table_name'],
2568       'data_type' => 'ContactReference',
2569       'options' => ['limit' => 0],
2570     ])['values'];
2571     foreach ($fields as $field) {
2572       $cidRefs[$field['custom_group_id.table_name']][] = $field['column_name'];
2573     }
2574   }
2575
2576   /**
2577    * Lookup the value of a MySQL global configuration variable.
2578    *
2579    * @param string $name
2580    *   E.g. "thread_stack".
2581    * @param mixed $default
2582    * @return mixed
2583    */
2584   public static function getGlobalSetting($name, $default = NULL) {
2585     // Alternatively, SELECT @@GLOBAL.thread_stack, but
2586     // that has been reported to fail under MySQL 5.0 for OS X
2587     $escapedName = self::escapeString($name);
2588     $dao = CRM_Core_DAO::executeQuery("SHOW VARIABLES LIKE '$escapedName'");
2589     if ($dao->fetch()) {
2590       return $dao->Value;
2591     }
2592     else {
2593       return $default;
2594     }
2595   }
2596
2597   /**
2598    * Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
2599    *
2600    * This is relevant where we want to offer both the ID field and the label field
2601    * as an option, e.g. search builder.
2602    *
2603    * It is currently limited for optionGroupName & id+ name+ FK combos for purposes keeping the scope of the
2604    * change small, but is appropriate for other sorts of pseudoconstants.
2605    *
2606    * @param array $fields
2607    */
2608   public static function appendPseudoConstantsToFields(&$fields) {
2609     foreach ($fields as $fieldUniqueName => $field) {
2610       if (!empty($field['pseudoconstant'])) {
2611         $pseudoConstant = $field['pseudoconstant'];
2612         if (!empty($pseudoConstant['optionGroupName'])) {
2613           $fields[$pseudoConstant['optionGroupName']] = [
2614             'title' => CRM_Core_BAO_OptionGroup::getTitleByName($pseudoConstant['optionGroupName']),
2615             'name' => $pseudoConstant['optionGroupName'],
2616             'data_type' => CRM_Utils_Type::T_STRING,
2617             'is_pseudofield_for' => $fieldUniqueName,
2618           ];
2619         }
2620         // We restrict to id + name + FK as we are extending this a bit, but cautiously.
2621         elseif (
2622           !empty($field['FKClassName'])
2623           && CRM_Utils_Array::value('keyColumn', $pseudoConstant) === 'id'
2624           && CRM_Utils_Array::value('labelColumn', $pseudoConstant) === 'name'
2625         ) {
2626           $pseudoFieldName = str_replace('_' . $pseudoConstant['keyColumn'], '', $field['name']);
2627           // This if is just an extra caution when adding change.
2628           if (!isset($fields[$pseudoFieldName])) {
2629             $daoName = $field['FKClassName'];
2630             $fkFields = $daoName::fields();
2631             foreach ($fkFields as $fkField) {
2632               if ($fkField['name'] === $pseudoConstant['labelColumn']) {
2633                 $fields[$pseudoFieldName] = [
2634                   'name' => $pseudoFieldName,
2635                   'is_pseudofield_for' => $field['name'],
2636                   'title' => $fkField['title'],
2637                   'data_type' => $fkField['type'],
2638                   'where' => $field['where'],
2639                 ];
2640               }
2641             }
2642           }
2643         }
2644       }
2645     }
2646   }
2647
2648   /**
2649    * Get options for the called BAO object's field.
2650    *
2651    * This function can be overridden by each BAO to add more logic related to context.
2652    * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
2653    *
2654    * @param string $fieldName
2655    * @param string $context
2656    * @see CRM_Core_DAO::buildOptionsContext
2657    * @param array $props
2658    *   Raw field values; whatever is known about this bao object.
2659    *
2660    * Note: $props can contain unsanitized input and should not be passed directly to CRM_Core_PseudoConstant::get
2661    *
2662    * @return array|bool
2663    */
2664   public static function buildOptions($fieldName, $context = NULL, $props = []) {
2665     // If a given bao does not override this function
2666     $baoName = get_called_class();
2667     return CRM_Core_PseudoConstant::get($baoName, $fieldName, [], $context);
2668   }
2669
2670   /**
2671    * Populate option labels for this object's fields.
2672    *
2673    * @throws exception if called directly on the base class
2674    */
2675   public function getOptionLabels() {
2676     $fields = $this->fields();
2677     if ($fields === NULL) {
2678       throw new Exception('Cannot call getOptionLabels on CRM_Core_DAO');
2679     }
2680     foreach ($fields as $field) {
2681       $name = $field['name'] ?? NULL;
2682       if ($name && isset($this->$name)) {
2683         $label = CRM_Core_PseudoConstant::getLabel(get_class($this), $name, $this->$name);
2684         if ($label !== FALSE) {
2685           // Append 'label' onto the field name
2686           $labelName = $name . '_label';
2687           $this->$labelName = $label;
2688         }
2689       }
2690     }
2691   }
2692
2693   /**
2694    * Provides documentation and validation for the buildOptions $context param
2695    *
2696    * @param string $context
2697    *
2698    * @throws CRM_Core_Exception
2699    * @return array
2700    */
2701   public static function buildOptionsContext($context = NULL) {
2702     $contexts = [
2703       'get' => "get: all options are returned, even if they are disabled; labels are translated.",
2704       'create' => "create: options are filtered appropriately for the object being created/updated; labels are translated.",
2705       'search' => "search: searchable options are returned; labels are translated.",
2706       'validate' => "validate: all options are returned, even if they are disabled; machine names are used in place of labels.",
2707       'abbreviate' => "abbreviate: enabled options are returned; labels are replaced with abbreviations.",
2708       'match' => "match: enabled options are returned using machine names as keys; labels are translated.",
2709     ];
2710     // Validation: enforce uniformity of this param
2711     if ($context !== NULL && !isset($contexts[$context])) {
2712       throw new CRM_Core_Exception("'$context' is not a valid context for buildOptions.");
2713     }
2714     return $contexts;
2715   }
2716
2717   /**
2718    * @param string $fieldName
2719    * @return bool|array
2720    */
2721   public function getFieldSpec($fieldName) {
2722     $fields = $this->fields();
2723
2724     // Support "unique names" as well as sql names
2725     $fieldKey = $fieldName;
2726     if (empty($fields[$fieldKey])) {
2727       $fieldKeys = $this->fieldKeys();
2728       $fieldKey = $fieldKeys[$fieldName] ?? NULL;
2729     }
2730     // If neither worked then this field doesn't exist. Return false.
2731     if (empty($fields[$fieldKey])) {
2732       return FALSE;
2733     }
2734     return $fields[$fieldKey];
2735   }
2736
2737   /**
2738    * Get SQL where clause for SQL filter syntax input parameters.
2739    *
2740    * SQL version of api function to assign filters to the DAO based on the syntax
2741    * $field => array('IN' => array(4,6,9))
2742    * OR
2743    * $field => array('LIKE' => array('%me%))
2744    * etc
2745    *
2746    * @param string $fieldName
2747    *   Name of fields.
2748    * @param array $filter
2749    *   filter to be applied indexed by operator.
2750    * @param string $type
2751    *   type of field (not actually used - nor in api @todo ).
2752    * @param string $alias
2753    *   alternative field name ('as') @todo- not actually used.
2754    * @param bool $returnSanitisedArray
2755    *   Return a sanitised array instead of a clause.
2756    *   this is primarily so we can add filters @ the api level to the Query object based fields
2757    *
2758    * @throws Exception
2759    *
2760    * @return NULL|string|array
2761    *   a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL
2762    *   depending on whether it is supported as yet
2763    */
2764   public static function createSQLFilter($fieldName, $filter, $type = NULL, $alias = NULL, $returnSanitisedArray = FALSE) {
2765     foreach ($filter as $operator => $criteria) {
2766       if (!CRM_Core_BAO_SchemaHandler::databaseSupportsUTF8MB4()) {
2767         foreach ((array) $criteria as $criterion) {
2768           if (!empty($criterion) && !is_numeric($criterion)
2769             // The first 2 criteria are redundant but are added as they
2770             // seem like they would
2771             // be quicker than this 3rd check.
2772             && max(array_map('ord', str_split($criterion))) >= 240) {
2773             // String contains unsupported emojis.
2774             // We return a clause that resolves to false as an emoji string by definition cannot be saved.
2775             // note that if we return just 0 for false if gets lost in empty checks.
2776             // https://stackoverflow.com/questions/16496554/can-php-detect-4-byte-encoded-utf8-chars
2777             return '0 = 1';
2778           }
2779         }
2780       }
2781
2782       if (in_array($operator, self::acceptedSQLOperators(), TRUE)) {
2783         switch ($operator) {
2784           // unary operators
2785           case 'IS NULL':
2786           case 'IS NOT NULL':
2787             if (!$returnSanitisedArray) {
2788               return (sprintf('%s %s', $fieldName, $operator));
2789             }
2790             else {
2791               return (sprintf('%s %s ', $fieldName, $operator));
2792             }
2793             break;
2794
2795           // ternary operators
2796           case 'BETWEEN':
2797           case 'NOT BETWEEN':
2798             if ((empty($criteria[0]) && !in_array($criteria[0], ['0', 0]))|| (empty($criteria[1]) &&  !in_array($criteria[1], ['0', 0]))) {
2799               throw new Exception("invalid criteria for $operator");
2800             }
2801             if (!$returnSanitisedArray) {
2802               return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO::escapeString($criteria[0]), CRM_Core_DAO::escapeString($criteria[1])));
2803             }
2804             else {
2805               // not yet implemented (tests required to implement)
2806               return NULL;
2807             }
2808             break;
2809
2810           // n-ary operators
2811           case 'IN':
2812           case 'NOT IN':
2813             if (empty($criteria)) {
2814               throw new Exception("invalid criteria for $operator");
2815             }
2816             $escapedCriteria = array_map([
2817               'CRM_Core_DAO',
2818               'escapeString',
2819             ], $criteria);
2820             if (!$returnSanitisedArray) {
2821               return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
2822             }
2823             return $escapedCriteria;
2824
2825           // binary operators
2826
2827           default:
2828             if (!$returnSanitisedArray) {
2829               return (sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO::escapeString($criteria)));
2830             }
2831             else {
2832               // not yet implemented (tests required to implement)
2833               return NULL;
2834             }
2835         }
2836       }
2837     }
2838   }
2839
2840   /**
2841    * @see http://issues.civicrm.org/jira/browse/CRM-9150
2842    * support for other syntaxes is discussed in ticket but being put off for now
2843    * @return string[]
2844    */
2845   public static function acceptedSQLOperators() {
2846     return [
2847       '=',
2848       '<=',
2849       '>=',
2850       '>',
2851       '<',
2852       'LIKE',
2853       "<>",
2854       "!=",
2855       "NOT LIKE",
2856       'IN',
2857       'NOT IN',
2858       'BETWEEN',
2859       'NOT BETWEEN',
2860       'IS NOT NULL',
2861       'IS NULL',
2862     ];
2863   }
2864
2865   /**
2866    * SQL has a limit of 64 characters on various names:
2867    * table name, trigger name, column name ...
2868    *
2869    * For custom groups and fields we generated names from user entered input
2870    * which can be longer than this length, this function helps with creating
2871    * strings that meet various criteria.
2872    *
2873    * @param string $string
2874    *   The string to be shortened.
2875    * @param int $length
2876    *   The max length of the string.
2877    *
2878    * @param bool $makeRandom
2879    *
2880    * @return string
2881    */
2882   public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) {
2883     // early return for strings that meet the requirements
2884     if (strlen($string) <= $length) {
2885       return $string;
2886     }
2887
2888     // easy return for calls that dont need a randomized uniq string
2889     if (!$makeRandom) {
2890       return substr($string, 0, $length);
2891     }
2892
2893     // the string is longer than the length and we need a uniq string
2894     // for the same tablename we need the same uniq string every time
2895     // hence we use md5 on the string, which is not random
2896     // we'll append 8 characters to the end of the tableName
2897     $md5string = substr(md5($string), 0, 8);
2898     return substr($string, 0, $length - 8) . "_{$md5string}";
2899   }
2900
2901   /**
2902    * https://issues.civicrm.org/jira/browse/CRM-17748
2903    * Sets the internal options to be used on a query
2904    *
2905    * @param array $options
2906    *
2907    */
2908   public function setOptions($options) {
2909     if (is_array($options)) {
2910       $this->_options = $options;
2911     }
2912   }
2913
2914   /**
2915    * https://issues.civicrm.org/jira/browse/CRM-17748
2916    * wrapper to pass internal DAO options down to DB_mysql/DB_Common level
2917    *
2918    * @param array $options
2919    *
2920    */
2921   protected function _setDBOptions($options) {
2922     global $_DB_DATAOBJECT;
2923
2924     if (is_array($options) && count($options)) {
2925       $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
2926       foreach ($options as $option_name => $option_value) {
2927         $conn->setOption($option_name, $option_value);
2928       }
2929     }
2930   }
2931
2932   /**
2933    * @deprecated
2934    * @param array $params
2935    */
2936   public function setApiFilter(&$params) {
2937   }
2938
2939   /**
2940    * Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
2941    *
2942    * Return format is in the form of fieldname => clauses starting with an operator. e.g.:
2943    * ```
2944    *   array(
2945    *     'location_type_id' => array('IS NOT NULL', 'IN (1,2,3)')
2946    *   )
2947    * ```
2948    *
2949    * Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values.
2950    *
2951    * @return array
2952    */
2953   public function addSelectWhereClause() {
2954     $clauses = [];
2955     $fields = $this->fields();
2956     foreach ($fields as $fieldName => $field) {
2957       // Clause for contact-related entities like Email, Relationship, etc.
2958       if (strpos($fieldName, 'contact_id') === 0 && CRM_Utils_Array::value('FKClassName', $field) == 'CRM_Contact_DAO_Contact') {
2959         $clauses[$fieldName] = CRM_Utils_SQL::mergeSubquery('Contact');
2960       }
2961       // Clause for an entity_table/entity_id combo
2962       if ($fieldName == 'entity_id' && isset($fields['entity_table'])) {
2963         $relatedClauses = [];
2964         $relatedEntities = $this->buildOptions('entity_table', 'get');
2965         foreach ((array) $relatedEntities as $table => $ent) {
2966           if (!empty($ent)) {
2967             $ent = CRM_Core_DAO_AllCoreTables::getBriefName(CRM_Core_DAO_AllCoreTables::getClassForTable($table));
2968             $subquery = CRM_Utils_SQL::mergeSubquery($ent);
2969             if ($subquery) {
2970               $relatedClauses[] = "(entity_table = '$table' AND entity_id " . implode(' AND entity_id ', $subquery) . ")";
2971             }
2972             else {
2973               $relatedClauses[] = "(entity_table = '$table')";
2974             }
2975           }
2976         }
2977         if ($relatedClauses) {
2978           $clauses['id'] = 'IN (SELECT id FROM `' . $this->tableName() . '` WHERE (' . implode(') OR (', $relatedClauses) . '))';
2979         }
2980       }
2981     }
2982     CRM_Utils_Hook::selectWhereClause($this, $clauses);
2983     return $clauses;
2984   }
2985
2986   /**
2987    * This returns the final permissioned query string for this entity
2988    *
2989    * With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
2990    *
2991    * @param string $tableAlias
2992    * @return array
2993    */
2994   public static function getSelectWhereClause($tableAlias = NULL) {
2995     $bao = new static();
2996     if ($tableAlias === NULL) {
2997       $tableAlias = $bao->tableName();
2998     }
2999     $clauses = [];
3000     foreach ((array) $bao->addSelectWhereClause() as $field => $vals) {
3001       $clauses[$field] = NULL;
3002       if ($vals) {
3003         $clauses[$field] = "(`$tableAlias`.`$field` IS NULL OR (`$tableAlias`.`$field` " . implode(" AND `$tableAlias`.`$field` ", (array) $vals) . '))';
3004       }
3005     }
3006     return $clauses;
3007   }
3008
3009   /**
3010    * ensure database name is 'safe', i.e. only contains word characters (includes underscores)
3011    * and dashes, and contains at least one [a-z] case insenstive.
3012    *
3013    * @param $database
3014    *
3015    * @return bool
3016    */
3017   public static function requireSafeDBName($database) {
3018     $matches = [];
3019     preg_match(
3020       "/^[\w\-]*[a-z]+[\w\-]*$/i",
3021       $database,
3022       $matches
3023     );
3024     if (empty($matches)) {
3025       return FALSE;
3026     }
3027     return TRUE;
3028   }
3029
3030   /**
3031    * Transform an array to a serialized string for database storage.
3032    *
3033    * @param array|null $value
3034    * @param int $serializationType
3035    * @return string|null
3036    *
3037    * @throws \Exception
3038    */
3039   public static function serializeField($value, $serializationType) {
3040     if ($value === NULL) {
3041       return NULL;
3042     }
3043     switch ($serializationType) {
3044       case self::SERIALIZE_SEPARATOR_BOOKEND:
3045         return $value === [] ? '' : CRM_Utils_Array::implodePadded($value);
3046
3047       case self::SERIALIZE_SEPARATOR_TRIMMED:
3048         return is_array($value) ? implode(self::VALUE_SEPARATOR, $value) : $value;
3049
3050       case self::SERIALIZE_JSON:
3051         return is_array($value) ? json_encode($value) : $value;
3052
3053       case self::SERIALIZE_PHP:
3054         return is_array($value) ? serialize($value) : $value;
3055
3056       case self::SERIALIZE_COMMA:
3057         return is_array($value) ? implode(',', $value) : $value;
3058
3059       default:
3060         throw new Exception('Unknown serialization method for field.');
3061     }
3062   }
3063
3064   /**
3065    * Transform a serialized string from the database into an array.
3066    *
3067    * @param string|null $value
3068    * @param $serializationType
3069    *
3070    * @return array|null
3071    * @throws CRM_Core_Exception
3072    */
3073   public static function unSerializeField($value, $serializationType) {
3074     if ($value === NULL) {
3075       return NULL;
3076     }
3077     if ($value === '') {
3078       return [];
3079     }
3080     switch ($serializationType) {
3081       case self::SERIALIZE_SEPARATOR_BOOKEND:
3082         return (array) CRM_Utils_Array::explodePadded($value);
3083
3084       case self::SERIALIZE_SEPARATOR_TRIMMED:
3085         return explode(self::VALUE_SEPARATOR, trim($value));
3086
3087       case self::SERIALIZE_JSON:
3088         return strlen($value) ? json_decode($value, TRUE) : [];
3089
3090       case self::SERIALIZE_PHP:
3091         return strlen($value) ? CRM_Utils_String::unserialize($value) : [];
3092
3093       case self::SERIALIZE_COMMA:
3094         return explode(',', trim(str_replace(', ', '', $value)));
3095
3096       default:
3097         throw new CRM_Core_Exception('Unknown serialization method for field.');
3098     }
3099   }
3100
3101   /**
3102    * @return array
3103    */
3104   public static function getEntityRefFilters() {
3105     return [];
3106   }
3107
3108   /**
3109    * Get exportable fields with pseudoconstants rendered as an extra field.
3110    *
3111    * @param string $baoClass
3112    *
3113    * @return array
3114    */
3115   public static function getExportableFieldsWithPseudoConstants($baoClass) {
3116     if (method_exists($baoClass, 'exportableFields')) {
3117       $fields = $baoClass::exportableFields();
3118     }
3119     else {
3120       $fields = $baoClass::export();
3121     }
3122     CRM_Core_DAO::appendPseudoConstantsToFields($fields);
3123     return $fields;
3124   }
3125
3126   /**
3127    * Remove item from static cache during update/delete operations
3128    */
3129   private function clearDbColumnValueCache() {
3130     $daoName = get_class($this);
3131     while (strpos($daoName, '_BAO_') !== FALSE) {
3132       $daoName = get_parent_class($daoName);
3133     }
3134     if (isset($this->id)) {
3135       unset(self::$_dbColumnValueCache[$daoName]['id'][$this->id]);
3136     }
3137     if (isset($this->name)) {
3138       unset(self::$_dbColumnValueCache[$daoName]['name'][$this->name]);
3139     }
3140   }
3141
3142   /**
3143    * Return a mapping from field-name to the corresponding key (as used in fields()).
3144    *
3145    * @return array
3146    *   Array(string $name => string $uniqueName).
3147    */
3148   public static function fieldKeys() {
3149     return array_flip(CRM_Utils_Array::collect('name', static::fields()));
3150   }
3151
3152   /**
3153    * Returns system paths related to this entity (as defined in the xml schema)
3154    *
3155    * @return array
3156    */
3157   public static function getEntityPaths() {
3158     return static::$_paths ?? [];
3159   }
3160
3161 }