3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * Base Database Access Object class.
15 * All DAO classes should inherit from this class.
18 * @copyright CiviCRM LLC https://civicrm.org/licensing
21 if (!defined('DB_DSN_MODE')) {
22 define('DB_DSN_MODE', 'auto');
25 require_once 'PEAR.php';
26 require_once 'DB/DataObject.php';
28 require_once 'CRM/Core/I18n.php';
33 class CRM_Core_DAO
extends DB_DataObject
{
36 * Primary key field(s).
40 public static $_primaryKey = ['id'];
43 * How many times has this instance been cloned.
47 protected $resultCopies = 0;
53 public static $_nullObject = NULL;
56 * Icon associated with this entity.
60 public static $_icon = NULL;
63 * Field to show when displaying a record.
67 public static $_labelField = NULL;
73 public static $_nullArray = [];
75 public static $_dbColumnValueCache = NULL;
76 const NOT_NULL
= 1, IS_NULL
= 2,
78 VALUE_SEPARATOR
= "\ 1",
79 BULK_INSERT_COUNT
= 200,
80 BULK_INSERT_HIGH_COUNT
= 200,
81 QUERY_FORMAT_WILDCARD
= 1,
82 QUERY_FORMAT_NO_QUOTES
= 2,
85 * Serialized string separated by and bookended with VALUE_SEPARATOR
87 SERIALIZE_SEPARATOR_BOOKEND
= 1,
89 * @deprecated format separated by VALUE_SEPARATOR
91 SERIALIZE_SEPARATOR_TRIMMED
= 2,
93 * Recommended serialization format
97 * @deprecated format using php serialize()
101 * Comma separated string, no quotes, no spaces
106 * Define entities that shouldn't be created or deleted when creating/ deleting
107 * test objects - this prevents world regions, countries etc from being added / deleted
110 public static $_testEntitiesToSkip = [];
112 * The factory class for this application.
115 public static $_factory = NULL;
118 * https://issues.civicrm.org/jira/browse/CRM-17748
119 * internal variable for DAO to hold per-query settings
122 protected $_options = [];
127 * @return \CRM_Core_DAO
129 public function __construct() {
131 $this->__table
= $this->getTableName();
135 * Returns localized title of this entity.
139 public static function getEntityTitle() {
140 $className = static::class;
141 CRM_Core_Error
::deprecatedWarning("$className needs to be regenerated. Missing getEntityTitle method.");
142 return CRM_Core_DAO_AllCoreTables
::getBriefName($className);
146 * Returns user-friendly description of this entity.
148 * @return string|null
150 public static function getEntityDescription() {
154 public function __clone() {
155 if (!empty($this->_DB_resultid
)) {
156 $this->resultCopies++
;
163 public function __destruct() {
164 if ($this->resultCopies
=== 0) {
167 $this->resultCopies
--;
171 * Returns the name of this table
175 public static function getTableName() {
176 return self
::getLocaleTableName(static::$_tableName ??
NULL);
180 * Returns if this table needs to be logged
184 public function getLog() {
185 return static::$_log ??
FALSE;
189 * Initialize the DAO object.
192 * The database connection string.
194 public static function init($dsn) {
195 Civi
::$statics[__CLASS__
]['init'] = 1;
196 $options = &PEAR
::getStaticProperty('DB_DataObject', 'options');
197 $dsn = CRM_Utils_SQL
::autoSwitchDSN($dsn);
198 $options['database'] = $dsn;
199 $options['quote_identifiers'] = TRUE;
200 if (CRM_Utils_SQL
::isSSLDSN($dsn)) {
201 // There are two different options arrays.
202 $other_options = &PEAR
::getStaticProperty('DB', 'options');
203 $other_options['ssl'] = TRUE;
205 if (defined('CIVICRM_DAO_DEBUG')) {
206 self
::DebugLevel(CIVICRM_DAO_DEBUG
);
208 $factory = new CRM_Contact_DAO_Factory();
209 CRM_Core_DAO
::setFactory($factory);
210 CRM_Core_DAO
::executeQuery('SET NAMES utf8mb4');
211 CRM_Core_DAO
::executeQuery('SET @uniqueID = %1', [1 => [CRM_Utils_Request
::id(), 'String']]);
217 public static function getConnection() {
218 global $_DB_DATAOBJECT;
219 $dao = new CRM_Core_DAO();
220 return $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5
];
224 * Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary
226 public static function disableFullGroupByMode() {
227 $currentModes = CRM_Utils_SQL
::getSqlModes();
228 if (in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL
::isGroupByModeInDefault()) {
229 $key = array_search('ONLY_FULL_GROUP_BY', $currentModes);
230 unset($currentModes[$key]);
231 CRM_Core_DAO
::executeQuery("SET SESSION sql_mode = %1", [1 => [implode(',', $currentModes), 'String']]);
236 * Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary..
238 public static function reenableFullGroupByMode() {
239 $currentModes = CRM_Utils_SQL
::getSqlModes();
240 if (!in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL
::isGroupByModeInDefault()) {
241 $currentModes[] = 'ONLY_FULL_GROUP_BY';
242 CRM_Core_DAO
::executeQuery("SET SESSION sql_mode = %1", [1 => [implode(',', $currentModes), 'String']]);
247 * @param string $fieldName
249 * @param array $params
251 protected function assignTestFK($fieldName, $fieldDef, $params) {
252 $required = $fieldDef['required'] ??
NULL;
253 $FKClassName = $fieldDef['FKClassName'] ??
NULL;
254 $dbName = $fieldDef['name'];
255 $daoName = str_replace('_BAO_', '_DAO_', get_class($this));
257 // skip the FK if it is not required
258 // if it's contact id we should create even if not required
259 // we'll have a go @ fetching first though
260 // we WILL create campaigns though for so tests with a campaign pseudoconstant will complete
261 if ($FKClassName === 'CRM_Campaign_DAO_Campaign' && $daoName != $FKClassName) {
264 if (!$required && $dbName != 'contact_id') {
265 $fkDAO = new $FKClassName();
266 if ($fkDAO->find(TRUE)) {
267 $this->$dbName = $fkDAO->id
;
271 elseif (in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)) {
272 $depObject = new $FKClassName();
273 $depObject->find(TRUE);
274 $this->$dbName = $depObject->id
;
276 elseif ($daoName == 'CRM_Member_DAO_MembershipType' && $fieldName == 'member_of_contact_id') {
277 // FIXME: the fields() metadata is not specific enough
278 $depObject = CRM_Core_DAO
::createTestObject($FKClassName, ['contact_type' => 'Organization']);
279 $this->$dbName = $depObject->id
;
282 //if it is required we need to generate the dependency object first
283 $depObject = CRM_Core_DAO
::createTestObject($FKClassName, CRM_Utils_Array
::value($dbName, $params, 1));
284 $this->$dbName = $depObject->id
;
289 * Generate and assign an arbitrary value to a field of a test object.
291 * @param string $fieldName
292 * @param array $fieldDef
293 * @param int $counter
294 * The globally-unique ID of the test object.
296 * @throws \CRM_Core_Exception
298 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
299 $dbName = $fieldDef['name'];
300 $daoName = get_class($this);
303 if (!$handled && $dbName == 'contact_sub_type') {
304 //coming up with a rule to set this is too complex let's not set it
308 // Pick an option value if needed
309 if (!$handled && $fieldDef['type'] !== CRM_Utils_Type
::T_BOOLEAN
) {
310 $options = $daoName::buildOptions($dbName, 'create');
312 $this->$dbName = key($options);
318 switch ($fieldDef['type']) {
319 case CRM_Utils_Type
::T_INT
:
320 case CRM_Utils_Type
::T_FLOAT
:
321 case CRM_Utils_Type
::T_MONEY
:
322 if (isset($fieldDef['precision'])) {
323 // $object->$dbName = CRM_Utils_Number::createRandomDecimal($value['precision']);
324 $this->$dbName = CRM_Utils_Number
::createTruncatedDecimal($counter, $fieldDef['precision']);
327 $this->$dbName = $counter;
331 case CRM_Utils_Type
::T_BOOLEAN
:
332 if (isset($fieldDef['default'])) {
333 $this->$dbName = $fieldDef['default'];
335 elseif ($fieldDef['name'] == 'is_deleted' ||
$fieldDef['name'] == 'is_test') {
343 case CRM_Utils_Type
::T_DATE
:
344 case CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
:
345 $this->$dbName = '19700101';
346 if ($dbName == 'end_date') {
347 // put this in the future
348 $this->$dbName = '20200101';
352 case CRM_Utils_Type
::T_TIMESTAMP
:
353 $this->$dbName = '19700201000000';
356 case CRM_Utils_Type
::T_TIME
:
357 throw new CRM_Core_Exception('T_TIME shouldn\'t be used.');
359 case CRM_Utils_Type
::T_CCNUM
:
360 $this->$dbName = '4111 1111 1111 1111';
363 case CRM_Utils_Type
::T_URL
:
364 $this->$dbName = 'http://www.civicrm.org';
367 case CRM_Utils_Type
::T_STRING
:
368 case CRM_Utils_Type
::T_BLOB
:
369 case CRM_Utils_Type
::T_MEDIUMBLOB
:
370 case CRM_Utils_Type
::T_TEXT
:
371 case CRM_Utils_Type
::T_LONGTEXT
:
372 case CRM_Utils_Type
::T_EMAIL
:
374 // WAS: if (isset($value['enumValues'])) {
375 // TODO: see if this works with all pseudoconstants
376 if (isset($fieldDef['pseudoconstant'], $fieldDef['pseudoconstant']['callback'])) {
377 if (isset($fieldDef['default'])) {
378 $this->$dbName = $fieldDef['default'];
381 $options = CRM_Core_PseudoConstant
::get($daoName, $fieldName);
382 if (is_array($options)) {
383 $this->$dbName = $options[0];
386 $defaultValues = explode(',', $options);
387 $this->$dbName = $defaultValues[0];
392 $this->$dbName = $dbName . '_' . $counter;
393 $maxlength = $fieldDef['maxlength'] ??
NULL;
394 if ($maxlength > 0 && strlen($this->$dbName) > $maxlength) {
395 $this->$dbName = substr($this->$dbName, 0, $fieldDef['maxlength']);
403 * Reset the DAO object.
405 * DAO is kinda crappy in that there is an unwritten rule of one query per DAO.
407 * We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution
409 public function reset() {
411 foreach (array_keys($this->table()) as $field) {
412 unset($this->$field);
416 * reset the various DB_DAO structures manually
425 * @param string $tableName
429 public static function getLocaleTableName($tableName) {
432 $tables = CRM_Core_I18n_Schema
::schemaStructureTables();
433 if (in_array($tableName, $tables)) {
434 return $tableName . $dbLocale;
441 * Execute a query by the current DAO, localizing it along the way (if needed).
443 * @param string $query
444 * The SQL query for execution.
445 * @param bool $i18nRewrite
446 * Whether to rewrite the query.
449 * the current DAO object after the query execution
451 public function query($query, $i18nRewrite = TRUE) {
452 // rewrite queries that should use $dbLocale-based views for multi-language installs
453 global $dbLocale, $_DB_DATAOBJECT;
455 if (empty($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
])) {
456 // Will force connection to be populated per CRM-20541.
460 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
461 $orig_options = $conn->options
;
462 $this->_setDBOptions($this->_options
);
464 if ($i18nRewrite and $dbLocale) {
465 $query = CRM_Core_I18n_Schema
::rewriteQuery($query);
468 $ret = parent
::query($query);
470 $this->_setDBOptions($orig_options);
475 * Static function to set the factory instance for this class.
477 * @param object $factory
478 * The factory application object.
480 public static function setFactory(&$factory) {
481 self
::$_factory = &$factory;
485 * Factory method to instantiate a new object from a table name.
487 * @param string $table
488 * @return \DataObject|\PEAR_Error
490 public function factory($table = '') {
491 if (!isset(self
::$_factory)) {
492 return parent
::factory($table);
495 return self
::$_factory->create($table);
499 * Initialization for all DAO objects. Since we access DB_DO programatically
500 * we need to set the links manually.
502 public function initialize() {
504 if (empty(Civi
::$statics[__CLASS__
]['init'])) {
505 // CRM_Core_DAO::init() must be called before CRM_Core_DAO->initialize().
506 // This occurs very early in bootstrap - error handlers may not be wired up.
507 echo "Inconsistent system initialization sequence. Premature access of (" . get_class($this) . ")";
508 CRM_Utils_System
::civiExit();
513 * Defines the default key as 'id'.
517 public function keys() {
526 * Tells DB_DataObject which keys use autoincrement.
527 * 'id' is autoincrementing by default.
532 public function sequenceKey() {
533 static $sequenceKeys;
534 if (!isset($sequenceKeys)) {
535 $sequenceKeys = ['id', TRUE];
537 return $sequenceKeys;
541 * Returns list of FK relationships.
543 * @return CRM_Core_Reference_Basic[]
545 public static function getReferenceColumns() {
546 if (!isset(Civi
::$statics[static::class]['links'])) {
547 Civi
::$statics[static::class]['links'] = static::createReferenceColumns(static::class);
548 CRM_Core_DAO_AllCoreTables
::invoke(static::class, 'links_callback', Civi
::$statics[static::class]['links']);
550 return Civi
::$statics[static::class]['links'];
554 * Returns all the column names of this table.
559 public static function &fields() {
565 * Returns all usable fields, indexed by name.
567 * This function differs from fields() in that it indexes by name rather than unique_name.
569 * It excludes fields not added yet by pending upgrades.
570 * This avoids problems with trying to SELECT a field that exists in code but has not yet been added to the db.
572 * @param bool $checkPermissions
573 * Filter by field permissions.
576 public static function getSupportedFields($checkPermissions = FALSE) {
577 $fields = array_column((array) static::fields(), NULL, 'name');
579 // Exclude fields yet not added by pending upgrades
580 $dbVer = \CRM_Core_BAO_Domain
::version();
581 $daoExt = defined(static::class . '::EXT') ?
constant(static::class . '::EXT') : NULL;
582 if ($fields && $daoExt === 'civicrm' && version_compare($dbVer, \CRM_Utils_System
::version()) < 0) {
583 $fields = array_filter($fields, function($field) use ($dbVer) {
584 $add = $field['add'] ??
'1.0.0';
585 if (substr_count($add, '.') < 2) {
588 return version_compare($dbVer, $add, '>=');
592 // Exclude fields the user does not have permission for
593 if ($checkPermissions) {
594 $fields = array_filter($fields, function($field) {
595 return empty($field['permission']) || CRM_Core_Permission
::check($field['permission']);
603 * Get/set an associative array of table columns
608 public function table() {
609 $fields = $this->fields();
613 foreach ($fields as $name => $value) {
614 $table[$value['name']] = $value['type'];
615 if (!empty($value['required'])) {
616 $table[$value['name']] +
= self
::DB_DAO_NOTNULL
;
629 * @return CRM_Core_DAO
631 public function save($hook = TRUE) {
633 if (!empty($this->id
)) {
635 $preEvent = new \Civi\Core\DAO\Event\
PreUpdate($this);
636 $preEvent->eventID
= $eventID;
637 \Civi
::dispatcher()->dispatch("civi.dao.preUpdate", $preEvent);
640 $result = $this->update();
643 $event = new \Civi\Core\DAO\Event\
PostUpdate($this, $result);
644 $event->eventID
= $eventID;
645 \Civi
::dispatcher()->dispatch("civi.dao.postUpdate", $event);
647 $this->clearDbColumnValueCache();
651 $preEvent = new \Civi\Core\DAO\Event\
PreUpdate($this);
652 $preEvent->eventID
= $eventID;
653 \Civi
::dispatcher()->dispatch("civi.dao.preInsert", $preEvent);
656 $result = $this->insert();
659 $event = new \Civi\Core\DAO\Event\
PostUpdate($this, $result);
660 $event->eventID
= $eventID;
661 \Civi
::dispatcher()->dispatch("civi.dao.postInsert", $event);
667 CRM_Utils_Hook
::postSave($this);
674 * Deletes items from table which match current objects variables.
676 * Returns the true on success
680 * Designed to be extended
682 * $object = new mytable();
684 * echo $object->delete(); // builds a conditon
686 * $object = new mytable();
687 * $object->whereAdd('age > 12');
689 * $object->orderBy('age DESC');
690 * $object->delete(true); // dont use object vars, use the conditions, limit and order.
692 * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
693 * we will build the condition only using the whereAdd's. Default is to
694 * build the condition only using the object parameters.
696 * * @return mixed Int (No. of rows affected) on success, false on failure, 0 on no data affected
698 public function delete($useWhere = FALSE) {
699 $preEvent = new \Civi\Core\DAO\Event\
PreDelete($this);
700 \Civi
::dispatcher()->dispatch("civi.dao.preDelete", $preEvent);
702 $result = parent
::delete($useWhere);
704 $event = new \Civi\Core\DAO\Event\
PostDelete($this, $result);
705 \Civi
::dispatcher()->dispatch("civi.dao.postDelete", $event);
708 $this->clearDbColumnValueCache();
714 * @param bool $created
716 public function log($created = FALSE) {
719 if (!$this->getLog()) {
724 $session = CRM_Core_Session
::singleton();
725 $cid = $session->get('userID');
728 // return is we dont have handle to FK
733 $dao = new CRM_Core_DAO_Log();
734 $dao->entity_table
= $this->getTableName();
735 $dao->entity_id
= $this->id
;
736 $dao->modified_id
= $cid;
737 $dao->modified_date
= date("YmdHis");
742 * Given an associative array of name/value pairs, extract all the values
743 * that belong to this object and initialize the object with said values
745 * @param array $params
746 * Array of name/value pairs to save.
749 * Did we copy all null values into the object
751 public function copyValues($params) {
753 foreach ($this->fields() as $uniqueName => $field) {
754 $dbName = $field['name'];
755 if (array_key_exists($dbName, $params)) {
756 $value = $params[$dbName];
759 elseif (array_key_exists($uniqueName, $params)) {
760 $value = $params[$uniqueName];
767 // if there is no value then make the variable NULL
770 $this->$dbName = 'null';
772 elseif (is_array($value) && !empty($field['serialize'])) {
773 $this->$dbName = CRM_Core_DAO
::serializeField($value, $field['serialize']);
777 $maxLength = $field['maxlength'] ??
NULL;
778 if (!is_array($value) && $maxLength && mb_strlen($value) > $maxLength && empty($field['pseudoconstant'])) {
779 // No ts() since this is a sysadmin-y string not seen by general users.
780 Civi
::log()->warning('A string for field {dbName} has been truncated. The original string was {value}.', ['dbName' => $dbName, 'value' => $value]);
781 // The string is too long - what to do what to do? Well losing data is generally bad so let's truncate
782 $value = CRM_Utils_String
::ellipsify($value, $maxLength);
784 $this->$dbName = $value;
793 * Store all the values from this object in an associative array
794 * this is a destructive store, calling function is responsible
795 * for keeping sanity of id's.
797 * @param object $object
798 * The object that we are extracting data from.
799 * @param array $values
800 * (reference ) associative array of name/value pairs.
802 public static function storeValues(&$object, &$values) {
803 $fields = $object->fields();
804 foreach ($fields as $name => $value) {
805 $dbName = $value['name'];
806 if (isset($object->$dbName) && $object->$dbName !== 'null') {
807 $values[$dbName] = $object->$dbName;
808 if ($name != $dbName) {
809 $values[$name] = $object->$dbName;
816 * Create an attribute for this specific field. We only do this for strings and text
818 * @param array $field
819 * The field under task.
822 * the attributes for the object
824 public static function makeAttribute($field) {
826 if (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_STRING
) {
827 $maxLength = $field['maxlength'] ??
NULL;
828 $size = $field['size'] ??
NULL;
829 if ($maxLength ||
$size) {
832 $attributes['maxlength'] = $maxLength;
835 $attributes['size'] = $size;
840 elseif (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_TEXT
) {
841 $rows = $field['rows'] ??
NULL;
845 $cols = $field['cols'] ??
NULL;
851 $attributes['rows'] = $rows;
852 $attributes['cols'] = $cols;
855 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
) {
856 $attributes['size'] = 6;
857 $attributes['maxlength'] = 14;
865 * Get the size and maxLength attributes for this text field.
866 * (or for all text fields) in the DAO object.
868 * @param string $class
870 * @param string $fieldName
871 * Field that i'm interested in or null if.
872 * you want the attributes for all DAO text fields
875 * assoc array of name => attribute pairs
877 public static function getAttribute($class, $fieldName = NULL) {
878 $object = new $class();
879 $fields = $object->fields();
880 if ($fieldName != NULL) {
881 $field = $fields[$fieldName] ??
NULL;
882 return self
::makeAttribute($field);
886 foreach ($fields as $name => $field) {
887 $attribute = self
::makeAttribute($field);
889 $attributes[$name] = $attribute;
893 if (!empty($attributes)) {
901 * Create or update a record from supplied params.
903 * If 'id' is supplied, an existing record will be updated
904 * Otherwise a new record will be created.
906 * @param array $record
909 * @throws \CRM_Core_Exception
911 public static function writeRecord(array $record): CRM_Core_DAO
{
912 $hook = empty($record['id']) ?
'create' : 'edit';
913 $className = CRM_Core_DAO_AllCoreTables
::getCanonicalClassName(static::class);
914 if ($className === 'CRM_Core_DAO') {
915 throw new CRM_Core_Exception('Function writeRecord must be called on a subclass of CRM_Core_DAO');
917 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName($className);
919 \CRM_Utils_Hook
::pre($hook, $entityName, $record['id'] ??
NULL, $record);
920 $instance = new $className();
921 $instance->copyValues($record);
923 \CRM_Utils_Hook
::post($hook, $entityName, $instance->id
, $instance);
929 * Bulk save multiple records
931 * @param array[] $records
933 * @throws CRM_Core_Exception
935 public static function writeRecords(array $records) {
937 foreach ($records as $record) {
938 $results[] = static::writeRecord($record);
944 * Delete a record from supplied params.
946 * @param array $record
949 * @throws CRM_Core_Exception
951 public static function deleteRecord(array $record) {
952 $className = CRM_Core_DAO_AllCoreTables
::getCanonicalClassName(static::class);
953 if ($className === 'CRM_Core_DAO') {
954 throw new CRM_Core_Exception('Function deleteRecord must be called on a subclass of CRM_Core_DAO');
956 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName($className);
957 if (empty($record['id'])) {
958 throw new CRM_Core_Exception("Cannot delete {$entityName} with no id.");
960 CRM_Utils_Type
::validate($record['id'], 'Positive');
962 CRM_Utils_Hook
::pre('delete', $entityName, $record['id'], $record);
963 $instance = new $className();
964 $instance->id
= $record['id'];
965 if (!$instance->delete()) {
966 throw new CRM_Core_Exception("Could not delete {$entityName} id {$record['id']}");
968 CRM_Utils_Hook
::post('delete', $entityName, $record['id'], $instance);
974 * Bulk delete multiple records.
976 * @param array[] $records
978 * @throws CRM_Core_Exception
980 public static function deleteRecords(array $records) {
982 foreach ($records as $record) {
983 $results[] = static::deleteRecord($record);
989 * Check if there is a record with the same name in the db.
991 * @param string $value
992 * The value of the field we are checking.
993 * @param string $daoName
994 * The dao object name.
995 * @param string $daoID
996 * The id of the object being updated. u can change your name.
997 * as long as there is no conflict
998 * @param string $fieldName
999 * The name of the field in the DAO.
1001 * @param string $domainID
1002 * The id of the domain. Object exists only for the given domain.
1005 * true if object exists
1007 public static function objectExists($value, $daoName, $daoID, $fieldName = 'name', $domainID = NULL) {
1008 $object = new $daoName();
1009 $object->$fieldName = $value;
1011 $object->domain_id
= $domainID;
1014 if ($object->find(TRUE)) {
1015 return $daoID && $object->id
== $daoID;
1023 * Check if there is a given column in a specific table.
1026 * @see CRM_Core_BAO_SchemaHandler::checkIfFieldExists
1028 * @param string $tableName
1029 * @param string $columnName
1030 * @param bool $i18nRewrite
1031 * Whether to rewrite the query on multilingual setups.
1034 * true if exists, else false
1036 public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
1037 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Core_BAO_SchemaHandler::checkIfFieldExists');
1038 return CRM_Core_BAO_SchemaHandler
::checkIfFieldExists($tableName, $columnName, $i18nRewrite);
1042 * Scans all the tables using a slow query and table name.
1046 public static function getTableNames() {
1047 $dao = CRM_Core_DAO
::executeQuery(
1049 FROM information_schema.TABLES
1050 WHERE TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
1051 AND TABLE_NAME LIKE 'civicrm_%'
1052 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
1053 AND TABLE_NAME NOT LIKE '%_temp%'
1056 while ($dao->fetch()) {
1057 $values[] = $dao->TABLE_NAME
;
1063 * @param int $maxTablesToCheck
1067 public static function isDBMyISAM($maxTablesToCheck = 10) {
1068 return CRM_Core_DAO
::singleValueQuery(
1070 FROM information_schema.TABLES
1071 WHERE ENGINE = 'MyISAM'
1072 AND TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
1073 AND TABLE_NAME LIKE 'civicrm_%'
1074 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
1075 AND TABLE_NAME NOT LIKE '%_temp%'
1076 AND TABLE_NAME NOT LIKE 'civicrm_tmp_%'
1081 * Get the name of the CiviCRM database.
1085 public static function getDatabaseName() {
1086 $daoObj = new CRM_Core_DAO();
1087 return $daoObj->database();
1091 * Checks if a constraint exists for a specified table.
1093 * @param string $tableName
1094 * @param string $constraint
1097 * true if constraint exists, false otherwise
1099 * @throws \CRM_Core_Exception
1101 public static function checkConstraintExists($tableName, $constraint) {
1104 if (!array_key_exists($tableName, $show)) {
1105 $query = "SHOW CREATE TABLE $tableName";
1106 $dao = CRM_Core_DAO
::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
1108 if (!$dao->fetch()) {
1109 throw new CRM_Core_Exception('query failed');
1112 $show[$tableName] = $dao->Create_Table
;
1115 return (bool) preg_match("/\b$constraint\b/i", $show[$tableName]);
1119 * Checks if CONSTRAINT keyword exists for a specified table.
1121 * @param array $tables
1123 * @throws CRM_Core_Exception
1126 * true if CONSTRAINT keyword exists, false otherwise
1128 public static function schemaRequiresRebuilding($tables = ["civicrm_contact"]) {
1130 foreach ($tables as $tableName) {
1131 if (!array_key_exists($tableName, $show)) {
1132 $query = "SHOW CREATE TABLE $tableName";
1133 $dao = CRM_Core_DAO
::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
1135 if (!$dao->fetch()) {
1136 throw new CRM_Core_Exception('Show create table failed.');
1139 $show[$tableName] = $dao->Create_Table
;
1142 $result = (bool) preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]);
1143 if ($result == TRUE) {
1154 * Checks if the FK constraint name is in the format 'FK_tableName_columnName'
1155 * for a specified column of a table.
1157 * @param string $tableName
1158 * @param string $columnName
1161 * true if in format, false otherwise
1163 * @throws \CRM_Core_Exception
1165 public static function checkFKConstraintInFormat($tableName, $columnName) {
1168 if (!array_key_exists($tableName, $show)) {
1169 $query = "SHOW CREATE TABLE $tableName";
1170 $dao = CRM_Core_DAO
::executeQuery($query);
1172 if (!$dao->fetch()) {
1173 throw new CRM_Core_Exception('query failed');
1176 $show[$tableName] = $dao->Create_Table
;
1178 $constraint = "`FK_{$tableName}_{$columnName}`";
1179 $pattern = "/\bCONSTRAINT\b\s+%s\s+\bFOREIGN\s+KEY\b\s/i";
1180 return (bool) preg_match(sprintf($pattern, $constraint), $show[$tableName]);
1184 * Check whether a specific column in a specific table has always the same value.
1186 * @param string $tableName
1187 * @param string $columnName
1188 * @param string $columnValue
1191 * true if the value is always $columnValue, false otherwise
1193 public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
1194 $query = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'";
1195 $dao = CRM_Core_DAO
::executeQuery($query);
1196 $result = $dao->fetch() ?
FALSE : TRUE;
1201 * Check whether a specific column in a specific table is always NULL.
1203 * @param string $tableName
1204 * @param string $columnName
1207 * true if if the value is always NULL, false otherwise
1209 public static function checkFieldIsAlwaysNull($tableName, $columnName) {
1210 $query = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL";
1211 $dao = CRM_Core_DAO
::executeQuery($query);
1212 $result = $dao->fetch() ?
FALSE : TRUE;
1217 * Checks if this DAO's table ought to exist.
1219 * If there are pending DB updates, this function compares the CiviCRM version of the table to the current schema version.
1222 * @throws CRM_Core_Exception
1224 public static function tableHasBeenAdded() {
1225 if (CRM_Utils_System
::version() === CRM_Core_BAO_Domain
::version()) {
1228 $daoExt = defined(static::class . '::EXT') ?
constant(static::class . '::EXT') : NULL;
1229 $daoVersion = defined(static::class . '::TABLE_ADDED') ?
constant(static::class . '::TABLE_ADDED') : '1.0';
1230 return !($daoExt === 'civicrm' && version_compare(CRM_Core_BAO_Domain
::version(), $daoVersion, '<'));
1234 * Check if there is a given table in the database.
1236 * @param string $tableName
1239 * true if exists, else false
1241 public static function checkTableExists($tableName) {
1246 $params = [1 => [$tableName, 'String']];
1248 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1249 return (bool) $dao->fetch();
1253 * Check if a given table has data.
1255 * @param string $tableName
1257 * TRUE if $tableName has at least one record.
1259 public static function checkTableHasData($tableName) {
1260 $c = CRM_Core_DAO
::singleValueQuery(sprintf('SELECT count(*) c FROM `%s`', $tableName));
1269 public function checkVersion($version) {
1270 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Core_BAO_Domain::version');
1271 $dbVersion = CRM_Core_BAO_Domain
::version();
1272 return trim($version) == trim($dbVersion);
1276 * Find a DAO object for the given ID and return it.
1279 * Id of the DAO object being searched for.
1281 * @return CRM_Core_DAO
1282 * Object of the type of the class that called this function.
1286 public static function findById($id) {
1287 $object = new static();
1289 if (!$object->find(TRUE)) {
1290 throw new Exception("Unable to find a " . get_called_class() . " with id {$id}.");
1296 * Returns all results as array-encoded records.
1300 public function fetchAll($k = FALSE, $v = FALSE, $method = FALSE) {
1302 while ($this->fetch()) {
1303 $result[] = $this->toArray();
1309 * Return the results as PHP generator.
1311 * @param string $type
1312 * Whether the generator yields 'dao' objects or 'array's.
1314 public function fetchGenerator($type = 'dao') {
1315 while ($this->fetch()) {
1322 yield
$this->toArray();
1326 throw new \
RuntimeException("Invalid record type ($type)");
1332 * Returns a singular value.
1334 * @return mixed|NULL
1336 public function fetchValue() {
1337 $result = $this->getDatabaseResult();
1338 $row = $result->fetchRow();
1348 * Get all the result records as mapping between columns.
1350 * @param string $keyColumn
1352 * @param string $valueColumn
1355 * Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]
1357 public function fetchMap($keyColumn, $valueColumn) {
1359 while ($this->fetch()) {
1360 $result[$this->{$keyColumn}] = $this->{$valueColumn};
1366 * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
1368 * @param string $daoName
1369 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1370 * @param int $searchValue
1371 * Value of the column you want to search by.
1372 * @param string $returnColumn
1373 * Name of the column you want to GET the value of.
1374 * @param string $searchColumn
1375 * Name of the column you want to search by.
1376 * @param bool $force
1377 * Skip use of the cache.
1379 * @return string|int|null
1380 * Value of $returnColumn in the retrieved record
1382 * @throws \CRM_Core_Exception
1384 public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
1386 empty($searchValue) ||
1387 trim(strtolower($searchValue)) == 'null'
1389 // adding this here since developers forget to check for an id
1390 // or for the 'null' (which is a bad DAO kludge)
1391 // and hence we get the first value in the db
1392 throw new CRM_Core_Exception('getFieldValue failed');
1395 self
::$_dbColumnValueCache = self
::$_dbColumnValueCache ??
[];
1397 while (strpos($daoName, '_BAO_') !== FALSE) {
1398 $daoName = get_parent_class($daoName);
1402 empty(self
::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue]) ||
1403 !array_key_exists($returnColumn, self
::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue])
1405 $object = new $daoName();
1406 $object->$searchColumn = $searchValue;
1407 $object->selectAdd();
1408 $object->selectAdd($returnColumn);
1411 if ($object->find(TRUE)) {
1412 $result = $object->$returnColumn;
1415 self
::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn] = $result;
1417 return self
::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn];
1421 * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
1423 * @param string $daoName
1424 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1425 * @param int $searchValue
1426 * Value of the column you want to search by.
1427 * @param string $setColumn
1428 * Name of the column you want to SET the value of.
1429 * @param string $setValue
1430 * SET the setColumn to this value.
1431 * @param string $searchColumn
1432 * Name of the column you want to search by.
1435 * true if we found and updated the object, else false
1437 public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
1438 $object = new $daoName();
1439 $object->selectAdd();
1440 $object->selectAdd("$searchColumn, $setColumn");
1441 $object->$searchColumn = $searchValue;
1443 if ($object->find(TRUE)) {
1444 $object->$setColumn = $setValue;
1445 if ($object->save()) {
1456 * @param array|object $sort either array or CRM_Utils_Sort
1457 * @param string $default
1458 * Default sort value.
1462 public static function getSortString($sort, $default = NULL) {
1463 // check if sort is of type CRM_Utils_Sort
1464 if (is_a($sort, 'CRM_Utils_Sort')) {
1465 return $sort->orderBy();
1470 // is it an array specified as $field => $sortDirection ?
1472 foreach ($sort as $k => $v) {
1473 $sortString .= "$k $v,";
1475 return rtrim($sortString, ',');
1481 * Fetch object based on array of properties.
1483 * @param string $daoName
1484 * Name of the dao object.
1485 * @param array $params
1486 * (reference ) an assoc array of name/value pairs.
1487 * @param array $defaults
1488 * (reference ) an assoc array to hold the flattened values.
1489 * @param array $returnProperities
1490 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1493 * an object of type referenced by daoName
1495 public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
1496 $object = new $daoName();
1497 $object->copyValues($params);
1499 // return only specific fields if returnproperties are sent
1500 if (!empty($returnProperities)) {
1501 $object->selectAdd();
1502 $object->selectAdd(implode(',', $returnProperities));
1505 if ($object->find(TRUE)) {
1506 self
::storeValues($object, $defaults);
1513 * Delete the object records that are associated with this contact.
1515 * @param string $daoName
1516 * Name of the dao object.
1517 * @param int $contactId
1518 * Id of the contact to delete.
1520 public static function deleteEntityContact($daoName, $contactId) {
1521 $object = new $daoName();
1523 $object->entity_table
= 'civicrm_contact';
1524 $object->entity_id
= $contactId;
1529 * Execute an unbuffered query.
1531 * This is a wrapper around new functionality exposed with CRM-17748.
1533 * @param string $query query to be executed
1535 * @param array $params
1536 * @param bool $abort
1537 * @param null $daoName
1538 * @param bool $freeDAO
1539 * @param bool $i18nRewrite
1540 * @param bool $trapException
1542 * @return CRM_Core_DAO
1543 * Object that points to an unbuffered result set
1545 public static function executeUnbufferedQuery(
1551 $i18nRewrite = TRUE,
1552 $trapException = FALSE
1555 return self
::executeQuery(
1563 ['result_buffering' => 0]
1570 * @param string $query
1571 * Query to be executed.
1573 * @param array $params
1574 * @param bool $abort
1575 * @param null $daoName
1576 * @param bool $freeDAO
1577 * @param bool $i18nRewrite
1578 * @param bool $trapException
1579 * @param array $options
1581 * @return CRM_Core_DAO|object
1582 * object that holds the results of the query
1583 * NB - if this is defined as just returning a DAO phpstorm keeps pointing
1584 * out all the properties that are not part of the DAO
1586 public static function &executeQuery(
1592 $i18nRewrite = TRUE,
1593 $trapException = FALSE,
1596 $queryStr = self
::composeQuery($query, $params, $abort);
1599 $dao = new CRM_Core_DAO();
1602 $dao = new $daoName();
1605 if ($trapException) {
1606 CRM_Core_Error
::deprecatedFunctionWarning('calling functions should handle exceptions');
1607 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
1610 if ($dao->isValidOption($options)) {
1611 $dao->setOptions($options);
1614 $result = $dao->query($queryStr, $i18nRewrite);
1616 // since it is unbuffered, ($dao->N==0) is true. This blocks the standard fetch() mechanism.
1617 if (CRM_Utils_Array
::value('result_buffering', $options) === 0) {
1621 if (is_a($result, 'DB_Error')) {
1622 CRM_Core_Error
::deprecatedFunctionWarning('calling functions should handle exceptions');
1630 * Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
1632 * @param array $options
1635 * Provided options are valid
1637 public function isValidOption($options) {
1646 if (empty($options)) {
1650 foreach (array_keys($options) as $option) {
1651 if (!in_array($option, $validOptions)) {
1661 * Execute a query and get the single result.
1663 * @param string $query
1664 * Query to be executed.
1665 * @param array $params
1666 * @param bool $abort
1667 * @param bool $i18nRewrite
1668 * @return string|null
1669 * the result of the query if any
1672 public static function &singleValueQuery(
1678 $queryStr = self
::composeQuery($query, $params, $abort);
1680 static $_dao = NULL;
1683 $_dao = new CRM_Core_DAO();
1686 $_dao->query($queryStr, $i18nRewrite);
1688 $result = $_dao->getDatabaseResult();
1691 $row = $result->fetchRow();
1701 * Compose the query by merging the parameters into it.
1703 * @param string $query
1704 * @param array $params
1705 * @param bool $abort
1708 * @throws CRM_Core_Exception
1710 public static function composeQuery($query, $params = [], $abort = TRUE) {
1712 foreach ($params as $key => $item) {
1713 if (is_numeric($key)) {
1714 if (CRM_Utils_Type
::validate($item[0], $item[1]) !== NULL) {
1715 $item[0] = self
::escapeString($item[0]);
1716 if ($item[1] == 'String' ||
1717 $item[1] == 'Memo' ||
1720 // Support class constants stipulating wildcard characters and/or
1721 // non-quoting of strings. Also support legacy code which may be
1722 // passing in TRUE or 1 for $item[2], which used to indicate the
1723 // use of wildcard characters.
1724 if (!empty($item[2])) {
1725 if ($item[2] & CRM_Core_DAO
::QUERY_FORMAT_WILDCARD ||
$item[2] === TRUE) {
1726 $item[0] = "'%{$item[0]}%'";
1728 elseif (!($item[2] & CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
)) {
1729 $item[0] = "'{$item[0]}'";
1733 $item[0] = "'{$item[0]}'";
1737 if (($item[1] == 'Date' ||
$item[1] == 'Timestamp') &&
1738 strlen($item[0]) == 0
1743 $tr['%' . $key] = $item[0];
1746 throw new CRM_Core_Exception("{$item[0]} is not of type {$item[1]}");
1751 return strtr($query, $tr);
1757 public static function freeResult($ids = NULL) {
1758 global $_DB_DATAOBJECT;
1761 if (!$_DB_DATAOBJECT ||
1762 !isset($_DB_DATAOBJECT['RESULTS'])
1766 $ids = array_keys($_DB_DATAOBJECT['RESULTS']);
1769 foreach ($ids as $id) {
1770 if (isset($_DB_DATAOBJECT['RESULTS'][$id])) {
1771 $_DB_DATAOBJECT['RESULTS'][$id]->free();
1772 unset($_DB_DATAOBJECT['RESULTS'][$id]);
1775 if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$id])) {
1776 unset($_DB_DATAOBJECT['RESULTFIELDS'][$id]);
1782 * Make a shallow copy of an object and all the fields in the object.
1784 * @param string $daoName
1786 * @param array $criteria
1787 * Array of all the fields & values.
1788 * on which basis to copy
1789 * @param array $newData
1790 * Array of all the fields & values.
1791 * to be copied besides the other fields
1792 * @param string $fieldsFix
1793 * Array of fields that you want to prefix/suffix/replace.
1794 * @param string $blockCopyOfDependencies
1795 * Fields that you want to block from.
1797 * @param bool $blockCopyofCustomValues
1798 * Case when you don't want to copy the custom values set in a
1799 * template as it will override/ignore the submitted custom values
1801 * @return CRM_Core_DAO|bool
1802 * the newly created copy of the object. False if none created.
1804 public static function copyGeneric($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL, $blockCopyofCustomValues = FALSE) {
1805 $object = new $daoName();
1808 $object->id
= $criteria['id'];
1811 foreach ($criteria as $key => $value) {
1812 $object->$key = $value;
1817 while ($object->fetch()) {
1819 // all the objects except with $blockCopyOfDependencies set
1820 // be copied - addresses #CRM-1962
1822 if ($blockCopyOfDependencies && $object->$blockCopyOfDependencies) {
1826 $newObject = new $daoName();
1828 $fields = $object->fields();
1829 $fieldsToPrefix = [];
1830 $fieldsToSuffix = [];
1831 $fieldsToReplace = [];
1832 if (!empty($fieldsFix['prefix'])) {
1833 $fieldsToPrefix = $fieldsFix['prefix'];
1835 if (!empty($fieldsFix['suffix'])) {
1836 $fieldsToSuffix = $fieldsFix['suffix'];
1838 if (!empty($fieldsFix['replace'])) {
1839 $fieldsToReplace = $fieldsFix['replace'];
1842 $localizableFields = FALSE;
1843 foreach ($fields as $name => $value) {
1844 if ($name == 'id' ||
$value['name'] == 'id') {
1845 // copy everything but the id!
1849 $dbName = $value['name'];
1850 $type = CRM_Utils_Type
::typeToString($value['type']);
1851 $newObject->$dbName = $object->$dbName;
1852 if (isset($fieldsToPrefix[$dbName])) {
1853 $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1855 if (isset($fieldsToSuffix[$dbName])) {
1856 $newObject->$dbName .= $fieldsToSuffix[$dbName];
1858 if (isset($fieldsToReplace[$dbName])) {
1859 $newObject->$dbName = $fieldsToReplace[$dbName];
1862 if ($type == 'Timestamp' ||
$type == 'Date') {
1863 $newObject->$dbName = CRM_Utils_Date
::isoToMysql($newObject->$dbName);
1866 if (!empty($value['localizable'])) {
1867 $localizableFields = TRUE;
1871 $newObject->copyValues($newData);
1876 // ensure we copy all localized fields as well
1877 if (CRM_Core_I18n
::isMultilingual() && $localizableFields) {
1879 $locales = CRM_Core_I18n
::getMultilingual();
1880 $curLocale = CRM_Core_I18n
::getLocale();
1881 // loop on other locales
1882 foreach ($locales as $locale) {
1883 if ($locale != $curLocale) {
1884 // setLocale doesn't seems to be reliable to set dbLocale and we only need to change the db locale
1885 $dbLocale = '_' . $locale;
1886 $newObject->copyLocalizable($object->id
, $newObject->id
, $fieldsToPrefix, $fieldsToSuffix, $fieldsToReplace);
1889 // restore dbLocale to starting value
1890 $dbLocale = '_' . $curLocale;
1893 if (!$blockCopyofCustomValues) {
1894 $newObject->copyCustomFields($object->id
, $newObject->id
);
1896 CRM_Utils_Hook
::post('create', CRM_Core_DAO_AllCoreTables
::getBriefName($daoName), $newObject->id
, $newObject);
1903 * Method that copies localizable fields from an old entity to a new one.
1905 * Fixes bug dev/core#2479,
1906 * where non current locale fields are copied from current locale losing translation when copying
1908 * @param int $entityID
1909 * @param int $newEntityID
1910 * @param array $fieldsToPrefix
1911 * @param array $fieldsToSuffix
1912 * @param array $fieldsToReplace
1914 protected function copyLocalizable($entityID, $newEntityID, $fieldsToPrefix, $fieldsToSuffix, $fieldsToReplace) {
1915 $entity = get_class($this);
1916 $object = new $entity();
1917 $object->id
= $entityID;
1920 $newObject = new $entity();
1921 $newObject->id
= $newEntityID;
1925 if ($object->fetch() && $newObject->fetch()) {
1927 $fields = $object->fields();
1928 foreach ($fields as $name => $value) {
1930 if ($name == 'id' ||
$value['name'] == 'id') {
1931 // copy everything but the id!
1935 // only copy localizable fields
1936 if (!$value['localizable']) {
1940 $dbName = $value['name'];
1941 $type = CRM_Utils_Type
::typeToString($value['type']);
1942 $newObject->$dbName = $object->$dbName;
1943 if (isset($fieldsToPrefix[$dbName])) {
1944 $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1946 if (isset($fieldsToSuffix[$dbName])) {
1947 $newObject->$dbName .= $fieldsToSuffix[$dbName];
1949 if (isset($fieldsToReplace[$dbName])) {
1950 $newObject->$dbName = $fieldsToReplace[$dbName];
1953 if ($type == 'Timestamp' ||
$type == 'Date') {
1954 $newObject->$dbName = CRM_Utils_Date
::isoToMysql($newObject->$dbName);
1964 * Method that copies custom fields values from an old entity to a new one.
1966 * Fixes bug CRM-19302,
1967 * where if a custom field of File type was present, left both events using the same file,
1968 * breaking download URL's for the old event.
1970 * @todo the goal here is to clean this up so that it works for any entity. Copy Generic already DOES some custom field stuff
1971 * but it seems to be bypassed & perhaps less good than this (or this just duplicates it...)
1973 * @param int $entityID
1974 * @param int $newEntityID
1975 * @param string $parentOperation
1977 public function copyCustomFields($entityID, $newEntityID, $parentOperation = NULL) {
1978 $entity = CRM_Core_DAO_AllCoreTables
::getBriefName(get_class($this));
1979 $tableName = CRM_Core_DAO_AllCoreTables
::getTableForClass(get_class($this));
1980 // Obtain custom values for the old entity.
1981 $customParams = $htmlType = [];
1982 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($entityID, $entity);
1984 // If custom values present, we copy them
1985 if (!empty($customValues)) {
1986 // Get Field ID's and identify File type attributes, to handle file copying.
1987 $fieldIds = implode(', ', array_keys($customValues));
1988 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
1989 $result = CRM_Core_DAO
::executeQuery($sql);
1991 // Build array of File type fields
1992 while ($result->fetch()) {
1993 $htmlType[] = $result->id
;
1996 // Build params array of custom values
1997 foreach ($customValues as $field => $value) {
1998 if ($value !== NULL) {
1999 // Handle File type attributes
2000 if (in_array($field, $htmlType)) {
2001 $fileValues = CRM_Core_BAO_File
::path($value, $entityID);
2002 $customParams["custom_{$field}_-1"] = [
2003 'name' => CRM_Utils_File
::duplicate($fileValues[0]),
2004 'type' => $fileValues[1],
2007 // Handle other types
2009 $customParams["custom_{$field}_-1"] = $value;
2014 // Save Custom Fields for new Entity.
2015 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, $tableName, $newEntityID, $entity, $parentOperation ??
'create');
2018 // copy activity attachments ( if any )
2019 CRM_Core_BAO_File
::copyEntityFile($tableName, $entityID, $tableName, $newEntityID);
2023 * Cascade update through related entities.
2025 * @param string $daoName
2028 * @param array $newData
2030 * @return CRM_Core_DAO|null
2032 public static function cascadeUpdate($daoName, $fromId, $toId, $newData = []) {
2033 $object = new $daoName();
2034 $object->id
= $fromId;
2036 if ($object->find(TRUE)) {
2037 $newObject = new $daoName();
2038 $newObject->id
= $toId;
2040 if ($newObject->find(TRUE)) {
2041 $fields = $object->fields();
2042 foreach ($fields as $name => $value) {
2043 if ($name == 'id' ||
$value['name'] == 'id') {
2044 // copy everything but the id!
2048 $colName = $value['name'];
2049 $newObject->$colName = $object->$colName;
2051 if (substr($name, -5) == '_date' ||
2052 substr($name, -10) == '_date_time'
2054 $newObject->$colName = CRM_Utils_Date
::isoToMysql($newObject->$colName);
2057 foreach ($newData as $k => $v) {
2058 $newObject->$k = $v;
2068 * Given the component id, compute the contact id
2069 * since its used for things like send email
2071 * @param $componentIDs
2072 * @param string $tableName
2073 * @param string $idField
2077 public static function getContactIDsFromComponent($componentIDs, $tableName, $idField = 'id') {
2080 if (empty($componentIDs)) {
2084 $IDs = implode(',', $componentIDs);
2088 WHERE $idField IN ( $IDs )
2091 $dao = CRM_Core_DAO
::executeQuery($query);
2092 while ($dao->fetch()) {
2093 $contactIDs[] = $dao->contact_id
;
2099 * Fetch object based on array of properties.
2101 * @param string $daoName
2102 * Name of the dao object.
2103 * @param string $fieldIdName
2104 * @param int $fieldId
2106 * @param array $returnProperities
2107 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
2110 * an object of type referenced by daoName
2112 public static function commonRetrieveAll($daoName, $fieldIdName, $fieldId, &$details, $returnProperities = NULL) {
2113 require_once str_replace('_', DIRECTORY_SEPARATOR
, $daoName) . ".php";
2114 $object = new $daoName();
2115 $object->$fieldIdName = $fieldId;
2117 // return only specific fields if returnproperties are sent
2118 if (!empty($returnProperities)) {
2119 $object->selectAdd();
2120 $object->selectAdd('id');
2121 $object->selectAdd(implode(',', $returnProperities));
2125 while ($object->fetch()) {
2127 self
::storeValues($object, $defaults);
2128 $details[$object->id
] = $defaults;
2135 * Drop all CiviCRM tables.
2137 * @throws \CRM_Core_Exception
2139 public static function dropAllTables() {
2141 // first drop all the custom tables we've created
2142 CRM_Core_BAO_CustomGroup
::dropAllTables();
2144 // drop all multilingual views
2145 CRM_Core_I18n_Schema
::dropAllViews();
2147 CRM_Utils_File
::sourceSQLFile(CIVICRM_DSN
,
2148 dirname(__FILE__
) . DIRECTORY_SEPARATOR
.
2149 '..' . DIRECTORY_SEPARATOR
.
2150 '..' . DIRECTORY_SEPARATOR
.
2151 'sql' . DIRECTORY_SEPARATOR
.
2152 'civicrm_drop.mysql'
2161 public static function escapeString($string) {
2162 static $_dao = NULL;
2164 // If this is an atypical case (e.g. preparing .sql file before CiviCRM
2165 // has been installed), then we fallback DB-less str_replace escaping, as
2166 // we can't use mysqli_real_escape_string, as there is no DB connection.
2167 // Note: In typical usage, escapeString() will only check one conditional
2168 // ("if !$_dao") rather than two conditionals ("if !defined(DSN)")
2169 if (!defined('CIVICRM_DSN')) {
2170 // See http://php.net/manual/en/mysqli.real-escape-string.php for the
2171 // list of characters mysqli_real_escape_string escapes.
2172 $search = ["\\", "\x00", "\n", "\r", "'", '"', "\x1a"];
2173 $replace = ["\\\\", "\\0", "\\n", "\\r", "\'", '\"', "\\Z"];
2174 return str_replace($search, $replace, $string);
2176 $_dao = new CRM_Core_DAO();
2178 return $_dao->escape($string);
2182 * Escape a list of strings for use with "WHERE X IN (...)" queries.
2184 * @param array $strings
2185 * @param string $default
2186 * the value to use if $strings has no elements.
2188 * eg "abc","def","ghi"
2190 public static function escapeStrings($strings, $default = NULL) {
2191 static $_dao = NULL;
2193 $_dao = new CRM_Core_DAO();
2196 if (empty($strings)) {
2200 $escapes = array_map([$_dao, 'escape'], $strings);
2201 return '"' . implode('","', $escapes) . '"';
2209 public static function escapeWildCardString($string) {
2211 // ensure we escape the single characters % and _ which are mysql wild
2212 // card characters and could come in via sortByCharacter
2213 // note that mysql does not escape these characters
2214 if ($string && in_array($string,
2215 ['%', '_', '%%', '_%']
2218 return '\\' . $string;
2221 return self
::escapeString($string);
2225 * Creates a test object, including any required objects it needs via recursion
2226 * createOnly: only create in database, do not store or return the objects (useful for perf testing)
2227 * ONLY USE FOR TESTING
2229 * @param string $daoName
2230 * @param array $params
2231 * @param int $numObjects
2232 * @param bool $createOnly
2234 * @return object|array|NULL
2235 * NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.
2237 public static function createTestObject(
2243 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
2244 // so we re-set here in case
2245 $config = CRM_Core_Config
::singleton();
2246 $config->backtrace
= TRUE;
2248 static $counter = 0;
2249 CRM_Core_DAO
::$_testEntitiesToSkip = [
2250 'CRM_Core_DAO_Worldregion',
2251 'CRM_Core_DAO_StateProvince',
2252 'CRM_Core_DAO_Country',
2253 'CRM_Core_DAO_Domain',
2254 'CRM_Financial_DAO_FinancialType',
2255 //because valid ones exist & we use pick them due to pseudoconstant can't reliably create & delete these
2258 // Prefer to instantiate BAO's instead of DAO's (when possible)
2259 // so that assignTestValue()/assignTestFK() can be overloaded.
2260 $baoName = str_replace('_DAO_', '_BAO_', $daoName);
2261 if ($baoName === 'CRM_Financial_BAO_FinancialTrxn') {
2262 // OMG OMG OMG this is so incredibly bad. The BAO is insanely named.
2263 // @todo create a new class called what the BAO SHOULD be
2264 // that extends BAO-crazy-name.... migrate.
2265 $baoName = 'CRM_Core_BAO_FinancialTrxn';
2267 if (class_exists($baoName)) {
2268 $daoName = $baoName;
2271 for ($i = 0; $i < $numObjects; ++
$i) {
2274 /** @var CRM_Core_DAO $object */
2275 $object = new $daoName();
2277 $fields = $object->fields();
2278 foreach ($fields as $fieldName => $fieldDef) {
2279 $dbName = $fieldDef['name'];
2280 $FKClassName = $fieldDef['FKClassName'] ??
NULL;
2282 if (isset($params[$dbName]) && !is_array($params[$dbName])) {
2283 $object->$dbName = $params[$dbName];
2286 elseif ($dbName != 'id') {
2287 if ($FKClassName != NULL) {
2288 $object->assignTestFK($fieldName, $fieldDef, $params);
2292 $object->assignTestValue($fieldName, $fieldDef, $counter);
2300 $objects[$i] = $object;
2310 elseif ($numObjects == 1) {
2319 * Deletes the this object plus any dependent objects that are associated with it.
2320 * ONLY USE FOR TESTING
2322 * @param string $daoName
2323 * @param array $params
2325 public static function deleteTestObjects($daoName, $params = []) {
2326 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
2327 // so we re-set here in case
2328 $config = CRM_Core_Config
::singleton();
2329 $config->backtrace
= TRUE;
2331 $object = new $daoName();
2332 $object->id
= $params['id'] ??
NULL;
2334 // array(array(0 => $daoName, 1 => $daoParams))
2336 if ($object->find(TRUE)) {
2338 $fields = $object->fields();
2339 foreach ($fields as $name => $value) {
2341 $dbName = $value['name'];
2343 $FKClassName = $value['FKClassName'] ??
NULL;
2344 $required = $value['required'] ??
NULL;
2345 if ($FKClassName != NULL
2347 && !in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)
2348 && ($required ||
$dbName == 'contact_id')
2349 //I'm a bit stuck on this one - we might need to change the singleValueAlter so that the entities don't share a contact
2350 // to make this test process pass - line below makes pass for now
2351 && $dbName != 'member_of_contact_id'
2354 $deletions[] = [$FKClassName, ['id' => $object->$dbName]];
2361 foreach ($deletions as $deletion) {
2362 CRM_Core_DAO
::deleteTestObjects($deletion[0], $deletion[1]);
2367 * Set defaults when creating new entity.
2368 * (don't call this set defaults as already in use with different signature in some places)
2370 * @param array $params
2373 public static function setCreateDefaults(&$params, $defaults) {
2374 if (!empty($params['id'])) {
2377 foreach ($defaults as $key => $value) {
2378 if (!array_key_exists($key, $params) ||
$params[$key] === NULL) {
2379 $params[$key] = $value;
2385 * @param string $prefix
2386 * @param bool $addRandomString
2387 * @param null $string
2391 * @see CRM_Utils_SQL_TempTable
2393 public static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
2394 CRM_Core_Error
::deprecatedFunctionWarning('Use CRM_Utils_SQL_TempTable interface to create temporary tables');
2395 $tableName = $prefix . "_temp";
2397 if ($addRandomString) {
2399 $tableName .= "_" . $string;
2402 $tableName .= "_" . md5(uniqid('', TRUE));
2410 * @param bool $trigger
2414 public static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
2415 if (\Civi
::settings()->get('logging_no_trigger_permission')) {
2418 // test for create view and trigger permissions and if allowed, add the option to go multilingual and logging
2419 $dao = new CRM_Core_DAO();
2422 $dao->query('CREATE OR REPLACE VIEW civicrm_domain_view AS SELECT * FROM civicrm_domain');
2423 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2427 $dao->query('CREATE TRIGGER civicrm_domain_trigger BEFORE INSERT ON civicrm_domain FOR EACH ROW BEGIN END');
2428 $dao->query('DROP TRIGGER IF EXISTS civicrm_domain_trigger');
2431 catch (Exception
$e) {
2439 * @param null $message
2440 * @param bool $printDAO
2442 public static function debugPrint($message = NULL, $printDAO = TRUE) {
2443 CRM_Utils_System
::xMemory("{$message}: ");
2446 global $_DB_DATAOBJECT;
2448 foreach (array_keys($_DB_DATAOBJECT['RESULTS']) as $id) {
2449 $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query
;
2451 CRM_Core_Error
::debug('_DB_DATAOBJECT', $q);
2456 * Build a list of triggers via hook and add them to (err, reconcile them
2457 * with) the database.
2459 * @param string $tableName
2460 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2461 * @param bool $force
2466 public static function triggerRebuild($tableName = NULL, $force = FALSE) {
2467 Civi
::service('sql_triggers')->rebuild($tableName, $force);
2471 * Wrapper function to drop triggers.
2473 * @param string $tableName
2474 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2477 public static function dropTriggers($tableName = NULL) {
2478 Civi
::service('sql_triggers')->dropTriggers($tableName);
2482 * @param array $info
2483 * per hook_civicrm_triggerInfo.
2484 * @param string $onlyTableName
2485 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2488 public static function createTriggers(&$info, $onlyTableName = NULL) {
2489 Civi
::service('sql_triggers')->createTriggers($info, $onlyTableName);
2493 * Given a list of fields, create a list of references.
2495 * @param string $className
2496 * BAO/DAO class name.
2497 * @return array<CRM_Core_Reference_Interface>
2499 public static function createReferenceColumns($className) {
2501 $fields = $className::fields();
2502 foreach ($fields as $field) {
2503 if (isset($field['pseudoconstant'], $field['pseudoconstant']['optionGroupName'])) {
2504 $result[] = new CRM_Core_Reference_OptionValue(
2505 $className::getTableName(),
2507 'civicrm_option_value',
2508 CRM_Utils_Array
::value('keyColumn', $field['pseudoconstant'], 'value'),
2509 $field['pseudoconstant']['optionGroupName']
2517 * Find all records which refer to this entity.
2520 * Array of objects referencing this
2522 public function findReferences() {
2523 $links = self
::getReferencesToTable(static::getTableName());
2526 foreach ($links as $refSpec) {
2527 /** @var $refSpec CRM_Core_Reference_Interface */
2528 $daoName = CRM_Core_DAO_AllCoreTables
::getClassForTable($refSpec->getReferenceTable());
2529 $result = $refSpec->findReferences($this);
2531 while ($result->fetch()) {
2532 $obj = new $daoName();
2533 $obj->id
= $result->id
;
2534 $occurrences[] = $obj;
2539 return $occurrences;
2544 * each item has keys:
2548 * - table: string|null SQL table name
2549 * - key: string|null SQL column name
2551 public function getReferenceCounts() {
2552 $links = self
::getReferencesToTable(static::getTableName());
2555 foreach ($links as $refSpec) {
2556 /** @var $refSpec CRM_Core_Reference_Interface */
2557 $count = $refSpec->getReferenceCount($this);
2558 if ($count['count'] != 0) {
2563 foreach (CRM_Core_Component
::getEnabledComponents() as $component) {
2564 /** @var $component CRM_Core_Component_Info */
2565 $counts = array_merge($counts, $component->getReferenceCounts($this));
2567 CRM_Utils_Hook
::referenceCounts($this, $counts);
2573 * List all tables which have hard foreign keys to this table.
2575 * For now, this returns a description of every entity_id/entity_table
2577 * TODO: filter dynamic entity references on the $tableName, based on
2578 * schema metadata in dynamicForeignKey which enumerates a restricted
2579 * set of possible entity_table's.
2581 * @param string $tableName
2582 * Table referred to.
2584 * @return CRM_Core_Reference_Interface[]
2585 * structure of table and column, listing every table with a
2586 * foreign key reference to $tableName, and the column where the key appears.
2588 public static function getReferencesToTable($tableName) {
2590 foreach (CRM_Core_DAO_AllCoreTables
::getClasses() as $daoClassName) {
2591 $links = $daoClassName::getReferenceColumns();
2593 foreach ($links as $refSpec) {
2594 /** @var $refSpec CRM_Core_Reference_Interface */
2595 if ($refSpec->matchesTargetTable($tableName)) {
2596 $refsFound[] = $refSpec;
2604 * Get all references to contact table.
2606 * This includes core tables, custom group tables, tables added by the merge
2607 * hook and the entity_tag table.
2609 * Refer to CRM-17454 for information on the danger of querying the information
2610 * schema to derive this.
2612 * @throws \CiviCRM_API3_Exception
2614 public static function getReferencesToContactTable() {
2615 if (isset(\Civi
::$statics[__CLASS__
]) && isset(\Civi
::$statics[__CLASS__
]['contact_references'])) {
2616 return \Civi
::$statics[__CLASS__
]['contact_references'];
2618 $contactReferences = [];
2619 $coreReferences = CRM_Core_DAO
::getReferencesToTable('civicrm_contact');
2620 foreach ($coreReferences as $coreReference) {
2622 // Exclude option values
2623 !is_a($coreReference, 'CRM_Core_Reference_Dynamic') &&
2624 // Exclude references to other columns
2625 $coreReference->getTargetKey() === 'id'
2627 $contactReferences[$coreReference->getReferenceTable()][] = $coreReference->getReferenceKey();
2630 self
::appendCustomTablesExtendingContacts($contactReferences);
2631 self
::appendCustomContactReferenceFields($contactReferences);
2632 \Civi
::$statics[__CLASS__
]['contact_references'] = $contactReferences;
2633 return \Civi
::$statics[__CLASS__
]['contact_references'];
2637 * Get all dynamic references to the given table.
2639 * @param string $tableName
2643 public static function getDynamicReferencesToTable($tableName) {
2644 if (!isset(\Civi
::$statics[__CLASS__
]['contact_references_dynamic'][$tableName])) {
2645 \Civi
::$statics[__CLASS__
]['contact_references_dynamic'][$tableName] = [];
2646 $coreReferences = CRM_Core_DAO
::getReferencesToTable($tableName);
2647 foreach ($coreReferences as $coreReference) {
2648 if ($coreReference instanceof \CRM_Core_Reference_Dynamic
) {
2649 \Civi
::$statics[__CLASS__
]['contact_references_dynamic'][$tableName][$coreReference->getReferenceTable()][] = [$coreReference->getReferenceKey(), $coreReference->getTypeColumn()];
2653 return \Civi
::$statics[__CLASS__
]['contact_references_dynamic'][$tableName];
2657 * Add custom tables that extend contacts to the list of contact references.
2659 * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish
2660 * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples
2661 * - the down side is it is not cached.
2663 * Further changes should be include tests in the CRM_Core_MergerTest class
2664 * to ensure that disabled, subtype, multiple etc groups are still captured.
2666 * @param array $cidRefs
2668 public static function appendCustomTablesExtendingContacts(&$cidRefs) {
2669 $customValueTables = CRM_Core_BAO_CustomGroup
::getAllCustomGroupsByBaseEntity('Contact');
2670 $customValueTables->find();
2671 while ($customValueTables->fetch()) {
2672 $cidRefs[$customValueTables->table_name
][] = 'entity_id';
2677 * Add custom ContactReference fields to the list of contact references
2679 * This includes active and inactive fields/groups
2681 * @param array $cidRefs
2683 * @throws \CiviCRM_API3_Exception
2685 public static function appendCustomContactReferenceFields(&$cidRefs) {
2686 $fields = civicrm_api3('CustomField', 'get', [
2687 'return' => ['column_name', 'custom_group_id.table_name'],
2688 'data_type' => 'ContactReference',
2689 'options' => ['limit' => 0],
2691 foreach ($fields as $field) {
2692 $cidRefs[$field['custom_group_id.table_name']][] = $field['column_name'];
2697 * Lookup the value of a MySQL global configuration variable.
2699 * @param string $name
2700 * E.g. "thread_stack".
2701 * @param mixed $default
2704 public static function getGlobalSetting($name, $default = NULL) {
2705 // Alternatively, SELECT @@GLOBAL.thread_stack, but
2706 // that has been reported to fail under MySQL 5.0 for OS X
2707 $escapedName = self
::escapeString($name);
2708 $dao = CRM_Core_DAO
::executeQuery("SHOW VARIABLES LIKE '$escapedName'");
2709 if ($dao->fetch()) {
2718 * Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
2720 * This is relevant where we want to offer both the ID field and the label field
2721 * as an option, e.g. search builder.
2723 * It is currently limited for optionGroupName & id+ name+ FK combos for purposes keeping the scope of the
2724 * change small, but is appropriate for other sorts of pseudoconstants.
2726 * @param array $fields
2728 public static function appendPseudoConstantsToFields(&$fields) {
2729 foreach ($fields as $fieldUniqueName => $field) {
2730 if (!empty($field['pseudoconstant'])) {
2731 $pseudoConstant = $field['pseudoconstant'];
2732 if (!empty($pseudoConstant['optionGroupName'])) {
2733 $fields[$pseudoConstant['optionGroupName']] = [
2734 'title' => CRM_Core_BAO_OptionGroup
::getTitleByName($pseudoConstant['optionGroupName']),
2735 'name' => $pseudoConstant['optionGroupName'],
2736 'data_type' => CRM_Utils_Type
::T_STRING
,
2737 'is_pseudofield_for' => $fieldUniqueName,
2740 // We restrict to id + name + FK as we are extending this a bit, but cautiously.
2742 !empty($field['FKClassName'])
2743 && CRM_Utils_Array
::value('keyColumn', $pseudoConstant) === 'id'
2744 && CRM_Utils_Array
::value('labelColumn', $pseudoConstant) === 'name'
2746 $pseudoFieldName = str_replace('_' . $pseudoConstant['keyColumn'], '', $field['name']);
2747 // This if is just an extra caution when adding change.
2748 if (!isset($fields[$pseudoFieldName])) {
2749 $daoName = $field['FKClassName'];
2750 $fkFields = $daoName::fields();
2751 foreach ($fkFields as $fkField) {
2752 if ($fkField['name'] === $pseudoConstant['labelColumn']) {
2753 $fields[$pseudoFieldName] = [
2754 'name' => $pseudoFieldName,
2755 'is_pseudofield_for' => $field['name'],
2756 'title' => $fkField['title'],
2757 'data_type' => $fkField['type'],
2758 'where' => $field['where'],
2769 * Get options for the called BAO object's field.
2771 * This function can be overridden by each BAO to add more logic related to context.
2772 * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
2774 * @param string $fieldName
2775 * @param string $context
2776 * @see CRM_Core_DAO::buildOptionsContext
2777 * @param array $props
2778 * Raw field values; whatever is known about this bao object.
2780 * Note: $props can contain unsanitized input and should not be passed directly to CRM_Core_PseudoConstant::get
2782 * @return array|bool
2784 public static function buildOptions($fieldName, $context = NULL, $props = []) {
2785 // If a given bao does not override this function
2786 $baoName = get_called_class();
2787 return CRM_Core_PseudoConstant
::get($baoName, $fieldName, [], $context);
2791 * Populate option labels for this object's fields.
2793 * @throws exception if called directly on the base class
2795 public function getOptionLabels() {
2796 $fields = $this->fields();
2797 if ($fields === NULL) {
2798 throw new Exception('Cannot call getOptionLabels on CRM_Core_DAO');
2800 foreach ($fields as $field) {
2801 $name = $field['name'] ??
NULL;
2802 if ($name && isset($this->$name)) {
2803 $label = CRM_Core_PseudoConstant
::getLabel(get_class($this), $name, $this->$name);
2804 if ($label !== FALSE) {
2805 // Append 'label' onto the field name
2806 $labelName = $name . '_label';
2807 $this->$labelName = $label;
2814 * Provides documentation and validation for the buildOptions $context param
2816 * @param string $context
2818 * @throws CRM_Core_Exception
2821 public static function buildOptionsContext($context = NULL) {
2823 'get' => "get: all options are returned, even if they are disabled; labels are translated.",
2824 'create' => "create: options are filtered appropriately for the object being created/updated; labels are translated.",
2825 'search' => "search: searchable options are returned; labels are translated.",
2826 'validate' => "validate: all options are returned, even if they are disabled; machine names are used in place of labels.",
2827 'abbreviate' => "abbreviate: enabled options are returned; labels are replaced with abbreviations.",
2828 'match' => "match: enabled options are returned using machine names as keys; labels are translated.",
2830 // Validation: enforce uniformity of this param
2831 if ($context !== NULL && !isset($contexts[$context])) {
2832 throw new CRM_Core_Exception("'$context' is not a valid context for buildOptions.");
2838 * @param string $fieldName
2839 * @return bool|array
2841 public function getFieldSpec($fieldName) {
2842 $fields = $this->fields();
2844 // Support "unique names" as well as sql names
2845 $fieldKey = $fieldName;
2846 if (empty($fields[$fieldKey])) {
2847 $fieldKeys = $this->fieldKeys();
2848 $fieldKey = $fieldKeys[$fieldName] ??
NULL;
2850 // If neither worked then this field doesn't exist. Return false.
2851 if (empty($fields[$fieldKey])) {
2854 return $fields[$fieldKey];
2858 * Get SQL where clause for SQL filter syntax input parameters.
2860 * SQL version of api function to assign filters to the DAO based on the syntax
2861 * $field => array('IN' => array(4,6,9))
2863 * $field => array('LIKE' => array('%me%))
2866 * @param string $fieldName
2868 * @param array $filter
2869 * filter to be applied indexed by operator.
2870 * @param string $type
2871 * type of field (not actually used - nor in api @todo ).
2872 * @param string $alias
2873 * alternative field name ('as') @todo- not actually used.
2874 * @param bool $returnSanitisedArray
2875 * Return a sanitised array instead of a clause.
2876 * this is primarily so we can add filters @ the api level to the Query object based fields
2880 * @return NULL|string|array
2881 * a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL
2882 * depending on whether it is supported as yet
2884 public static function createSQLFilter($fieldName, $filter, $type = NULL, $alias = NULL, $returnSanitisedArray = FALSE) {
2885 foreach ($filter as $operator => $criteria) {
2886 $emojiFilter = CRM_Utils_SQL
::handleEmojiInQuery($criteria);
2887 if ($emojiFilter === '0 = 1') {
2888 return $emojiFilter;
2891 if (in_array($operator, self
::acceptedSQLOperators(), TRUE)) {
2892 switch ($operator) {
2896 if (!$returnSanitisedArray) {
2897 return (sprintf('%s %s', $fieldName, $operator));
2900 return (sprintf('%s %s ', $fieldName, $operator));
2904 // ternary operators
2907 if ((empty($criteria[0]) && !in_array($criteria[0], ['0', 0]))||
(empty($criteria[1]) && !in_array($criteria[1], ['0', 0]))) {
2908 throw new Exception("invalid criteria for $operator");
2910 if (!$returnSanitisedArray) {
2911 return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO
::escapeString($criteria[0]), CRM_Core_DAO
::escapeString($criteria[1])));
2914 // not yet implemented (tests required to implement)
2922 if (empty($criteria)) {
2923 throw new Exception("invalid criteria for $operator");
2925 $escapedCriteria = array_map([
2929 if (!$returnSanitisedArray) {
2930 return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
2932 return $escapedCriteria;
2937 if (!$returnSanitisedArray) {
2938 return (sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO
::escapeString($criteria)));
2941 // not yet implemented (tests required to implement)
2950 * @see http://issues.civicrm.org/jira/browse/CRM-9150
2951 * support for other syntaxes is discussed in ticket but being put off for now
2954 public static function acceptedSQLOperators() {
2975 * SQL has a limit of 64 characters on various names:
2976 * table name, trigger name, column name ...
2978 * For custom groups and fields we generated names from user entered input
2979 * which can be longer than this length, this function helps with creating
2980 * strings that meet various criteria.
2982 * @param string $string
2983 * The string to be shortened.
2984 * @param int $length
2985 * The max length of the string.
2987 * @param bool $makeRandom
2991 public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) {
2992 // early return for strings that meet the requirements
2993 if (strlen($string) <= $length) {
2997 // easy return for calls that dont need a randomized uniq string
2999 return substr($string, 0, $length);
3002 // the string is longer than the length and we need a uniq string
3003 // for the same tablename we need the same uniq string every time
3004 // hence we use md5 on the string, which is not random
3005 // we'll append 8 characters to the end of the tableName
3006 $md5string = substr(md5($string), 0, 8);
3007 return substr($string, 0, $length - 8) . "_{$md5string}";
3011 * https://issues.civicrm.org/jira/browse/CRM-17748
3012 * Sets the internal options to be used on a query
3014 * @param array $options
3017 public function setOptions($options) {
3018 if (is_array($options)) {
3019 $this->_options
= $options;
3024 * https://issues.civicrm.org/jira/browse/CRM-17748
3025 * wrapper to pass internal DAO options down to DB_mysql/DB_Common level
3027 * @param array $options
3030 protected function _setDBOptions($options) {
3031 global $_DB_DATAOBJECT;
3033 if (is_array($options) && count($options)) {
3034 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
3035 foreach ($options as $option_name => $option_value) {
3036 $conn->setOption($option_name, $option_value);
3043 * @param array $params
3045 public function setApiFilter(&$params) {
3049 * Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
3051 * Return format is in the form of fieldname => clauses starting with an operator. e.g.:
3054 * 'location_type_id' => array('IS NOT NULL', 'IN (1,2,3)')
3058 * Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values.
3062 public function addSelectWhereClause() {
3064 $fields = $this->fields();
3065 foreach ($fields as $fieldName => $field) {
3066 // Clause for contact-related entities like Email, Relationship, etc.
3067 if (strpos($fieldName, 'contact_id') === 0 && CRM_Utils_Array
::value('FKClassName', $field) == 'CRM_Contact_DAO_Contact') {
3068 $clauses[$fieldName] = CRM_Utils_SQL
::mergeSubquery('Contact');
3070 // Clause for an entity_table/entity_id combo
3071 if ($fieldName === 'entity_id' && isset($fields['entity_table'])) {
3072 $relatedClauses = [];
3073 $relatedEntities = $this->buildOptions('entity_table', 'get');
3074 foreach ((array) $relatedEntities as $table => $ent) {
3076 $ent = CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table));
3077 $subquery = CRM_Utils_SQL
::mergeSubquery($ent);
3079 $relatedClauses[] = "(entity_table = '$table' AND entity_id " . implode(' AND entity_id ', $subquery) . ")";
3082 $relatedClauses[] = "(entity_table = '$table')";
3086 if ($relatedClauses) {
3087 $clauses['id'] = 'IN (SELECT id FROM `' . $this->tableName() . '` WHERE (' . implode(') OR (', $relatedClauses) . '))';
3091 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
3096 * This returns the final permissioned query string for this entity
3098 * With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
3100 * @param string $tableAlias
3103 public static function getSelectWhereClause($tableAlias = NULL) {
3104 $bao = new static();
3105 if ($tableAlias === NULL) {
3106 $tableAlias = $bao->tableName();
3109 foreach ((array) $bao->addSelectWhereClause() as $field => $vals) {
3110 $clauses[$field] = NULL;
3112 $clauses[$field] = "(`$tableAlias`.`$field` IS NULL OR (`$tableAlias`.`$field` " . implode(" AND `$tableAlias`.`$field` ", (array) $vals) . '))';
3119 * ensure database name is 'safe', i.e. only contains word characters (includes underscores)
3120 * and dashes, and contains at least one [a-z] case insensitive.
3126 public static function requireSafeDBName($database) {
3129 "/^[\w\-]*[a-z]+[\w\-]*$/i",
3133 if (empty($matches)) {
3140 * Transform an array to a serialized string for database storage.
3142 * @param array|null $value
3143 * @param int $serializationType
3144 * @return string|null
3146 * @throws \Exception
3148 public static function serializeField($value, $serializationType) {
3149 if ($value === NULL) {
3152 switch ($serializationType) {
3153 case self
::SERIALIZE_SEPARATOR_BOOKEND
:
3154 return $value === [] ?
'' : CRM_Utils_Array
::implodePadded($value);
3156 case self
::SERIALIZE_SEPARATOR_TRIMMED
:
3157 return is_array($value) ?
implode(self
::VALUE_SEPARATOR
, $value) : $value;
3159 case self
::SERIALIZE_JSON
:
3160 return is_array($value) ?
json_encode($value) : $value;
3162 case self
::SERIALIZE_PHP
:
3163 return is_array($value) ?
serialize($value) : $value;
3165 case self
::SERIALIZE_COMMA
:
3166 return is_array($value) ?
implode(',', $value) : $value;
3169 throw new Exception('Unknown serialization method for field.');
3174 * Transform a serialized string from the database into an array.
3176 * @param string|null $value
3177 * @param $serializationType
3179 * @return array|null
3180 * @throws CRM_Core_Exception
3182 public static function unSerializeField($value, $serializationType) {
3183 if ($value === NULL) {
3186 if ($value === '') {
3189 switch ($serializationType) {
3190 case self
::SERIALIZE_SEPARATOR_BOOKEND
:
3191 return (array) CRM_Utils_Array
::explodePadded($value);
3193 case self
::SERIALIZE_SEPARATOR_TRIMMED
:
3194 return explode(self
::VALUE_SEPARATOR
, trim($value));
3196 case self
::SERIALIZE_JSON
:
3197 return strlen($value) ?
json_decode($value, TRUE) : [];
3199 case self
::SERIALIZE_PHP
:
3200 return strlen($value) ? CRM_Utils_String
::unserialize($value) : [];
3202 case self
::SERIALIZE_COMMA
:
3203 return explode(',', trim(str_replace(', ', '', $value)));
3206 throw new CRM_Core_Exception('Unknown serialization method for field.');
3213 public static function getEntityRefFilters() {
3218 * Get exportable fields with pseudoconstants rendered as an extra field.
3220 * @param string $baoClass
3224 public static function getExportableFieldsWithPseudoConstants($baoClass) {
3225 if (method_exists($baoClass, 'exportableFields')) {
3226 $fields = $baoClass::exportableFields();
3229 $fields = $baoClass::export();
3231 CRM_Core_DAO
::appendPseudoConstantsToFields($fields);
3236 * Remove item from static cache during update/delete operations
3238 private function clearDbColumnValueCache() {
3239 $daoName = get_class($this);
3240 while (strpos($daoName, '_BAO_') !== FALSE) {
3241 $daoName = get_parent_class($daoName);
3243 if (isset($this->id
)) {
3244 unset(self
::$_dbColumnValueCache[$daoName]['id'][$this->id
]);
3246 if (isset($this->name
)) {
3247 unset(self
::$_dbColumnValueCache[$daoName]['name'][$this->name
]);
3252 * Return a mapping from field-name to the corresponding key (as used in fields()).
3255 * Array(string $name => string $uniqueName).
3257 public static function fieldKeys() {
3258 return array_flip(CRM_Utils_Array
::collect('name', static::fields()));
3262 * Returns system paths related to this entity (as defined in the xml schema)
3266 public static function getEntityPaths() {
3267 return static::$_paths ??
[];