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 * How many times has this instance been cloned.
40 protected $resultCopies = 0;
46 public static $_nullObject = NULL;
49 * Icon associated with this entity.
53 public static $_icon = NULL;
56 * Field to show when displaying a record.
60 public static $_labelField = NULL;
66 public static $_nullArray = [];
68 public static $_dbColumnValueCache = NULL;
69 const NOT_NULL
= 1, IS_NULL
= 2,
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,
78 * Serialized string separated by and bookended with VALUE_SEPARATOR
80 SERIALIZE_SEPARATOR_BOOKEND
= 1,
82 * @deprecated format separated by VALUE_SEPARATOR
84 SERIALIZE_SEPARATOR_TRIMMED
= 2,
86 * Recommended serialization format
90 * @deprecated format using php serialize()
94 * Comma separated string, no quotes, no spaces
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
103 public static $_testEntitiesToSkip = [];
105 * The factory class for this application.
108 public static $_factory = NULL;
110 public static $_checkedSqlFunctionsExist = FALSE;
113 * https://issues.civicrm.org/jira/browse/CRM-17748
114 * internal variable for DAO to hold per-query settings
117 protected $_options = [];
122 * @return \CRM_Core_DAO
124 public function __construct() {
126 $this->__table
= $this->getTableName();
130 * Returns localized title of this entity.
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);
140 public function __clone() {
141 if (!empty($this->_DB_resultid
)) {
142 $this->resultCopies++
;
149 public function __destruct() {
150 if ($this->resultCopies
=== 0) {
153 $this->resultCopies
--;
157 * Returns the name of this table
161 public static function getTableName() {
162 return self
::getLocaleTableName(static::$_tableName ??
NULL);
166 * Returns if this table needs to be logged
170 public function getLog() {
171 return static::$_log ??
FALSE;
175 * Initialize the DAO object.
178 * The database connection string.
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;
191 if (defined('CIVICRM_DAO_DEBUG')) {
192 self
::DebugLevel(CIVICRM_DAO_DEBUG
);
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']]);
203 public static function getConnection() {
204 global $_DB_DATAOBJECT;
205 $dao = new CRM_Core_DAO();
206 return $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5
];
210 * Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary
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']]);
222 * Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary..
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']]);
233 * @param string $fieldName
235 * @param array $params
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));
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) {
250 if (!$required && $dbName != 'contact_id') {
251 $fkDAO = new $FKClassName();
252 if ($fkDAO->find(TRUE)) {
253 $this->$dbName = $fkDAO->id
;
257 elseif (in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)) {
258 $depObject = new $FKClassName();
259 $depObject->find(TRUE);
260 $this->$dbName = $depObject->id
;
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
;
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
;
275 * Generate and assign an arbitrary value to a field of a test object.
277 * @param string $fieldName
278 * @param array $fieldDef
279 * @param int $counter
280 * The globally-unique ID of the test object.
282 * @throws \CRM_Core_Exception
284 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
285 $dbName = $fieldDef['name'];
286 $daoName = get_class($this);
289 if (!$handled && $dbName == 'contact_sub_type') {
290 //coming up with a rule to set this is too complex let's not set it
294 // Pick an option value if needed
295 if (!$handled && $fieldDef['type'] !== CRM_Utils_Type
::T_BOOLEAN
) {
296 $options = $daoName::buildOptions($dbName, 'create');
298 $this->$dbName = key($options);
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']);
313 $this->$dbName = $counter;
317 case CRM_Utils_Type
::T_BOOLEAN
:
318 if (isset($fieldDef['default'])) {
319 $this->$dbName = $fieldDef['default'];
321 elseif ($fieldDef['name'] == 'is_deleted' ||
$fieldDef['name'] == 'is_test') {
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';
338 case CRM_Utils_Type
::T_TIMESTAMP
:
339 $this->$dbName = '19700201000000';
342 case CRM_Utils_Type
::T_TIME
:
343 throw new CRM_Core_Exception('T_TIME shouldn\'t be used.');
345 case CRM_Utils_Type
::T_CCNUM
:
346 $this->$dbName = '4111 1111 1111 1111';
349 case CRM_Utils_Type
::T_URL
:
350 $this->$dbName = 'http://www.civicrm.org';
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
:
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'];
367 $options = CRM_Core_PseudoConstant
::get($daoName, $fieldName);
368 if (is_array($options)) {
369 $this->$dbName = $options[0];
372 $defaultValues = explode(',', $options);
373 $this->$dbName = $defaultValues[0];
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']);
389 * Reset the DAO object.
391 * DAO is kinda crappy in that there is an unwritten rule of one query per DAO.
393 * We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution
395 public function reset() {
397 foreach (array_keys($this->table()) as $field) {
398 unset($this->$field);
402 * reset the various DB_DAO structures manually
411 * @param string $tableName
415 public static function getLocaleTableName($tableName) {
418 $tables = CRM_Core_I18n_Schema
::schemaStructureTables();
419 if (in_array($tableName, $tables)) {
420 return $tableName . $dbLocale;
427 * Execute a query by the current DAO, localizing it along the way (if needed).
429 * @param string $query
430 * The SQL query for execution.
431 * @param bool $i18nRewrite
432 * Whether to rewrite the query.
435 * the current DAO object after the query execution
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;
441 if (empty($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
])) {
442 // Will force connection to be populated per CRM-20541.
446 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
447 $orig_options = $conn->options
;
448 $this->_setDBOptions($this->_options
);
450 if ($i18nRewrite and $dbLocale) {
451 $query = CRM_Core_I18n_Schema
::rewriteQuery($query);
454 $ret = parent
::query($query);
456 $this->_setDBOptions($orig_options);
461 * Static function to set the factory instance for this class.
463 * @param object $factory
464 * The factory application object.
466 public static function setFactory(&$factory) {
467 self
::$_factory = &$factory;
471 * Factory method to instantiate a new object from a table name.
473 * @param string $table
474 * @return \DataObject|\PEAR_Error
476 public function factory($table = '') {
477 if (!isset(self
::$_factory)) {
478 return parent
::factory($table);
481 return self
::$_factory->create($table);
485 * Initialization for all DAO objects. Since we access DB_DO programatically
486 * we need to set the links manually.
488 public function initialize() {
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();
499 * Defines the default key as 'id'.
503 public function keys() {
512 * Tells DB_DataObject which keys use autoincrement.
513 * 'id' is autoincrementing by default.
518 public function sequenceKey() {
519 static $sequenceKeys;
520 if (!isset($sequenceKeys)) {
521 $sequenceKeys = ['id', TRUE];
523 return $sequenceKeys;
527 * Returns list of FK relationships.
529 * @return CRM_Core_Reference_Basic[]
531 public static function getReferenceColumns() {
532 if (!isset(Civi
::$statics[static::class]['links'])) {
533 Civi
::$statics[static::class]['links'] = static::createReferenceColumns(static::class);
534 CRM_Core_DAO_AllCoreTables
::invoke(static::class, 'links_callback', Civi
::$statics[static::class]['links']);
536 return Civi
::$statics[static::class]['links'];
540 * Returns all the column names of this table.
545 public static function &fields() {
551 * Returns all usable fields, indexed by name.
553 * This function differs from fields() in that it indexes by name rather than unique_name.
555 * It excludes fields not added yet by pending upgrades.
556 * This avoids problems with trying to SELECT a field that exists in code but has not yet been added to the db.
558 * @param bool $checkPermissions
559 * Filter by field permissions.
562 public static function getSupportedFields($checkPermissions = FALSE) {
563 $fields = array_column((array) static::fields(), NULL, 'name');
565 // Exclude fields yet not added by pending upgrades
566 $dbVer = \CRM_Core_BAO_Domain
::version();
567 $daoExt = defined(static::class . '::EXT') ?
constant(static::class . '::EXT') : NULL;
568 if ($fields && $daoExt === 'civicrm' && version_compare($dbVer, \CRM_Utils_System
::version()) < 0) {
569 $fields = array_filter($fields, function($field) use ($dbVer) {
570 $add = $field['add'] ??
'1.0.0';
571 if (substr_count($add, '.') < 2) {
574 return version_compare($dbVer, $add, '>=');
578 // Exclude fields the user does not have permission for
579 if ($checkPermissions) {
580 $fields = array_filter($fields, function($field) {
581 return empty($field['permission']) || CRM_Core_Permission
::check($field['permission']);
589 * Get/set an associative array of table columns
594 public function table() {
595 $fields = $this->fields();
599 foreach ($fields as $name => $value) {
600 $table[$value['name']] = $value['type'];
601 if (!empty($value['required'])) {
602 $table[$value['name']] +
= self
::DB_DAO_NOTNULL
;
615 * @return CRM_Core_DAO
617 public function save($hook = TRUE) {
619 if (!empty($this->id
)) {
621 $preEvent = new \Civi\Core\DAO\Event\
PreUpdate($this);
622 $preEvent->eventID
= $eventID;
623 \Civi
::dispatcher()->dispatch("civi.dao.preUpdate", $preEvent);
626 $result = $this->update();
629 $event = new \Civi\Core\DAO\Event\
PostUpdate($this, $result);
630 $event->eventID
= $eventID;
631 \Civi
::dispatcher()->dispatch("civi.dao.postUpdate", $event);
633 $this->clearDbColumnValueCache();
637 $preEvent = new \Civi\Core\DAO\Event\
PreUpdate($this);
638 $preEvent->eventID
= $eventID;
639 \Civi
::dispatcher()->dispatch("civi.dao.preInsert", $preEvent);
642 $result = $this->insert();
645 $event = new \Civi\Core\DAO\Event\
PostUpdate($this, $result);
646 $event->eventID
= $eventID;
647 \Civi
::dispatcher()->dispatch("civi.dao.postInsert", $event);
653 CRM_Utils_Hook
::postSave($this);
660 * Deletes items from table which match current objects variables.
662 * Returns the true on success
666 * Designed to be extended
668 * $object = new mytable();
670 * echo $object->delete(); // builds a conditon
672 * $object = new mytable();
673 * $object->whereAdd('age > 12');
675 * $object->orderBy('age DESC');
676 * $object->delete(true); // dont use object vars, use the conditions, limit and order.
678 * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
679 * we will build the condition only using the whereAdd's. Default is to
680 * build the condition only using the object parameters.
682 * * @return mixed Int (No. of rows affected) on success, false on failure, 0 on no data affected
684 public function delete($useWhere = FALSE) {
685 $preEvent = new \Civi\Core\DAO\Event\
PreDelete($this);
686 \Civi
::dispatcher()->dispatch("civi.dao.preDelete", $preEvent);
688 $result = parent
::delete($useWhere);
690 $event = new \Civi\Core\DAO\Event\
PostDelete($this, $result);
691 \Civi
::dispatcher()->dispatch("civi.dao.postDelete", $event);
694 $this->clearDbColumnValueCache();
700 * @param bool $created
702 public function log($created = FALSE) {
705 if (!$this->getLog()) {
710 $session = CRM_Core_Session
::singleton();
711 $cid = $session->get('userID');
714 // return is we dont have handle to FK
719 $dao = new CRM_Core_DAO_Log();
720 $dao->entity_table
= $this->getTableName();
721 $dao->entity_id
= $this->id
;
722 $dao->modified_id
= $cid;
723 $dao->modified_date
= date("YmdHis");
728 * Given an associative array of name/value pairs, extract all the values
729 * that belong to this object and initialize the object with said values
731 * @param array $params
732 * Array of name/value pairs to save.
735 * Did we copy all null values into the object
737 public function copyValues($params) {
739 foreach ($this->fields() as $uniqueName => $field) {
740 $dbName = $field['name'];
741 if (array_key_exists($dbName, $params)) {
742 $value = $params[$dbName];
745 elseif (array_key_exists($uniqueName, $params)) {
746 $value = $params[$uniqueName];
753 // if there is no value then make the variable NULL
756 $this->$dbName = 'null';
758 elseif (is_array($value) && !empty($field['serialize'])) {
759 $this->$dbName = CRM_Core_DAO
::serializeField($value, $field['serialize']);
763 $maxLength = $field['maxlength'] ??
NULL;
764 if (!is_array($value) && $maxLength && mb_strlen($value) > $maxLength && empty($field['pseudoconstant'])) {
765 // No ts() since this is a sysadmin-y string not seen by general users.
766 Civi
::log()->warning('A string for field {dbName} has been truncated. The original string was {value}.', ['dbName' => $dbName, 'value' => $value]);
767 // The string is too long - what to do what to do? Well losing data is generally bad so let's truncate
768 $value = CRM_Utils_String
::ellipsify($value, $maxLength);
770 $this->$dbName = $value;
779 * Store all the values from this object in an associative array
780 * this is a destructive store, calling function is responsible
781 * for keeping sanity of id's.
783 * @param object $object
784 * The object that we are extracting data from.
785 * @param array $values
786 * (reference ) associative array of name/value pairs.
788 public static function storeValues(&$object, &$values) {
789 $fields = $object->fields();
790 foreach ($fields as $name => $value) {
791 $dbName = $value['name'];
792 if (isset($object->$dbName) && $object->$dbName !== 'null') {
793 $values[$dbName] = $object->$dbName;
794 if ($name != $dbName) {
795 $values[$name] = $object->$dbName;
802 * Create an attribute for this specific field. We only do this for strings and text
804 * @param array $field
805 * The field under task.
808 * the attributes for the object
810 public static function makeAttribute($field) {
812 if (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_STRING
) {
813 $maxLength = $field['maxlength'] ??
NULL;
814 $size = $field['size'] ??
NULL;
815 if ($maxLength ||
$size) {
818 $attributes['maxlength'] = $maxLength;
821 $attributes['size'] = $size;
826 elseif (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_TEXT
) {
827 $rows = $field['rows'] ??
NULL;
831 $cols = $field['cols'] ??
NULL;
837 $attributes['rows'] = $rows;
838 $attributes['cols'] = $cols;
841 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
) {
842 $attributes['size'] = 6;
843 $attributes['maxlength'] = 14;
851 * Get the size and maxLength attributes for this text field.
852 * (or for all text fields) in the DAO object.
854 * @param string $class
856 * @param string $fieldName
857 * Field that i'm interested in or null if.
858 * you want the attributes for all DAO text fields
861 * assoc array of name => attribute pairs
863 public static function getAttribute($class, $fieldName = NULL) {
864 $object = new $class();
865 $fields = $object->fields();
866 if ($fieldName != NULL) {
867 $field = $fields[$fieldName] ??
NULL;
868 return self
::makeAttribute($field);
872 foreach ($fields as $name => $field) {
873 $attribute = self
::makeAttribute($field);
875 $attributes[$name] = $attribute;
879 if (!empty($attributes)) {
887 * Create or update a record from supplied params.
889 * If 'id' is supplied, an existing record will be updated
890 * Otherwise a new record will be created.
892 * @param array $record
895 * @throws \CRM_Core_Exception
897 public static function writeRecord(array $record): CRM_Core_DAO
{
898 $hook = empty($record['id']) ?
'create' : 'edit';
899 $className = CRM_Core_DAO_AllCoreTables
::getCanonicalClassName(static::class);
900 if ($className === 'CRM_Core_DAO') {
901 throw new CRM_Core_Exception('Function writeRecord must be called on a subclass of CRM_Core_DAO');
903 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName($className);
905 \CRM_Utils_Hook
::pre($hook, $entityName, $record['id'] ??
NULL, $record);
906 $instance = new $className();
907 $instance->copyValues($record);
909 \CRM_Utils_Hook
::post($hook, $entityName, $instance->id
, $instance);
915 * Bulk save multiple records
917 * @param array[] $records
919 * @throws CRM_Core_Exception
921 public static function writeRecords(array $records) {
923 foreach ($records as $record) {
924 $results[] = static::writeRecord($record);
930 * Delete a record from supplied params.
932 * @param array $record
935 * @throws CRM_Core_Exception
937 public static function deleteRecord(array $record) {
938 $className = CRM_Core_DAO_AllCoreTables
::getCanonicalClassName(static::class);
939 if ($className === 'CRM_Core_DAO') {
940 throw new CRM_Core_Exception('Function deleteRecord must be called on a subclass of CRM_Core_DAO');
942 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName($className);
943 if (empty($record['id'])) {
944 throw new CRM_Core_Exception("Cannot delete {$entityName} with no id.");
947 CRM_Utils_Hook
::pre('delete', $entityName, $record['id'], $record);
948 $instance = new $className();
949 $instance->id
= $record['id'];
950 if (!$instance->delete()) {
951 throw new CRM_Core_Exception("Could not delete {$entityName} id {$record['id']}");
953 CRM_Utils_Hook
::post('delete', $entityName, $record['id'], $instance);
959 * Bulk delete multiple records.
961 * @param array[] $records
963 * @throws CRM_Core_Exception
965 public static function deleteRecords(array $records) {
967 foreach ($records as $record) {
968 $results[] = static::deleteRecord($record);
974 * Check if there is a record with the same name in the db.
976 * @param string $value
977 * The value of the field we are checking.
978 * @param string $daoName
979 * The dao object name.
980 * @param string $daoID
981 * The id of the object being updated. u can change your name.
982 * as long as there is no conflict
983 * @param string $fieldName
984 * The name of the field in the DAO.
986 * @param string $domainID
987 * The id of the domain. Object exists only for the given domain.
990 * true if object exists
992 public static function objectExists($value, $daoName, $daoID, $fieldName = 'name', $domainID = NULL) {
993 $object = new $daoName();
994 $object->$fieldName = $value;
996 $object->domain_id
= $domainID;
999 if ($object->find(TRUE)) {
1000 return $daoID && $object->id
== $daoID;
1008 * Check if there is a given column in a specific table.
1011 * @see CRM_Core_BAO_SchemaHandler::checkIfFieldExists
1013 * @param string $tableName
1014 * @param string $columnName
1015 * @param bool $i18nRewrite
1016 * Whether to rewrite the query on multilingual setups.
1019 * true if exists, else false
1021 public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
1022 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Core_BAO_SchemaHandler::checkIfFieldExists');
1023 return CRM_Core_BAO_SchemaHandler
::checkIfFieldExists($tableName, $columnName, $i18nRewrite);
1027 * Scans all the tables using a slow query and table name.
1031 public static function getTableNames() {
1032 $dao = CRM_Core_DAO
::executeQuery(
1034 FROM information_schema.TABLES
1035 WHERE TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
1036 AND TABLE_NAME LIKE 'civicrm_%'
1037 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
1038 AND TABLE_NAME NOT LIKE '%_temp%'
1041 while ($dao->fetch()) {
1042 $values[] = $dao->TABLE_NAME
;
1048 * @param int $maxTablesToCheck
1052 public static function isDBMyISAM($maxTablesToCheck = 10) {
1053 return CRM_Core_DAO
::singleValueQuery(
1055 FROM information_schema.TABLES
1056 WHERE ENGINE = 'MyISAM'
1057 AND TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
1058 AND TABLE_NAME LIKE 'civicrm_%'
1059 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
1060 AND TABLE_NAME NOT LIKE '%_temp%'
1061 AND TABLE_NAME NOT LIKE 'civicrm_tmp_%'
1066 * Get the name of the CiviCRM database.
1070 public static function getDatabaseName() {
1071 $daoObj = new CRM_Core_DAO();
1072 return $daoObj->database();
1076 * Checks if a constraint exists for a specified table.
1078 * @param string $tableName
1079 * @param string $constraint
1082 * true if constraint exists, false otherwise
1084 * @throws \CRM_Core_Exception
1086 public static function checkConstraintExists($tableName, $constraint) {
1089 if (!array_key_exists($tableName, $show)) {
1090 $query = "SHOW CREATE TABLE $tableName";
1091 $dao = CRM_Core_DAO
::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
1093 if (!$dao->fetch()) {
1094 throw new CRM_Core_Exception('query failed');
1097 $show[$tableName] = $dao->Create_Table
;
1100 return (bool) preg_match("/\b$constraint\b/i", $show[$tableName]);
1104 * Checks if CONSTRAINT keyword exists for a specified table.
1106 * @param array $tables
1108 * @throws CRM_Core_Exception
1111 * true if CONSTRAINT keyword exists, false otherwise
1113 public static function schemaRequiresRebuilding($tables = ["civicrm_contact"]) {
1115 foreach ($tables as $tableName) {
1116 if (!array_key_exists($tableName, $show)) {
1117 $query = "SHOW CREATE TABLE $tableName";
1118 $dao = CRM_Core_DAO
::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
1120 if (!$dao->fetch()) {
1121 throw new CRM_Core_Exception('Show create table failed.');
1124 $show[$tableName] = $dao->Create_Table
;
1127 $result = (bool) preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]);
1128 if ($result == TRUE) {
1139 * Checks if the FK constraint name is in the format 'FK_tableName_columnName'
1140 * for a specified column of a table.
1142 * @param string $tableName
1143 * @param string $columnName
1146 * true if in format, false otherwise
1148 * @throws \CRM_Core_Exception
1150 public static function checkFKConstraintInFormat($tableName, $columnName) {
1153 if (!array_key_exists($tableName, $show)) {
1154 $query = "SHOW CREATE TABLE $tableName";
1155 $dao = CRM_Core_DAO
::executeQuery($query);
1157 if (!$dao->fetch()) {
1158 throw new CRM_Core_Exception('query failed');
1161 $show[$tableName] = $dao->Create_Table
;
1163 $constraint = "`FK_{$tableName}_{$columnName}`";
1164 $pattern = "/\bCONSTRAINT\b\s+%s\s+\bFOREIGN\s+KEY\b\s/i";
1165 return (bool) preg_match(sprintf($pattern, $constraint), $show[$tableName]);
1169 * Check whether a specific column in a specific table has always the same value.
1171 * @param string $tableName
1172 * @param string $columnName
1173 * @param string $columnValue
1176 * true if the value is always $columnValue, false otherwise
1178 public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
1179 $query = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'";
1180 $dao = CRM_Core_DAO
::executeQuery($query);
1181 $result = $dao->fetch() ?
FALSE : TRUE;
1186 * Check whether a specific column in a specific table is always NULL.
1188 * @param string $tableName
1189 * @param string $columnName
1192 * true if if the value is always NULL, false otherwise
1194 public static function checkFieldIsAlwaysNull($tableName, $columnName) {
1195 $query = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL";
1196 $dao = CRM_Core_DAO
::executeQuery($query);
1197 $result = $dao->fetch() ?
FALSE : TRUE;
1202 * Checks if this DAO's table ought to exist.
1204 * If there are pending DB updates, this function compares the CiviCRM version of the table to the current schema version.
1207 * @throws CRM_Core_Exception
1209 public static function tableHasBeenAdded() {
1210 if (CRM_Utils_System
::version() === CRM_Core_BAO_Domain
::version()) {
1213 $daoExt = defined(static::class . '::EXT') ?
constant(static::class . '::EXT') : NULL;
1214 $daoVersion = defined(static::class . '::TABLE_ADDED') ?
constant(static::class . '::TABLE_ADDED') : '1.0';
1215 return !($daoExt === 'civicrm' && version_compare(CRM_Core_BAO_Domain
::version(), $daoVersion, '<'));
1219 * Check if there is a given table in the database.
1221 * @param string $tableName
1224 * true if exists, else false
1226 public static function checkTableExists($tableName) {
1231 $params = [1 => [$tableName, 'String']];
1233 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1234 return (bool) $dao->fetch();
1238 * Check if a given table has data.
1240 * @param string $tableName
1242 * TRUE if $tableName has at least one record.
1244 public static function checkTableHasData($tableName) {
1245 $c = CRM_Core_DAO
::singleValueQuery(sprintf('SELECT count(*) c FROM `%s`', $tableName));
1254 public function checkVersion($version) {
1255 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Core_BAO_Domain::version');
1256 $dbVersion = CRM_Core_BAO_Domain
::version();
1257 return trim($version) == trim($dbVersion);
1261 * Find a DAO object for the given ID and return it.
1264 * Id of the DAO object being searched for.
1266 * @return CRM_Core_DAO
1267 * Object of the type of the class that called this function.
1271 public static function findById($id) {
1272 $object = new static();
1274 if (!$object->find(TRUE)) {
1275 throw new Exception("Unable to find a " . get_called_class() . " with id {$id}.");
1281 * Returns all results as array-encoded records.
1285 public function fetchAll($k = FALSE, $v = FALSE, $method = FALSE) {
1287 while ($this->fetch()) {
1288 $result[] = $this->toArray();
1294 * Return the results as PHP generator.
1296 * @param string $type
1297 * Whether the generator yields 'dao' objects or 'array's.
1299 public function fetchGenerator($type = 'dao') {
1300 while ($this->fetch()) {
1307 yield
$this->toArray();
1311 throw new \
RuntimeException("Invalid record type ($type)");
1317 * Returns a singular value.
1319 * @return mixed|NULL
1321 public function fetchValue() {
1322 $result = $this->getDatabaseResult();
1323 $row = $result->fetchRow();
1333 * Get all the result records as mapping between columns.
1335 * @param string $keyColumn
1337 * @param string $valueColumn
1340 * Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]
1342 public function fetchMap($keyColumn, $valueColumn) {
1344 while ($this->fetch()) {
1345 $result[$this->{$keyColumn}] = $this->{$valueColumn};
1351 * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
1353 * @param string $daoName
1354 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1355 * @param int $searchValue
1356 * Value of the column you want to search by.
1357 * @param string $returnColumn
1358 * Name of the column you want to GET the value of.
1359 * @param string $searchColumn
1360 * Name of the column you want to search by.
1361 * @param bool $force
1362 * Skip use of the cache.
1364 * @return string|int|null
1365 * Value of $returnColumn in the retrieved record
1367 * @throws \CRM_Core_Exception
1369 public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
1371 empty($searchValue) ||
1372 trim(strtolower($searchValue)) == 'null'
1374 // adding this here since developers forget to check for an id
1375 // or for the 'null' (which is a bad DAO kludge)
1376 // and hence we get the first value in the db
1377 throw new CRM_Core_Exception('getFieldValue failed');
1380 self
::$_dbColumnValueCache = self
::$_dbColumnValueCache ??
[];
1382 while (strpos($daoName, '_BAO_') !== FALSE) {
1383 $daoName = get_parent_class($daoName);
1387 empty(self
::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue]) ||
1388 !array_key_exists($returnColumn, self
::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue])
1390 $object = new $daoName();
1391 $object->$searchColumn = $searchValue;
1392 $object->selectAdd();
1393 $object->selectAdd($returnColumn);
1396 if ($object->find(TRUE)) {
1397 $result = $object->$returnColumn;
1400 self
::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn] = $result;
1402 return self
::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn];
1406 * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
1408 * @param string $daoName
1409 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1410 * @param int $searchValue
1411 * Value of the column you want to search by.
1412 * @param string $setColumn
1413 * Name of the column you want to SET the value of.
1414 * @param string $setValue
1415 * SET the setColumn to this value.
1416 * @param string $searchColumn
1417 * Name of the column you want to search by.
1420 * true if we found and updated the object, else false
1422 public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
1423 $object = new $daoName();
1424 $object->selectAdd();
1425 $object->selectAdd("$searchColumn, $setColumn");
1426 $object->$searchColumn = $searchValue;
1428 if ($object->find(TRUE)) {
1429 $object->$setColumn = $setValue;
1430 if ($object->save()) {
1441 * @param array|object $sort either array or CRM_Utils_Sort
1442 * @param string $default
1443 * Default sort value.
1447 public static function getSortString($sort, $default = NULL) {
1448 // check if sort is of type CRM_Utils_Sort
1449 if (is_a($sort, 'CRM_Utils_Sort')) {
1450 return $sort->orderBy();
1455 // is it an array specified as $field => $sortDirection ?
1457 foreach ($sort as $k => $v) {
1458 $sortString .= "$k $v,";
1460 return rtrim($sortString, ',');
1466 * Fetch object based on array of properties.
1468 * @param string $daoName
1469 * Name of the dao object.
1470 * @param array $params
1471 * (reference ) an assoc array of name/value pairs.
1472 * @param array $defaults
1473 * (reference ) an assoc array to hold the flattened values.
1474 * @param array $returnProperities
1475 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1478 * an object of type referenced by daoName
1480 public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
1481 $object = new $daoName();
1482 $object->copyValues($params);
1484 // return only specific fields if returnproperties are sent
1485 if (!empty($returnProperities)) {
1486 $object->selectAdd();
1487 $object->selectAdd(implode(',', $returnProperities));
1490 if ($object->find(TRUE)) {
1491 self
::storeValues($object, $defaults);
1498 * Delete the object records that are associated with this contact.
1500 * @param string $daoName
1501 * Name of the dao object.
1502 * @param int $contactId
1503 * Id of the contact to delete.
1505 public static function deleteEntityContact($daoName, $contactId) {
1506 $object = new $daoName();
1508 $object->entity_table
= 'civicrm_contact';
1509 $object->entity_id
= $contactId;
1514 * Execute an unbuffered query.
1516 * This is a wrapper around new functionality exposed with CRM-17748.
1518 * @param string $query query to be executed
1520 * @param array $params
1521 * @param bool $abort
1522 * @param null $daoName
1523 * @param bool $freeDAO
1524 * @param bool $i18nRewrite
1525 * @param bool $trapException
1527 * @return CRM_Core_DAO
1528 * Object that points to an unbuffered result set
1530 public static function executeUnbufferedQuery(
1536 $i18nRewrite = TRUE,
1537 $trapException = FALSE
1540 return self
::executeQuery(
1548 ['result_buffering' => 0]
1555 * @param string $query
1556 * Query to be executed.
1558 * @param array $params
1559 * @param bool $abort
1560 * @param null $daoName
1561 * @param bool $freeDAO
1562 * @param bool $i18nRewrite
1563 * @param bool $trapException
1564 * @param array $options
1566 * @return CRM_Core_DAO|object
1567 * object that holds the results of the query
1568 * NB - if this is defined as just returning a DAO phpstorm keeps pointing
1569 * out all the properties that are not part of the DAO
1571 public static function &executeQuery(
1577 $i18nRewrite = TRUE,
1578 $trapException = FALSE,
1581 $queryStr = self
::composeQuery($query, $params, $abort);
1584 $dao = new CRM_Core_DAO();
1587 $dao = new $daoName();
1590 if ($trapException) {
1591 CRM_Core_Error
::deprecatedFunctionWarning('calling functions should handle exceptions');
1592 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
1595 if ($dao->isValidOption($options)) {
1596 $dao->setOptions($options);
1599 $result = $dao->query($queryStr, $i18nRewrite);
1601 // since it is unbuffered, ($dao->N==0) is true. This blocks the standard fetch() mechanism.
1602 if (CRM_Utils_Array
::value('result_buffering', $options) === 0) {
1606 if (is_a($result, 'DB_Error')) {
1607 CRM_Core_Error
::deprecatedFunctionWarning('calling functions should handle exceptions');
1615 * Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
1617 * @param array $options
1620 * Provided options are valid
1622 public function isValidOption($options) {
1631 if (empty($options)) {
1635 foreach (array_keys($options) as $option) {
1636 if (!in_array($option, $validOptions)) {
1646 * Execute a query and get the single result.
1648 * @param string $query
1649 * Query to be executed.
1650 * @param array $params
1651 * @param bool $abort
1652 * @param bool $i18nRewrite
1653 * @return string|null
1654 * the result of the query if any
1657 public static function &singleValueQuery(
1663 $queryStr = self
::composeQuery($query, $params, $abort);
1665 static $_dao = NULL;
1668 $_dao = new CRM_Core_DAO();
1671 $_dao->query($queryStr, $i18nRewrite);
1673 $result = $_dao->getDatabaseResult();
1676 $row = $result->fetchRow();
1686 * Compose the query by merging the parameters into it.
1688 * @param string $query
1689 * @param array $params
1690 * @param bool $abort
1693 * @throws CRM_Core_Exception
1695 public static function composeQuery($query, $params = [], $abort = TRUE) {
1697 foreach ($params as $key => $item) {
1698 if (is_numeric($key)) {
1699 if (CRM_Utils_Type
::validate($item[0], $item[1]) !== NULL) {
1700 $item[0] = self
::escapeString($item[0]);
1701 if ($item[1] == 'String' ||
1702 $item[1] == 'Memo' ||
1705 // Support class constants stipulating wildcard characters and/or
1706 // non-quoting of strings. Also support legacy code which may be
1707 // passing in TRUE or 1 for $item[2], which used to indicate the
1708 // use of wildcard characters.
1709 if (!empty($item[2])) {
1710 if ($item[2] & CRM_Core_DAO
::QUERY_FORMAT_WILDCARD ||
$item[2] === TRUE) {
1711 $item[0] = "'%{$item[0]}%'";
1713 elseif (!($item[2] & CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
)) {
1714 $item[0] = "'{$item[0]}'";
1718 $item[0] = "'{$item[0]}'";
1722 if (($item[1] == 'Date' ||
$item[1] == 'Timestamp') &&
1723 strlen($item[0]) == 0
1728 $tr['%' . $key] = $item[0];
1731 throw new CRM_Core_Exception("{$item[0]} is not of type {$item[1]}");
1736 return strtr($query, $tr);
1742 public static function freeResult($ids = NULL) {
1743 global $_DB_DATAOBJECT;
1746 if (!$_DB_DATAOBJECT ||
1747 !isset($_DB_DATAOBJECT['RESULTS'])
1751 $ids = array_keys($_DB_DATAOBJECT['RESULTS']);
1754 foreach ($ids as $id) {
1755 if (isset($_DB_DATAOBJECT['RESULTS'][$id])) {
1756 $_DB_DATAOBJECT['RESULTS'][$id]->free();
1757 unset($_DB_DATAOBJECT['RESULTS'][$id]);
1760 if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$id])) {
1761 unset($_DB_DATAOBJECT['RESULTFIELDS'][$id]);
1767 * Make a shallow copy of an object and all the fields in the object.
1769 * @param string $daoName
1771 * @param array $criteria
1772 * Array of all the fields & values.
1773 * on which basis to copy
1774 * @param array $newData
1775 * Array of all the fields & values.
1776 * to be copied besides the other fields
1777 * @param string $fieldsFix
1778 * Array of fields that you want to prefix/suffix/replace.
1779 * @param string $blockCopyOfDependencies
1780 * Fields that you want to block from.
1782 * @param bool $blockCopyofCustomValues
1783 * Case when you don't want to copy the custom values set in a
1784 * template as it will override/ignore the submitted custom values
1786 * @return CRM_Core_DAO|bool
1787 * the newly created copy of the object. False if none created.
1789 public static function copyGeneric($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL, $blockCopyofCustomValues = FALSE) {
1790 $object = new $daoName();
1793 $object->id
= $criteria['id'];
1796 foreach ($criteria as $key => $value) {
1797 $object->$key = $value;
1802 while ($object->fetch()) {
1804 // all the objects except with $blockCopyOfDependencies set
1805 // be copied - addresses #CRM-1962
1807 if ($blockCopyOfDependencies && $object->$blockCopyOfDependencies) {
1811 $newObject = new $daoName();
1813 $fields = $object->fields();
1814 $fieldsToPrefix = [];
1815 $fieldsToSuffix = [];
1816 $fieldsToReplace = [];
1817 if (!empty($fieldsFix['prefix'])) {
1818 $fieldsToPrefix = $fieldsFix['prefix'];
1820 if (!empty($fieldsFix['suffix'])) {
1821 $fieldsToSuffix = $fieldsFix['suffix'];
1823 if (!empty($fieldsFix['replace'])) {
1824 $fieldsToReplace = $fieldsFix['replace'];
1827 $localizableFields = FALSE;
1828 foreach ($fields as $name => $value) {
1829 if ($name == 'id' ||
$value['name'] == 'id') {
1830 // copy everything but the id!
1834 $dbName = $value['name'];
1835 $type = CRM_Utils_Type
::typeToString($value['type']);
1836 $newObject->$dbName = $object->$dbName;
1837 if (isset($fieldsToPrefix[$dbName])) {
1838 $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1840 if (isset($fieldsToSuffix[$dbName])) {
1841 $newObject->$dbName .= $fieldsToSuffix[$dbName];
1843 if (isset($fieldsToReplace[$dbName])) {
1844 $newObject->$dbName = $fieldsToReplace[$dbName];
1847 if ($type == 'Timestamp' ||
$type == 'Date') {
1848 $newObject->$dbName = CRM_Utils_Date
::isoToMysql($newObject->$dbName);
1851 if (!empty($value['localizable'])) {
1852 $localizableFields = TRUE;
1856 $newObject->copyValues($newData);
1861 // ensure we copy all localized fields as well
1862 if (CRM_Core_I18n
::isMultilingual() && $localizableFields) {
1864 $locales = CRM_Core_I18n
::getMultilingual();
1865 $curLocale = CRM_Core_I18n
::getLocale();
1866 // loop on other locales
1867 foreach ($locales as $locale) {
1868 if ($locale != $curLocale) {
1869 // setLocale doesn't seems to be reliable to set dbLocale and we only need to change the db locale
1870 $dbLocale = '_' . $locale;
1871 $newObject->copyLocalizable($object->id
, $newObject->id
, $fieldsToPrefix, $fieldsToSuffix, $fieldsToReplace);
1874 // restore dbLocale to starting value
1875 $dbLocale = '_' . $curLocale;
1878 if (!$blockCopyofCustomValues) {
1879 $newObject->copyCustomFields($object->id
, $newObject->id
);
1881 CRM_Utils_Hook
::post('create', CRM_Core_DAO_AllCoreTables
::getBriefName($daoName), $newObject->id
, $newObject);
1888 * Method that copies localizable fields from an old entity to a new one.
1890 * Fixes bug dev/core#2479,
1891 * where non current locale fields are copied from current locale losing translation when copying
1893 * @param int $entityID
1894 * @param int $newEntityID
1895 * @param array $fieldsToPrefix
1896 * @param array $fieldsToSuffix
1897 * @param array $fieldsToReplace
1899 protected function copyLocalizable($entityID, $newEntityID, $fieldsToPrefix, $fieldsToSuffix, $fieldsToReplace) {
1900 $entity = get_class($this);
1901 $object = new $entity();
1902 $object->id
= $entityID;
1905 $newObject = new $entity();
1906 $newObject->id
= $newEntityID;
1910 if ($object->fetch() && $newObject->fetch()) {
1912 $fields = $object->fields();
1913 foreach ($fields as $name => $value) {
1915 if ($name == 'id' ||
$value['name'] == 'id') {
1916 // copy everything but the id!
1920 // only copy localizable fields
1921 if (!$value['localizable']) {
1925 $dbName = $value['name'];
1926 $type = CRM_Utils_Type
::typeToString($value['type']);
1927 $newObject->$dbName = $object->$dbName;
1928 if (isset($fieldsToPrefix[$dbName])) {
1929 $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1931 if (isset($fieldsToSuffix[$dbName])) {
1932 $newObject->$dbName .= $fieldsToSuffix[$dbName];
1934 if (isset($fieldsToReplace[$dbName])) {
1935 $newObject->$dbName = $fieldsToReplace[$dbName];
1938 if ($type == 'Timestamp' ||
$type == 'Date') {
1939 $newObject->$dbName = CRM_Utils_Date
::isoToMysql($newObject->$dbName);
1949 * Method that copies custom fields values from an old entity to a new one.
1951 * Fixes bug CRM-19302,
1952 * where if a custom field of File type was present, left both events using the same file,
1953 * breaking download URL's for the old event.
1955 * @todo the goal here is to clean this up so that it works for any entity. Copy Generic already DOES some custom field stuff
1956 * but it seems to be bypassed & perhaps less good than this (or this just duplicates it...)
1958 * @param int $entityID
1959 * @param int $newEntityID
1961 public function copyCustomFields($entityID, $newEntityID) {
1962 $entity = CRM_Core_DAO_AllCoreTables
::getBriefName(get_class($this));
1963 $tableName = CRM_Core_DAO_AllCoreTables
::getTableForClass(get_class($this));
1964 // Obtain custom values for old event
1965 $customParams = $htmlType = [];
1966 $customValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($entityID, $entity);
1968 // If custom values present, we copy them
1969 if (!empty($customValues)) {
1970 // Get Field ID's and identify File type attributes, to handle file copying.
1971 $fieldIds = implode(', ', array_keys($customValues));
1972 $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
1973 $result = CRM_Core_DAO
::executeQuery($sql);
1975 // Build array of File type fields
1976 while ($result->fetch()) {
1977 $htmlType[] = $result->id
;
1980 // Build params array of custom values
1981 foreach ($customValues as $field => $value) {
1982 if ($value !== NULL) {
1983 // Handle File type attributes
1984 if (in_array($field, $htmlType)) {
1985 $fileValues = CRM_Core_BAO_File
::path($value, $entityID);
1986 $customParams["custom_{$field}_-1"] = [
1987 'name' => CRM_Utils_File
::duplicate($fileValues[0]),
1988 'type' => $fileValues[1],
1991 // Handle other types
1993 $customParams["custom_{$field}_-1"] = $value;
1998 // Save Custom Fields for new Event
1999 CRM_Core_BAO_CustomValueTable
::postProcess($customParams, $tableName, $newEntityID, $entity);
2002 // copy activity attachments ( if any )
2003 CRM_Core_BAO_File
::copyEntityFile($tableName, $entityID, $tableName, $newEntityID);
2007 * Cascade update through related entities.
2009 * @param string $daoName
2012 * @param array $newData
2014 * @return CRM_Core_DAO|null
2016 public static function cascadeUpdate($daoName, $fromId, $toId, $newData = []) {
2017 $object = new $daoName();
2018 $object->id
= $fromId;
2020 if ($object->find(TRUE)) {
2021 $newObject = new $daoName();
2022 $newObject->id
= $toId;
2024 if ($newObject->find(TRUE)) {
2025 $fields = $object->fields();
2026 foreach ($fields as $name => $value) {
2027 if ($name == 'id' ||
$value['name'] == 'id') {
2028 // copy everything but the id!
2032 $colName = $value['name'];
2033 $newObject->$colName = $object->$colName;
2035 if (substr($name, -5) == '_date' ||
2036 substr($name, -10) == '_date_time'
2038 $newObject->$colName = CRM_Utils_Date
::isoToMysql($newObject->$colName);
2041 foreach ($newData as $k => $v) {
2042 $newObject->$k = $v;
2052 * Given the component id, compute the contact id
2053 * since its used for things like send email
2055 * @param $componentIDs
2056 * @param string $tableName
2057 * @param string $idField
2061 public static function getContactIDsFromComponent($componentIDs, $tableName, $idField = 'id') {
2064 if (empty($componentIDs)) {
2068 $IDs = implode(',', $componentIDs);
2072 WHERE $idField IN ( $IDs )
2075 $dao = CRM_Core_DAO
::executeQuery($query);
2076 while ($dao->fetch()) {
2077 $contactIDs[] = $dao->contact_id
;
2083 * Fetch object based on array of properties.
2085 * @param string $daoName
2086 * Name of the dao object.
2087 * @param string $fieldIdName
2088 * @param int $fieldId
2090 * @param array $returnProperities
2091 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
2094 * an object of type referenced by daoName
2096 public static function commonRetrieveAll($daoName, $fieldIdName, $fieldId, &$details, $returnProperities = NULL) {
2097 require_once str_replace('_', DIRECTORY_SEPARATOR
, $daoName) . ".php";
2098 $object = new $daoName();
2099 $object->$fieldIdName = $fieldId;
2101 // return only specific fields if returnproperties are sent
2102 if (!empty($returnProperities)) {
2103 $object->selectAdd();
2104 $object->selectAdd('id');
2105 $object->selectAdd(implode(',', $returnProperities));
2109 while ($object->fetch()) {
2111 self
::storeValues($object, $defaults);
2112 $details[$object->id
] = $defaults;
2119 * Drop all CiviCRM tables.
2121 * @throws \CRM_Core_Exception
2123 public static function dropAllTables() {
2125 // first drop all the custom tables we've created
2126 CRM_Core_BAO_CustomGroup
::dropAllTables();
2128 // drop all multilingual views
2129 CRM_Core_I18n_Schema
::dropAllViews();
2131 CRM_Utils_File
::sourceSQLFile(CIVICRM_DSN
,
2132 dirname(__FILE__
) . DIRECTORY_SEPARATOR
.
2133 '..' . DIRECTORY_SEPARATOR
.
2134 '..' . DIRECTORY_SEPARATOR
.
2135 'sql' . DIRECTORY_SEPARATOR
.
2136 'civicrm_drop.mysql'
2145 public static function escapeString($string) {
2146 static $_dao = NULL;
2148 // If this is an atypical case (e.g. preparing .sql file before CiviCRM
2149 // has been installed), then we fallback DB-less str_replace escaping, as
2150 // we can't use mysqli_real_escape_string, as there is no DB connection.
2151 // Note: In typical usage, escapeString() will only check one conditional
2152 // ("if !$_dao") rather than two conditionals ("if !defined(DSN)")
2153 if (!defined('CIVICRM_DSN')) {
2154 // See http://php.net/manual/en/mysqli.real-escape-string.php for the
2155 // list of characters mysqli_real_escape_string escapes.
2156 $search = ["\\", "\x00", "\n", "\r", "'", '"', "\x1a"];
2157 $replace = ["\\\\", "\\0", "\\n", "\\r", "\'", '\"', "\\Z"];
2158 return str_replace($search, $replace, $string);
2160 $_dao = new CRM_Core_DAO();
2162 return $_dao->escape($string);
2166 * Escape a list of strings for use with "WHERE X IN (...)" queries.
2168 * @param array $strings
2169 * @param string $default
2170 * the value to use if $strings has no elements.
2172 * eg "abc","def","ghi"
2174 public static function escapeStrings($strings, $default = NULL) {
2175 static $_dao = NULL;
2177 $_dao = new CRM_Core_DAO();
2180 if (empty($strings)) {
2184 $escapes = array_map([$_dao, 'escape'], $strings);
2185 return '"' . implode('","', $escapes) . '"';
2193 public static function escapeWildCardString($string) {
2195 // ensure we escape the single characters % and _ which are mysql wild
2196 // card characters and could come in via sortByCharacter
2197 // note that mysql does not escape these characters
2198 if ($string && in_array($string,
2199 ['%', '_', '%%', '_%']
2202 return '\\' . $string;
2205 return self
::escapeString($string);
2209 * Creates a test object, including any required objects it needs via recursion
2210 * createOnly: only create in database, do not store or return the objects (useful for perf testing)
2211 * ONLY USE FOR TESTING
2213 * @param string $daoName
2214 * @param array $params
2215 * @param int $numObjects
2216 * @param bool $createOnly
2218 * @return object|array|NULL
2219 * NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.
2221 public static function createTestObject(
2227 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
2228 // so we re-set here in case
2229 $config = CRM_Core_Config
::singleton();
2230 $config->backtrace
= TRUE;
2232 static $counter = 0;
2233 CRM_Core_DAO
::$_testEntitiesToSkip = [
2234 'CRM_Core_DAO_Worldregion',
2235 'CRM_Core_DAO_StateProvince',
2236 'CRM_Core_DAO_Country',
2237 'CRM_Core_DAO_Domain',
2238 'CRM_Financial_DAO_FinancialType',
2239 //because valid ones exist & we use pick them due to pseudoconstant can't reliably create & delete these
2242 // Prefer to instantiate BAO's instead of DAO's (when possible)
2243 // so that assignTestValue()/assignTestFK() can be overloaded.
2244 $baoName = str_replace('_DAO_', '_BAO_', $daoName);
2245 if ($baoName === 'CRM_Financial_BAO_FinancialTrxn') {
2246 // OMG OMG OMG this is so incredibly bad. The BAO is insanely named.
2247 // @todo create a new class called what the BAO SHOULD be
2248 // that extends BAO-crazy-name.... migrate.
2249 $baoName = 'CRM_Core_BAO_FinancialTrxn';
2251 if (class_exists($baoName)) {
2252 $daoName = $baoName;
2255 for ($i = 0; $i < $numObjects; ++
$i) {
2258 /** @var CRM_Core_DAO $object */
2259 $object = new $daoName();
2261 $fields = $object->fields();
2262 foreach ($fields as $fieldName => $fieldDef) {
2263 $dbName = $fieldDef['name'];
2264 $FKClassName = $fieldDef['FKClassName'] ??
NULL;
2266 if (isset($params[$dbName]) && !is_array($params[$dbName])) {
2267 $object->$dbName = $params[$dbName];
2270 elseif ($dbName != 'id') {
2271 if ($FKClassName != NULL) {
2272 $object->assignTestFK($fieldName, $fieldDef, $params);
2276 $object->assignTestValue($fieldName, $fieldDef, $counter);
2284 $objects[$i] = $object;
2294 elseif ($numObjects == 1) {
2303 * Deletes the this object plus any dependent objects that are associated with it.
2304 * ONLY USE FOR TESTING
2306 * @param string $daoName
2307 * @param array $params
2309 public static function deleteTestObjects($daoName, $params = []) {
2310 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
2311 // so we re-set here in case
2312 $config = CRM_Core_Config
::singleton();
2313 $config->backtrace
= TRUE;
2315 $object = new $daoName();
2316 $object->id
= $params['id'] ??
NULL;
2318 // array(array(0 => $daoName, 1 => $daoParams))
2320 if ($object->find(TRUE)) {
2322 $fields = $object->fields();
2323 foreach ($fields as $name => $value) {
2325 $dbName = $value['name'];
2327 $FKClassName = $value['FKClassName'] ??
NULL;
2328 $required = $value['required'] ??
NULL;
2329 if ($FKClassName != NULL
2331 && !in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)
2332 && ($required ||
$dbName == 'contact_id')
2333 //I'm a bit stuck on this one - we might need to change the singleValueAlter so that the entities don't share a contact
2334 // to make this test process pass - line below makes pass for now
2335 && $dbName != 'member_of_contact_id'
2338 $deletions[] = [$FKClassName, ['id' => $object->$dbName]];
2345 foreach ($deletions as $deletion) {
2346 CRM_Core_DAO
::deleteTestObjects($deletion[0], $deletion[1]);
2351 * Set defaults when creating new entity.
2352 * (don't call this set defaults as already in use with different signature in some places)
2354 * @param array $params
2357 public static function setCreateDefaults(&$params, $defaults) {
2358 if (!empty($params['id'])) {
2361 foreach ($defaults as $key => $value) {
2362 if (!array_key_exists($key, $params) ||
$params[$key] === NULL) {
2363 $params[$key] = $value;
2369 * @param string $prefix
2370 * @param bool $addRandomString
2371 * @param null $string
2375 * @see CRM_Utils_SQL_TempTable
2377 public static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
2378 CRM_Core_Error
::deprecatedFunctionWarning('Use CRM_Utils_SQL_TempTable interface to create temporary tables');
2379 $tableName = $prefix . "_temp";
2381 if ($addRandomString) {
2383 $tableName .= "_" . $string;
2386 $tableName .= "_" . md5(uniqid('', TRUE));
2394 * @param bool $trigger
2398 public static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
2399 if (\Civi
::settings()->get('logging_no_trigger_permission')) {
2402 // test for create view and trigger permissions and if allowed, add the option to go multilingual and logging
2403 $dao = new CRM_Core_DAO();
2406 $dao->query('CREATE OR REPLACE VIEW civicrm_domain_view AS SELECT * FROM civicrm_domain');
2407 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2411 $dao->query('CREATE TRIGGER civicrm_domain_trigger BEFORE INSERT ON civicrm_domain FOR EACH ROW BEGIN END');
2412 $dao->query('DROP TRIGGER IF EXISTS civicrm_domain_trigger');
2415 catch (Exception
$e) {
2423 * @param null $message
2424 * @param bool $printDAO
2426 public static function debugPrint($message = NULL, $printDAO = TRUE) {
2427 CRM_Utils_System
::xMemory("{$message}: ");
2430 global $_DB_DATAOBJECT;
2432 foreach (array_keys($_DB_DATAOBJECT['RESULTS']) as $id) {
2433 $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query
;
2435 CRM_Core_Error
::debug('_DB_DATAOBJECT', $q);
2440 * Build a list of triggers via hook and add them to (err, reconcile them
2441 * with) the database.
2443 * @param string $tableName
2444 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2445 * @param bool $force
2450 public static function triggerRebuild($tableName = NULL, $force = FALSE) {
2451 Civi
::service('sql_triggers')->rebuild($tableName, $force);
2455 * Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
2456 * @see http://issues.civicrm.org/jira/browse/CRM-13822
2457 * TODO: Alternative solutions might be
2458 * * Stop using functions and find another way to strip numeric characters from phones
2459 * * Give better error messages (currently a missing fn fatals with "unknown error")
2461 public static function checkSqlFunctionsExist() {
2462 if (!self
::$_checkedSqlFunctionsExist) {
2463 self
::$_checkedSqlFunctionsExist = TRUE;
2464 $dao = CRM_Core_DAO
::executeQuery("SHOW function status WHERE db = database() AND name = 'civicrm_strip_non_numeric'");
2465 if (!$dao->fetch()) {
2466 self
::triggerRebuild();
2472 * Wrapper function to drop triggers.
2474 * @param string $tableName
2475 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2478 public static function dropTriggers($tableName = NULL) {
2479 Civi
::service('sql_triggers')->dropTriggers($tableName);
2483 * @param array $info
2484 * per hook_civicrm_triggerInfo.
2485 * @param string $onlyTableName
2486 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2489 public static function createTriggers(&$info, $onlyTableName = NULL) {
2490 Civi
::service('sql_triggers')->createTriggers($info, $onlyTableName);
2494 * Given a list of fields, create a list of references.
2496 * @param string $className
2497 * BAO/DAO class name.
2498 * @return array<CRM_Core_Reference_Interface>
2500 public static function createReferenceColumns($className) {
2502 $fields = $className::fields();
2503 foreach ($fields as $field) {
2504 if (isset($field['pseudoconstant'], $field['pseudoconstant']['optionGroupName'])) {
2505 $result[] = new CRM_Core_Reference_OptionValue(
2506 $className::getTableName(),
2508 'civicrm_option_value',
2509 CRM_Utils_Array
::value('keyColumn', $field['pseudoconstant'], 'value'),
2510 $field['pseudoconstant']['optionGroupName']
2518 * Find all records which refer to this entity.
2521 * Array of objects referencing this
2523 public function findReferences() {
2524 $links = self
::getReferencesToTable(static::getTableName());
2527 foreach ($links as $refSpec) {
2528 /** @var $refSpec CRM_Core_Reference_Interface */
2529 $daoName = CRM_Core_DAO_AllCoreTables
::getClassForTable($refSpec->getReferenceTable());
2530 $result = $refSpec->findReferences($this);
2532 while ($result->fetch()) {
2533 $obj = new $daoName();
2534 $obj->id
= $result->id
;
2535 $occurrences[] = $obj;
2540 return $occurrences;
2545 * each item has keys:
2549 * - table: string|null SQL table name
2550 * - key: string|null SQL column name
2552 public function getReferenceCounts() {
2553 $links = self
::getReferencesToTable(static::getTableName());
2556 foreach ($links as $refSpec) {
2557 /** @var $refSpec CRM_Core_Reference_Interface */
2558 $count = $refSpec->getReferenceCount($this);
2559 if ($count['count'] != 0) {
2564 foreach (CRM_Core_Component
::getEnabledComponents() as $component) {
2565 /** @var $component CRM_Core_Component_Info */
2566 $counts = array_merge($counts, $component->getReferenceCounts($this));
2568 CRM_Utils_Hook
::referenceCounts($this, $counts);
2574 * List all tables which have hard foreign keys to this table.
2576 * For now, this returns a description of every entity_id/entity_table
2578 * TODO: filter dynamic entity references on the $tableName, based on
2579 * schema metadata in dynamicForeignKey which enumerates a restricted
2580 * set of possible entity_table's.
2582 * @param string $tableName
2583 * Table referred to.
2586 * structure of table and column, listing every table with a
2587 * foreign key reference to $tableName, and the column where the key appears.
2589 public static function getReferencesToTable($tableName) {
2591 foreach (CRM_Core_DAO_AllCoreTables
::getClasses() as $daoClassName) {
2592 $links = $daoClassName::getReferenceColumns();
2594 foreach ($links as $refSpec) {
2595 /** @var $refSpec CRM_Core_Reference_Interface */
2596 if ($refSpec->matchesTargetTable($tableName)) {
2597 $refsFound[] = $refSpec;
2605 * Get all references to contact table.
2607 * This includes core tables, custom group tables, tables added by the merge
2608 * hook and the entity_tag table.
2610 * Refer to CRM-17454 for information on the danger of querying the information
2611 * schema to derive this.
2613 * @throws \CiviCRM_API3_Exception
2615 public static function getReferencesToContactTable() {
2616 if (isset(\Civi
::$statics[__CLASS__
]) && isset(\Civi
::$statics[__CLASS__
]['contact_references'])) {
2617 return \Civi
::$statics[__CLASS__
]['contact_references'];
2619 $contactReferences = [];
2620 $coreReferences = CRM_Core_DAO
::getReferencesToTable('civicrm_contact');
2621 foreach ($coreReferences as $coreReference) {
2622 if (!is_a($coreReference, 'CRM_Core_Reference_Dynamic')) {
2623 $contactReferences[$coreReference->getReferenceTable()][] = $coreReference->getReferenceKey();
2626 self
::appendCustomTablesExtendingContacts($contactReferences);
2627 self
::appendCustomContactReferenceFields($contactReferences);
2628 \Civi
::$statics[__CLASS__
]['contact_references'] = $contactReferences;
2629 return \Civi
::$statics[__CLASS__
]['contact_references'];
2633 * Get all dynamic references to the given table.
2635 * @param string $tableName
2639 public static function getDynamicReferencesToTable($tableName) {
2640 if (!isset(\Civi
::$statics[__CLASS__
]['contact_references_dynamic'][$tableName])) {
2641 \Civi
::$statics[__CLASS__
]['contact_references_dynamic'][$tableName] = [];
2642 $coreReferences = CRM_Core_DAO
::getReferencesToTable($tableName);
2643 foreach ($coreReferences as $coreReference) {
2644 if ($coreReference instanceof \CRM_Core_Reference_Dynamic
) {
2645 \Civi
::$statics[__CLASS__
]['contact_references_dynamic'][$tableName][$coreReference->getReferenceTable()][] = [$coreReference->getReferenceKey(), $coreReference->getTypeColumn()];
2649 return \Civi
::$statics[__CLASS__
]['contact_references_dynamic'][$tableName];
2653 * Add custom tables that extend contacts to the list of contact references.
2655 * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish
2656 * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples
2657 * - the down side is it is not cached.
2659 * Further changes should be include tests in the CRM_Core_MergerTest class
2660 * to ensure that disabled, subtype, multiple etc groups are still captured.
2662 * @param array $cidRefs
2664 public static function appendCustomTablesExtendingContacts(&$cidRefs) {
2665 $customValueTables = CRM_Core_BAO_CustomGroup
::getAllCustomGroupsByBaseEntity('Contact');
2666 $customValueTables->find();
2667 while ($customValueTables->fetch()) {
2668 $cidRefs[$customValueTables->table_name
][] = 'entity_id';
2673 * Add custom ContactReference fields to the list of contact references
2675 * This includes active and inactive fields/groups
2677 * @param array $cidRefs
2679 * @throws \CiviCRM_API3_Exception
2681 public static function appendCustomContactReferenceFields(&$cidRefs) {
2682 $fields = civicrm_api3('CustomField', 'get', [
2683 'return' => ['column_name', 'custom_group_id.table_name'],
2684 'data_type' => 'ContactReference',
2685 'options' => ['limit' => 0],
2687 foreach ($fields as $field) {
2688 $cidRefs[$field['custom_group_id.table_name']][] = $field['column_name'];
2693 * Lookup the value of a MySQL global configuration variable.
2695 * @param string $name
2696 * E.g. "thread_stack".
2697 * @param mixed $default
2700 public static function getGlobalSetting($name, $default = NULL) {
2701 // Alternatively, SELECT @@GLOBAL.thread_stack, but
2702 // that has been reported to fail under MySQL 5.0 for OS X
2703 $escapedName = self
::escapeString($name);
2704 $dao = CRM_Core_DAO
::executeQuery("SHOW VARIABLES LIKE '$escapedName'");
2705 if ($dao->fetch()) {
2714 * Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
2716 * This is relevant where we want to offer both the ID field and the label field
2717 * as an option, e.g. search builder.
2719 * It is currently limited for optionGroupName & id+ name+ FK combos for purposes keeping the scope of the
2720 * change small, but is appropriate for other sorts of pseudoconstants.
2722 * @param array $fields
2724 public static function appendPseudoConstantsToFields(&$fields) {
2725 foreach ($fields as $fieldUniqueName => $field) {
2726 if (!empty($field['pseudoconstant'])) {
2727 $pseudoConstant = $field['pseudoconstant'];
2728 if (!empty($pseudoConstant['optionGroupName'])) {
2729 $fields[$pseudoConstant['optionGroupName']] = [
2730 'title' => CRM_Core_BAO_OptionGroup
::getTitleByName($pseudoConstant['optionGroupName']),
2731 'name' => $pseudoConstant['optionGroupName'],
2732 'data_type' => CRM_Utils_Type
::T_STRING
,
2733 'is_pseudofield_for' => $fieldUniqueName,
2736 // We restrict to id + name + FK as we are extending this a bit, but cautiously.
2738 !empty($field['FKClassName'])
2739 && CRM_Utils_Array
::value('keyColumn', $pseudoConstant) === 'id'
2740 && CRM_Utils_Array
::value('labelColumn', $pseudoConstant) === 'name'
2742 $pseudoFieldName = str_replace('_' . $pseudoConstant['keyColumn'], '', $field['name']);
2743 // This if is just an extra caution when adding change.
2744 if (!isset($fields[$pseudoFieldName])) {
2745 $daoName = $field['FKClassName'];
2746 $fkFields = $daoName::fields();
2747 foreach ($fkFields as $fkField) {
2748 if ($fkField['name'] === $pseudoConstant['labelColumn']) {
2749 $fields[$pseudoFieldName] = [
2750 'name' => $pseudoFieldName,
2751 'is_pseudofield_for' => $field['name'],
2752 'title' => $fkField['title'],
2753 'data_type' => $fkField['type'],
2754 'where' => $field['where'],
2765 * Get options for the called BAO object's field.
2767 * This function can be overridden by each BAO to add more logic related to context.
2768 * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
2770 * @param string $fieldName
2771 * @param string $context
2772 * @see CRM_Core_DAO::buildOptionsContext
2773 * @param array $props
2774 * Raw field values; whatever is known about this bao object.
2776 * Note: $props can contain unsanitized input and should not be passed directly to CRM_Core_PseudoConstant::get
2778 * @return array|bool
2780 public static function buildOptions($fieldName, $context = NULL, $props = []) {
2781 // If a given bao does not override this function
2782 $baoName = get_called_class();
2783 return CRM_Core_PseudoConstant
::get($baoName, $fieldName, [], $context);
2787 * Populate option labels for this object's fields.
2789 * @throws exception if called directly on the base class
2791 public function getOptionLabels() {
2792 $fields = $this->fields();
2793 if ($fields === NULL) {
2794 throw new Exception('Cannot call getOptionLabels on CRM_Core_DAO');
2796 foreach ($fields as $field) {
2797 $name = $field['name'] ??
NULL;
2798 if ($name && isset($this->$name)) {
2799 $label = CRM_Core_PseudoConstant
::getLabel(get_class($this), $name, $this->$name);
2800 if ($label !== FALSE) {
2801 // Append 'label' onto the field name
2802 $labelName = $name . '_label';
2803 $this->$labelName = $label;
2810 * Provides documentation and validation for the buildOptions $context param
2812 * @param string $context
2814 * @throws CRM_Core_Exception
2817 public static function buildOptionsContext($context = NULL) {
2819 'get' => "get: all options are returned, even if they are disabled; labels are translated.",
2820 'create' => "create: options are filtered appropriately for the object being created/updated; labels are translated.",
2821 'search' => "search: searchable options are returned; labels are translated.",
2822 'validate' => "validate: all options are returned, even if they are disabled; machine names are used in place of labels.",
2823 'abbreviate' => "abbreviate: enabled options are returned; labels are replaced with abbreviations.",
2824 'match' => "match: enabled options are returned using machine names as keys; labels are translated.",
2826 // Validation: enforce uniformity of this param
2827 if ($context !== NULL && !isset($contexts[$context])) {
2828 throw new CRM_Core_Exception("'$context' is not a valid context for buildOptions.");
2834 * @param string $fieldName
2835 * @return bool|array
2837 public function getFieldSpec($fieldName) {
2838 $fields = $this->fields();
2840 // Support "unique names" as well as sql names
2841 $fieldKey = $fieldName;
2842 if (empty($fields[$fieldKey])) {
2843 $fieldKeys = $this->fieldKeys();
2844 $fieldKey = $fieldKeys[$fieldName] ??
NULL;
2846 // If neither worked then this field doesn't exist. Return false.
2847 if (empty($fields[$fieldKey])) {
2850 return $fields[$fieldKey];
2854 * Get SQL where clause for SQL filter syntax input parameters.
2856 * SQL version of api function to assign filters to the DAO based on the syntax
2857 * $field => array('IN' => array(4,6,9))
2859 * $field => array('LIKE' => array('%me%))
2862 * @param string $fieldName
2864 * @param array $filter
2865 * filter to be applied indexed by operator.
2866 * @param string $type
2867 * type of field (not actually used - nor in api @todo ).
2868 * @param string $alias
2869 * alternative field name ('as') @todo- not actually used.
2870 * @param bool $returnSanitisedArray
2871 * Return a sanitised array instead of a clause.
2872 * this is primarily so we can add filters @ the api level to the Query object based fields
2876 * @return NULL|string|array
2877 * a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL
2878 * depending on whether it is supported as yet
2880 public static function createSQLFilter($fieldName, $filter, $type = NULL, $alias = NULL, $returnSanitisedArray = FALSE) {
2881 foreach ($filter as $operator => $criteria) {
2882 if (!CRM_Core_BAO_SchemaHandler
::databaseSupportsUTF8MB4()) {
2883 foreach ((array) $criteria as $criterion) {
2884 if (!empty($criterion) && !is_numeric($criterion)
2885 // The first 2 criteria are redundant but are added as they
2886 // seem like they would
2887 // be quicker than this 3rd check.
2888 && max(array_map('ord', str_split($criterion))) >= 240) {
2889 // String contains unsupported emojis.
2890 // We return a clause that resolves to false as an emoji string by definition cannot be saved.
2891 // note that if we return just 0 for false if gets lost in empty checks.
2892 // https://stackoverflow.com/questions/16496554/can-php-detect-4-byte-encoded-utf8-chars
2898 if (in_array($operator, self
::acceptedSQLOperators(), TRUE)) {
2899 switch ($operator) {
2903 if (!$returnSanitisedArray) {
2904 return (sprintf('%s %s', $fieldName, $operator));
2907 return (sprintf('%s %s ', $fieldName, $operator));
2911 // ternary operators
2914 if ((empty($criteria[0]) && !in_array($criteria[0], ['0', 0]))||
(empty($criteria[1]) && !in_array($criteria[1], ['0', 0]))) {
2915 throw new Exception("invalid criteria for $operator");
2917 if (!$returnSanitisedArray) {
2918 return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO
::escapeString($criteria[0]), CRM_Core_DAO
::escapeString($criteria[1])));
2921 // not yet implemented (tests required to implement)
2929 if (empty($criteria)) {
2930 throw new Exception("invalid criteria for $operator");
2932 $escapedCriteria = array_map([
2936 if (!$returnSanitisedArray) {
2937 return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
2939 return $escapedCriteria;
2944 if (!$returnSanitisedArray) {
2945 return (sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO
::escapeString($criteria)));
2948 // not yet implemented (tests required to implement)
2957 * @see http://issues.civicrm.org/jira/browse/CRM-9150
2958 * support for other syntaxes is discussed in ticket but being put off for now
2961 public static function acceptedSQLOperators() {
2982 * SQL has a limit of 64 characters on various names:
2983 * table name, trigger name, column name ...
2985 * For custom groups and fields we generated names from user entered input
2986 * which can be longer than this length, this function helps with creating
2987 * strings that meet various criteria.
2989 * @param string $string
2990 * The string to be shortened.
2991 * @param int $length
2992 * The max length of the string.
2994 * @param bool $makeRandom
2998 public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) {
2999 // early return for strings that meet the requirements
3000 if (strlen($string) <= $length) {
3004 // easy return for calls that dont need a randomized uniq string
3006 return substr($string, 0, $length);
3009 // the string is longer than the length and we need a uniq string
3010 // for the same tablename we need the same uniq string every time
3011 // hence we use md5 on the string, which is not random
3012 // we'll append 8 characters to the end of the tableName
3013 $md5string = substr(md5($string), 0, 8);
3014 return substr($string, 0, $length - 8) . "_{$md5string}";
3018 * https://issues.civicrm.org/jira/browse/CRM-17748
3019 * Sets the internal options to be used on a query
3021 * @param array $options
3024 public function setOptions($options) {
3025 if (is_array($options)) {
3026 $this->_options
= $options;
3031 * https://issues.civicrm.org/jira/browse/CRM-17748
3032 * wrapper to pass internal DAO options down to DB_mysql/DB_Common level
3034 * @param array $options
3037 protected function _setDBOptions($options) {
3038 global $_DB_DATAOBJECT;
3040 if (is_array($options) && count($options)) {
3041 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
3042 foreach ($options as $option_name => $option_value) {
3043 $conn->setOption($option_name, $option_value);
3050 * @param array $params
3052 public function setApiFilter(&$params) {
3056 * Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
3058 * Return format is in the form of fieldname => clauses starting with an operator. e.g.:
3061 * 'location_type_id' => array('IS NOT NULL', 'IN (1,2,3)')
3065 * Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values.
3069 public function addSelectWhereClause() {
3071 $fields = $this->fields();
3072 foreach ($fields as $fieldName => $field) {
3073 // Clause for contact-related entities like Email, Relationship, etc.
3074 if (strpos($fieldName, 'contact_id') === 0 && CRM_Utils_Array
::value('FKClassName', $field) == 'CRM_Contact_DAO_Contact') {
3075 $clauses[$fieldName] = CRM_Utils_SQL
::mergeSubquery('Contact');
3077 // Clause for an entity_table/entity_id combo
3078 if ($fieldName === 'entity_id' && isset($fields['entity_table'])) {
3079 $relatedClauses = [];
3080 $relatedEntities = $this->buildOptions('entity_table', 'get');
3081 foreach ((array) $relatedEntities as $table => $ent) {
3083 $ent = CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table));
3084 $subquery = CRM_Utils_SQL
::mergeSubquery($ent);
3086 $relatedClauses[] = "(entity_table = '$table' AND entity_id " . implode(' AND entity_id ', $subquery) . ")";
3089 $relatedClauses[] = "(entity_table = '$table')";
3093 if ($relatedClauses) {
3094 $clauses['id'] = 'IN (SELECT id FROM `' . $this->tableName() . '` WHERE (' . implode(') OR (', $relatedClauses) . '))';
3098 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
3103 * This returns the final permissioned query string for this entity
3105 * With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
3107 * @param string $tableAlias
3110 public static function getSelectWhereClause($tableAlias = NULL) {
3111 $bao = new static();
3112 if ($tableAlias === NULL) {
3113 $tableAlias = $bao->tableName();
3116 foreach ((array) $bao->addSelectWhereClause() as $field => $vals) {
3117 $clauses[$field] = NULL;
3119 $clauses[$field] = "(`$tableAlias`.`$field` IS NULL OR (`$tableAlias`.`$field` " . implode(" AND `$tableAlias`.`$field` ", (array) $vals) . '))';
3126 * ensure database name is 'safe', i.e. only contains word characters (includes underscores)
3127 * and dashes, and contains at least one [a-z] case insensitive.
3133 public static function requireSafeDBName($database) {
3136 "/^[\w\-]*[a-z]+[\w\-]*$/i",
3140 if (empty($matches)) {
3147 * Transform an array to a serialized string for database storage.
3149 * @param array|null $value
3150 * @param int $serializationType
3151 * @return string|null
3153 * @throws \Exception
3155 public static function serializeField($value, $serializationType) {
3156 if ($value === NULL) {
3159 switch ($serializationType) {
3160 case self
::SERIALIZE_SEPARATOR_BOOKEND
:
3161 return $value === [] ?
'' : CRM_Utils_Array
::implodePadded($value);
3163 case self
::SERIALIZE_SEPARATOR_TRIMMED
:
3164 return is_array($value) ?
implode(self
::VALUE_SEPARATOR
, $value) : $value;
3166 case self
::SERIALIZE_JSON
:
3167 return is_array($value) ?
json_encode($value) : $value;
3169 case self
::SERIALIZE_PHP
:
3170 return is_array($value) ?
serialize($value) : $value;
3172 case self
::SERIALIZE_COMMA
:
3173 return is_array($value) ?
implode(',', $value) : $value;
3176 throw new Exception('Unknown serialization method for field.');
3181 * Transform a serialized string from the database into an array.
3183 * @param string|null $value
3184 * @param $serializationType
3186 * @return array|null
3187 * @throws CRM_Core_Exception
3189 public static function unSerializeField($value, $serializationType) {
3190 if ($value === NULL) {
3193 if ($value === '') {
3196 switch ($serializationType) {
3197 case self
::SERIALIZE_SEPARATOR_BOOKEND
:
3198 return (array) CRM_Utils_Array
::explodePadded($value);
3200 case self
::SERIALIZE_SEPARATOR_TRIMMED
:
3201 return explode(self
::VALUE_SEPARATOR
, trim($value));
3203 case self
::SERIALIZE_JSON
:
3204 return strlen($value) ?
json_decode($value, TRUE) : [];
3206 case self
::SERIALIZE_PHP
:
3207 return strlen($value) ? CRM_Utils_String
::unserialize($value) : [];
3209 case self
::SERIALIZE_COMMA
:
3210 return explode(',', trim(str_replace(', ', '', $value)));
3213 throw new CRM_Core_Exception('Unknown serialization method for field.');
3220 public static function getEntityRefFilters() {
3225 * Get exportable fields with pseudoconstants rendered as an extra field.
3227 * @param string $baoClass
3231 public static function getExportableFieldsWithPseudoConstants($baoClass) {
3232 if (method_exists($baoClass, 'exportableFields')) {
3233 $fields = $baoClass::exportableFields();
3236 $fields = $baoClass::export();
3238 CRM_Core_DAO
::appendPseudoConstantsToFields($fields);
3243 * Remove item from static cache during update/delete operations
3245 private function clearDbColumnValueCache() {
3246 $daoName = get_class($this);
3247 while (strpos($daoName, '_BAO_') !== FALSE) {
3248 $daoName = get_parent_class($daoName);
3250 if (isset($this->id
)) {
3251 unset(self
::$_dbColumnValueCache[$daoName]['id'][$this->id
]);
3253 if (isset($this->name
)) {
3254 unset(self
::$_dbColumnValueCache[$daoName]['name'][$this->name
]);
3259 * Return a mapping from field-name to the corresponding key (as used in fields()).
3262 * Array(string $name => string $uniqueName).
3264 public static function fieldKeys() {
3265 return array_flip(CRM_Utils_Array
::collect('name', static::fields()));
3269 * Returns system paths related to this entity (as defined in the xml schema)
3273 public static function getEntityPaths() {
3274 return static::$_paths ??
[];