3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
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
{
55 static $_nullObject = NULL;
60 static $_nullArray = array();
62 static $_dbColumnValueCache = NULL;
63 const NOT_NULL
= 1, IS_NULL
= 2,
65 VALUE_SEPARATOR
= "\ 1",
66 BULK_INSERT_COUNT
= 200,
67 BULK_INSERT_HIGH_COUNT
= 200,
68 QUERY_FORMAT_WILDCARD
= 1,
69 QUERY_FORMAT_NO_QUOTES
= 2,
72 * Serialized string separated by and bookended with VALUE_SEPARATOR
74 SERIALIZE_SEPARATOR_BOOKEND
= 1,
76 * @deprecated format separated by VALUE_SEPARATOR
78 SERIALIZE_SEPARATOR_TRIMMED
= 2,
80 * Recommended serialization format
84 * @deprecated format using php serialize()
88 * Comma separated string, no quotes, no spaces
93 * Define entities that shouldn't be created or deleted when creating/ deleting
94 * test objects - this prevents world regions, countries etc from being added / deleted
97 static $_testEntitiesToSkip = array();
99 * The factory class for this application.
102 static $_factory = NULL;
104 static $_checkedSqlFunctionsExist = FALSE;
107 * https://issues.civicrm.org/jira/browse/CRM-17748
108 * internal variable for DAO to hold per-query settings
110 protected $_options = array();
115 * @return \CRM_Core_DAO
117 public function __construct() {
119 $this->__table
= $this->getTableName();
123 * Empty definition for virtual function.
125 public static function getTableName() {
130 * Initialize the DAO object.
133 * The database connection string.
135 public static function init($dsn) {
136 Civi
::$statics[__CLASS__
]['init'] = 1;
137 $options = &PEAR
::getStaticProperty('DB_DataObject', 'options');
138 $options['database'] = $dsn;
139 if (defined('CIVICRM_DAO_DEBUG')) {
140 self
::DebugLevel(CIVICRM_DAO_DEBUG
);
142 $factory = new CRM_Contact_DAO_Factory();
143 CRM_Core_DAO
::setFactory($factory);
144 $currentModes = CRM_Utils_SQL
::getSqlModes();
145 if (CRM_Utils_Constant
::value('CIVICRM_MYSQL_STRICT', CRM_Utils_System
::isDevelopment())) {
146 if (CRM_Utils_SQL
::supportsFullGroupBy() && !in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL
::isGroupByModeInDefault()) {
147 $currentModes[] = 'ONLY_FULL_GROUP_BY';
149 if (!in_array('STRICT_TRANS_TABLES', $currentModes)) {
150 $currentModes = array_merge(array('STRICT_TRANS_TABLES'), $currentModes);
152 CRM_Core_DAO
::executeQuery("SET SESSION sql_mode = %1", array(1 => array(implode(',', $currentModes), 'String')));
154 CRM_Core_DAO
::executeQuery('SET NAMES utf8');
155 CRM_Core_DAO
::executeQuery('SET @uniqueID = %1', array(1 => array(CRM_Utils_Request
::id(), 'String')));
161 public static function getConnection() {
162 global $_DB_DATAOBJECT;
163 $dao = new CRM_Core_DAO();
164 return $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5
];
168 * @param string $fieldName
170 * @param array $params
172 protected function assignTestFK($fieldName, $fieldDef, $params) {
173 $required = CRM_Utils_Array
::value('required', $fieldDef);
174 $FKClassName = CRM_Utils_Array
::value('FKClassName', $fieldDef);
175 $dbName = $fieldDef['name'];
176 $daoName = str_replace('_BAO_', '_DAO_', get_class($this));
178 // skip the FK if it is not required
179 // if it's contact id we should create even if not required
180 // we'll have a go @ fetching first though
181 // we WILL create campaigns though for so tests with a campaign pseudoconstant will complete
182 if ($FKClassName === 'CRM_Campaign_DAO_Campaign' && $daoName != $FKClassName) {
185 if (!$required && $dbName != 'contact_id') {
186 $fkDAO = new $FKClassName();
187 if ($fkDAO->find(TRUE)) {
188 $this->$dbName = $fkDAO->id
;
193 elseif (in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)) {
194 $depObject = new $FKClassName();
195 $depObject->find(TRUE);
196 $this->$dbName = $depObject->id
;
199 elseif ($daoName == 'CRM_Member_DAO_MembershipType' && $fieldName == 'member_of_contact_id') {
200 // FIXME: the fields() metadata is not specific enough
201 $depObject = CRM_Core_DAO
::createTestObject($FKClassName, array('contact_type' => 'Organization'));
202 $this->$dbName = $depObject->id
;
206 //if it is required we need to generate the dependency object first
207 $depObject = CRM_Core_DAO
::createTestObject($FKClassName, CRM_Utils_Array
::value($dbName, $params, 1));
208 $this->$dbName = $depObject->id
;
214 * Generate and assign an arbitrary value to a field of a test object.
216 * @param string $fieldName
217 * @param array $fieldDef
218 * @param int $counter
219 * The globally-unique ID of the test object.
221 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
222 $dbName = $fieldDef['name'];
223 $daoName = get_class($this);
226 if (!$handled && $dbName == 'contact_sub_type') {
227 //coming up with a rule to set this is too complex let's not set it
231 // Pick an option value if needed
232 if (!$handled && $fieldDef['type'] !== CRM_Utils_Type
::T_BOOLEAN
) {
233 $options = $daoName::buildOptions($dbName, 'create');
235 $this->$dbName = key($options);
241 switch ($fieldDef['type']) {
242 case CRM_Utils_Type
::T_INT
:
243 case CRM_Utils_Type
::T_FLOAT
:
244 case CRM_Utils_Type
::T_MONEY
:
245 if (isset($fieldDef['precision'])) {
246 // $object->$dbName = CRM_Utils_Number::createRandomDecimal($value['precision']);
247 $this->$dbName = CRM_Utils_Number
::createTruncatedDecimal($counter, $fieldDef['precision']);
250 $this->$dbName = $counter;
254 case CRM_Utils_Type
::T_BOOLEAN
:
255 if (isset($fieldDef['default'])) {
256 $this->$dbName = $fieldDef['default'];
258 elseif ($fieldDef['name'] == 'is_deleted' ||
$fieldDef['name'] == 'is_test') {
266 case CRM_Utils_Type
::T_DATE
:
267 case CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
:
268 $this->$dbName = '19700101';
269 if ($dbName == 'end_date') {
270 // put this in the future
271 $this->$dbName = '20200101';
275 case CRM_Utils_Type
::T_TIMESTAMP
:
276 $this->$dbName = '19700201000000';
279 case CRM_Utils_Type
::T_TIME
:
280 CRM_Core_Error
::fatal("T_TIME shouldn't be used.");
281 //$object->$dbName='000000';
283 case CRM_Utils_Type
::T_CCNUM
:
284 $this->$dbName = '4111 1111 1111 1111';
287 case CRM_Utils_Type
::T_URL
:
288 $this->$dbName = 'http://www.civicrm.org';
291 case CRM_Utils_Type
::T_STRING
:
292 case CRM_Utils_Type
::T_BLOB
:
293 case CRM_Utils_Type
::T_MEDIUMBLOB
:
294 case CRM_Utils_Type
::T_TEXT
:
295 case CRM_Utils_Type
::T_LONGTEXT
:
296 case CRM_Utils_Type
::T_EMAIL
:
298 // WAS: if (isset($value['enumValues'])) {
299 // TODO: see if this works with all pseudoconstants
300 if (isset($fieldDef['pseudoconstant'], $fieldDef['pseudoconstant']['callback'])) {
301 if (isset($fieldDef['default'])) {
302 $this->$dbName = $fieldDef['default'];
305 $options = CRM_Core_PseudoConstant
::get($daoName, $fieldName);
306 if (is_array($options)) {
307 $this->$dbName = $options[0];
310 $defaultValues = explode(',', $options);
311 $this->$dbName = $defaultValues[0];
316 $this->$dbName = $dbName . '_' . $counter;
317 $maxlength = CRM_Utils_Array
::value('maxlength', $fieldDef);
318 if ($maxlength > 0 && strlen($this->$dbName) > $maxlength) {
319 $this->$dbName = substr($this->$dbName, 0, $fieldDef['maxlength']);
327 * Reset the DAO object.
329 * DAO is kinda crappy in that there is an unwritten rule of one query per DAO.
331 * We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution
333 public function reset() {
335 foreach (array_keys($this->table()) as $field) {
336 unset($this->$field);
340 * reset the various DB_DAO structures manually
342 $this->_query
= array();
349 * @param string $tableName
353 public static function getLocaleTableName($tableName) {
356 $tables = CRM_Core_I18n_Schema
::schemaStructureTables();
357 if (in_array($tableName, $tables)) {
358 return $tableName . $dbLocale;
365 * Execute a query by the current DAO, localizing it along the way (if needed).
367 * @param string $query
368 * The SQL query for execution.
369 * @param bool $i18nRewrite
370 * Whether to rewrite the query.
373 * the current DAO object after the query execution
375 public function query($query, $i18nRewrite = TRUE) {
376 // rewrite queries that should use $dbLocale-based views for multi-language installs
377 global $dbLocale, $_DB_DATAOBJECT;
379 if (empty($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
])) {
380 // Will force connection to be populated per CRM-20541.
384 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
385 $orig_options = $conn->options
;
386 $this->_setDBOptions($this->_options
);
388 if ($i18nRewrite and $dbLocale) {
389 $query = CRM_Core_I18n_Schema
::rewriteQuery($query);
392 $ret = parent
::query($query);
394 $this->_setDBOptions($orig_options);
399 * Static function to set the factory instance for this class.
401 * @param object $factory
402 * The factory application object.
404 public static function setFactory(&$factory) {
405 self
::$_factory = &$factory;
409 * Factory method to instantiate a new object from a table name.
411 * @param string $table
412 * @return \DataObject|\PEAR_Error
414 public function factory($table = '') {
415 if (!isset(self
::$_factory)) {
416 return parent
::factory($table);
419 return self
::$_factory->create($table);
423 * Initialization for all DAO objects. Since we access DB_DO programatically
424 * we need to set the links manually.
426 public function initialize() {
428 if (empty(Civi
::$statics[__CLASS__
]['init'])) {
429 // CRM_Core_DAO::init() must be called before CRM_Core_DAO->initialize().
430 // This occurs very early in bootstrap - error handlers may not be wired up.
431 echo "Inconsistent system initialization sequence. Premature access of (" . get_class($this) . ")";
432 CRM_Utils_System
::civiExit();
437 * Defines the default key as 'id'.
441 public function keys() {
450 * Tells DB_DataObject which keys use autoincrement.
451 * 'id' is autoincrementing by default.
456 public function sequenceKey() {
457 static $sequenceKeys;
458 if (!isset($sequenceKeys)) {
459 $sequenceKeys = array('id', TRUE);
461 return $sequenceKeys;
465 * Returns list of FK relationships.
469 * Array of CRM_Core_Reference_Interface
471 public static function getReferenceColumns() {
476 * Returns all the column names of this table.
481 public static function &fields() {
487 * Get/set an associative array of table columns
492 public function table() {
493 $fields = $this->fields();
497 foreach ($fields as $name => $value) {
498 $table[$value['name']] = $value['type'];
499 if (!empty($value['required'])) {
500 $table[$value['name']] +
= self
::DB_DAO_NOTNULL
;
513 * @return CRM_Core_DAO
515 public function save($hook = TRUE) {
516 if (!empty($this->id
)) {
520 $event = new \Civi\Core\DAO\Event\
PostUpdate($this);
521 \Civi
::service('dispatcher')->dispatch("civi.dao.postUpdate", $event);
528 $event = new \Civi\Core\DAO\Event\
PostUpdate($this);
529 \Civi
::service('dispatcher')->dispatch("civi.dao.postInsert", $event);
535 CRM_Utils_Hook
::postSave($this);
542 * Deletes items from table which match current objects variables.
544 * Returns the true on success
548 * Designed to be extended
550 * $object = new mytable();
552 * echo $object->delete(); // builds a conditon
554 * $object = new mytable();
555 * $object->whereAdd('age > 12');
557 * $object->orderBy('age DESC');
558 * $object->delete(true); // dont use object vars, use the conditions, limit and order.
560 * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
561 * we will build the condition only using the whereAdd's. Default is to
562 * build the condition only using the object parameters.
564 * * @return mixed Int (No. of rows affected) on success, false on failure, 0 on no data affected
566 public function delete($useWhere = FALSE) {
567 $preEvent = new \Civi\Core\DAO\Event\
PreDelete($this);
568 \Civi
::service('dispatcher')->dispatch("civi.dao.preDelete", $preEvent);
570 $result = parent
::delete($useWhere);
572 $event = new \Civi\Core\DAO\Event\
PostDelete($this, $result);
573 \Civi
::service('dispatcher')->dispatch("civi.dao.postDelete", $event);
580 * @param bool $created
582 public function log($created = FALSE) {
585 if (!$this->getLog()) {
590 $session = CRM_Core_Session
::singleton();
591 $cid = $session->get('userID');
594 // return is we dont have handle to FK
599 $dao = new CRM_Core_DAO_Log();
600 $dao->entity_table
= $this->getTableName();
601 $dao->entity_id
= $this->id
;
602 $dao->modified_id
= $cid;
603 $dao->modified_date
= date("YmdHis");
608 * Given an associative array of name/value pairs, extract all the values
609 * that belong to this object and initialize the object with said values
611 * @param array $params
612 * (reference ) associative array of name/value pairs.
613 * @param bool $serializeArrays
614 * Should arrays that are passed in be serialised according to the metadata.
615 * Eventually this should be always true / gone, but in the interests of caution
616 * it is being grandfathered in. In general an array is not valid on the DAO
617 * but there may be instances where this function is called & then some handling
618 * takes place on the would-be array.
621 * Did we copy all null values into the object
623 public function copyValues(&$params, $serializeArrays = FALSE) {
624 $fields = $this->fields();
626 foreach ($fields as $name => $value) {
627 $dbName = $value['name'];
628 if (array_key_exists($dbName, $params)) {
629 $pValue = $params[$dbName];
632 elseif (array_key_exists($name, $params)) {
633 $pValue = $params[$name];
640 // if there is no value then make the variable NULL
642 if ($pValue === '') {
643 $this->$dbName = 'null';
645 elseif ($serializeArrays && is_array($pValue) && !empty($value['serialize'])) {
646 $this->$dbName = CRM_Core_DAO
::serializeField($pValue, $value['serialize']);
650 if (!$serializeArrays && is_array($pValue) && !empty($value['serialize'])) {
651 Civi
::log()->warning(ts('use copyParams to serialize arrays (' . __CLASS__
. '.' . $name . ')'), ['civi.tag' => 'deprecated']);
653 $this->$dbName = $pValue;
662 * Store all the values from this object in an associative array
663 * this is a destructive store, calling function is responsible
664 * for keeping sanity of id's.
666 * @param object $object
667 * The object that we are extracting data from.
668 * @param array $values
669 * (reference ) associative array of name/value pairs.
671 public static function storeValues(&$object, &$values) {
672 $fields = $object->fields();
673 foreach ($fields as $name => $value) {
674 $dbName = $value['name'];
675 if (isset($object->$dbName) && $object->$dbName !== 'null') {
676 $values[$dbName] = $object->$dbName;
677 if ($name != $dbName) {
678 $values[$name] = $object->$dbName;
685 * Create an attribute for this specific field. We only do this for strings and text
687 * @param array $field
688 * The field under task.
691 * the attributes for the object
693 public static function makeAttribute($field) {
695 if (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_STRING
) {
696 $maxLength = CRM_Utils_Array
::value('maxlength', $field);
697 $size = CRM_Utils_Array
::value('size', $field);
698 if ($maxLength ||
$size) {
699 $attributes = array();
701 $attributes['maxlength'] = $maxLength;
704 $attributes['size'] = $size;
709 elseif (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_TEXT
) {
710 $rows = CRM_Utils_Array
::value('rows', $field);
714 $cols = CRM_Utils_Array
::value('cols', $field);
719 $attributes = array();
720 $attributes['rows'] = $rows;
721 $attributes['cols'] = $cols;
724 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
) {
725 $attributes['size'] = 6;
726 $attributes['maxlength'] = 14;
734 * Get the size and maxLength attributes for this text field.
735 * (or for all text fields) in the DAO object.
737 * @param string $class
739 * @param string $fieldName
740 * Field that i'm interested in or null if.
741 * you want the attributes for all DAO text fields
744 * assoc array of name => attribute pairs
746 public static function getAttribute($class, $fieldName = NULL) {
747 $object = new $class();
748 $fields = $object->fields();
749 if ($fieldName != NULL) {
750 $field = CRM_Utils_Array
::value($fieldName, $fields);
751 return self
::makeAttribute($field);
754 $attributes = array();
755 foreach ($fields as $name => $field) {
756 $attribute = self
::makeAttribute($field);
758 $attributes[$name] = $attribute;
762 if (!empty($attributes)) {
770 * Check if there is a record with the same name in the db.
772 * @param string $value
773 * The value of the field we are checking.
774 * @param string $daoName
775 * The dao object name.
776 * @param string $daoID
777 * The id of the object being updated. u can change your name.
778 * as long as there is no conflict
779 * @param string $fieldName
780 * The name of the field in the DAO.
782 * @param string $domainID
783 * The id of the domain. Object exists only for the given domain.
786 * true if object exists
788 public static function objectExists($value, $daoName, $daoID, $fieldName = 'name', $domainID = NULL) {
789 $object = new $daoName();
790 $object->$fieldName = $value;
792 $object->domain_id
= $domainID;
795 if ($object->find(TRUE)) {
796 return ($daoID && $object->id
== $daoID) ?
TRUE : FALSE;
804 * Check if there is a given column in a specific table.
806 * @param string $tableName
807 * @param string $columnName
808 * @param bool $i18nRewrite
809 * Whether to rewrite the query on multilingual setups.
812 * true if exists, else false
814 public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
820 $params = array(1 => array($columnName, 'String'));
821 $dao = CRM_Core_DAO
::executeQuery($query, $params, TRUE, NULL, FALSE, $i18nRewrite);
822 $result = $dao->fetch() ?
TRUE : FALSE;
828 * Scans all the tables using a slow query and table name.
832 public static function getTableNames() {
833 $dao = CRM_Core_DAO
::executeQuery(
835 FROM information_schema.TABLES
836 WHERE TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
837 AND TABLE_NAME LIKE 'civicrm_%'
838 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
839 AND TABLE_NAME NOT LIKE '%_temp%'
842 while ($dao->fetch()) {
843 $values[] = $dao->TABLE_NAME
;
850 * @param int $maxTablesToCheck
854 public static function isDBMyISAM($maxTablesToCheck = 10) {
855 return CRM_Core_DAO
::singleValueQuery(
857 FROM information_schema.TABLES
858 WHERE ENGINE = 'MyISAM'
859 AND TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
860 AND TABLE_NAME LIKE 'civicrm_%'
861 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
862 AND TABLE_NAME NOT LIKE '%_temp%'
867 * Get the name of the CiviCRM database.
871 public static function getDatabaseName() {
872 $daoObj = new CRM_Core_DAO();
873 return $daoObj->database();
877 * Checks if a constraint exists for a specified table.
879 * @param string $tableName
880 * @param string $constraint
883 * true if constraint exists, false otherwise
885 public static function checkConstraintExists($tableName, $constraint) {
886 static $show = array();
888 if (!array_key_exists($tableName, $show)) {
889 $query = "SHOW CREATE TABLE $tableName";
890 $dao = CRM_Core_DAO
::executeQuery($query);
892 if (!$dao->fetch()) {
893 CRM_Core_Error
::fatal();
897 $show[$tableName] = $dao->Create_Table
;
900 return preg_match("/\b$constraint\b/i", $show[$tableName]) ?
TRUE : FALSE;
904 * Checks if CONSTRAINT keyword exists for a specified table.
906 * @param array $tables
911 * true if CONSTRAINT keyword exists, false otherwise
913 public static function schemaRequiresRebuilding($tables = array("civicrm_contact")) {
915 foreach ($tables as $tableName) {
916 if (!array_key_exists($tableName, $show)) {
917 $query = "SHOW CREATE TABLE $tableName";
918 $dao = CRM_Core_DAO
::executeQuery($query);
920 if (!$dao->fetch()) {
921 CRM_Core_Error
::fatal();
925 $show[$tableName] = $dao->Create_Table
;
928 $result = preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]) ?
TRUE : FALSE;
929 if ($result == TRUE) {
940 * Checks if the FK constraint name is in the format 'FK_tableName_columnName'
941 * for a specified column of a table.
943 * @param string $tableName
944 * @param string $columnName
947 * true if in format, false otherwise
949 public static function checkFKConstraintInFormat($tableName, $columnName) {
950 static $show = array();
952 if (!array_key_exists($tableName, $show)) {
953 $query = "SHOW CREATE TABLE $tableName";
954 $dao = CRM_Core_DAO
::executeQuery($query);
956 if (!$dao->fetch()) {
957 CRM_Core_Error
::fatal();
961 $show[$tableName] = $dao->Create_Table
;
963 $constraint = "`FK_{$tableName}_{$columnName}`";
964 $pattern = "/\bCONSTRAINT\b\s+%s\s+\bFOREIGN\s+KEY\b\s/i";
965 return preg_match(sprintf($pattern, $constraint), $show[$tableName]) ?
TRUE : FALSE;
969 * Check whether a specific column in a specific table has always the same value.
971 * @param string $tableName
972 * @param string $columnName
973 * @param string $columnValue
976 * true if the value is always $columnValue, false otherwise
978 public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
979 $query = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'";
980 $dao = CRM_Core_DAO
::executeQuery($query);
981 $result = $dao->fetch() ?
FALSE : TRUE;
987 * Check whether a specific column in a specific table is always NULL.
989 * @param string $tableName
990 * @param string $columnName
993 * true if if the value is always NULL, false otherwise
995 public static function checkFieldIsAlwaysNull($tableName, $columnName) {
996 $query = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL";
997 $dao = CRM_Core_DAO
::executeQuery($query);
998 $result = $dao->fetch() ?
FALSE : TRUE;
1004 * Check if there is a given table in the database.
1006 * @param string $tableName
1009 * true if exists, else false
1011 public static function checkTableExists($tableName) {
1016 $params = array(1 => array($tableName, 'String'));
1018 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1019 $result = $dao->fetch() ?
TRUE : FALSE;
1029 public function checkVersion($version) {
1034 $dbVersion = CRM_Core_DAO
::singleValueQuery($query);
1035 return trim($version) == trim($dbVersion) ?
TRUE : FALSE;
1039 * Find a DAO object for the given ID and return it.
1042 * Id of the DAO object being searched for.
1044 * @return CRM_Core_DAO
1045 * Object of the type of the class that called this function.
1049 public static function findById($id) {
1050 $object = new static();
1052 if (!$object->find(TRUE)) {
1053 throw new Exception("Unable to find a " . get_called_class() . " with id {$id}.");
1059 * Returns all results as array-encoded records.
1063 public function fetchAll() {
1065 while ($this->fetch()) {
1066 $result[] = $this->toArray();
1072 * Returns a singular value.
1074 * @return mixed|NULL
1076 public function fetchValue() {
1077 $result = $this->getDatabaseResult();
1078 $row = $result->fetchRow();
1088 * Get all the result records as mapping between columns.
1090 * @param string $keyColumn
1092 * @param string $valueColumn
1095 * Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]
1097 public function fetchMap($keyColumn, $valueColumn) {
1099 while ($this->fetch()) {
1100 $result[$this->{$keyColumn}] = $this->{$valueColumn};
1106 * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
1108 * @param string $daoName
1109 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1110 * @param int $searchValue
1111 * Value of the column you want to search by.
1112 * @param string $returnColumn
1113 * Name of the column you want to GET the value of.
1114 * @param string $searchColumn
1115 * Name of the column you want to search by.
1116 * @param bool $force
1117 * Skip use of the cache.
1119 * @return string|null
1120 * Value of $returnColumn in the retrieved record
1122 public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
1124 empty($searchValue) ||
1125 trim(strtolower($searchValue)) == 'null'
1127 // adding this here since developers forget to check for an id
1128 // or for the 'null' (which is a bad DAO kludge)
1129 // and hence we get the first value in the db
1130 CRM_Core_Error
::fatal();
1133 $cacheKey = "{$daoName}:{$searchValue}:{$returnColumn}:{$searchColumn}";
1134 if (self
::$_dbColumnValueCache === NULL) {
1135 self
::$_dbColumnValueCache = array();
1138 if (!array_key_exists($cacheKey, self
::$_dbColumnValueCache) ||
$force) {
1139 $object = new $daoName();
1140 $object->$searchColumn = $searchValue;
1141 $object->selectAdd();
1142 $object->selectAdd($returnColumn);
1145 if ($object->find(TRUE)) {
1146 $result = $object->$returnColumn;
1150 self
::$_dbColumnValueCache[$cacheKey] = $result;
1152 return self
::$_dbColumnValueCache[$cacheKey];
1156 * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
1158 * @param string $daoName
1159 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1160 * @param int $searchValue
1161 * Value of the column you want to search by.
1162 * @param string $setColumn
1163 * Name of the column you want to SET the value of.
1164 * @param string $setValue
1165 * SET the setColumn to this value.
1166 * @param string $searchColumn
1167 * Name of the column you want to search by.
1170 * true if we found and updated the object, else false
1172 public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
1173 $object = new $daoName();
1174 $object->selectAdd();
1175 $object->selectAdd("$searchColumn, $setColumn");
1176 $object->$searchColumn = $searchValue;
1178 if ($object->find(TRUE)) {
1179 $object->$setColumn = $setValue;
1180 if ($object->save()) {
1191 * @param array|object $sort either array or CRM_Utils_Sort
1192 * @param string $default
1193 * Default sort value.
1197 public static function getSortString($sort, $default = NULL) {
1198 // check if sort is of type CRM_Utils_Sort
1199 if (is_a($sort, 'CRM_Utils_Sort')) {
1200 return $sort->orderBy();
1205 // is it an array specified as $field => $sortDirection ?
1207 foreach ($sort as $k => $v) {
1208 $sortString .= "$k $v,";
1210 return rtrim($sortString, ',');
1216 * Fetch object based on array of properties.
1218 * @param string $daoName
1219 * Name of the dao object.
1220 * @param array $params
1221 * (reference ) an assoc array of name/value pairs.
1222 * @param array $defaults
1223 * (reference ) an assoc array to hold the flattened values.
1224 * @param array $returnProperities
1225 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1228 * an object of type referenced by daoName
1230 public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
1231 $object = new $daoName();
1232 $object->copyValues($params);
1234 // return only specific fields if returnproperties are sent
1235 if (!empty($returnProperities)) {
1236 $object->selectAdd();
1237 $object->selectAdd(implode(',', $returnProperities));
1240 if ($object->find(TRUE)) {
1241 self
::storeValues($object, $defaults);
1248 * Delete the object records that are associated with this contact.
1250 * @param string $daoName
1251 * Name of the dao object.
1252 * @param int $contactId
1253 * Id of the contact to delete.
1255 public static function deleteEntityContact($daoName, $contactId) {
1256 $object = new $daoName();
1258 $object->entity_table
= 'civicrm_contact';
1259 $object->entity_id
= $contactId;
1264 * Execute an unbuffered query.
1266 * This is a wrapper around new functionality exposed with CRM-17748.
1268 * @param string $query query to be executed
1270 * @param array $params
1271 * @param bool $abort
1272 * @param null $daoName
1273 * @param bool $freeDAO
1274 * @param bool $i18nRewrite
1275 * @param bool $trapException
1277 * @return CRM_Core_DAO
1278 * Object that points to an unbuffered result set
1280 static public function executeUnbufferedQuery(
1286 $i18nRewrite = TRUE,
1287 $trapException = FALSE
1290 return self
::executeQuery(
1298 array('result_buffering' => 0)
1305 * @param string $query
1306 * Query to be executed.
1308 * @param array $params
1309 * @param bool $abort
1310 * @param null $daoName
1311 * @param bool $freeDAO
1312 * @param bool $i18nRewrite
1313 * @param bool $trapException
1314 * @param array $options
1316 * @return CRM_Core_DAO|object
1317 * object that holds the results of the query
1318 * NB - if this is defined as just returning a DAO phpstorm keeps pointing
1319 * out all the properties that are not part of the DAO
1321 public static function &executeQuery(
1327 $i18nRewrite = TRUE,
1328 $trapException = FALSE,
1331 $queryStr = self
::composeQuery($query, $params, $abort);
1334 $dao = new CRM_Core_DAO();
1337 $dao = new $daoName();
1340 if ($trapException) {
1341 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
1344 if ($dao->isValidOption($options)) {
1345 $dao->setOptions($options);
1348 $result = $dao->query($queryStr, $i18nRewrite);
1350 // since it is unbuffered, ($dao->N==0) is true. This blocks the standard fetch() mechanism.
1351 if (CRM_Utils_Array
::value('result_buffering', $options) === 0) {
1355 if (is_a($result, 'DB_Error')) {
1360 preg_match('/^(insert|update|delete|create|drop|replace)/i', $queryStr)
1362 // we typically do this for insert/update/delete statements OR if explicitly asked to
1370 * Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
1372 * @param array $options
1375 * Provided options are valid
1377 public function isValidOption($options) {
1379 $validOptions = array(
1386 if (empty($options)) {
1390 foreach (array_keys($options) as $option) {
1391 if (!in_array($option, $validOptions)) {
1401 * Execute a query and get the single result.
1403 * @param string $query
1404 * Query to be executed.
1405 * @param array $params
1406 * @param bool $abort
1407 * @param bool $i18nRewrite
1408 * @return string|null
1409 * the result of the query if any
1412 public static function &singleValueQuery(
1418 $queryStr = self
::composeQuery($query, $params, $abort);
1420 static $_dao = NULL;
1423 $_dao = new CRM_Core_DAO();
1426 $_dao->query($queryStr, $i18nRewrite);
1428 $result = $_dao->getDatabaseResult();
1431 $row = $result->fetchRow();
1441 * Compose the query by merging the parameters into it.
1443 * @param string $query
1444 * @param array $params
1445 * @param bool $abort
1450 public static function composeQuery($query, $params, $abort = TRUE) {
1452 foreach ($params as $key => $item) {
1453 if (is_numeric($key)) {
1454 if (CRM_Utils_Type
::validate($item[0], $item[1]) !== NULL) {
1455 $item[0] = self
::escapeString($item[0]);
1456 if ($item[1] == 'String' ||
1457 $item[1] == 'Memo' ||
1460 // Support class constants stipulating wildcard characters and/or
1461 // non-quoting of strings. Also support legacy code which may be
1462 // passing in TRUE or 1 for $item[2], which used to indicate the
1463 // use of wildcard characters.
1464 if (!empty($item[2])) {
1465 if ($item[2] & CRM_Core_DAO
::QUERY_FORMAT_WILDCARD ||
$item[2] === TRUE) {
1466 $item[0] = "'%{$item[0]}%'";
1468 elseif (!($item[2] & CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
)) {
1469 $item[0] = "'{$item[0]}'";
1473 $item[0] = "'{$item[0]}'";
1477 if (($item[1] == 'Date' ||
$item[1] == 'Timestamp') &&
1478 strlen($item[0]) == 0
1483 $tr['%' . $key] = $item[0];
1486 CRM_Core_Error
::fatal("{$item[0]} is not of type {$item[1]}");
1491 return strtr($query, $tr);
1497 public static function freeResult($ids = NULL) {
1498 global $_DB_DATAOBJECT;
1501 if (!$_DB_DATAOBJECT ||
1502 !isset($_DB_DATAOBJECT['RESULTS'])
1506 $ids = array_keys($_DB_DATAOBJECT['RESULTS']);
1509 foreach ($ids as $id) {
1510 if (isset($_DB_DATAOBJECT['RESULTS'][$id])) {
1511 $_DB_DATAOBJECT['RESULTS'][$id]->free();
1512 unset($_DB_DATAOBJECT['RESULTS'][$id]);
1515 if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$id])) {
1516 unset($_DB_DATAOBJECT['RESULTFIELDS'][$id]);
1522 * Make a shallow copy of an object and all the fields in the object.
1524 * @param string $daoName
1526 * @param array $criteria
1527 * Array of all the fields & values.
1528 * on which basis to copy
1529 * @param array $newData
1530 * Array of all the fields & values.
1531 * to be copied besides the other fields
1532 * @param string $fieldsFix
1533 * Array of fields that you want to prefix/suffix/replace.
1534 * @param string $blockCopyOfDependencies
1535 * Fields that you want to block from.
1538 * @return CRM_Core_DAO
1539 * the newly created copy of the object
1541 public static function ©Generic($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL) {
1542 $object = new $daoName();
1544 $object->id
= $criteria['id'];
1547 foreach ($criteria as $key => $value) {
1548 $object->$key = $value;
1553 while ($object->fetch()) {
1555 // all the objects except with $blockCopyOfDependencies set
1556 // be copied - addresses #CRM-1962
1558 if ($blockCopyOfDependencies && $object->$blockCopyOfDependencies) {
1562 $newObject = new $daoName();
1564 $fields = $object->fields();
1565 if (!is_array($fieldsFix)) {
1566 $fieldsToPrefix = array();
1567 $fieldsToSuffix = array();
1568 $fieldsToReplace = array();
1570 if (!empty($fieldsFix['prefix'])) {
1571 $fieldsToPrefix = $fieldsFix['prefix'];
1573 if (!empty($fieldsFix['suffix'])) {
1574 $fieldsToSuffix = $fieldsFix['suffix'];
1576 if (!empty($fieldsFix['replace'])) {
1577 $fieldsToReplace = $fieldsFix['replace'];
1580 foreach ($fields as $name => $value) {
1581 if ($name == 'id' ||
$value['name'] == 'id') {
1582 // copy everything but the id!
1586 $dbName = $value['name'];
1587 $type = CRM_Utils_Type
::typeToString($value['type']);
1588 $newObject->$dbName = $object->$dbName;
1589 if (isset($fieldsToPrefix[$dbName])) {
1590 $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1592 if (isset($fieldsToSuffix[$dbName])) {
1593 $newObject->$dbName .= $fieldsToSuffix[$dbName];
1595 if (isset($fieldsToReplace[$dbName])) {
1596 $newObject->$dbName = $fieldsToReplace[$dbName];
1599 if ($type == 'Timestamp' ||
$type == 'Date') {
1600 $newObject->$dbName = CRM_Utils_Date
::isoToMysql($newObject->$dbName);
1604 foreach ($newData as $k => $v) {
1605 $newObject->$k = $v;
1615 * Cascade update through related entities.
1617 * @param string $daoName
1620 * @param array $newData
1622 * @return CRM_Core_DAO|null
1624 public static function cascadeUpdate($daoName, $fromId, $toId, $newData = array()) {
1625 $object = new $daoName();
1626 $object->id
= $fromId;
1628 if ($object->find(TRUE)) {
1629 $newObject = new $daoName();
1630 $newObject->id
= $toId;
1632 if ($newObject->find(TRUE)) {
1633 $fields = $object->fields();
1634 foreach ($fields as $name => $value) {
1635 if ($name == 'id' ||
$value['name'] == 'id') {
1636 // copy everything but the id!
1640 $colName = $value['name'];
1641 $newObject->$colName = $object->$colName;
1643 if (substr($name, -5) == '_date' ||
1644 substr($name, -10) == '_date_time'
1646 $newObject->$colName = CRM_Utils_Date
::isoToMysql($newObject->$colName);
1649 foreach ($newData as $k => $v) {
1650 $newObject->$k = $v;
1660 * Given the component id, compute the contact id
1661 * since its used for things like send email
1663 * @param $componentIDs
1664 * @param string $tableName
1665 * @param string $idField
1668 public static function getContactIDsFromComponent($componentIDs, $tableName, $idField = 'id') {
1669 $contactIDs = array();
1671 if (empty($componentIDs)) {
1675 $IDs = implode(',', $componentIDs);
1679 WHERE $idField IN ( $IDs )
1682 $dao = CRM_Core_DAO
::executeQuery($query);
1683 while ($dao->fetch()) {
1684 $contactIDs[] = $dao->contact_id
;
1690 * Fetch object based on array of properties.
1692 * @param string $daoName
1693 * Name of the dao object.
1694 * @param string $fieldIdName
1695 * @param int $fieldId
1697 * @param array $returnProperities
1698 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1701 * an object of type referenced by daoName
1703 public static function commonRetrieveAll($daoName, $fieldIdName = 'id', $fieldId, &$details, $returnProperities = NULL) {
1704 require_once str_replace('_', DIRECTORY_SEPARATOR
, $daoName) . ".php";
1705 $object = new $daoName();
1706 $object->$fieldIdName = $fieldId;
1708 // return only specific fields if returnproperties are sent
1709 if (!empty($returnProperities)) {
1710 $object->selectAdd();
1711 $object->selectAdd('id');
1712 $object->selectAdd(implode(',', $returnProperities));
1716 while ($object->fetch()) {
1717 $defaults = array();
1718 self
::storeValues($object, $defaults);
1719 $details[$object->id
] = $defaults;
1726 * Drop all CiviCRM tables.
1728 * @throws \CRM_Exception
1730 public static function dropAllTables() {
1732 // first drop all the custom tables we've created
1733 CRM_Core_BAO_CustomGroup
::dropAllTables();
1735 // drop all multilingual views
1736 CRM_Core_I18n_Schema
::dropAllViews();
1738 CRM_Utils_File
::sourceSQLFile(CIVICRM_DSN
,
1739 dirname(__FILE__
) . DIRECTORY_SEPARATOR
.
1740 '..' . DIRECTORY_SEPARATOR
.
1741 '..' . DIRECTORY_SEPARATOR
.
1742 'sql' . DIRECTORY_SEPARATOR
.
1743 'civicrm_drop.mysql'
1752 public static function escapeString($string) {
1753 static $_dao = NULL;
1755 // If this is an atypical case (e.g. preparing .sql file before CiviCRM
1756 // has been installed), then we fallback DB-less str_replace escaping, as
1757 // we can't use mysqli_real_escape_string, as there is no DB connection.
1758 // Note: In typical usage, escapeString() will only check one conditional
1759 // ("if !$_dao") rather than two conditionals ("if !defined(DSN)")
1760 if (!defined('CIVICRM_DSN')) {
1761 // See http://php.net/manual/en/mysqli.real-escape-string.php for the
1762 // list of characters mysqli_real_escape_string escapes.
1763 $search = array("\\", "\x00", "\n", "\r", "'", '"', "\x1a");
1764 $replace = array("\\\\", "\\0", "\\n", "\\r", "\'", '\"', "\\Z");
1765 return str_replace($search, $replace, $string);
1767 $_dao = new CRM_Core_DAO();
1769 return $_dao->escape($string);
1773 * Escape a list of strings for use with "WHERE X IN (...)" queries.
1775 * @param array $strings
1776 * @param string $default
1777 * the value to use if $strings has no elements.
1779 * eg "abc","def","ghi"
1781 public static function escapeStrings($strings, $default = NULL) {
1782 static $_dao = NULL;
1784 $_dao = new CRM_Core_DAO();
1787 if (empty($strings)) {
1791 $escapes = array_map(array($_dao, 'escape'), $strings);
1792 return '"' . implode('","', $escapes) . '"';
1800 public static function escapeWildCardString($string) {
1802 // ensure we escape the single characters % and _ which are mysql wild
1803 // card characters and could come in via sortByCharacter
1804 // note that mysql does not escape these characters
1805 if ($string && in_array($string,
1806 array('%', '_', '%%', '_%')
1809 return '\\' . $string;
1812 return self
::escapeString($string);
1816 * Creates a test object, including any required objects it needs via recursion
1817 * createOnly: only create in database, do not store or return the objects (useful for perf testing)
1818 * ONLY USE FOR TESTING
1820 * @param string $daoName
1821 * @param array $params
1822 * @param int $numObjects
1823 * @param bool $createOnly
1825 * @return object|array|NULL
1826 * NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.
1828 public static function createTestObject(
1834 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
1835 // so we re-set here in case
1836 $config = CRM_Core_Config
::singleton();
1837 $config->backtrace
= TRUE;
1839 static $counter = 0;
1840 CRM_Core_DAO
::$_testEntitiesToSkip = array(
1841 'CRM_Core_DAO_Worldregion',
1842 'CRM_Core_DAO_StateProvince',
1843 'CRM_Core_DAO_Country',
1844 'CRM_Core_DAO_Domain',
1845 'CRM_Financial_DAO_FinancialType',
1846 //because valid ones exist & we use pick them due to pseudoconstant can't reliably create & delete these
1849 // Prefer to instantiate BAO's instead of DAO's (when possible)
1850 // so that assignTestValue()/assignTestFK() can be overloaded.
1851 $baoName = str_replace('_DAO_', '_BAO_', $daoName);
1852 if (class_exists($baoName)) {
1853 $daoName = $baoName;
1856 for ($i = 0; $i < $numObjects; ++
$i) {
1859 /** @var CRM_Core_DAO $object */
1860 $object = new $daoName();
1862 $fields = $object->fields();
1863 foreach ($fields as $fieldName => $fieldDef) {
1864 $dbName = $fieldDef['name'];
1865 $FKClassName = CRM_Utils_Array
::value('FKClassName', $fieldDef);
1866 $required = CRM_Utils_Array
::value('required', $fieldDef);
1868 if (CRM_Utils_Array
::value($dbName, $params) !== NULL && !is_array($params[$dbName])) {
1869 $object->$dbName = $params[$dbName];
1872 elseif ($dbName != 'id') {
1873 if ($FKClassName != NULL) {
1874 $object->assignTestFK($fieldName, $fieldDef, $params);
1878 $object->assignTestValue($fieldName, $fieldDef, $counter);
1886 $objects[$i] = $object;
1896 elseif ($numObjects == 1) {
1905 * Deletes the this object plus any dependent objects that are associated with it.
1906 * ONLY USE FOR TESTING
1908 * @param string $daoName
1909 * @param array $params
1911 public static function deleteTestObjects($daoName, $params = array()) {
1912 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
1913 // so we re-set here in case
1914 $config = CRM_Core_Config
::singleton();
1915 $config->backtrace
= TRUE;
1917 $object = new $daoName();
1918 $object->id
= CRM_Utils_Array
::value('id', $params);
1920 $deletions = array(); // array(array(0 => $daoName, 1 => $daoParams))
1921 if ($object->find(TRUE)) {
1923 $fields = $object->fields();
1924 foreach ($fields as $name => $value) {
1926 $dbName = $value['name'];
1928 $FKClassName = CRM_Utils_Array
::value('FKClassName', $value);
1929 $required = CRM_Utils_Array
::value('required', $value);
1930 if ($FKClassName != NULL
1932 && !in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)
1933 && ($required ||
$dbName == 'contact_id')
1934 //I'm a bit stuck on this one - we might need to change the singleValueAlter so that the entities don't share a contact
1935 // to make this test process pass - line below makes pass for now
1936 && $dbName != 'member_of_contact_id'
1938 $deletions[] = array($FKClassName, array('id' => $object->$dbName)); // x
1945 foreach ($deletions as $deletion) {
1946 CRM_Core_DAO
::deleteTestObjects($deletion[0], $deletion[1]);
1951 * Set defaults when creating new entity.
1952 * (don't call this set defaults as already in use with different signature in some places)
1954 * @param array $params
1957 public static function setCreateDefaults(&$params, $defaults) {
1958 if (!empty($params['id'])) {
1961 foreach ($defaults as $key => $value) {
1962 if (!array_key_exists($key, $params) ||
$params[$key] === NULL) {
1963 $params[$key] = $value;
1969 * @param string $prefix
1970 * @param bool $addRandomString
1971 * @param null $string
1975 public static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
1976 $tableName = $prefix . "_temp";
1978 if ($addRandomString) {
1980 $tableName .= "_" . $string;
1983 $tableName .= "_" . md5(uniqid('', TRUE));
1991 * @param bool $trigger
1995 public static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
1996 if (\Civi
::settings()->get('logging_no_trigger_permission')) {
1999 // test for create view and trigger permissions and if allowed, add the option to go multilingual
2001 // I'm not sure why we use the getStaticProperty for an error, rather than checking for DB_Error
2002 CRM_Core_TemporaryErrorScope
::ignoreException();
2003 $dao = new CRM_Core_DAO();
2005 $result = $dao->query('CREATE OR REPLACE VIEW civicrm_domain_view AS SELECT * FROM civicrm_domain');
2006 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError') ||
is_a($result, 'DB_Error')) {
2012 $result = $dao->query('CREATE TRIGGER civicrm_domain_trigger BEFORE INSERT ON civicrm_domain FOR EACH ROW BEGIN END');
2013 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError') ||
is_a($result, 'DB_Error')) {
2015 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2020 $dao->query('DROP TRIGGER IF EXISTS civicrm_domain_trigger');
2021 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
2023 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2030 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2031 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
2040 * @param null $message
2041 * @param bool $printDAO
2043 public static function debugPrint($message = NULL, $printDAO = TRUE) {
2044 CRM_Utils_System
::xMemory("{$message}: ");
2047 global $_DB_DATAOBJECT;
2049 foreach (array_keys($_DB_DATAOBJECT['RESULTS']) as $id) {
2050 $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query
;
2052 CRM_Core_Error
::debug('_DB_DATAOBJECT', $q);
2057 * Build a list of triggers via hook and add them to (err, reconcile them
2058 * with) the database.
2060 * @param string $tableName
2061 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2062 * @param bool $force
2067 public static function triggerRebuild($tableName = NULL, $force = FALSE) {
2068 Civi
::service('sql_triggers')->rebuild($tableName, $force);
2072 * Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
2073 * @see http://issues.civicrm.org/jira/browse/CRM-13822
2074 * TODO: Alternative solutions might be
2075 * * Stop using functions and find another way to strip numeric characters from phones
2076 * * Give better error messages (currently a missing fn fatals with "unknown error")
2078 public static function checkSqlFunctionsExist() {
2079 if (!self
::$_checkedSqlFunctionsExist) {
2080 self
::$_checkedSqlFunctionsExist = TRUE;
2081 $dao = CRM_Core_DAO
::executeQuery("SHOW function status WHERE db = database() AND name = 'civicrm_strip_non_numeric'");
2082 if (!$dao->fetch()) {
2083 self
::triggerRebuild();
2089 * Wrapper function to drop triggers.
2091 * @param string $tableName
2092 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2095 public static function dropTriggers($tableName = NULL) {
2096 Civi
::service('sql_triggers')->dropTriggers($tableName);
2100 * @param array $info
2101 * per hook_civicrm_triggerInfo.
2102 * @param string $onlyTableName
2103 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2106 public static function createTriggers(&$info, $onlyTableName = NULL) {
2107 Civi
::service('sql_triggers')->createTriggers($info, $onlyTableName);
2111 * Given a list of fields, create a list of references.
2113 * @param string $className
2114 * BAO/DAO class name.
2115 * @return array<CRM_Core_Reference_Interface>
2117 public static function createReferenceColumns($className) {
2119 $fields = $className::fields();
2120 foreach ($fields as $field) {
2121 if (isset($field['pseudoconstant'], $field['pseudoconstant']['optionGroupName'])) {
2122 $result[] = new CRM_Core_Reference_OptionValue(
2123 $className::getTableName(),
2125 'civicrm_option_value',
2126 CRM_Utils_Array
::value('keyColumn', $field['pseudoconstant'], 'value'),
2127 $field['pseudoconstant']['optionGroupName']
2135 * Find all records which refer to this entity.
2138 * Array of objects referencing this
2140 public function findReferences() {
2141 $links = self
::getReferencesToTable(static::getTableName());
2143 $occurrences = array();
2144 foreach ($links as $refSpec) {
2145 /** @var $refSpec CRM_Core_Reference_Interface */
2146 $daoName = CRM_Core_DAO_AllCoreTables
::getClassForTable($refSpec->getReferenceTable());
2147 $result = $refSpec->findReferences($this);
2149 while ($result->fetch()) {
2150 $obj = new $daoName();
2151 $obj->id
= $result->id
;
2152 $occurrences[] = $obj;
2157 return $occurrences;
2162 * each item has keys:
2166 * - table: string|null SQL table name
2167 * - key: string|null SQL column name
2169 public function getReferenceCounts() {
2170 $links = self
::getReferencesToTable(static::getTableName());
2173 foreach ($links as $refSpec) {
2174 /** @var $refSpec CRM_Core_Reference_Interface */
2175 $count = $refSpec->getReferenceCount($this);
2176 if ($count['count'] != 0) {
2181 foreach (CRM_Core_Component
::getEnabledComponents() as $component) {
2182 /** @var $component CRM_Core_Component_Info */
2183 $counts = array_merge($counts, $component->getReferenceCounts($this));
2185 CRM_Utils_Hook
::referenceCounts($this, $counts);
2191 * List all tables which have hard foreign keys to this table.
2193 * For now, this returns a description of every entity_id/entity_table
2195 * TODO: filter dynamic entity references on the $tableName, based on
2196 * schema metadata in dynamicForeignKey which enumerates a restricted
2197 * set of possible entity_table's.
2199 * @param string $tableName
2200 * Table referred to.
2203 * structure of table and column, listing every table with a
2204 * foreign key reference to $tableName, and the column where the key appears.
2206 public static function getReferencesToTable($tableName) {
2207 $refsFound = array();
2208 foreach (CRM_Core_DAO_AllCoreTables
::getClasses() as $daoClassName) {
2209 $links = $daoClassName::getReferenceColumns();
2210 $daoTableName = $daoClassName::getTableName();
2212 foreach ($links as $refSpec) {
2213 /** @var $refSpec CRM_Core_Reference_Interface */
2214 if ($refSpec->matchesTargetTable($tableName)) {
2215 $refsFound[] = $refSpec;
2223 * Lookup the value of a MySQL global configuration variable.
2225 * @param string $name
2226 * E.g. "thread_stack".
2227 * @param mixed $default
2230 public static function getGlobalSetting($name, $default = NULL) {
2231 // Alternatively, SELECT @@GLOBAL.thread_stack, but
2232 // that has been reported to fail under MySQL 5.0 for OS X
2233 $escapedName = self
::escapeString($name);
2234 $dao = CRM_Core_DAO
::executeQuery("SHOW VARIABLES LIKE '$escapedName'");
2235 if ($dao->fetch()) {
2245 * Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
2247 * This is relevant where we want to offer both the ID field and the label field
2248 * as an option, e.g. search builder.
2250 * It is currently limited for optionGroupName for purposes keeping the scope of the
2251 * change small, but is appropriate for other sorts of pseudoconstants.
2253 * @param array $fields
2255 protected static function appendPseudoConstantsToFields(&$fields) {
2256 foreach ($fields as $field) {
2257 if (!empty($field['pseudoconstant']) && !empty($field['pseudoconstant']['optionGroupName'])) {
2258 $fields[$field['pseudoconstant']['optionGroupName']] = array(
2259 'title' => CRM_Core_BAO_OptionGroup
::getTitleByName($field['pseudoconstant']['optionGroupName']),
2260 'name' => $field['pseudoconstant']['optionGroupName'],
2261 'data_type' => CRM_Utils_Type
::T_STRING
,
2268 * Get options for the called BAO object's field.
2270 * This function can be overridden by each BAO to add more logic related to context.
2271 * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
2273 * @param string $fieldName
2274 * @param string $context
2275 * @see CRM_Core_DAO::buildOptionsContext
2276 * @param array $props
2277 * whatever is known about this bao object.
2279 * @return array|bool
2281 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
2282 // If a given bao does not override this function
2283 $baoName = get_called_class();
2284 return CRM_Core_PseudoConstant
::get($baoName, $fieldName, $props, $context);
2288 * Populate option labels for this object's fields.
2290 * @throws exception if called directly on the base class
2292 public function getOptionLabels() {
2293 $fields = $this->fields();
2294 if ($fields === NULL) {
2295 throw new Exception('Cannot call getOptionLabels on CRM_Core_DAO');
2297 foreach ($fields as $field) {
2298 $name = CRM_Utils_Array
::value('name', $field);
2299 if ($name && isset($this->$name)) {
2300 $label = CRM_Core_PseudoConstant
::getLabel(get_class($this), $name, $this->$name);
2301 if ($label !== FALSE) {
2302 // Append 'label' onto the field name
2303 $labelName = $name . '_label';
2304 $this->$labelName = $label;
2311 * Provides documentation and validation for the buildOptions $context param
2313 * @param string $context
2318 public static function buildOptionsContext($context = NULL) {
2320 'get' => "get: all options are returned, even if they are disabled; labels are translated.",
2321 'create' => "create: options are filtered appropriately for the object being created/updated; labels are translated.",
2322 'search' => "search: searchable options are returned; labels are translated.",
2323 'validate' => "validate: all options are returned, even if they are disabled; machine names are used in place of labels.",
2324 'abbreviate' => "abbreviate: enabled options are returned; labels are replaced with abbreviations.",
2325 'match' => "match: enabled options are returned using machine names as keys; labels are translated.",
2327 // Validation: enforce uniformity of this param
2328 if ($context !== NULL && !isset($contexts[$context])) {
2329 throw new Exception("'$context' is not a valid context for buildOptions.");
2335 * @param string $fieldName
2336 * @return bool|array
2338 public function getFieldSpec($fieldName) {
2339 $fields = $this->fields();
2340 $fieldKeys = $this->fieldKeys();
2342 // Support "unique names" as well as sql names
2343 $fieldKey = $fieldName;
2344 if (empty($fields[$fieldKey])) {
2345 $fieldKey = CRM_Utils_Array
::value($fieldName, $fieldKeys);
2347 // If neither worked then this field doesn't exist. Return false.
2348 if (empty($fields[$fieldKey])) {
2351 return $fields[$fieldKey];
2355 * Get SQL where clause for SQL filter syntax input parameters.
2357 * SQL version of api function to assign filters to the DAO based on the syntax
2358 * $field => array('IN' => array(4,6,9))
2360 * $field => array('LIKE' => array('%me%))
2363 * @param string $fieldName
2365 * @param array $filter
2366 * filter to be applied indexed by operator.
2367 * @param string $type
2368 * type of field (not actually used - nor in api @todo ).
2369 * @param string $alias
2370 * alternative field name ('as') @todo- not actually used.
2371 * @param bool $returnSanitisedArray
2372 * Return a sanitised array instead of a clause.
2373 * this is primarily so we can add filters @ the api level to the Query object based fields
2377 * @return NULL|string|array
2378 * a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL
2379 * depending on whether it is supported as yet
2381 public static function createSQLFilter($fieldName, $filter, $type = NULL, $alias = NULL, $returnSanitisedArray = FALSE) {
2382 foreach ($filter as $operator => $criteria) {
2383 if (in_array($operator, self
::acceptedSQLOperators(), TRUE)) {
2384 switch ($operator) {
2388 if (!$returnSanitisedArray) {
2389 return (sprintf('%s %s', $fieldName, $operator));
2392 return (sprintf('%s %s ', $fieldName, $operator));
2396 // ternary operators
2399 if (empty($criteria[0]) ||
empty($criteria[1])) {
2400 throw new Exception("invalid criteria for $operator");
2402 if (!$returnSanitisedArray) {
2403 return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO
::escapeString($criteria[0]), CRM_Core_DAO
::escapeString($criteria[1])));
2406 return NULL; // not yet implemented (tests required to implement)
2413 if (empty($criteria)) {
2414 throw new Exception("invalid criteria for $operator");
2416 $escapedCriteria = array_map(array(
2420 if (!$returnSanitisedArray) {
2421 return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
2423 return $escapedCriteria;
2428 if (!$returnSanitisedArray) {
2429 return (sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO
::escapeString($criteria)));
2432 return NULL; // not yet implemented (tests required to implement)
2440 * @see http://issues.civicrm.org/jira/browse/CRM-9150
2441 * support for other syntaxes is discussed in ticket but being put off for now
2444 public static function acceptedSQLOperators() {
2465 * SQL has a limit of 64 characters on various names:
2466 * table name, trigger name, column name ...
2468 * For custom groups and fields we generated names from user entered input
2469 * which can be longer than this length, this function helps with creating
2470 * strings that meet various criteria.
2472 * @param string $string
2473 * The string to be shortened.
2474 * @param int $length
2475 * The max length of the string.
2477 * @param bool $makeRandom
2481 public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) {
2482 // early return for strings that meet the requirements
2483 if (strlen($string) <= $length) {
2487 // easy return for calls that dont need a randomized uniq string
2489 return substr($string, 0, $length);
2492 // the string is longer than the length and we need a uniq string
2493 // for the same tablename we need the same uniq string every time
2494 // hence we use md5 on the string, which is not random
2495 // we'll append 8 characters to the end of the tableName
2496 $md5string = substr(md5($string), 0, 8);
2497 return substr($string, 0, $length - 8) . "_{$md5string}";
2501 * https://issues.civicrm.org/jira/browse/CRM-17748
2502 * Sets the internal options to be used on a query
2504 * @param array $options
2507 public function setOptions($options) {
2508 if (is_array($options)) {
2509 $this->_options
= $options;
2514 * https://issues.civicrm.org/jira/browse/CRM-17748
2515 * wrapper to pass internal DAO options down to DB_mysql/DB_Common level
2517 * @param array $options
2520 protected function _setDBOptions($options) {
2521 global $_DB_DATAOBJECT;
2523 if (is_array($options) && count($options)) {
2524 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
2525 foreach ($options as $option_name => $option_value) {
2526 $conn->setOption($option_name, $option_value);
2533 * @param array $params
2535 public function setApiFilter(&$params) {
2539 * Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
2541 * Return format is in the form of fieldname => clauses starting with an operator. e.g.:
2544 * 'location_type_id' => array('IS NOT NULL', 'IN (1,2,3)')
2548 * Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values.
2552 public function addSelectWhereClause() {
2554 $fields = $this->fields();
2555 foreach ($fields as $fieldName => $field) {
2556 // Clause for contact-related entities like Email, Relationship, etc.
2557 if (strpos($fieldName, 'contact_id') === 0 && CRM_Utils_Array
::value('FKClassName', $field) == 'CRM_Contact_DAO_Contact') {
2558 $clauses[$fieldName] = CRM_Utils_SQL
::mergeSubquery('Contact');
2560 // Clause for an entity_table/entity_id combo
2561 if ($fieldName == 'entity_id' && isset($fields['entity_table'])) {
2562 $relatedClauses = array();
2563 $relatedEntities = $this->buildOptions('entity_table', 'get');
2564 foreach ((array) $relatedEntities as $table => $ent) {
2566 $ent = CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table));
2567 $subquery = CRM_Utils_SQL
::mergeSubquery($ent);
2569 $relatedClauses[] = "(entity_table = '$table' AND entity_id " . implode(' AND entity_id ', $subquery) . ")";
2572 $relatedClauses[] = "(entity_table = '$table')";
2576 if ($relatedClauses) {
2577 $clauses['id'] = 'IN (SELECT id FROM `' . $this->tableName() . '` WHERE (' . implode(') OR (', $relatedClauses) . '))';
2581 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
2586 * This returns the final permissioned query string for this entity
2588 * With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
2590 * @param string $tableAlias
2593 public static function getSelectWhereClause($tableAlias = NULL) {
2594 $bao = new static();
2595 if ($tableAlias === NULL) {
2596 $tableAlias = $bao->tableName();
2599 foreach ((array) $bao->addSelectWhereClause() as $field => $vals) {
2600 $clauses[$field] = NULL;
2602 $clauses[$field] = "(`$tableAlias`.`$field` IS NULL OR (`$tableAlias`.`$field` " . implode(" AND `$tableAlias`.`$field` ", (array) $vals) . '))';
2609 * ensure database name is 'safe', i.e. only contains word characters (includes underscores)
2610 * and dashes, and contains at least one [a-z] case insenstive.
2616 public static function requireSafeDBName($database) {
2619 "/^[\w\-]*[a-z]+[\w\-]*$/i",
2623 if (empty($matches)) {
2630 * Transform an array to a serialized string for database storage.
2632 * @param array|NULL $value
2633 * @param $serializationType
2634 * @return string|NULL
2635 * @throws \Exception
2637 public static function serializeField($value, $serializationType) {
2638 if ($value === NULL) {
2641 switch ($serializationType) {
2642 case self
::SERIALIZE_SEPARATOR_BOOKEND
:
2643 return $value === array() ?
'' : CRM_Utils_Array
::implodePadded($value);
2645 case self
::SERIALIZE_SEPARATOR_TRIMMED
:
2646 return is_array($value) ?
implode(self
::VALUE_SEPARATOR
, $value) : $value;
2648 case self
::SERIALIZE_JSON
:
2649 return is_array($value) ?
json_encode($value) : $value;
2651 case self
::SERIALIZE_PHP
:
2652 return is_array($value) ?
serialize($value) : $value;
2654 case self
::SERIALIZE_COMMA
:
2655 return is_array($value) ?
implode(',', $value) : $value;
2658 throw new Exception('Unknown serialization method for field.');
2663 * Transform a serialized string from the database into an array.
2665 * @param string|null $value
2666 * @param $serializationType
2667 * @return array|null
2668 * @throws \Exception
2670 public static function unSerializeField($value, $serializationType) {
2671 if ($value === NULL) {
2674 if ($value === '') {
2677 switch ($serializationType) {
2678 case self
::SERIALIZE_SEPARATOR_BOOKEND
:
2679 return (array) CRM_Utils_Array
::explodePadded($value);
2681 case self
::SERIALIZE_SEPARATOR_TRIMMED
:
2682 return explode(self
::VALUE_SEPARATOR
, trim($value));
2684 case self
::SERIALIZE_JSON
:
2685 return strlen($value) ?
json_decode($value, TRUE) : array();
2687 case self
::SERIALIZE_PHP
:
2688 return strlen($value) ?
unserialize($value) : array();
2690 case self
::SERIALIZE_COMMA
:
2691 return explode(',', trim(str_replace(', ', '', $value)));
2694 throw new Exception('Unknown serialization method for field.');