3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * Base Database Access Object class.
31 * All DAO classes should inherit from this class.
34 * @copyright CiviCRM LLC (c) 2004-2019
37 if (!defined('DB_DSN_MODE')) {
38 define('DB_DSN_MODE', 'auto');
41 require_once 'PEAR.php';
42 require_once 'DB/DataObject.php';
44 require_once 'CRM/Core/I18n.php';
49 class CRM_Core_DAO
extends DB_DataObject
{
52 * How many times has this instance been cloned.
56 protected $resultCopies = 0;
62 static $_nullObject = NULL;
67 static $_nullArray = array();
69 static $_dbColumnValueCache = NULL;
70 const NOT_NULL
= 1, IS_NULL
= 2,
72 VALUE_SEPARATOR
= "\ 1",
73 BULK_INSERT_COUNT
= 200,
74 BULK_INSERT_HIGH_COUNT
= 200,
75 QUERY_FORMAT_WILDCARD
= 1,
76 QUERY_FORMAT_NO_QUOTES
= 2,
79 * Serialized string separated by and bookended with VALUE_SEPARATOR
81 SERIALIZE_SEPARATOR_BOOKEND
= 1,
83 * @deprecated format separated by VALUE_SEPARATOR
85 SERIALIZE_SEPARATOR_TRIMMED
= 2,
87 * Recommended serialization format
91 * @deprecated format using php serialize()
95 * Comma separated string, no quotes, no spaces
100 * Define entities that shouldn't be created or deleted when creating/ deleting
101 * test objects - this prevents world regions, countries etc from being added / deleted
104 static $_testEntitiesToSkip = array();
106 * The factory class for this application.
109 static $_factory = NULL;
111 static $_checkedSqlFunctionsExist = FALSE;
114 * https://issues.civicrm.org/jira/browse/CRM-17748
115 * internal variable for DAO to hold per-query settings
117 protected $_options = array();
122 * @return \CRM_Core_DAO
124 public function __construct() {
126 $this->__table
= $this->getTableName();
129 public function __clone() {
130 if (!empty($this->_DB_resultid
)) {
131 $this->resultCopies++
;
138 public function __destruct() {
139 if ($this->resultCopies
=== 0) {
142 $this->resultCopies
--;
146 * Empty definition for virtual function.
148 public static function getTableName() {
153 * Initialize the DAO object.
156 * The database connection string.
158 public static function init($dsn) {
159 Civi
::$statics[__CLASS__
]['init'] = 1;
160 $options = &PEAR
::getStaticProperty('DB_DataObject', 'options');
161 $options['database'] = $dsn;
162 if (defined('CIVICRM_DAO_DEBUG')) {
163 self
::DebugLevel(CIVICRM_DAO_DEBUG
);
165 $factory = new CRM_Contact_DAO_Factory();
166 CRM_Core_DAO
::setFactory($factory);
167 $currentModes = CRM_Utils_SQL
::getSqlModes();
168 if (CRM_Utils_Constant
::value('CIVICRM_MYSQL_STRICT', CRM_Utils_System
::isDevelopment())) {
169 if (CRM_Utils_SQL
::supportsFullGroupBy() && !in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL
::isGroupByModeInDefault()) {
170 $currentModes[] = 'ONLY_FULL_GROUP_BY';
172 if (!in_array('STRICT_TRANS_TABLES', $currentModes)) {
173 $currentModes = array_merge(array('STRICT_TRANS_TABLES'), $currentModes);
175 CRM_Core_DAO
::executeQuery("SET SESSION sql_mode = %1", array(1 => array(implode(',', $currentModes), 'String')));
177 CRM_Core_DAO
::executeQuery('SET NAMES utf8');
178 CRM_Core_DAO
::executeQuery('SET @uniqueID = %1', array(1 => array(CRM_Utils_Request
::id(), 'String')));
184 public static function getConnection() {
185 global $_DB_DATAOBJECT;
186 $dao = new CRM_Core_DAO();
187 return $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5
];
191 * Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary
193 public static function disableFullGroupByMode() {
194 $currentModes = CRM_Utils_SQL
::getSqlModes();
195 if (in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL
::isGroupByModeInDefault()) {
196 $key = array_search('ONLY_FULL_GROUP_BY', $currentModes);
197 unset($currentModes[$key]);
198 CRM_Core_DAO
::executeQuery("SET SESSION sql_mode = %1", array(1 => array(implode(',', $currentModes), 'String')));
203 * Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary..
205 public static function reenableFullGroupByMode() {
206 $currentModes = CRM_Utils_SQL
::getSqlModes();
207 if (!in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL
::isGroupByModeInDefault()) {
208 $currentModes[] = 'ONLY_FULL_GROUP_BY';
209 CRM_Core_DAO
::executeQuery("SET SESSION sql_mode = %1", array(1 => array(implode(',', $currentModes), 'String')));
214 * @param string $fieldName
216 * @param array $params
218 protected function assignTestFK($fieldName, $fieldDef, $params) {
219 $required = CRM_Utils_Array
::value('required', $fieldDef);
220 $FKClassName = CRM_Utils_Array
::value('FKClassName', $fieldDef);
221 $dbName = $fieldDef['name'];
222 $daoName = str_replace('_BAO_', '_DAO_', get_class($this));
224 // skip the FK if it is not required
225 // if it's contact id we should create even if not required
226 // we'll have a go @ fetching first though
227 // we WILL create campaigns though for so tests with a campaign pseudoconstant will complete
228 if ($FKClassName === 'CRM_Campaign_DAO_Campaign' && $daoName != $FKClassName) {
231 if (!$required && $dbName != 'contact_id') {
232 $fkDAO = new $FKClassName();
233 if ($fkDAO->find(TRUE)) {
234 $this->$dbName = $fkDAO->id
;
239 elseif (in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)) {
240 $depObject = new $FKClassName();
241 $depObject->find(TRUE);
242 $this->$dbName = $depObject->id
;
245 elseif ($daoName == 'CRM_Member_DAO_MembershipType' && $fieldName == 'member_of_contact_id') {
246 // FIXME: the fields() metadata is not specific enough
247 $depObject = CRM_Core_DAO
::createTestObject($FKClassName, array('contact_type' => 'Organization'));
248 $this->$dbName = $depObject->id
;
252 //if it is required we need to generate the dependency object first
253 $depObject = CRM_Core_DAO
::createTestObject($FKClassName, CRM_Utils_Array
::value($dbName, $params, 1));
254 $this->$dbName = $depObject->id
;
260 * Generate and assign an arbitrary value to a field of a test object.
262 * @param string $fieldName
263 * @param array $fieldDef
264 * @param int $counter
265 * The globally-unique ID of the test object.
267 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
268 $dbName = $fieldDef['name'];
269 $daoName = get_class($this);
272 if (!$handled && $dbName == 'contact_sub_type') {
273 //coming up with a rule to set this is too complex let's not set it
277 // Pick an option value if needed
278 if (!$handled && $fieldDef['type'] !== CRM_Utils_Type
::T_BOOLEAN
) {
279 $options = $daoName::buildOptions($dbName, 'create');
281 $this->$dbName = key($options);
287 switch ($fieldDef['type']) {
288 case CRM_Utils_Type
::T_INT
:
289 case CRM_Utils_Type
::T_FLOAT
:
290 case CRM_Utils_Type
::T_MONEY
:
291 if (isset($fieldDef['precision'])) {
292 // $object->$dbName = CRM_Utils_Number::createRandomDecimal($value['precision']);
293 $this->$dbName = CRM_Utils_Number
::createTruncatedDecimal($counter, $fieldDef['precision']);
296 $this->$dbName = $counter;
300 case CRM_Utils_Type
::T_BOOLEAN
:
301 if (isset($fieldDef['default'])) {
302 $this->$dbName = $fieldDef['default'];
304 elseif ($fieldDef['name'] == 'is_deleted' ||
$fieldDef['name'] == 'is_test') {
312 case CRM_Utils_Type
::T_DATE
:
313 case CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
:
314 $this->$dbName = '19700101';
315 if ($dbName == 'end_date') {
316 // put this in the future
317 $this->$dbName = '20200101';
321 case CRM_Utils_Type
::T_TIMESTAMP
:
322 $this->$dbName = '19700201000000';
325 case CRM_Utils_Type
::T_TIME
:
326 CRM_Core_Error
::fatal("T_TIME shouldn't be used.");
327 //$object->$dbName='000000';
329 case CRM_Utils_Type
::T_CCNUM
:
330 $this->$dbName = '4111 1111 1111 1111';
333 case CRM_Utils_Type
::T_URL
:
334 $this->$dbName = 'http://www.civicrm.org';
337 case CRM_Utils_Type
::T_STRING
:
338 case CRM_Utils_Type
::T_BLOB
:
339 case CRM_Utils_Type
::T_MEDIUMBLOB
:
340 case CRM_Utils_Type
::T_TEXT
:
341 case CRM_Utils_Type
::T_LONGTEXT
:
342 case CRM_Utils_Type
::T_EMAIL
:
344 // WAS: if (isset($value['enumValues'])) {
345 // TODO: see if this works with all pseudoconstants
346 if (isset($fieldDef['pseudoconstant'], $fieldDef['pseudoconstant']['callback'])) {
347 if (isset($fieldDef['default'])) {
348 $this->$dbName = $fieldDef['default'];
351 $options = CRM_Core_PseudoConstant
::get($daoName, $fieldName);
352 if (is_array($options)) {
353 $this->$dbName = $options[0];
356 $defaultValues = explode(',', $options);
357 $this->$dbName = $defaultValues[0];
362 $this->$dbName = $dbName . '_' . $counter;
363 $maxlength = CRM_Utils_Array
::value('maxlength', $fieldDef);
364 if ($maxlength > 0 && strlen($this->$dbName) > $maxlength) {
365 $this->$dbName = substr($this->$dbName, 0, $fieldDef['maxlength']);
373 * Reset the DAO object.
375 * DAO is kinda crappy in that there is an unwritten rule of one query per DAO.
377 * We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution
379 public function reset() {
381 foreach (array_keys($this->table()) as $field) {
382 unset($this->$field);
386 * reset the various DB_DAO structures manually
388 $this->_query
= array();
395 * @param string $tableName
399 public static function getLocaleTableName($tableName) {
402 $tables = CRM_Core_I18n_Schema
::schemaStructureTables();
403 if (in_array($tableName, $tables)) {
404 return $tableName . $dbLocale;
411 * Execute a query by the current DAO, localizing it along the way (if needed).
413 * @param string $query
414 * The SQL query for execution.
415 * @param bool $i18nRewrite
416 * Whether to rewrite the query.
419 * the current DAO object after the query execution
421 public function query($query, $i18nRewrite = TRUE) {
422 // rewrite queries that should use $dbLocale-based views for multi-language installs
423 global $dbLocale, $_DB_DATAOBJECT;
425 if (empty($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
])) {
426 // Will force connection to be populated per CRM-20541.
430 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
431 $orig_options = $conn->options
;
432 $this->_setDBOptions($this->_options
);
434 if ($i18nRewrite and $dbLocale) {
435 $query = CRM_Core_I18n_Schema
::rewriteQuery($query);
438 $ret = parent
::query($query);
440 $this->_setDBOptions($orig_options);
445 * Static function to set the factory instance for this class.
447 * @param object $factory
448 * The factory application object.
450 public static function setFactory(&$factory) {
451 self
::$_factory = &$factory;
455 * Factory method to instantiate a new object from a table name.
457 * @param string $table
458 * @return \DataObject|\PEAR_Error
460 public function factory($table = '') {
461 if (!isset(self
::$_factory)) {
462 return parent
::factory($table);
465 return self
::$_factory->create($table);
469 * Initialization for all DAO objects. Since we access DB_DO programatically
470 * we need to set the links manually.
472 public function initialize() {
474 if (empty(Civi
::$statics[__CLASS__
]['init'])) {
475 // CRM_Core_DAO::init() must be called before CRM_Core_DAO->initialize().
476 // This occurs very early in bootstrap - error handlers may not be wired up.
477 echo "Inconsistent system initialization sequence. Premature access of (" . get_class($this) . ")";
478 CRM_Utils_System
::civiExit();
483 * Defines the default key as 'id'.
487 public function keys() {
496 * Tells DB_DataObject which keys use autoincrement.
497 * 'id' is autoincrementing by default.
502 public function sequenceKey() {
503 static $sequenceKeys;
504 if (!isset($sequenceKeys)) {
505 $sequenceKeys = array('id', TRUE);
507 return $sequenceKeys;
511 * Returns list of FK relationships.
515 * Array of CRM_Core_Reference_Interface
517 public static function getReferenceColumns() {
522 * Returns all the column names of this table.
527 public static function &fields() {
533 * Get/set an associative array of table columns
538 public function table() {
539 $fields = $this->fields();
543 foreach ($fields as $name => $value) {
544 $table[$value['name']] = $value['type'];
545 if (!empty($value['required'])) {
546 $table[$value['name']] +
= self
::DB_DAO_NOTNULL
;
559 * @return CRM_Core_DAO
561 public function save($hook = TRUE) {
562 if (!empty($this->id
)) {
566 $event = new \Civi\Core\DAO\Event\
PostUpdate($this);
567 \Civi
::service('dispatcher')->dispatch("civi.dao.postUpdate", $event);
574 $event = new \Civi\Core\DAO\Event\
PostUpdate($this);
575 \Civi
::service('dispatcher')->dispatch("civi.dao.postInsert", $event);
581 CRM_Utils_Hook
::postSave($this);
588 * Deletes items from table which match current objects variables.
590 * Returns the true on success
594 * Designed to be extended
596 * $object = new mytable();
598 * echo $object->delete(); // builds a conditon
600 * $object = new mytable();
601 * $object->whereAdd('age > 12');
603 * $object->orderBy('age DESC');
604 * $object->delete(true); // dont use object vars, use the conditions, limit and order.
606 * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
607 * we will build the condition only using the whereAdd's. Default is to
608 * build the condition only using the object parameters.
610 * * @return mixed Int (No. of rows affected) on success, false on failure, 0 on no data affected
612 public function delete($useWhere = FALSE) {
613 $preEvent = new \Civi\Core\DAO\Event\
PreDelete($this);
614 \Civi
::service('dispatcher')->dispatch("civi.dao.preDelete", $preEvent);
616 $result = parent
::delete($useWhere);
618 $event = new \Civi\Core\DAO\Event\
PostDelete($this, $result);
619 \Civi
::service('dispatcher')->dispatch("civi.dao.postDelete", $event);
626 * @param bool $created
628 public function log($created = FALSE) {
631 if (!$this->getLog()) {
636 $session = CRM_Core_Session
::singleton();
637 $cid = $session->get('userID');
640 // return is we dont have handle to FK
645 $dao = new CRM_Core_DAO_Log();
646 $dao->entity_table
= $this->getTableName();
647 $dao->entity_id
= $this->id
;
648 $dao->modified_id
= $cid;
649 $dao->modified_date
= date("YmdHis");
654 * Given an associative array of name/value pairs, extract all the values
655 * that belong to this object and initialize the object with said values
657 * @param array $params
658 * (reference ) associative array of name/value pairs.
659 * @param bool $serializeArrays
660 * Should arrays that are passed in be serialised according to the metadata.
661 * Eventually this should be always true / gone, but in the interests of caution
662 * it is being grandfathered in. In general an array is not valid on the DAO
663 * but there may be instances where this function is called & then some handling
664 * takes place on the would-be array.
667 * Did we copy all null values into the object
669 public function copyValues(&$params, $serializeArrays = FALSE) {
670 $fields = $this->fields();
672 foreach ($fields as $name => $value) {
673 $dbName = $value['name'];
674 if (array_key_exists($dbName, $params)) {
675 $pValue = $params[$dbName];
678 elseif (array_key_exists($name, $params)) {
679 $pValue = $params[$name];
686 // if there is no value then make the variable NULL
688 if ($pValue === '') {
689 $this->$dbName = 'null';
691 elseif ($serializeArrays && is_array($pValue) && !empty($value['serialize'])) {
692 $this->$dbName = CRM_Core_DAO
::serializeField($pValue, $value['serialize']);
696 if (!$serializeArrays && is_array($pValue) && !empty($value['serialize'])) {
697 Civi
::log()->warning(ts('use copyParams to serialize arrays (' . __CLASS__
. '.' . $name . ')'), ['civi.tag' => 'deprecated']);
699 $maxLength = CRM_Utils_Array
::value('maxlength', $value);
700 if (!is_array($pValue) && $maxLength && mb_strlen($pValue) > $maxLength
701 && empty($value['pseudoconstant'])
703 Civi
::log()->warning(ts('A string for field $dbName has been truncated. The original string was %1', [CRM_Utils_Type
::escape($pValue, 'String')]));
704 // The string is too long - what to do what to do? Well losing data is generally bad so lets' truncate
705 $pValue = CRM_Utils_String
::ellipsify($pValue, $maxLength);
707 $this->$dbName = $pValue;
716 * Store all the values from this object in an associative array
717 * this is a destructive store, calling function is responsible
718 * for keeping sanity of id's.
720 * @param object $object
721 * The object that we are extracting data from.
722 * @param array $values
723 * (reference ) associative array of name/value pairs.
725 public static function storeValues(&$object, &$values) {
726 $fields = $object->fields();
727 foreach ($fields as $name => $value) {
728 $dbName = $value['name'];
729 if (isset($object->$dbName) && $object->$dbName !== 'null') {
730 $values[$dbName] = $object->$dbName;
731 if ($name != $dbName) {
732 $values[$name] = $object->$dbName;
739 * Create an attribute for this specific field. We only do this for strings and text
741 * @param array $field
742 * The field under task.
745 * the attributes for the object
747 public static function makeAttribute($field) {
749 if (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_STRING
) {
750 $maxLength = CRM_Utils_Array
::value('maxlength', $field);
751 $size = CRM_Utils_Array
::value('size', $field);
752 if ($maxLength ||
$size) {
753 $attributes = array();
755 $attributes['maxlength'] = $maxLength;
758 $attributes['size'] = $size;
763 elseif (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_TEXT
) {
764 $rows = CRM_Utils_Array
::value('rows', $field);
768 $cols = CRM_Utils_Array
::value('cols', $field);
773 $attributes = array();
774 $attributes['rows'] = $rows;
775 $attributes['cols'] = $cols;
778 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
) {
779 $attributes['size'] = 6;
780 $attributes['maxlength'] = 14;
788 * Get the size and maxLength attributes for this text field.
789 * (or for all text fields) in the DAO object.
791 * @param string $class
793 * @param string $fieldName
794 * Field that i'm interested in or null if.
795 * you want the attributes for all DAO text fields
798 * assoc array of name => attribute pairs
800 public static function getAttribute($class, $fieldName = NULL) {
801 $object = new $class();
802 $fields = $object->fields();
803 if ($fieldName != NULL) {
804 $field = CRM_Utils_Array
::value($fieldName, $fields);
805 return self
::makeAttribute($field);
808 $attributes = array();
809 foreach ($fields as $name => $field) {
810 $attribute = self
::makeAttribute($field);
812 $attributes[$name] = $attribute;
816 if (!empty($attributes)) {
824 * Check if there is a record with the same name in the db.
826 * @param string $value
827 * The value of the field we are checking.
828 * @param string $daoName
829 * The dao object name.
830 * @param string $daoID
831 * The id of the object being updated. u can change your name.
832 * as long as there is no conflict
833 * @param string $fieldName
834 * The name of the field in the DAO.
836 * @param string $domainID
837 * The id of the domain. Object exists only for the given domain.
840 * true if object exists
842 public static function objectExists($value, $daoName, $daoID, $fieldName = 'name', $domainID = NULL) {
843 $object = new $daoName();
844 $object->$fieldName = $value;
846 $object->domain_id
= $domainID;
849 if ($object->find(TRUE)) {
850 return ($daoID && $object->id
== $daoID) ?
TRUE : FALSE;
858 * Check if there is a given column in a specific table.
861 * @see CRM_Core_BAO_SchemaHandler::checkIfFieldExists
863 * @param string $tableName
864 * @param string $columnName
865 * @param bool $i18nRewrite
866 * Whether to rewrite the query on multilingual setups.
869 * true if exists, else false
871 public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
872 return CRM_Core_BAO_SchemaHandler
::checkIfFieldExists($tableName, $columnName, $i18nRewrite);
876 * Scans all the tables using a slow query and table name.
880 public static function getTableNames() {
881 $dao = CRM_Core_DAO
::executeQuery(
883 FROM information_schema.TABLES
884 WHERE TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
885 AND TABLE_NAME LIKE 'civicrm_%'
886 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
887 AND TABLE_NAME NOT LIKE '%_temp%'
890 while ($dao->fetch()) {
891 $values[] = $dao->TABLE_NAME
;
897 * @param int $maxTablesToCheck
901 public static function isDBMyISAM($maxTablesToCheck = 10) {
902 return CRM_Core_DAO
::singleValueQuery(
904 FROM information_schema.TABLES
905 WHERE ENGINE = 'MyISAM'
906 AND TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
907 AND TABLE_NAME LIKE 'civicrm_%'
908 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
909 AND TABLE_NAME NOT LIKE '%_temp%'
910 AND TABLE_NAME NOT LIKE 'civicrm_tmp_%'
915 * Get the name of the CiviCRM database.
919 public static function getDatabaseName() {
920 $daoObj = new CRM_Core_DAO();
921 return $daoObj->database();
925 * Checks if a constraint exists for a specified table.
927 * @param string $tableName
928 * @param string $constraint
931 * true if constraint exists, false otherwise
933 public static function checkConstraintExists($tableName, $constraint) {
934 static $show = array();
936 if (!array_key_exists($tableName, $show)) {
937 $query = "SHOW CREATE TABLE $tableName";
938 $dao = CRM_Core_DAO
::executeQuery($query);
940 if (!$dao->fetch()) {
941 CRM_Core_Error
::fatal();
944 $show[$tableName] = $dao->Create_Table
;
947 return preg_match("/\b$constraint\b/i", $show[$tableName]) ?
TRUE : FALSE;
951 * Checks if CONSTRAINT keyword exists for a specified table.
953 * @param array $tables
958 * true if CONSTRAINT keyword exists, false otherwise
960 public static function schemaRequiresRebuilding($tables = array("civicrm_contact")) {
962 foreach ($tables as $tableName) {
963 if (!array_key_exists($tableName, $show)) {
964 $query = "SHOW CREATE TABLE $tableName";
965 $dao = CRM_Core_DAO
::executeQuery($query);
967 if (!$dao->fetch()) {
968 CRM_Core_Error
::fatal();
971 $show[$tableName] = $dao->Create_Table
;
974 $result = preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]) ?
TRUE : FALSE;
975 if ($result == TRUE) {
986 * Checks if the FK constraint name is in the format 'FK_tableName_columnName'
987 * for a specified column of a table.
989 * @param string $tableName
990 * @param string $columnName
993 * true if in format, false otherwise
995 public static function checkFKConstraintInFormat($tableName, $columnName) {
996 static $show = array();
998 if (!array_key_exists($tableName, $show)) {
999 $query = "SHOW CREATE TABLE $tableName";
1000 $dao = CRM_Core_DAO
::executeQuery($query);
1002 if (!$dao->fetch()) {
1003 CRM_Core_Error
::fatal();
1006 $show[$tableName] = $dao->Create_Table
;
1008 $constraint = "`FK_{$tableName}_{$columnName}`";
1009 $pattern = "/\bCONSTRAINT\b\s+%s\s+\bFOREIGN\s+KEY\b\s/i";
1010 return preg_match(sprintf($pattern, $constraint), $show[$tableName]) ?
TRUE : FALSE;
1014 * Check whether a specific column in a specific table has always the same value.
1016 * @param string $tableName
1017 * @param string $columnName
1018 * @param string $columnValue
1021 * true if the value is always $columnValue, false otherwise
1023 public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
1024 $query = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'";
1025 $dao = CRM_Core_DAO
::executeQuery($query);
1026 $result = $dao->fetch() ?
FALSE : TRUE;
1031 * Check whether a specific column in a specific table is always NULL.
1033 * @param string $tableName
1034 * @param string $columnName
1037 * true if if the value is always NULL, false otherwise
1039 public static function checkFieldIsAlwaysNull($tableName, $columnName) {
1040 $query = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL";
1041 $dao = CRM_Core_DAO
::executeQuery($query);
1042 $result = $dao->fetch() ?
FALSE : TRUE;
1047 * Check if there is a given table in the database.
1049 * @param string $tableName
1052 * true if exists, else false
1054 public static function checkTableExists($tableName) {
1059 $params = array(1 => array($tableName, 'String'));
1061 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1062 $result = $dao->fetch() ?
TRUE : FALSE;
1071 public function checkVersion($version) {
1076 $dbVersion = CRM_Core_DAO
::singleValueQuery($query);
1077 return trim($version) == trim($dbVersion) ?
TRUE : FALSE;
1081 * Find a DAO object for the given ID and return it.
1084 * Id of the DAO object being searched for.
1086 * @return CRM_Core_DAO
1087 * Object of the type of the class that called this function.
1091 public static function findById($id) {
1092 $object = new static();
1094 if (!$object->find(TRUE)) {
1095 throw new Exception("Unable to find a " . get_called_class() . " with id {$id}.");
1101 * Returns all results as array-encoded records.
1105 public function fetchAll() {
1107 while ($this->fetch()) {
1108 $result[] = $this->toArray();
1114 * Return the results as PHP generator.
1116 * @param string $type
1117 * Whether the generator yields 'dao' objects or 'array's.
1119 public function fetchGenerator($type = 'dao') {
1120 while ($this->fetch()) {
1127 yield
$this->toArray();
1131 throw new \
RuntimeException("Invalid record type ($type)");
1137 * Returns a singular value.
1139 * @return mixed|NULL
1141 public function fetchValue() {
1142 $result = $this->getDatabaseResult();
1143 $row = $result->fetchRow();
1153 * Get all the result records as mapping between columns.
1155 * @param string $keyColumn
1157 * @param string $valueColumn
1160 * Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]
1162 public function fetchMap($keyColumn, $valueColumn) {
1164 while ($this->fetch()) {
1165 $result[$this->{$keyColumn}] = $this->{$valueColumn};
1171 * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
1173 * @param string $daoName
1174 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1175 * @param int $searchValue
1176 * Value of the column you want to search by.
1177 * @param string $returnColumn
1178 * Name of the column you want to GET the value of.
1179 * @param string $searchColumn
1180 * Name of the column you want to search by.
1181 * @param bool $force
1182 * Skip use of the cache.
1184 * @return string|null
1185 * Value of $returnColumn in the retrieved record
1187 public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
1189 empty($searchValue) ||
1190 trim(strtolower($searchValue)) == 'null'
1192 // adding this here since developers forget to check for an id
1193 // or for the 'null' (which is a bad DAO kludge)
1194 // and hence we get the first value in the db
1195 CRM_Core_Error
::fatal();
1198 $cacheKey = "{$daoName}:{$searchValue}:{$returnColumn}:{$searchColumn}";
1199 if (self
::$_dbColumnValueCache === NULL) {
1200 self
::$_dbColumnValueCache = array();
1203 if (!array_key_exists($cacheKey, self
::$_dbColumnValueCache) ||
$force) {
1204 $object = new $daoName();
1205 $object->$searchColumn = $searchValue;
1206 $object->selectAdd();
1207 $object->selectAdd($returnColumn);
1210 if ($object->find(TRUE)) {
1211 $result = $object->$returnColumn;
1215 self
::$_dbColumnValueCache[$cacheKey] = $result;
1217 return self
::$_dbColumnValueCache[$cacheKey];
1221 * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
1223 * @param string $daoName
1224 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1225 * @param int $searchValue
1226 * Value of the column you want to search by.
1227 * @param string $setColumn
1228 * Name of the column you want to SET the value of.
1229 * @param string $setValue
1230 * SET the setColumn to this value.
1231 * @param string $searchColumn
1232 * Name of the column you want to search by.
1235 * true if we found and updated the object, else false
1237 public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
1238 $object = new $daoName();
1239 $object->selectAdd();
1240 $object->selectAdd("$searchColumn, $setColumn");
1241 $object->$searchColumn = $searchValue;
1243 if ($object->find(TRUE)) {
1244 $object->$setColumn = $setValue;
1245 if ($object->save()) {
1256 * @param array|object $sort either array or CRM_Utils_Sort
1257 * @param string $default
1258 * Default sort value.
1262 public static function getSortString($sort, $default = NULL) {
1263 // check if sort is of type CRM_Utils_Sort
1264 if (is_a($sort, 'CRM_Utils_Sort')) {
1265 return $sort->orderBy();
1270 // is it an array specified as $field => $sortDirection ?
1272 foreach ($sort as $k => $v) {
1273 $sortString .= "$k $v,";
1275 return rtrim($sortString, ',');
1281 * Fetch object based on array of properties.
1283 * @param string $daoName
1284 * Name of the dao object.
1285 * @param array $params
1286 * (reference ) an assoc array of name/value pairs.
1287 * @param array $defaults
1288 * (reference ) an assoc array to hold the flattened values.
1289 * @param array $returnProperities
1290 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1293 * an object of type referenced by daoName
1295 public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
1296 $object = new $daoName();
1297 $object->copyValues($params);
1299 // return only specific fields if returnproperties are sent
1300 if (!empty($returnProperities)) {
1301 $object->selectAdd();
1302 $object->selectAdd(implode(',', $returnProperities));
1305 if ($object->find(TRUE)) {
1306 self
::storeValues($object, $defaults);
1313 * Delete the object records that are associated with this contact.
1315 * @param string $daoName
1316 * Name of the dao object.
1317 * @param int $contactId
1318 * Id of the contact to delete.
1320 public static function deleteEntityContact($daoName, $contactId) {
1321 $object = new $daoName();
1323 $object->entity_table
= 'civicrm_contact';
1324 $object->entity_id
= $contactId;
1329 * Execute an unbuffered query.
1331 * This is a wrapper around new functionality exposed with CRM-17748.
1333 * @param string $query query to be executed
1335 * @param array $params
1336 * @param bool $abort
1337 * @param null $daoName
1338 * @param bool $freeDAO
1339 * @param bool $i18nRewrite
1340 * @param bool $trapException
1342 * @return CRM_Core_DAO
1343 * Object that points to an unbuffered result set
1345 static public function executeUnbufferedQuery(
1351 $i18nRewrite = TRUE,
1352 $trapException = FALSE
1355 return self
::executeQuery(
1363 array('result_buffering' => 0)
1370 * @param string $query
1371 * Query to be executed.
1373 * @param array $params
1374 * @param bool $abort
1375 * @param null $daoName
1376 * @param bool $freeDAO
1377 * @param bool $i18nRewrite
1378 * @param bool $trapException
1379 * @param array $options
1381 * @return CRM_Core_DAO|object
1382 * object that holds the results of the query
1383 * NB - if this is defined as just returning a DAO phpstorm keeps pointing
1384 * out all the properties that are not part of the DAO
1386 public static function &executeQuery(
1392 $i18nRewrite = TRUE,
1393 $trapException = FALSE,
1396 $queryStr = self
::composeQuery($query, $params, $abort);
1399 $dao = new CRM_Core_DAO();
1402 $dao = new $daoName();
1405 if ($trapException) {
1406 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
1409 if ($dao->isValidOption($options)) {
1410 $dao->setOptions($options);
1413 $result = $dao->query($queryStr, $i18nRewrite);
1415 // since it is unbuffered, ($dao->N==0) is true. This blocks the standard fetch() mechanism.
1416 if (CRM_Utils_Array
::value('result_buffering', $options) === 0) {
1420 if (is_a($result, 'DB_Error')) {
1425 preg_match('/^(insert|update|delete|create|drop|replace)/i', $queryStr)
1427 // we typically do this for insert/update/delete statements OR if explicitly asked to
1434 * Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
1436 * @param array $options
1439 * Provided options are valid
1441 public function isValidOption($options) {
1443 $validOptions = array(
1450 if (empty($options)) {
1454 foreach (array_keys($options) as $option) {
1455 if (!in_array($option, $validOptions)) {
1465 * Execute a query and get the single result.
1467 * @param string $query
1468 * Query to be executed.
1469 * @param array $params
1470 * @param bool $abort
1471 * @param bool $i18nRewrite
1472 * @return string|null
1473 * the result of the query if any
1476 public static function &singleValueQuery(
1482 $queryStr = self
::composeQuery($query, $params, $abort);
1484 static $_dao = NULL;
1487 $_dao = new CRM_Core_DAO();
1490 $_dao->query($queryStr, $i18nRewrite);
1492 $result = $_dao->getDatabaseResult();
1495 $row = $result->fetchRow();
1505 * Compose the query by merging the parameters into it.
1507 * @param string $query
1508 * @param array $params
1509 * @param bool $abort
1514 public static function composeQuery($query, $params, $abort = TRUE) {
1516 foreach ($params as $key => $item) {
1517 if (is_numeric($key)) {
1518 if (CRM_Utils_Type
::validate($item[0], $item[1]) !== NULL) {
1519 $item[0] = self
::escapeString($item[0]);
1520 if ($item[1] == 'String' ||
1521 $item[1] == 'Memo' ||
1524 // Support class constants stipulating wildcard characters and/or
1525 // non-quoting of strings. Also support legacy code which may be
1526 // passing in TRUE or 1 for $item[2], which used to indicate the
1527 // use of wildcard characters.
1528 if (!empty($item[2])) {
1529 if ($item[2] & CRM_Core_DAO
::QUERY_FORMAT_WILDCARD ||
$item[2] === TRUE) {
1530 $item[0] = "'%{$item[0]}%'";
1532 elseif (!($item[2] & CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
)) {
1533 $item[0] = "'{$item[0]}'";
1537 $item[0] = "'{$item[0]}'";
1541 if (($item[1] == 'Date' ||
$item[1] == 'Timestamp') &&
1542 strlen($item[0]) == 0
1547 $tr['%' . $key] = $item[0];
1550 CRM_Core_Error
::fatal("{$item[0]} is not of type {$item[1]}");
1555 return strtr($query, $tr);
1561 public static function freeResult($ids = NULL) {
1562 global $_DB_DATAOBJECT;
1565 if (!$_DB_DATAOBJECT ||
1566 !isset($_DB_DATAOBJECT['RESULTS'])
1570 $ids = array_keys($_DB_DATAOBJECT['RESULTS']);
1573 foreach ($ids as $id) {
1574 if (isset($_DB_DATAOBJECT['RESULTS'][$id])) {
1575 $_DB_DATAOBJECT['RESULTS'][$id]->free();
1576 unset($_DB_DATAOBJECT['RESULTS'][$id]);
1579 if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$id])) {
1580 unset($_DB_DATAOBJECT['RESULTFIELDS'][$id]);
1586 * Make a shallow copy of an object and all the fields in the object.
1588 * @param string $daoName
1590 * @param array $criteria
1591 * Array of all the fields & values.
1592 * on which basis to copy
1593 * @param array $newData
1594 * Array of all the fields & values.
1595 * to be copied besides the other fields
1596 * @param string $fieldsFix
1597 * Array of fields that you want to prefix/suffix/replace.
1598 * @param string $blockCopyOfDependencies
1599 * Fields that you want to block from.
1602 * @return CRM_Core_DAO
1603 * the newly created copy of the object
1605 public static function ©Generic($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL) {
1606 $object = new $daoName();
1608 $object->id
= $criteria['id'];
1611 foreach ($criteria as $key => $value) {
1612 $object->$key = $value;
1617 while ($object->fetch()) {
1619 // all the objects except with $blockCopyOfDependencies set
1620 // be copied - addresses #CRM-1962
1622 if ($blockCopyOfDependencies && $object->$blockCopyOfDependencies) {
1626 $newObject = new $daoName();
1628 $fields = $object->fields();
1629 if (!is_array($fieldsFix)) {
1630 $fieldsToPrefix = array();
1631 $fieldsToSuffix = array();
1632 $fieldsToReplace = array();
1634 if (!empty($fieldsFix['prefix'])) {
1635 $fieldsToPrefix = $fieldsFix['prefix'];
1637 if (!empty($fieldsFix['suffix'])) {
1638 $fieldsToSuffix = $fieldsFix['suffix'];
1640 if (!empty($fieldsFix['replace'])) {
1641 $fieldsToReplace = $fieldsFix['replace'];
1644 foreach ($fields as $name => $value) {
1645 if ($name == 'id' ||
$value['name'] == 'id') {
1646 // copy everything but the id!
1650 $dbName = $value['name'];
1651 $type = CRM_Utils_Type
::typeToString($value['type']);
1652 $newObject->$dbName = $object->$dbName;
1653 if (isset($fieldsToPrefix[$dbName])) {
1654 $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1656 if (isset($fieldsToSuffix[$dbName])) {
1657 $newObject->$dbName .= $fieldsToSuffix[$dbName];
1659 if (isset($fieldsToReplace[$dbName])) {
1660 $newObject->$dbName = $fieldsToReplace[$dbName];
1663 if ($type == 'Timestamp' ||
$type == 'Date') {
1664 $newObject->$dbName = CRM_Utils_Date
::isoToMysql($newObject->$dbName);
1668 foreach ($newData as $k => $v) {
1669 $newObject->$k = $v;
1674 CRM_Utils_Hook
::post('create', CRM_Core_DAO_AllCoreTables
::getBriefName($daoName), $newObject->id
, $newObject);
1681 * Cascade update through related entities.
1683 * @param string $daoName
1686 * @param array $newData
1688 * @return CRM_Core_DAO|null
1690 public static function cascadeUpdate($daoName, $fromId, $toId, $newData = array()) {
1691 $object = new $daoName();
1692 $object->id
= $fromId;
1694 if ($object->find(TRUE)) {
1695 $newObject = new $daoName();
1696 $newObject->id
= $toId;
1698 if ($newObject->find(TRUE)) {
1699 $fields = $object->fields();
1700 foreach ($fields as $name => $value) {
1701 if ($name == 'id' ||
$value['name'] == 'id') {
1702 // copy everything but the id!
1706 $colName = $value['name'];
1707 $newObject->$colName = $object->$colName;
1709 if (substr($name, -5) == '_date' ||
1710 substr($name, -10) == '_date_time'
1712 $newObject->$colName = CRM_Utils_Date
::isoToMysql($newObject->$colName);
1715 foreach ($newData as $k => $v) {
1716 $newObject->$k = $v;
1726 * Given the component id, compute the contact id
1727 * since its used for things like send email
1729 * @param $componentIDs
1730 * @param string $tableName
1731 * @param string $idField
1735 public static function getContactIDsFromComponent($componentIDs, $tableName, $idField = 'id') {
1736 $contactIDs = array();
1738 if (empty($componentIDs)) {
1742 $IDs = implode(',', $componentIDs);
1746 WHERE $idField IN ( $IDs )
1749 $dao = CRM_Core_DAO
::executeQuery($query);
1750 while ($dao->fetch()) {
1751 $contactIDs[] = $dao->contact_id
;
1757 * Fetch object based on array of properties.
1759 * @param string $daoName
1760 * Name of the dao object.
1761 * @param string $fieldIdName
1762 * @param int $fieldId
1764 * @param array $returnProperities
1765 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1768 * an object of type referenced by daoName
1770 public static function commonRetrieveAll($daoName, $fieldIdName = 'id', $fieldId, &$details, $returnProperities = NULL) {
1771 require_once str_replace('_', DIRECTORY_SEPARATOR
, $daoName) . ".php";
1772 $object = new $daoName();
1773 $object->$fieldIdName = $fieldId;
1775 // return only specific fields if returnproperties are sent
1776 if (!empty($returnProperities)) {
1777 $object->selectAdd();
1778 $object->selectAdd('id');
1779 $object->selectAdd(implode(',', $returnProperities));
1783 while ($object->fetch()) {
1784 $defaults = array();
1785 self
::storeValues($object, $defaults);
1786 $details[$object->id
] = $defaults;
1793 * Drop all CiviCRM tables.
1795 * @throws \CRM_Exception
1797 public static function dropAllTables() {
1799 // first drop all the custom tables we've created
1800 CRM_Core_BAO_CustomGroup
::dropAllTables();
1802 // drop all multilingual views
1803 CRM_Core_I18n_Schema
::dropAllViews();
1805 CRM_Utils_File
::sourceSQLFile(CIVICRM_DSN
,
1806 dirname(__FILE__
) . DIRECTORY_SEPARATOR
.
1807 '..' . DIRECTORY_SEPARATOR
.
1808 '..' . DIRECTORY_SEPARATOR
.
1809 'sql' . DIRECTORY_SEPARATOR
.
1810 'civicrm_drop.mysql'
1819 public static function escapeString($string) {
1820 static $_dao = NULL;
1822 // If this is an atypical case (e.g. preparing .sql file before CiviCRM
1823 // has been installed), then we fallback DB-less str_replace escaping, as
1824 // we can't use mysqli_real_escape_string, as there is no DB connection.
1825 // Note: In typical usage, escapeString() will only check one conditional
1826 // ("if !$_dao") rather than two conditionals ("if !defined(DSN)")
1827 if (!defined('CIVICRM_DSN')) {
1828 // See http://php.net/manual/en/mysqli.real-escape-string.php for the
1829 // list of characters mysqli_real_escape_string escapes.
1830 $search = array("\\", "\x00", "\n", "\r", "'", '"', "\x1a");
1831 $replace = array("\\\\", "\\0", "\\n", "\\r", "\'", '\"', "\\Z");
1832 return str_replace($search, $replace, $string);
1834 $_dao = new CRM_Core_DAO();
1836 return $_dao->escape($string);
1840 * Escape a list of strings for use with "WHERE X IN (...)" queries.
1842 * @param array $strings
1843 * @param string $default
1844 * the value to use if $strings has no elements.
1846 * eg "abc","def","ghi"
1848 public static function escapeStrings($strings, $default = NULL) {
1849 static $_dao = NULL;
1851 $_dao = new CRM_Core_DAO();
1854 if (empty($strings)) {
1858 $escapes = array_map(array($_dao, 'escape'), $strings);
1859 return '"' . implode('","', $escapes) . '"';
1867 public static function escapeWildCardString($string) {
1869 // ensure we escape the single characters % and _ which are mysql wild
1870 // card characters and could come in via sortByCharacter
1871 // note that mysql does not escape these characters
1872 if ($string && in_array($string,
1873 array('%', '_', '%%', '_%')
1876 return '\\' . $string;
1879 return self
::escapeString($string);
1883 * Creates a test object, including any required objects it needs via recursion
1884 * createOnly: only create in database, do not store or return the objects (useful for perf testing)
1885 * ONLY USE FOR TESTING
1887 * @param string $daoName
1888 * @param array $params
1889 * @param int $numObjects
1890 * @param bool $createOnly
1892 * @return object|array|NULL
1893 * NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.
1895 public static function createTestObject(
1901 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
1902 // so we re-set here in case
1903 $config = CRM_Core_Config
::singleton();
1904 $config->backtrace
= TRUE;
1906 static $counter = 0;
1907 CRM_Core_DAO
::$_testEntitiesToSkip = array(
1908 'CRM_Core_DAO_Worldregion',
1909 'CRM_Core_DAO_StateProvince',
1910 'CRM_Core_DAO_Country',
1911 'CRM_Core_DAO_Domain',
1912 'CRM_Financial_DAO_FinancialType',
1913 //because valid ones exist & we use pick them due to pseudoconstant can't reliably create & delete these
1916 // Prefer to instantiate BAO's instead of DAO's (when possible)
1917 // so that assignTestValue()/assignTestFK() can be overloaded.
1918 $baoName = str_replace('_DAO_', '_BAO_', $daoName);
1919 if (class_exists($baoName)) {
1920 $daoName = $baoName;
1923 for ($i = 0; $i < $numObjects; ++
$i) {
1926 /** @var CRM_Core_DAO $object */
1927 $object = new $daoName();
1929 $fields = $object->fields();
1930 foreach ($fields as $fieldName => $fieldDef) {
1931 $dbName = $fieldDef['name'];
1932 $FKClassName = CRM_Utils_Array
::value('FKClassName', $fieldDef);
1933 $required = CRM_Utils_Array
::value('required', $fieldDef);
1935 if (CRM_Utils_Array
::value($dbName, $params) !== NULL && !is_array($params[$dbName])) {
1936 $object->$dbName = $params[$dbName];
1939 elseif ($dbName != 'id') {
1940 if ($FKClassName != NULL) {
1941 $object->assignTestFK($fieldName, $fieldDef, $params);
1945 $object->assignTestValue($fieldName, $fieldDef, $counter);
1953 $objects[$i] = $object;
1963 elseif ($numObjects == 1) {
1972 * Deletes the this object plus any dependent objects that are associated with it.
1973 * ONLY USE FOR TESTING
1975 * @param string $daoName
1976 * @param array $params
1978 public static function deleteTestObjects($daoName, $params = array()) {
1979 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
1980 // so we re-set here in case
1981 $config = CRM_Core_Config
::singleton();
1982 $config->backtrace
= TRUE;
1984 $object = new $daoName();
1985 $object->id
= CRM_Utils_Array
::value('id', $params);
1987 $deletions = array(); // array(array(0 => $daoName, 1 => $daoParams))
1988 if ($object->find(TRUE)) {
1990 $fields = $object->fields();
1991 foreach ($fields as $name => $value) {
1993 $dbName = $value['name'];
1995 $FKClassName = CRM_Utils_Array
::value('FKClassName', $value);
1996 $required = CRM_Utils_Array
::value('required', $value);
1997 if ($FKClassName != NULL
1999 && !in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)
2000 && ($required ||
$dbName == 'contact_id')
2001 //I'm a bit stuck on this one - we might need to change the singleValueAlter so that the entities don't share a contact
2002 // to make this test process pass - line below makes pass for now
2003 && $dbName != 'member_of_contact_id'
2005 $deletions[] = array($FKClassName, array('id' => $object->$dbName)); // x
2012 foreach ($deletions as $deletion) {
2013 CRM_Core_DAO
::deleteTestObjects($deletion[0], $deletion[1]);
2018 * Set defaults when creating new entity.
2019 * (don't call this set defaults as already in use with different signature in some places)
2021 * @param array $params
2024 public static function setCreateDefaults(&$params, $defaults) {
2025 if (!empty($params['id'])) {
2028 foreach ($defaults as $key => $value) {
2029 if (!array_key_exists($key, $params) ||
$params[$key] === NULL) {
2030 $params[$key] = $value;
2036 * @param string $prefix
2037 * @param bool $addRandomString
2038 * @param null $string
2042 * @see CRM_Utils_SQL_TempTable
2044 public static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
2045 $tableName = $prefix . "_temp";
2047 if ($addRandomString) {
2049 $tableName .= "_" . $string;
2052 $tableName .= "_" . md5(uniqid('', TRUE));
2060 * @param bool $trigger
2064 public static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
2065 if (\Civi
::settings()->get('logging_no_trigger_permission')) {
2068 // test for create view and trigger permissions and if allowed, add the option to go multilingual
2070 // I'm not sure why we use the getStaticProperty for an error, rather than checking for DB_Error
2071 CRM_Core_TemporaryErrorScope
::ignoreException();
2072 $dao = new CRM_Core_DAO();
2074 $result = $dao->query('CREATE OR REPLACE VIEW civicrm_domain_view AS SELECT * FROM civicrm_domain');
2075 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError') ||
is_a($result, 'DB_Error')) {
2081 $result = $dao->query('CREATE TRIGGER civicrm_domain_trigger BEFORE INSERT ON civicrm_domain FOR EACH ROW BEGIN END');
2082 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError') ||
is_a($result, 'DB_Error')) {
2084 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2089 $dao->query('DROP TRIGGER IF EXISTS civicrm_domain_trigger');
2090 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
2092 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2099 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2100 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
2109 * @param null $message
2110 * @param bool $printDAO
2112 public static function debugPrint($message = NULL, $printDAO = TRUE) {
2113 CRM_Utils_System
::xMemory("{$message}: ");
2116 global $_DB_DATAOBJECT;
2118 foreach (array_keys($_DB_DATAOBJECT['RESULTS']) as $id) {
2119 $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query
;
2121 CRM_Core_Error
::debug('_DB_DATAOBJECT', $q);
2126 * Build a list of triggers via hook and add them to (err, reconcile them
2127 * with) the database.
2129 * @param string $tableName
2130 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2131 * @param bool $force
2136 public static function triggerRebuild($tableName = NULL, $force = FALSE) {
2137 Civi
::service('sql_triggers')->rebuild($tableName, $force);
2141 * Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
2142 * @see http://issues.civicrm.org/jira/browse/CRM-13822
2143 * TODO: Alternative solutions might be
2144 * * Stop using functions and find another way to strip numeric characters from phones
2145 * * Give better error messages (currently a missing fn fatals with "unknown error")
2147 public static function checkSqlFunctionsExist() {
2148 if (!self
::$_checkedSqlFunctionsExist) {
2149 self
::$_checkedSqlFunctionsExist = TRUE;
2150 $dao = CRM_Core_DAO
::executeQuery("SHOW function status WHERE db = database() AND name = 'civicrm_strip_non_numeric'");
2151 if (!$dao->fetch()) {
2152 self
::triggerRebuild();
2158 * Wrapper function to drop triggers.
2160 * @param string $tableName
2161 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2164 public static function dropTriggers($tableName = NULL) {
2165 Civi
::service('sql_triggers')->dropTriggers($tableName);
2169 * @param array $info
2170 * per hook_civicrm_triggerInfo.
2171 * @param string $onlyTableName
2172 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2175 public static function createTriggers(&$info, $onlyTableName = NULL) {
2176 Civi
::service('sql_triggers')->createTriggers($info, $onlyTableName);
2180 * Given a list of fields, create a list of references.
2182 * @param string $className
2183 * BAO/DAO class name.
2184 * @return array<CRM_Core_Reference_Interface>
2186 public static function createReferenceColumns($className) {
2188 $fields = $className::fields();
2189 foreach ($fields as $field) {
2190 if (isset($field['pseudoconstant'], $field['pseudoconstant']['optionGroupName'])) {
2191 $result[] = new CRM_Core_Reference_OptionValue(
2192 $className::getTableName(),
2194 'civicrm_option_value',
2195 CRM_Utils_Array
::value('keyColumn', $field['pseudoconstant'], 'value'),
2196 $field['pseudoconstant']['optionGroupName']
2204 * Find all records which refer to this entity.
2207 * Array of objects referencing this
2209 public function findReferences() {
2210 $links = self
::getReferencesToTable(static::getTableName());
2212 $occurrences = array();
2213 foreach ($links as $refSpec) {
2214 /** @var $refSpec CRM_Core_Reference_Interface */
2215 $daoName = CRM_Core_DAO_AllCoreTables
::getClassForTable($refSpec->getReferenceTable());
2216 $result = $refSpec->findReferences($this);
2218 while ($result->fetch()) {
2219 $obj = new $daoName();
2220 $obj->id
= $result->id
;
2221 $occurrences[] = $obj;
2226 return $occurrences;
2231 * each item has keys:
2235 * - table: string|null SQL table name
2236 * - key: string|null SQL column name
2238 public function getReferenceCounts() {
2239 $links = self
::getReferencesToTable(static::getTableName());
2242 foreach ($links as $refSpec) {
2243 /** @var $refSpec CRM_Core_Reference_Interface */
2244 $count = $refSpec->getReferenceCount($this);
2245 if ($count['count'] != 0) {
2250 foreach (CRM_Core_Component
::getEnabledComponents() as $component) {
2251 /** @var $component CRM_Core_Component_Info */
2252 $counts = array_merge($counts, $component->getReferenceCounts($this));
2254 CRM_Utils_Hook
::referenceCounts($this, $counts);
2260 * List all tables which have hard foreign keys to this table.
2262 * For now, this returns a description of every entity_id/entity_table
2264 * TODO: filter dynamic entity references on the $tableName, based on
2265 * schema metadata in dynamicForeignKey which enumerates a restricted
2266 * set of possible entity_table's.
2268 * @param string $tableName
2269 * Table referred to.
2272 * structure of table and column, listing every table with a
2273 * foreign key reference to $tableName, and the column where the key appears.
2275 public static function getReferencesToTable($tableName) {
2276 $refsFound = array();
2277 foreach (CRM_Core_DAO_AllCoreTables
::getClasses() as $daoClassName) {
2278 $links = $daoClassName::getReferenceColumns();
2279 $daoTableName = $daoClassName::getTableName();
2281 foreach ($links as $refSpec) {
2282 /** @var $refSpec CRM_Core_Reference_Interface */
2283 if ($refSpec->matchesTargetTable($tableName)) {
2284 $refsFound[] = $refSpec;
2292 * Get all references to contact table.
2294 * This includes core tables, custom group tables, tables added by the merge
2295 * hook and the entity_tag table.
2297 * Refer to CRM-17454 for information on the danger of querying the information
2298 * schema to derive this.
2300 public static function getReferencesToContactTable() {
2301 if (isset(\Civi
::$statics[__CLASS__
]) && isset(\Civi
::$statics[__CLASS__
]['contact_references'])) {
2302 return \Civi
::$statics[__CLASS__
]['contact_references'];
2304 $contactReferences = [];
2305 $coreReferences = CRM_Core_DAO
::getReferencesToTable('civicrm_contact');
2306 foreach ($coreReferences as $coreReference) {
2307 if (!is_a($coreReference, 'CRM_Core_Reference_Dynamic')) {
2308 $contactReferences[$coreReference->getReferenceTable()][] = $coreReference->getReferenceKey();
2311 self
::appendCustomTablesExtendingContacts($contactReferences);
2313 // FixME for time being adding below line statically as no Foreign key constraint defined for table 'civicrm_entity_tag'
2314 $contactReferences['civicrm_entity_tag'][] = 'entity_id';
2315 \Civi
::$statics[__CLASS__
]['contact_references'] = $contactReferences;
2316 return \Civi
::$statics[__CLASS__
]['contact_references'];
2320 * Add custom tables that extend contacts to the list of contact references.
2322 * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish
2323 * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples
2324 * - the down side is it is not cached.
2326 * Further changes should be include tests in the CRM_Core_MergerTest class
2327 * to ensure that disabled, subtype, multiple etc groups are still captured.
2329 * @param array $cidRefs
2331 public static function appendCustomTablesExtendingContacts(&$cidRefs) {
2332 $customValueTables = CRM_Core_BAO_CustomGroup
::getAllCustomGroupsByBaseEntity('Contact');
2333 $customValueTables->find();
2334 while ($customValueTables->fetch()) {
2335 $cidRefs[$customValueTables->table_name
] = array('entity_id');
2340 * Lookup the value of a MySQL global configuration variable.
2342 * @param string $name
2343 * E.g. "thread_stack".
2344 * @param mixed $default
2347 public static function getGlobalSetting($name, $default = NULL) {
2348 // Alternatively, SELECT @@GLOBAL.thread_stack, but
2349 // that has been reported to fail under MySQL 5.0 for OS X
2350 $escapedName = self
::escapeString($name);
2351 $dao = CRM_Core_DAO
::executeQuery("SHOW VARIABLES LIKE '$escapedName'");
2352 if ($dao->fetch()) {
2362 * Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
2364 * This is relevant where we want to offer both the ID field and the label field
2365 * as an option, e.g. search builder.
2367 * It is currently limited for optionGroupName for purposes keeping the scope of the
2368 * change small, but is appropriate for other sorts of pseudoconstants.
2370 * @param array $fields
2372 protected static function appendPseudoConstantsToFields(&$fields) {
2373 foreach ($fields as $field) {
2374 if (!empty($field['pseudoconstant']) && !empty($field['pseudoconstant']['optionGroupName'])) {
2375 $fields[$field['pseudoconstant']['optionGroupName']] = array(
2376 'title' => CRM_Core_BAO_OptionGroup
::getTitleByName($field['pseudoconstant']['optionGroupName']),
2377 'name' => $field['pseudoconstant']['optionGroupName'],
2378 'data_type' => CRM_Utils_Type
::T_STRING
,
2385 * Get options for the called BAO object's field.
2387 * This function can be overridden by each BAO to add more logic related to context.
2388 * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
2390 * @param string $fieldName
2391 * @param string $context
2392 * @see CRM_Core_DAO::buildOptionsContext
2393 * @param array $props
2394 * whatever is known about this bao object.
2396 * @return array|bool
2398 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
2399 // If a given bao does not override this function
2400 $baoName = get_called_class();
2401 return CRM_Core_PseudoConstant
::get($baoName, $fieldName, $props, $context);
2405 * Populate option labels for this object's fields.
2407 * @throws exception if called directly on the base class
2409 public function getOptionLabels() {
2410 $fields = $this->fields();
2411 if ($fields === NULL) {
2412 throw new Exception('Cannot call getOptionLabels on CRM_Core_DAO');
2414 foreach ($fields as $field) {
2415 $name = CRM_Utils_Array
::value('name', $field);
2416 if ($name && isset($this->$name)) {
2417 $label = CRM_Core_PseudoConstant
::getLabel(get_class($this), $name, $this->$name);
2418 if ($label !== FALSE) {
2419 // Append 'label' onto the field name
2420 $labelName = $name . '_label';
2421 $this->$labelName = $label;
2428 * Provides documentation and validation for the buildOptions $context param
2430 * @param string $context
2435 public static function buildOptionsContext($context = NULL) {
2437 'get' => "get: all options are returned, even if they are disabled; labels are translated.",
2438 'create' => "create: options are filtered appropriately for the object being created/updated; labels are translated.",
2439 'search' => "search: searchable options are returned; labels are translated.",
2440 'validate' => "validate: all options are returned, even if they are disabled; machine names are used in place of labels.",
2441 'abbreviate' => "abbreviate: enabled options are returned; labels are replaced with abbreviations.",
2442 'match' => "match: enabled options are returned using machine names as keys; labels are translated.",
2444 // Validation: enforce uniformity of this param
2445 if ($context !== NULL && !isset($contexts[$context])) {
2446 throw new Exception("'$context' is not a valid context for buildOptions.");
2452 * @param string $fieldName
2453 * @return bool|array
2455 public function getFieldSpec($fieldName) {
2456 $fields = $this->fields();
2457 $fieldKeys = $this->fieldKeys();
2459 // Support "unique names" as well as sql names
2460 $fieldKey = $fieldName;
2461 if (empty($fields[$fieldKey])) {
2462 $fieldKey = CRM_Utils_Array
::value($fieldName, $fieldKeys);
2464 // If neither worked then this field doesn't exist. Return false.
2465 if (empty($fields[$fieldKey])) {
2468 return $fields[$fieldKey];
2472 * Get SQL where clause for SQL filter syntax input parameters.
2474 * SQL version of api function to assign filters to the DAO based on the syntax
2475 * $field => array('IN' => array(4,6,9))
2477 * $field => array('LIKE' => array('%me%))
2480 * @param string $fieldName
2482 * @param array $filter
2483 * filter to be applied indexed by operator.
2484 * @param string $type
2485 * type of field (not actually used - nor in api @todo ).
2486 * @param string $alias
2487 * alternative field name ('as') @todo- not actually used.
2488 * @param bool $returnSanitisedArray
2489 * Return a sanitised array instead of a clause.
2490 * this is primarily so we can add filters @ the api level to the Query object based fields
2494 * @return NULL|string|array
2495 * a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL
2496 * depending on whether it is supported as yet
2498 public static function createSQLFilter($fieldName, $filter, $type = NULL, $alias = NULL, $returnSanitisedArray = FALSE) {
2499 foreach ($filter as $operator => $criteria) {
2500 if (in_array($operator, self
::acceptedSQLOperators(), TRUE)) {
2501 switch ($operator) {
2505 if (!$returnSanitisedArray) {
2506 return (sprintf('%s %s', $fieldName, $operator));
2509 return (sprintf('%s %s ', $fieldName, $operator));
2513 // ternary operators
2516 if (empty($criteria[0]) ||
empty($criteria[1])) {
2517 throw new Exception("invalid criteria for $operator");
2519 if (!$returnSanitisedArray) {
2520 return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO
::escapeString($criteria[0]), CRM_Core_DAO
::escapeString($criteria[1])));
2523 return NULL; // not yet implemented (tests required to implement)
2530 if (empty($criteria)) {
2531 throw new Exception("invalid criteria for $operator");
2533 $escapedCriteria = array_map(array(
2537 if (!$returnSanitisedArray) {
2538 return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
2540 return $escapedCriteria;
2545 if (!$returnSanitisedArray) {
2546 return (sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO
::escapeString($criteria)));
2549 return NULL; // not yet implemented (tests required to implement)
2557 * @see http://issues.civicrm.org/jira/browse/CRM-9150
2558 * support for other syntaxes is discussed in ticket but being put off for now
2561 public static function acceptedSQLOperators() {
2582 * SQL has a limit of 64 characters on various names:
2583 * table name, trigger name, column name ...
2585 * For custom groups and fields we generated names from user entered input
2586 * which can be longer than this length, this function helps with creating
2587 * strings that meet various criteria.
2589 * @param string $string
2590 * The string to be shortened.
2591 * @param int $length
2592 * The max length of the string.
2594 * @param bool $makeRandom
2598 public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) {
2599 // early return for strings that meet the requirements
2600 if (strlen($string) <= $length) {
2604 // easy return for calls that dont need a randomized uniq string
2606 return substr($string, 0, $length);
2609 // the string is longer than the length and we need a uniq string
2610 // for the same tablename we need the same uniq string every time
2611 // hence we use md5 on the string, which is not random
2612 // we'll append 8 characters to the end of the tableName
2613 $md5string = substr(md5($string), 0, 8);
2614 return substr($string, 0, $length - 8) . "_{$md5string}";
2618 * https://issues.civicrm.org/jira/browse/CRM-17748
2619 * Sets the internal options to be used on a query
2621 * @param array $options
2624 public function setOptions($options) {
2625 if (is_array($options)) {
2626 $this->_options
= $options;
2631 * https://issues.civicrm.org/jira/browse/CRM-17748
2632 * wrapper to pass internal DAO options down to DB_mysql/DB_Common level
2634 * @param array $options
2637 protected function _setDBOptions($options) {
2638 global $_DB_DATAOBJECT;
2640 if (is_array($options) && count($options)) {
2641 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
2642 foreach ($options as $option_name => $option_value) {
2643 $conn->setOption($option_name, $option_value);
2650 * @param array $params
2652 public function setApiFilter(&$params) {
2656 * Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
2658 * Return format is in the form of fieldname => clauses starting with an operator. e.g.:
2661 * 'location_type_id' => array('IS NOT NULL', 'IN (1,2,3)')
2665 * Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values.
2669 public function addSelectWhereClause() {
2671 $fields = $this->fields();
2672 foreach ($fields as $fieldName => $field) {
2673 // Clause for contact-related entities like Email, Relationship, etc.
2674 if (strpos($fieldName, 'contact_id') === 0 && CRM_Utils_Array
::value('FKClassName', $field) == 'CRM_Contact_DAO_Contact') {
2675 $clauses[$fieldName] = CRM_Utils_SQL
::mergeSubquery('Contact');
2677 // Clause for an entity_table/entity_id combo
2678 if ($fieldName == 'entity_id' && isset($fields['entity_table'])) {
2679 $relatedClauses = array();
2680 $relatedEntities = $this->buildOptions('entity_table', 'get');
2681 foreach ((array) $relatedEntities as $table => $ent) {
2683 $ent = CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table));
2684 $subquery = CRM_Utils_SQL
::mergeSubquery($ent);
2686 $relatedClauses[] = "(entity_table = '$table' AND entity_id " . implode(' AND entity_id ', $subquery) . ")";
2689 $relatedClauses[] = "(entity_table = '$table')";
2693 if ($relatedClauses) {
2694 $clauses['id'] = 'IN (SELECT id FROM `' . $this->tableName() . '` WHERE (' . implode(') OR (', $relatedClauses) . '))';
2698 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
2703 * This returns the final permissioned query string for this entity
2705 * With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
2707 * @param string $tableAlias
2710 public static function getSelectWhereClause($tableAlias = NULL) {
2711 $bao = new static();
2712 if ($tableAlias === NULL) {
2713 $tableAlias = $bao->tableName();
2716 foreach ((array) $bao->addSelectWhereClause() as $field => $vals) {
2717 $clauses[$field] = NULL;
2719 $clauses[$field] = "(`$tableAlias`.`$field` IS NULL OR (`$tableAlias`.`$field` " . implode(" AND `$tableAlias`.`$field` ", (array) $vals) . '))';
2726 * ensure database name is 'safe', i.e. only contains word characters (includes underscores)
2727 * and dashes, and contains at least one [a-z] case insenstive.
2733 public static function requireSafeDBName($database) {
2736 "/^[\w\-]*[a-z]+[\w\-]*$/i",
2740 if (empty($matches)) {
2747 * Transform an array to a serialized string for database storage.
2749 * @param array|NULL $value
2750 * @param $serializationType
2751 * @return string|NULL
2752 * @throws \Exception
2754 public static function serializeField($value, $serializationType) {
2755 if ($value === NULL) {
2758 switch ($serializationType) {
2759 case self
::SERIALIZE_SEPARATOR_BOOKEND
:
2760 return $value === array() ?
'' : CRM_Utils_Array
::implodePadded($value);
2762 case self
::SERIALIZE_SEPARATOR_TRIMMED
:
2763 return is_array($value) ?
implode(self
::VALUE_SEPARATOR
, $value) : $value;
2765 case self
::SERIALIZE_JSON
:
2766 return is_array($value) ?
json_encode($value) : $value;
2768 case self
::SERIALIZE_PHP
:
2769 return is_array($value) ?
serialize($value) : $value;
2771 case self
::SERIALIZE_COMMA
:
2772 return is_array($value) ?
implode(',', $value) : $value;
2775 throw new Exception('Unknown serialization method for field.');
2780 * Transform a serialized string from the database into an array.
2782 * @param string|null $value
2783 * @param $serializationType
2784 * @return array|null
2785 * @throws \Exception
2787 public static function unSerializeField($value, $serializationType) {
2788 if ($value === NULL) {
2791 if ($value === '') {
2794 switch ($serializationType) {
2795 case self
::SERIALIZE_SEPARATOR_BOOKEND
:
2796 return (array) CRM_Utils_Array
::explodePadded($value);
2798 case self
::SERIALIZE_SEPARATOR_TRIMMED
:
2799 return explode(self
::VALUE_SEPARATOR
, trim($value));
2801 case self
::SERIALIZE_JSON
:
2802 return strlen($value) ?
json_decode($value, TRUE) : array();
2804 case self
::SERIALIZE_PHP
:
2805 return strlen($value) ?
unserialize($value) : array();
2807 case self
::SERIALIZE_COMMA
:
2808 return explode(',', trim(str_replace(', ', '', $value)));
2811 throw new Exception('Unknown serialization method for field.');