3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 * Our base DAO class. All DAO classes should inherit from this class.
32 * @copyright CiviCRM LLC (c) 2004-2017
35 if (!defined('DB_DSN_MODE')) {
36 define('DB_DSN_MODE', 'auto');
39 require_once 'PEAR.php';
40 require_once 'DB/DataObject.php';
42 require_once 'CRM/Core/I18n.php';
47 class CRM_Core_DAO
extends DB_DataObject
{
53 static $_nullObject = NULL;
58 static $_nullArray = array();
60 static $_dbColumnValueCache = NULL;
61 const NOT_NULL
= 1, IS_NULL
= 2,
63 VALUE_SEPARATOR
= "\ 1",
64 BULK_INSERT_COUNT
= 200,
65 BULK_INSERT_HIGH_COUNT
= 200,
66 QUERY_FORMAT_WILDCARD
= 1,
67 QUERY_FORMAT_NO_QUOTES
= 2;
70 * Define entities that shouldn't be created or deleted when creating/ deleting
71 * test objects - this prevents world regions, countries etc from being added / deleted
74 static $_testEntitiesToSkip = array();
76 * The factory class for this application.
79 static $_factory = NULL;
81 static $_checkedSqlFunctionsExist = FALSE;
84 * https://issues.civicrm.org/jira/browse/CRM-17748
85 * internal variable for DAO to hold per-query settings
87 protected $_options = array();
92 * @return \CRM_Core_DAO
94 public function __construct() {
96 $this->__table
= $this->getTableName();
100 * Empty definition for virtual function.
102 public static function getTableName() {
107 * Initialize the DAO object.
110 * The database connection string.
112 public static function init($dsn) {
113 Civi
::$statics[__CLASS__
]['init'] = 1;
114 $options = &PEAR
::getStaticProperty('DB_DataObject', 'options');
115 $options['database'] = $dsn;
116 if (defined('CIVICRM_DAO_DEBUG')) {
117 self
::DebugLevel(CIVICRM_DAO_DEBUG
);
119 $factory = new CRM_Contact_DAO_Factory();
120 CRM_Core_DAO
::setFactory($factory);
121 if (CRM_Utils_Constant
::value('CIVICRM_MYSQL_STRICT', CRM_Utils_System
::isDevelopment())) {
122 CRM_Core_DAO
::executeQuery('SET SESSION sql_mode = STRICT_TRANS_TABLES');
124 CRM_Core_DAO
::executeQuery('SET NAMES utf8');
125 CRM_Core_DAO
::executeQuery('SET @uniqueID = %1', array(1 => array(CRM_Utils_Request
::id(), 'String')));
131 public static function getConnection() {
132 global $_DB_DATAOBJECT;
133 $dao = new CRM_Core_DAO();
134 return $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5
];
138 * @param string $fieldName
140 * @param array $params
142 protected function assignTestFK($fieldName, $fieldDef, $params) {
143 $required = CRM_Utils_Array
::value('required', $fieldDef);
144 $FKClassName = CRM_Utils_Array
::value('FKClassName', $fieldDef);
145 $dbName = $fieldDef['name'];
146 $daoName = str_replace('_BAO_', '_DAO_', get_class($this));
148 // skip the FK if it is not required
149 // if it's contact id we should create even if not required
150 // we'll have a go @ fetching first though
151 // we WILL create campaigns though for so tests with a campaign pseudoconstant will complete
152 if ($FKClassName === 'CRM_Campaign_DAO_Campaign' && $daoName != $FKClassName) {
155 if (!$required && $dbName != 'contact_id') {
156 $fkDAO = new $FKClassName();
157 if ($fkDAO->find(TRUE)) {
158 $this->$dbName = $fkDAO->id
;
163 elseif (in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)) {
164 $depObject = new $FKClassName();
165 $depObject->find(TRUE);
166 $this->$dbName = $depObject->id
;
169 elseif ($daoName == 'CRM_Member_DAO_MembershipType' && $fieldName == 'member_of_contact_id') {
170 // FIXME: the fields() metadata is not specific enough
171 $depObject = CRM_Core_DAO
::createTestObject($FKClassName, array('contact_type' => 'Organization'));
172 $this->$dbName = $depObject->id
;
176 //if it is required we need to generate the dependency object first
177 $depObject = CRM_Core_DAO
::createTestObject($FKClassName, CRM_Utils_Array
::value($dbName, $params, 1));
178 $this->$dbName = $depObject->id
;
184 * Generate and assign an arbitrary value to a field of a test object.
186 * @param string $fieldName
187 * @param array $fieldDef
188 * @param int $counter
189 * The globally-unique ID of the test object.
191 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
192 $dbName = $fieldDef['name'];
193 $daoName = get_class($this);
196 if (!$handled && $dbName == 'contact_sub_type') {
197 //coming up with a rule to set this is too complex let's not set it
201 // Pick an option value if needed
202 if (!$handled && $fieldDef['type'] !== CRM_Utils_Type
::T_BOOLEAN
) {
203 $options = $daoName::buildOptions($dbName, 'create');
205 $this->$dbName = key($options);
211 switch ($fieldDef['type']) {
212 case CRM_Utils_Type
::T_INT
:
213 case CRM_Utils_Type
::T_FLOAT
:
214 case CRM_Utils_Type
::T_MONEY
:
215 if (isset($fieldDef['precision'])) {
216 // $object->$dbName = CRM_Utils_Number::createRandomDecimal($value['precision']);
217 $this->$dbName = CRM_Utils_Number
::createTruncatedDecimal($counter, $fieldDef['precision']);
220 $this->$dbName = $counter;
224 case CRM_Utils_Type
::T_BOOLEAN
:
225 if (isset($fieldDef['default'])) {
226 $this->$dbName = $fieldDef['default'];
228 elseif ($fieldDef['name'] == 'is_deleted' ||
$fieldDef['name'] == 'is_test') {
236 case CRM_Utils_Type
::T_DATE
:
237 case CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
:
238 $this->$dbName = '19700101';
239 if ($dbName == 'end_date') {
240 // put this in the future
241 $this->$dbName = '20200101';
245 case CRM_Utils_Type
::T_TIMESTAMP
:
246 $this->$dbName = '19700201000000';
249 case CRM_Utils_Type
::T_TIME
:
250 CRM_Core_Error
::fatal("T_TIME shouldn't be used.");
251 //$object->$dbName='000000';
253 case CRM_Utils_Type
::T_CCNUM
:
254 $this->$dbName = '4111 1111 1111 1111';
257 case CRM_Utils_Type
::T_URL
:
258 $this->$dbName = 'http://www.civicrm.org';
261 case CRM_Utils_Type
::T_STRING
:
262 case CRM_Utils_Type
::T_BLOB
:
263 case CRM_Utils_Type
::T_MEDIUMBLOB
:
264 case CRM_Utils_Type
::T_TEXT
:
265 case CRM_Utils_Type
::T_LONGTEXT
:
266 case CRM_Utils_Type
::T_EMAIL
:
268 // WAS: if (isset($value['enumValues'])) {
269 // TODO: see if this works with all pseudoconstants
270 if (isset($fieldDef['pseudoconstant'], $fieldDef['pseudoconstant']['callback'])) {
271 if (isset($fieldDef['default'])) {
272 $this->$dbName = $fieldDef['default'];
275 $options = CRM_Core_PseudoConstant
::get($daoName, $fieldName);
276 if (is_array($options)) {
277 $this->$dbName = $options[0];
280 $defaultValues = explode(',', $options);
281 $this->$dbName = $defaultValues[0];
286 $this->$dbName = $dbName . '_' . $counter;
287 $maxlength = CRM_Utils_Array
::value('maxlength', $fieldDef);
288 if ($maxlength > 0 && strlen($this->$dbName) > $maxlength) {
289 $this->$dbName = substr($this->$dbName, 0, $fieldDef['maxlength']);
297 * Reset the DAO object.
299 * DAO is kinda crappy in that there is an unwritten rule of one query per DAO.
301 * We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution
303 public function reset() {
305 foreach (array_keys($this->table()) as $field) {
306 unset($this->$field);
310 * reset the various DB_DAO structures manually
312 $this->_query
= array();
319 * @param string $tableName
323 public static function getLocaleTableName($tableName) {
326 $tables = CRM_Core_I18n_Schema
::schemaStructureTables();
327 if (in_array($tableName, $tables)) {
328 return $tableName . $dbLocale;
335 * Execute a query by the current DAO, localizing it along the way (if needed).
337 * @param string $query
338 * The SQL query for execution.
339 * @param bool $i18nRewrite
340 * Whether to rewrite the query.
343 * the current DAO object after the query execution
345 public function query($query, $i18nRewrite = TRUE) {
346 // rewrite queries that should use $dbLocale-based views for multi-language installs
347 global $dbLocale, $_DB_DATAOBJECT;
349 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
350 $orig_options = $conn->options
;
351 $this->_setDBOptions($this->_options
);
353 if ($i18nRewrite and $dbLocale) {
354 $query = CRM_Core_I18n_Schema
::rewriteQuery($query);
357 $ret = parent
::query($query);
359 $this->_setDBOptions($orig_options);
364 * Static function to set the factory instance for this class.
366 * @param object $factory
367 * The factory application object.
369 public static function setFactory(&$factory) {
370 self
::$_factory = &$factory;
374 * Factory method to instantiate a new object from a table name.
376 * @param string $table
378 public function factory($table = '') {
379 if (!isset(self
::$_factory)) {
380 return parent
::factory($table);
383 return self
::$_factory->create($table);
387 * Initialization for all DAO objects. Since we access DB_DO programatically
388 * we need to set the links manually.
390 public function initialize() {
392 if (empty(Civi
::$statics[__CLASS__
]['init'])) {
393 // CRM_Core_DAO::init() must be called before CRM_Core_DAO->initialize().
394 // This occurs very early in bootstrap - error handlers may not be wired up.
395 echo "Inconsistent system initialization sequence. Premature access of (" . get_class($this) . ")";
396 CRM_Utils_System
::civiExit();
401 * Defines the default key as 'id'.
406 public function keys() {
415 * Tells DB_DataObject which keys use autoincrement.
416 * 'id' is autoincrementing by default.
421 public function sequenceKey() {
422 static $sequenceKeys;
423 if (!isset($sequenceKeys)) {
424 $sequenceKeys = array('id', TRUE);
426 return $sequenceKeys;
430 * Returns list of FK relationships.
434 * Array of CRM_Core_Reference_Interface
436 public static function getReferenceColumns() {
441 * Returns all the column names of this table.
446 public static function &fields() {
452 * Get/set an associative array of table columns
457 public function table() {
458 $fields = &$this->fields();
462 foreach ($fields as $name => $value) {
463 $table[$value['name']] = $value['type'];
464 if (!empty($value['required'])) {
465 $table[$value['name']] +
= self
::DB_DAO_NOTNULL
;
478 * @return CRM_Core_DAO
480 public function save($hook = TRUE) {
481 if (!empty($this->id
)) {
485 $event = new \Civi\Core\DAO\Event\
PostUpdate($this);
486 \Civi
::service('dispatcher')->dispatch("civi.dao.postUpdate", $event);
493 $event = new \Civi\Core\DAO\Event\
PostUpdate($this);
494 \Civi
::service('dispatcher')->dispatch("civi.dao.postInsert", $event);
500 CRM_Utils_Hook
::postSave($this);
507 * Deletes items from table which match current objects variables.
509 * Returns the true on success
513 * Designed to be extended
515 * $object = new mytable();
517 * echo $object->delete(); // builds a conditon
519 * $object = new mytable();
520 * $object->whereAdd('age > 12');
522 * $object->orderBy('age DESC');
523 * $object->delete(true); // dont use object vars, use the conditions, limit and order.
525 * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
526 * we will build the condition only using the whereAdd's. Default is to
527 * build the condition only using the object parameters.
529 * * @return mixed Int (No. of rows affected) on success, false on failure, 0 on no data affected
531 public function delete($useWhere = FALSE) {
532 $result = parent
::delete($useWhere);
534 $event = new \Civi\Core\DAO\Event\
PostDelete($this, $result);
535 \Civi
::service('dispatcher')->dispatch("civi.dao.postDelete", $event);
542 * @param bool $created
544 public function log($created = FALSE) {
547 if (!$this->getLog()) {
552 $session = CRM_Core_Session
::singleton();
553 $cid = $session->get('userID');
556 // return is we dont have handle to FK
561 $dao = new CRM_Core_DAO_Log();
562 $dao->entity_table
= $this->getTableName();
563 $dao->entity_id
= $this->id
;
564 $dao->modified_id
= $cid;
565 $dao->modified_date
= date("YmdHis");
570 * Given an associative array of name/value pairs, extract all the values
571 * that belong to this object and initialize the object with said values
573 * @param array $params
574 * (reference ) associative array of name/value pairs.
577 * Did we copy all null values into the object
579 public function copyValues(&$params) {
580 $fields = &$this->fields();
582 foreach ($fields as $name => $value) {
583 $dbName = $value['name'];
584 if (array_key_exists($dbName, $params)) {
585 $pValue = $params[$dbName];
588 elseif (array_key_exists($name, $params)) {
589 $pValue = $params[$name];
596 // if there is no value then make the variable NULL
598 if ($pValue === '') {
599 $this->$dbName = 'null';
602 $this->$dbName = $pValue;
611 * Store all the values from this object in an associative array
612 * this is a destructive store, calling function is responsible
613 * for keeping sanity of id's.
615 * @param object $object
616 * The object that we are extracting data from.
617 * @param array $values
618 * (reference ) associative array of name/value pairs.
620 public static function storeValues(&$object, &$values) {
621 $fields = &$object->fields();
622 foreach ($fields as $name => $value) {
623 $dbName = $value['name'];
624 if (isset($object->$dbName) && $object->$dbName !== 'null') {
625 $values[$dbName] = $object->$dbName;
626 if ($name != $dbName) {
627 $values[$name] = $object->$dbName;
634 * Create an attribute for this specific field. We only do this for strings and text
636 * @param array $field
637 * The field under task.
640 * the attributes for the object
642 public static function makeAttribute($field) {
644 if (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_STRING
) {
645 $maxLength = CRM_Utils_Array
::value('maxlength', $field);
646 $size = CRM_Utils_Array
::value('size', $field);
647 if ($maxLength ||
$size) {
648 $attributes = array();
650 $attributes['maxlength'] = $maxLength;
653 $attributes['size'] = $size;
658 elseif (CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_TEXT
) {
659 $rows = CRM_Utils_Array
::value('rows', $field);
663 $cols = CRM_Utils_Array
::value('cols', $field);
668 $attributes = array();
669 $attributes['rows'] = $rows;
670 $attributes['cols'] = $cols;
673 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
) {
674 $attributes['size'] = 6;
675 $attributes['maxlength'] = 14;
683 * Get the size and maxLength attributes for this text field.
684 * (or for all text fields) in the DAO object.
686 * @param string $class
688 * @param string $fieldName
689 * Field that i'm interested in or null if.
690 * you want the attributes for all DAO text fields
693 * assoc array of name => attribute pairs
695 public static function getAttribute($class, $fieldName = NULL) {
696 $object = new $class();
697 $fields = &$object->fields();
698 if ($fieldName != NULL) {
699 $field = CRM_Utils_Array
::value($fieldName, $fields);
700 return self
::makeAttribute($field);
703 $attributes = array();
704 foreach ($fields as $name => $field) {
705 $attribute = self
::makeAttribute($field);
707 $attributes[$name] = $attribute;
711 if (!empty($attributes)) {
723 public static function transaction($type) {
724 CRM_Core_Error
::fatal('This function is obsolete, please use CRM_Core_Transaction');
728 * Check if there is a record with the same name in the db.
730 * @param string $value
731 * The value of the field we are checking.
732 * @param string $daoName
733 * The dao object name.
734 * @param string $daoID
735 * The id of the object being updated. u can change your name.
736 * as long as there is no conflict
737 * @param string $fieldName
738 * The name of the field in the DAO.
740 * @param string $domainID
741 * The id of the domain. Object exists only for the given domain.
744 * true if object exists
746 public static function objectExists($value, $daoName, $daoID, $fieldName = 'name', $domainID = NULL) {
747 $object = new $daoName();
748 $object->$fieldName = $value;
750 $object->domain_id
= $domainID;
753 if ($object->find(TRUE)) {
754 return ($daoID && $object->id
== $daoID) ?
TRUE : FALSE;
762 * Check if there is a given column in a specific table.
764 * @param string $tableName
765 * @param string $columnName
766 * @param bool $i18nRewrite
767 * Whether to rewrite the query on multilingual setups.
770 * true if exists, else false
772 public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
778 $params = array(1 => array($columnName, 'String'));
779 $dao = CRM_Core_DAO
::executeQuery($query, $params, TRUE, NULL, FALSE, $i18nRewrite);
780 $result = $dao->fetch() ?
TRUE : FALSE;
786 * Scans all the tables using a slow query and table name.
790 public static function getTableNames() {
791 $dao = CRM_Core_DAO
::executeQuery(
793 FROM information_schema.TABLES
794 WHERE TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
795 AND TABLE_NAME LIKE 'civicrm_%'
796 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
797 AND TABLE_NAME NOT LIKE '%_temp%'
800 while ($dao->fetch()) {
801 $values[] = $dao->TABLE_NAME
;
808 * @param int $maxTablesToCheck
812 public static function isDBMyISAM($maxTablesToCheck = 10) {
813 return CRM_Core_DAO
::singleValueQuery(
815 FROM information_schema.TABLES
816 WHERE ENGINE = 'MyISAM'
817 AND TABLE_SCHEMA = '" . CRM_Core_DAO
::getDatabaseName() . "'
818 AND TABLE_NAME LIKE 'civicrm_%'
819 AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
820 AND TABLE_NAME NOT LIKE '%_temp%'
825 * Get the name of the CiviCRM database.
829 public static function getDatabaseName() {
830 $daoObj = new CRM_Core_DAO();
831 return $daoObj->database();
835 * Checks if a constraint exists for a specified table.
837 * @param string $tableName
838 * @param string $constraint
841 * true if constraint exists, false otherwise
843 public static function checkConstraintExists($tableName, $constraint) {
844 static $show = array();
846 if (!array_key_exists($tableName, $show)) {
847 $query = "SHOW CREATE TABLE $tableName";
848 $dao = CRM_Core_DAO
::executeQuery($query);
850 if (!$dao->fetch()) {
851 CRM_Core_Error
::fatal();
855 $show[$tableName] = $dao->Create_Table
;
858 return preg_match("/\b$constraint\b/i", $show[$tableName]) ?
TRUE : FALSE;
862 * Checks if CONSTRAINT keyword exists for a specified table.
864 * @param array $tables
869 * true if CONSTRAINT keyword exists, false otherwise
871 public static function schemaRequiresRebuilding($tables = array("civicrm_contact")) {
873 foreach ($tables as $tableName) {
874 if (!array_key_exists($tableName, $show)) {
875 $query = "SHOW CREATE TABLE $tableName";
876 $dao = CRM_Core_DAO
::executeQuery($query);
878 if (!$dao->fetch()) {
879 CRM_Core_Error
::fatal();
883 $show[$tableName] = $dao->Create_Table
;
886 $result = preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]) ?
TRUE : FALSE;
887 if ($result == TRUE) {
898 * Checks if the FK constraint name is in the format 'FK_tableName_columnName'
899 * for a specified column of a table.
901 * @param string $tableName
902 * @param string $columnName
905 * true if in format, false otherwise
907 public static function checkFKConstraintInFormat($tableName, $columnName) {
908 static $show = array();
910 if (!array_key_exists($tableName, $show)) {
911 $query = "SHOW CREATE TABLE $tableName";
912 $dao = CRM_Core_DAO
::executeQuery($query);
914 if (!$dao->fetch()) {
915 CRM_Core_Error
::fatal();
919 $show[$tableName] = $dao->Create_Table
;
921 $constraint = "`FK_{$tableName}_{$columnName}`";
922 $pattern = "/\bCONSTRAINT\b\s+%s\s+\bFOREIGN\s+KEY\b\s/i";
923 return preg_match(sprintf($pattern, $constraint), $show[$tableName]) ?
TRUE : FALSE;
927 * Check whether a specific column in a specific table has always the same value.
929 * @param string $tableName
930 * @param string $columnName
931 * @param string $columnValue
934 * true if the value is always $columnValue, false otherwise
936 public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
937 $query = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'";
938 $dao = CRM_Core_DAO
::executeQuery($query);
939 $result = $dao->fetch() ?
FALSE : TRUE;
945 * Check whether a specific column in a specific table is always NULL.
947 * @param string $tableName
948 * @param string $columnName
951 * true if if the value is always NULL, false otherwise
953 public static function checkFieldIsAlwaysNull($tableName, $columnName) {
954 $query = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL";
955 $dao = CRM_Core_DAO
::executeQuery($query);
956 $result = $dao->fetch() ?
FALSE : TRUE;
962 * Check if there is a given table in the database.
964 * @param string $tableName
967 * true if exists, else false
969 public static function checkTableExists($tableName) {
974 $params = array(1 => array($tableName, 'String'));
976 $dao = CRM_Core_DAO
::executeQuery($query, $params);
977 $result = $dao->fetch() ?
TRUE : FALSE;
987 public function checkVersion($version) {
992 $dbVersion = CRM_Core_DAO
::singleValueQuery($query);
993 return trim($version) == trim($dbVersion) ?
TRUE : FALSE;
997 * Find a DAO object for the given ID and return it.
1000 * Id of the DAO object being searched for.
1003 * Object of the type of the class that called this function.
1005 public static function findById($id) {
1006 $object = new static();
1008 if (!$object->find(TRUE)) {
1009 throw new Exception("Unable to find a " . get_called_class() . " with id {$id}.");
1015 * Returns all results as array-encoded records.
1019 public function fetchAll() {
1021 while ($this->fetch()) {
1022 $result[] = $this->toArray();
1028 * Get all the result records as mapping between columns.
1030 * @param string $keyColumn
1032 * @param string $valueColumn
1035 * Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]
1037 public function fetchMap($keyColumn, $valueColumn) {
1039 while ($this->fetch()) {
1040 $result[$this->{$keyColumn}] = $this->{$valueColumn};
1046 * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
1048 * @param string $daoName
1049 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1050 * @param int $searchValue
1051 * Value of the column you want to search by.
1052 * @param string $returnColumn
1053 * Name of the column you want to GET the value of.
1054 * @param string $searchColumn
1055 * Name of the column you want to search by.
1056 * @param bool $force
1057 * Skip use of the cache.
1059 * @return string|null
1060 * Value of $returnColumn in the retrieved record
1062 public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
1064 empty($searchValue) ||
1065 trim(strtolower($searchValue)) == 'null'
1067 // adding this year since developers forget to check for an id
1068 // or for the 'null' (which is a bad DAO kludge)
1069 // and hence we get the first value in the db
1070 CRM_Core_Error
::fatal();
1073 $cacheKey = "{$daoName}:{$searchValue}:{$returnColumn}:{$searchColumn}";
1074 if (self
::$_dbColumnValueCache === NULL) {
1075 self
::$_dbColumnValueCache = array();
1078 if (!array_key_exists($cacheKey, self
::$_dbColumnValueCache) ||
$force) {
1079 $object = new $daoName();
1080 $object->$searchColumn = $searchValue;
1081 $object->selectAdd();
1082 $object->selectAdd($returnColumn);
1085 if ($object->find(TRUE)) {
1086 $result = $object->$returnColumn;
1090 self
::$_dbColumnValueCache[$cacheKey] = $result;
1092 return self
::$_dbColumnValueCache[$cacheKey];
1096 * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
1098 * @param string $daoName
1099 * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1100 * @param int $searchValue
1101 * Value of the column you want to search by.
1102 * @param string $setColumn
1103 * Name of the column you want to SET the value of.
1104 * @param string $setValue
1105 * SET the setColumn to this value.
1106 * @param string $searchColumn
1107 * Name of the column you want to search by.
1110 * true if we found and updated the object, else false
1112 public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
1113 $object = new $daoName();
1114 $object->selectAdd();
1115 $object->selectAdd("$searchColumn, $setColumn");
1116 $object->$searchColumn = $searchValue;
1118 if ($object->find(TRUE)) {
1119 $object->$setColumn = $setValue;
1120 if ($object->save()) {
1131 * @param array|object $sort either array or CRM_Utils_Sort
1132 * @param string $default
1133 * Default sort value.
1138 public static function getSortString($sort, $default = NULL) {
1139 // check if sort is of type CRM_Utils_Sort
1140 if (is_a($sort, 'CRM_Utils_Sort')) {
1141 return $sort->orderBy();
1144 // is it an array specified as $field => $sortDirection ?
1146 foreach ($sort as $k => $v) {
1147 $sortString .= "$k $v,";
1149 return rtrim($sortString, ',');
1155 * Fetch object based on array of properties.
1157 * @param string $daoName
1158 * Name of the dao object.
1159 * @param array $params
1160 * (reference ) an assoc array of name/value pairs.
1161 * @param array $defaults
1162 * (reference ) an assoc array to hold the flattened values.
1163 * @param array $returnProperities
1164 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1167 * an object of type referenced by daoName
1169 public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
1170 $object = new $daoName();
1171 $object->copyValues($params);
1173 // return only specific fields if returnproperties are sent
1174 if (!empty($returnProperities)) {
1175 $object->selectAdd();
1176 $object->selectAdd(implode(',', $returnProperities));
1179 if ($object->find(TRUE)) {
1180 self
::storeValues($object, $defaults);
1187 * Delete the object records that are associated with this contact.
1189 * @param string $daoName
1190 * Name of the dao object.
1191 * @param int $contactId
1192 * Id of the contact to delete.
1194 public static function deleteEntityContact($daoName, $contactId) {
1195 $object = new $daoName();
1197 $object->entity_table
= 'civicrm_contact';
1198 $object->entity_id
= $contactId;
1203 * Execute an unbuffered query.
1205 * This is a wrapper around new functionality exposed with CRM-17748.
1207 * @param string $query query to be executed
1209 * @param array $params
1210 * @param bool $abort
1211 * @param null $daoName
1212 * @param bool $freeDAO
1213 * @param bool $i18nRewrite
1214 * @param bool $trapException
1216 * @return CRM_Core_DAO
1217 * Object that points to an unbuffered result set
1219 static public function executeUnbufferedQuery(
1225 $i18nRewrite = TRUE,
1226 $trapException = FALSE
1228 $queryStr = self
::composeQuery($query, $params, $abort);
1229 //CRM_Core_Error::debug( 'q', $queryStr );
1231 $dao = new CRM_Core_DAO();
1234 $dao = new $daoName();
1237 if ($trapException) {
1238 CRM_Core_Error
::ignoreException();
1241 // set the DAO object to use an unbuffered query
1242 $dao->setOptions(array('result_buffering' => 0));
1244 $result = $dao->query($queryStr, $i18nRewrite);
1246 if ($trapException) {
1247 CRM_Core_Error
::setCallback();
1250 if (is_a($result, 'DB_Error')) {
1254 // since it is unbuffered, ($dao->N==0) is true. This blocks the standard fetch() mechanism.
1258 preg_match('/^(insert|update|delete|create|drop|replace)/i', $queryStr)
1260 // we typically do this for insert/update/delete stataments OR if explicitly asked to
1270 * @param string $query
1271 * Query to be executed.
1273 * @param array $params
1274 * @param bool $abort
1275 * @param null $daoName
1276 * @param bool $freeDAO
1277 * @param bool $i18nRewrite
1278 * @param bool $trapException
1280 * @return CRM_Core_DAO|object
1281 * object that holds the results of the query
1282 * NB - if this is defined as just returning a DAO phpstorm keeps pointing
1283 * out all the properties that are not part of the DAO
1285 public static function &executeQuery(
1291 $i18nRewrite = TRUE,
1292 $trapException = FALSE
1294 $queryStr = self
::composeQuery($query, $params, $abort);
1297 $dao = new CRM_Core_DAO();
1300 $dao = new $daoName();
1303 if ($trapException) {
1304 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
1307 $result = $dao->query($queryStr, $i18nRewrite);
1309 if (is_a($result, 'DB_Error')) {
1314 preg_match('/^(insert|update|delete|create|drop|replace)/i', $queryStr)
1316 // we typically do this for insert/update/delete statements OR if explicitly asked to
1324 * Execute a query and get the single result.
1326 * @param string $query
1327 * Query to be executed.
1328 * @param array $params
1329 * @param bool $abort
1330 * @param bool $i18nRewrite
1331 * @return string|null
1332 * the result of the query if any
1335 public static function &singleValueQuery(
1341 $queryStr = self
::composeQuery($query, $params, $abort);
1343 static $_dao = NULL;
1346 $_dao = new CRM_Core_DAO();
1349 $_dao->query($queryStr, $i18nRewrite);
1351 $result = $_dao->getDatabaseResult();
1354 $row = $result->fetchRow();
1364 * Compose the query by merging the parameters into it.
1366 * @param string $query
1367 * @param array $params
1368 * @param bool $abort
1373 public static function composeQuery($query, $params, $abort = TRUE) {
1375 foreach ($params as $key => $item) {
1376 if (is_numeric($key)) {
1377 if (CRM_Utils_Type
::validate($item[0], $item[1]) !== NULL) {
1378 $item[0] = self
::escapeString($item[0]);
1379 if ($item[1] == 'String' ||
1380 $item[1] == 'Memo' ||
1383 // Support class constants stipulating wildcard characters and/or
1384 // non-quoting of strings. Also support legacy code which may be
1385 // passing in TRUE or 1 for $item[2], which used to indicate the
1386 // use of wildcard characters.
1387 if (!empty($item[2])) {
1388 if ($item[2] & CRM_Core_DAO
::QUERY_FORMAT_WILDCARD ||
$item[2] === TRUE) {
1389 $item[0] = "'%{$item[0]}%'";
1391 elseif (!($item[2] & CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
)) {
1392 $item[0] = "'{$item[0]}'";
1396 $item[0] = "'{$item[0]}'";
1400 if (($item[1] == 'Date' ||
$item[1] == 'Timestamp') &&
1401 strlen($item[0]) == 0
1406 $tr['%' . $key] = $item[0];
1409 CRM_Core_Error
::fatal("{$item[0]} is not of type {$item[1]}");
1414 return strtr($query, $tr);
1420 public static function freeResult($ids = NULL) {
1421 global $_DB_DATAOBJECT;
1424 if (!$_DB_DATAOBJECT ||
1425 !isset($_DB_DATAOBJECT['RESULTS'])
1429 $ids = array_keys($_DB_DATAOBJECT['RESULTS']);
1432 foreach ($ids as $id) {
1433 if (isset($_DB_DATAOBJECT['RESULTS'][$id])) {
1434 $_DB_DATAOBJECT['RESULTS'][$id]->free();
1435 unset($_DB_DATAOBJECT['RESULTS'][$id]);
1438 if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$id])) {
1439 unset($_DB_DATAOBJECT['RESULTFIELDS'][$id]);
1445 * make a shallow copy of an object.
1446 * and all the fields in the object
1448 * @param string $daoName
1450 * @param array $criteria
1451 * Array of all the fields & values.
1452 * on which basis to copy
1453 * @param array $newData
1454 * Array of all the fields & values.
1455 * to be copied besides the other fields
1456 * @param string $fieldsFix
1457 * Array of fields that you want to prefix/suffix/replace.
1458 * @param string $blockCopyOfDependencies
1459 * Fields that you want to block from.
1463 * @return CRM_Core_DAO
1464 * the newly created copy of the object
1466 public static function ©Generic($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL) {
1467 $object = new $daoName();
1469 $object->id
= $criteria['id'];
1472 foreach ($criteria as $key => $value) {
1473 $object->$key = $value;
1478 while ($object->fetch()) {
1480 // all the objects except with $blockCopyOfDependencies set
1481 // be copied - addresses #CRM-1962
1483 if ($blockCopyOfDependencies && $object->$blockCopyOfDependencies) {
1487 $newObject = new $daoName();
1489 $fields = &$object->fields();
1490 if (!is_array($fieldsFix)) {
1491 $fieldsToPrefix = array();
1492 $fieldsToSuffix = array();
1493 $fieldsToReplace = array();
1495 if (!empty($fieldsFix['prefix'])) {
1496 $fieldsToPrefix = $fieldsFix['prefix'];
1498 if (!empty($fieldsFix['suffix'])) {
1499 $fieldsToSuffix = $fieldsFix['suffix'];
1501 if (!empty($fieldsFix['replace'])) {
1502 $fieldsToReplace = $fieldsFix['replace'];
1505 foreach ($fields as $name => $value) {
1506 if ($name == 'id' ||
$value['name'] == 'id') {
1507 // copy everything but the id!
1511 $dbName = $value['name'];
1512 $type = CRM_Utils_Type
::typeToString($value['type']);
1513 $newObject->$dbName = $object->$dbName;
1514 if (isset($fieldsToPrefix[$dbName])) {
1515 $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1517 if (isset($fieldsToSuffix[$dbName])) {
1518 $newObject->$dbName .= $fieldsToSuffix[$dbName];
1520 if (isset($fieldsToReplace[$dbName])) {
1521 $newObject->$dbName = $fieldsToReplace[$dbName];
1524 if ($type == 'Timestamp' ||
$type == 'Date') {
1525 $newObject->$dbName = CRM_Utils_Date
::isoToMysql($newObject->$dbName);
1529 foreach ($newData as $k => $v) {
1530 $newObject->$k = $v;
1540 * Cascade update through related entities.
1542 * @param string $daoName
1545 * @param array $newData
1547 * @return CRM_Core_DAO|null
1549 public static function cascadeUpdate($daoName, $fromId, $toId, $newData = array()) {
1550 $object = new $daoName();
1551 $object->id
= $fromId;
1553 if ($object->find(TRUE)) {
1554 $newObject = new $daoName();
1555 $newObject->id
= $toId;
1557 if ($newObject->find(TRUE)) {
1558 $fields = &$object->fields();
1559 foreach ($fields as $name => $value) {
1560 if ($name == 'id' ||
$value['name'] == 'id') {
1561 // copy everything but the id!
1565 $colName = $value['name'];
1566 $newObject->$colName = $object->$colName;
1568 if (substr($name, -5) == '_date' ||
1569 substr($name, -10) == '_date_time'
1571 $newObject->$colName = CRM_Utils_Date
::isoToMysql($newObject->$colName);
1574 foreach ($newData as $k => $v) {
1575 $newObject->$k = $v;
1585 * Given the component id, compute the contact id
1586 * since its used for things like send email
1588 * @param $componentIDs
1589 * @param string $tableName
1593 public static function &getContactIDsFromComponent(&$componentIDs, $tableName) {
1594 $contactIDs = array();
1596 if (empty($componentIDs)) {
1600 $IDs = implode(',', $componentIDs);
1604 WHERE id IN ( $IDs )
1607 $dao = CRM_Core_DAO
::executeQuery($query);
1608 while ($dao->fetch()) {
1609 $contactIDs[] = $dao->contact_id
;
1615 * Fetch object based on array of properties.
1617 * @param string $daoName
1618 * Name of the dao object.
1619 * @param string $fieldIdName
1620 * @param int $fieldId
1622 * @param array $returnProperities
1623 * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1626 * an object of type referenced by daoName
1628 public static function commonRetrieveAll($daoName, $fieldIdName = 'id', $fieldId, &$details, $returnProperities = NULL) {
1629 require_once str_replace('_', DIRECTORY_SEPARATOR
, $daoName) . ".php";
1630 $object = new $daoName();
1631 $object->$fieldIdName = $fieldId;
1633 // return only specific fields if returnproperties are sent
1634 if (!empty($returnProperities)) {
1635 $object->selectAdd();
1636 $object->selectAdd('id');
1637 $object->selectAdd(implode(',', $returnProperities));
1641 while ($object->fetch()) {
1642 $defaults = array();
1643 self
::storeValues($object, $defaults);
1644 $details[$object->id
] = $defaults;
1650 public static function dropAllTables() {
1652 // first drop all the custom tables we've created
1653 CRM_Core_BAO_CustomGroup
::dropAllTables();
1655 // drop all multilingual views
1656 CRM_Core_I18n_Schema
::dropAllViews();
1658 CRM_Utils_File
::sourceSQLFile(CIVICRM_DSN
,
1659 dirname(__FILE__
) . DIRECTORY_SEPARATOR
.
1660 '..' . DIRECTORY_SEPARATOR
.
1661 '..' . DIRECTORY_SEPARATOR
.
1662 'sql' . DIRECTORY_SEPARATOR
.
1663 'civicrm_drop.mysql'
1672 public static function escapeString($string) {
1673 static $_dao = NULL;
1675 // If this is an atypical case (e.g. preparing .sql file before CiviCRM
1676 // has been installed), then we fallback DB-less str_replace escaping, as
1677 // we can't use mysqli_real_escape_string, as there is no DB connection.
1678 // Note: In typical usage, escapeString() will only check one conditional
1679 // ("if !$_dao") rather than two conditionals ("if !defined(DSN)")
1680 if (!defined('CIVICRM_DSN')) {
1681 // See http://php.net/manual/en/mysqli.real-escape-string.php for the
1682 // list of characters mysqli_real_escape_string escapes.
1683 $search = array("\\", "\x00", "\n", "\r", "'", '"', "\x1a");
1684 $replace = array("\\\\", "\\0", "\\n", "\\r", "\'", '\"', "\\Z");
1685 return str_replace($search, $replace, $string);
1687 $_dao = new CRM_Core_DAO();
1689 return $_dao->escape($string);
1693 * Escape a list of strings for use with "WHERE X IN (...)" queries.
1695 * @param array $strings
1696 * @param string $default
1697 * the value to use if $strings has no elements.
1699 * eg "abc","def","ghi"
1701 public static function escapeStrings($strings, $default = NULL) {
1702 static $_dao = NULL;
1704 $_dao = new CRM_Core_DAO();
1707 if (empty($strings)) {
1711 $escapes = array_map(array($_dao, 'escape'), $strings);
1712 return '"' . implode('","', $escapes) . '"';
1720 public static function escapeWildCardString($string) {
1722 // ensure we escape the single characters % and _ which are mysql wild
1723 // card characters and could come in via sortByCharacter
1724 // note that mysql does not escape these characters
1725 if ($string && in_array($string,
1726 array('%', '_', '%%', '_%')
1729 return '\\' . $string;
1732 return self
::escapeString($string);
1736 * Creates a test object, including any required objects it needs via recursion
1737 * createOnly: only create in database, do not store or return the objects (useful for perf testing)
1738 * ONLY USE FOR TESTING
1740 * @param string $daoName
1741 * @param array $params
1742 * @param int $numObjects
1743 * @param bool $createOnly
1745 * @return object|array|NULL
1746 * NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.
1748 public static function createTestObject(
1754 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
1755 // so we re-set here in case
1756 $config = CRM_Core_Config
::singleton();
1757 $config->backtrace
= TRUE;
1759 static $counter = 0;
1760 CRM_Core_DAO
::$_testEntitiesToSkip = array(
1761 'CRM_Core_DAO_Worldregion',
1762 'CRM_Core_DAO_StateProvince',
1763 'CRM_Core_DAO_Country',
1764 'CRM_Core_DAO_Domain',
1765 'CRM_Financial_DAO_FinancialType',
1766 //because valid ones exist & we use pick them due to pseudoconstant can't reliably create & delete these
1769 // Prefer to instantiate BAO's instead of DAO's (when possible)
1770 // so that assignTestValue()/assignTestFK() can be overloaded.
1771 $baoName = str_replace('_DAO_', '_BAO_', $daoName);
1772 if (class_exists($baoName)) {
1773 $daoName = $baoName;
1776 for ($i = 0; $i < $numObjects; ++
$i) {
1779 /** @var CRM_Core_DAO $object */
1780 $object = new $daoName();
1782 $fields = &$object->fields();
1783 foreach ($fields as $fieldName => $fieldDef) {
1784 $dbName = $fieldDef['name'];
1785 $FKClassName = CRM_Utils_Array
::value('FKClassName', $fieldDef);
1786 $required = CRM_Utils_Array
::value('required', $fieldDef);
1788 if (CRM_Utils_Array
::value($dbName, $params) !== NULL && !is_array($params[$dbName])) {
1789 $object->$dbName = $params[$dbName];
1792 elseif ($dbName != 'id') {
1793 if ($FKClassName != NULL) {
1794 $object->assignTestFK($fieldName, $fieldDef, $params);
1798 $object->assignTestValue($fieldName, $fieldDef, $counter);
1806 $objects[$i] = $object;
1816 elseif ($numObjects == 1) {
1825 * Deletes the this object plus any dependent objects that are associated with it.
1826 * ONLY USE FOR TESTING
1828 * @param string $daoName
1829 * @param array $params
1831 public static function deleteTestObjects($daoName, $params = array()) {
1832 //this is a test function also backtrace is set for the test suite it sometimes unsets itself
1833 // so we re-set here in case
1834 $config = CRM_Core_Config
::singleton();
1835 $config->backtrace
= TRUE;
1837 $object = new $daoName();
1838 $object->id
= CRM_Utils_Array
::value('id', $params);
1840 $deletions = array(); // array(array(0 => $daoName, 1 => $daoParams))
1841 if ($object->find(TRUE)) {
1843 $fields = &$object->fields();
1844 foreach ($fields as $name => $value) {
1846 $dbName = $value['name'];
1848 $FKClassName = CRM_Utils_Array
::value('FKClassName', $value);
1849 $required = CRM_Utils_Array
::value('required', $value);
1850 if ($FKClassName != NULL
1852 && !in_array($FKClassName, CRM_Core_DAO
::$_testEntitiesToSkip)
1853 && ($required ||
$dbName == 'contact_id')
1854 //I'm a bit stuck on this one - we might need to change the singleValueAlter so that the entities don't share a contact
1855 // to make this test process pass - line below makes pass for now
1856 && $dbName != 'member_of_contact_id'
1858 $deletions[] = array($FKClassName, array('id' => $object->$dbName)); // x
1865 foreach ($deletions as $deletion) {
1866 CRM_Core_DAO
::deleteTestObjects($deletion[0], $deletion[1]);
1871 * Set defaults when creating new entity.
1872 * (don't call this set defaults as already in use with different signature in some places)
1874 * @param array $params
1877 public static function setCreateDefaults(&$params, $defaults) {
1878 if (!empty($params['id'])) {
1881 foreach ($defaults as $key => $value) {
1882 if (!array_key_exists($key, $params) ||
$params[$key] === NULL) {
1883 $params[$key] = $value;
1889 * @param string $prefix
1890 * @param bool $addRandomString
1891 * @param null $string
1895 public static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
1896 $tableName = $prefix . "_temp";
1898 if ($addRandomString) {
1900 $tableName .= "_" . $string;
1903 $tableName .= "_" . md5(uniqid('', TRUE));
1911 * @param bool $trigger
1915 public static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
1916 if (\Civi
::settings()->get('logging_no_trigger_permission')) {
1919 // test for create view and trigger permissions and if allowed, add the option to go multilingual
1921 // I'm not sure why we use the getStaticProperty for an error, rather than checking for DB_Error
1922 CRM_Core_TemporaryErrorScope
::ignoreException();
1923 $dao = new CRM_Core_DAO();
1925 $result = $dao->query('CREATE OR REPLACE VIEW civicrm_domain_view AS SELECT * FROM civicrm_domain');
1926 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError') ||
is_a($result, 'DB_Error')) {
1932 $result = $dao->query('CREATE TRIGGER civicrm_domain_trigger BEFORE INSERT ON civicrm_domain FOR EACH ROW BEGIN END');
1933 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError') ||
is_a($result, 'DB_Error')) {
1935 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
1940 $dao->query('DROP TRIGGER IF EXISTS civicrm_domain_trigger');
1941 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
1943 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
1950 $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
1951 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
1960 * @param null $message
1961 * @param bool $printDAO
1963 public static function debugPrint($message = NULL, $printDAO = TRUE) {
1964 CRM_Utils_System
::xMemory("{$message}: ");
1967 global $_DB_DATAOBJECT;
1969 foreach (array_keys($_DB_DATAOBJECT['RESULTS']) as $id) {
1970 $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query
;
1972 CRM_Core_Error
::debug('_DB_DATAOBJECT', $q);
1977 * Build a list of triggers via hook and add them to (err, reconcile them
1978 * with) the database.
1980 * @param string $tableName
1981 * the specific table requiring a rebuild; or NULL to rebuild all tables.
1982 * @param bool $force
1987 public static function triggerRebuild($tableName = NULL, $force = FALSE) {
1988 Civi
::service('sql_triggers')->rebuild($tableName, $force);
1992 * Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
1993 * @see http://issues.civicrm.org/jira/browse/CRM-13822
1994 * TODO: Alternative solutions might be
1995 * * Stop using functions and find another way to strip numeric characters from phones
1996 * * Give better error messages (currently a missing fn fatals with "unknown error")
1998 public static function checkSqlFunctionsExist() {
1999 if (!self
::$_checkedSqlFunctionsExist) {
2000 self
::$_checkedSqlFunctionsExist = TRUE;
2001 $dao = CRM_Core_DAO
::executeQuery("SHOW function status WHERE db = database() AND name = 'civicrm_strip_non_numeric'");
2002 if (!$dao->fetch()) {
2003 self
::triggerRebuild();
2009 * Wrapper function to drop triggers.
2011 * @param string $tableName
2012 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2015 public static function dropTriggers($tableName = NULL) {
2016 Civi
::service('sql_triggers')->dropTriggers($tableName);
2020 * @param array $info
2021 * per hook_civicrm_triggerInfo.
2022 * @param string $onlyTableName
2023 * the specific table requiring a rebuild; or NULL to rebuild all tables.
2026 public static function createTriggers(&$info, $onlyTableName = NULL) {
2027 Civi
::service('sql_triggers')->createTriggers($info, $onlyTableName);
2031 * Given a list of fields, create a list of references.
2033 * @param string $className
2034 * BAO/DAO class name.
2035 * @return array<CRM_Core_Reference_Interface>
2037 public static function createReferenceColumns($className) {
2039 $fields = $className::fields();
2040 foreach ($fields as $field) {
2041 if (isset($field['pseudoconstant'], $field['pseudoconstant']['optionGroupName'])) {
2042 $result[] = new CRM_Core_Reference_OptionValue(
2043 $className::getTableName(),
2045 'civicrm_option_value',
2046 CRM_Utils_Array
::value('keyColumn', $field['pseudoconstant'], 'value'),
2047 $field['pseudoconstant']['optionGroupName']
2055 * Find all records which refer to this entity.
2058 * Array of objects referencing this
2060 public function findReferences() {
2061 $links = self
::getReferencesToTable(static::getTableName());
2063 $occurrences = array();
2064 foreach ($links as $refSpec) {
2065 /** @var $refSpec CRM_Core_Reference_Interface */
2066 $daoName = CRM_Core_DAO_AllCoreTables
::getClassForTable($refSpec->getReferenceTable());
2067 $result = $refSpec->findReferences($this);
2069 while ($result->fetch()) {
2070 $obj = new $daoName();
2071 $obj->id
= $result->id
;
2072 $occurrences[] = $obj;
2077 return $occurrences;
2082 * each item has keys:
2086 * - table: string|null SQL table name
2087 * - key: string|null SQL column name
2089 public function getReferenceCounts() {
2090 $links = self
::getReferencesToTable(static::getTableName());
2093 foreach ($links as $refSpec) {
2094 /** @var $refSpec CRM_Core_Reference_Interface */
2095 $count = $refSpec->getReferenceCount($this);
2096 if ($count['count'] != 0) {
2101 foreach (CRM_Core_Component
::getEnabledComponents() as $component) {
2102 /** @var $component CRM_Core_Component_Info */
2103 $counts = array_merge($counts, $component->getReferenceCounts($this));
2105 CRM_Utils_Hook
::referenceCounts($this, $counts);
2111 * List all tables which have hard foreign keys to this table.
2113 * For now, this returns a description of every entity_id/entity_table
2115 * TODO: filter dynamic entity references on the $tableName, based on
2116 * schema metadata in dynamicForeignKey which enumerates a restricted
2117 * set of possible entity_table's.
2119 * @param string $tableName
2120 * Table referred to.
2123 * structure of table and column, listing every table with a
2124 * foreign key reference to $tableName, and the column where the key appears.
2126 public static function getReferencesToTable($tableName) {
2127 $refsFound = array();
2128 foreach (CRM_Core_DAO_AllCoreTables
::getClasses() as $daoClassName) {
2129 $links = $daoClassName::getReferenceColumns();
2130 $daoTableName = $daoClassName::getTableName();
2132 foreach ($links as $refSpec) {
2133 /** @var $refSpec CRM_Core_Reference_Interface */
2134 if ($refSpec->matchesTargetTable($tableName)) {
2135 $refsFound[] = $refSpec;
2143 * Lookup the value of a MySQL global configuration variable.
2145 * @param string $name
2146 * E.g. "thread_stack".
2147 * @param mixed $default
2150 public static function getGlobalSetting($name, $default = NULL) {
2151 // Alternatively, SELECT @@GLOBAL.thread_stack, but
2152 // that has been reported to fail under MySQL 5.0 for OS X
2153 $escapedName = self
::escapeString($name);
2154 $dao = CRM_Core_DAO
::executeQuery("SHOW VARIABLES LIKE '$escapedName'");
2155 if ($dao->fetch()) {
2165 * Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
2167 * This is relevant where we want to offer both the ID field and the label field
2168 * as an option, e.g. search builder.
2170 * It is currently limited for optionGroupName for purposes keeping the scope of the
2171 * change small, but is appropriate for other sorts of pseudoconstants.
2173 * @param array $fields
2175 protected static function appendPseudoConstantsToFields(&$fields) {
2176 foreach ($fields as $field) {
2177 if (!empty($field['pseudoconstant']) && !empty($field['pseudoconstant']['optionGroupName'])) {
2178 $fields[$field['pseudoconstant']['optionGroupName']] = array(
2179 'title' => CRM_Core_BAO_OptionGroup
::getTitleByName($field['pseudoconstant']['optionGroupName']),
2180 'name' => $field['pseudoconstant']['optionGroupName'],
2181 'data_type' => CRM_Utils_Type
::T_STRING
,
2188 * Get options for the called BAO object's field.
2190 * This function can be overridden by each BAO to add more logic related to context.
2191 * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
2193 * @param string $fieldName
2194 * @param string $context
2195 * @see CRM_Core_DAO::buildOptionsContext
2196 * @param array $props
2197 * whatever is known about this bao object.
2199 * @return array|bool
2201 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
2202 // If a given bao does not override this function
2203 $baoName = get_called_class();
2204 return CRM_Core_PseudoConstant
::get($baoName, $fieldName, array(), $context);
2208 * Populate option labels for this object's fields.
2210 * @throws exception if called directly on the base class
2212 public function getOptionLabels() {
2213 $fields = $this->fields();
2214 if ($fields === NULL) {
2215 throw new Exception('Cannot call getOptionLabels on CRM_Core_DAO');
2217 foreach ($fields as $field) {
2218 $name = CRM_Utils_Array
::value('name', $field);
2219 if ($name && isset($this->$name)) {
2220 $label = CRM_Core_PseudoConstant
::getLabel(get_class($this), $name, $this->$name);
2221 if ($label !== FALSE) {
2222 // Append 'label' onto the field name
2223 $labelName = $name . '_label';
2224 $this->$labelName = $label;
2231 * Provides documentation and validation for the buildOptions $context param
2233 * @param string $context
2238 public static function buildOptionsContext($context = NULL) {
2240 'get' => "get: all options are returned, even if they are disabled; labels are translated.",
2241 'create' => "create: options are filtered appropriately for the object being created/updated; labels are translated.",
2242 'search' => "search: searchable options are returned; labels are translated.",
2243 'validate' => "validate: all options are returned, even if they are disabled; machine names are used in place of labels.",
2244 'abbreviate' => "abbreviate: enabled options are returned; labels are replaced with abbreviations.",
2245 'match' => "match: enabled options are returned using machine names as keys; labels are translated.",
2247 // Validation: enforce uniformity of this param
2248 if ($context !== NULL && !isset($contexts[$context])) {
2249 throw new Exception("'$context' is not a valid context for buildOptions.");
2255 * @param string $fieldName
2256 * @return bool|array
2258 public function getFieldSpec($fieldName) {
2259 $fields = $this->fields();
2260 $fieldKeys = $this->fieldKeys();
2262 // Support "unique names" as well as sql names
2263 $fieldKey = $fieldName;
2264 if (empty($fields[$fieldKey])) {
2265 $fieldKey = CRM_Utils_Array
::value($fieldName, $fieldKeys);
2267 // If neither worked then this field doesn't exist. Return false.
2268 if (empty($fields[$fieldKey])) {
2271 return $fields[$fieldKey];
2275 * Get SQL where clause for SQL filter syntax input parameters.
2277 * SQL version of api function to assign filters to the DAO based on the syntax
2278 * $field => array('IN' => array(4,6,9))
2280 * $field => array('LIKE' => array('%me%))
2283 * @param string $fieldName
2285 * @param array $filter
2286 * filter to be applied indexed by operator.
2287 * @param string $type
2288 * type of field (not actually used - nor in api @todo ).
2289 * @param string $alias
2290 * alternative field name ('as') @todo- not actually used.
2291 * @param bool $returnSanitisedArray
2292 * Return a sanitised array instead of a clause.
2293 * this is primarily so we can add filters @ the api level to the Query object based fields
2297 * @return NULL|string|array
2298 * a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL
2299 * depending on whether it is supported as yet
2301 public static function createSQLFilter($fieldName, $filter, $type = NULL, $alias = NULL, $returnSanitisedArray = FALSE) {
2302 foreach ($filter as $operator => $criteria) {
2303 if (in_array($operator, self
::acceptedSQLOperators(), TRUE)) {
2304 switch ($operator) {
2308 if (!$returnSanitisedArray) {
2309 return (sprintf('%s %s', $fieldName, $operator));
2312 return (sprintf('%s %s ', $fieldName, $operator));
2316 // ternary operators
2319 if (empty($criteria[0]) ||
empty($criteria[1])) {
2320 throw new Exception("invalid criteria for $operator");
2322 if (!$returnSanitisedArray) {
2323 return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO
::escapeString($criteria[0]), CRM_Core_DAO
::escapeString($criteria[1])));
2326 return NULL; // not yet implemented (tests required to implement)
2333 if (empty($criteria)) {
2334 throw new Exception("invalid criteria for $operator");
2336 $escapedCriteria = array_map(array(
2340 if (!$returnSanitisedArray) {
2341 return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
2343 return $escapedCriteria;
2348 if (!$returnSanitisedArray) {
2349 return (sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO
::escapeString($criteria)));
2352 return NULL; // not yet implemented (tests required to implement)
2360 * @see http://issues.civicrm.org/jira/browse/CRM-9150
2361 * support for other syntaxes is discussed in ticket but being put off for now
2364 public static function acceptedSQLOperators() {
2385 * SQL has a limit of 64 characters on various names:
2386 * table name, trigger name, column name ...
2388 * For custom groups and fields we generated names from user entered input
2389 * which can be longer than this length, this function helps with creating
2390 * strings that meet various criteria.
2392 * @param string $string
2393 * The string to be shortened.
2394 * @param int $length
2395 * The max length of the string.
2397 * @param bool $makeRandom
2401 public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) {
2402 // early return for strings that meet the requirements
2403 if (strlen($string) <= $length) {
2407 // easy return for calls that dont need a randomized uniq string
2409 return substr($string, 0, $length);
2412 // the string is longer than the length and we need a uniq string
2413 // for the same tablename we need the same uniq string every time
2414 // hence we use md5 on the string, which is not random
2415 // we'll append 8 characters to the end of the tableName
2416 $md5string = substr(md5($string), 0, 8);
2417 return substr($string, 0, $length - 8) . "_{$md5string}";
2421 * https://issues.civicrm.org/jira/browse/CRM-17748
2422 * Sets the internal options to be used on a query
2424 * @param array $options
2427 public function setOptions($options) {
2428 if (is_array($options)) {
2429 $this->_options
= $options;
2434 * https://issues.civicrm.org/jira/browse/CRM-17748
2435 * wrapper to pass internal DAO options down to DB_mysql/DB_Common level
2437 * @param array $options
2440 protected function _setDBOptions($options) {
2441 global $_DB_DATAOBJECT;
2443 if (is_array($options) && count($options)) {
2444 $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5
];
2445 foreach ($options as $option_name => $option_value) {
2446 $conn->setOption($option_name, $option_value);
2453 * @param array $params
2455 public function setApiFilter(&$params) {
2459 * Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
2461 * Return format is in the form of fieldname => clauses starting with an operator. e.g.:
2464 * 'location_type_id' => array('IS NOT NULL', 'IN (1,2,3)')
2468 * Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values.
2472 public function addSelectWhereClause() {
2474 $fields = $this->fields();
2475 foreach ($fields as $fieldName => $field) {
2476 // Clause for contact-related entities like Email, Relationship, etc.
2477 if (strpos($fieldName, 'contact_id') === 0 && CRM_Utils_Array
::value('FKClassName', $field) == 'CRM_Contact_DAO_Contact') {
2478 $clauses[$fieldName] = CRM_Utils_SQL
::mergeSubquery('Contact');
2480 // Clause for an entity_table/entity_id combo
2481 if ($fieldName == 'entity_id' && isset($fields['entity_table'])) {
2482 $relatedClauses = array();
2483 $relatedEntities = $this->buildOptions('entity_table', 'get');
2484 foreach ((array) $relatedEntities as $table => $ent) {
2486 $ent = CRM_Core_DAO_AllCoreTables
::getBriefName(CRM_Core_DAO_AllCoreTables
::getClassForTable($table));
2487 $subquery = CRM_Utils_SQL
::mergeSubquery($ent);
2489 $relatedClauses[] = "(entity_table = '$table' AND entity_id " . implode(' AND entity_id ', $subquery) . ")";
2492 $relatedClauses[] = "(entity_table = '$table')";
2496 if ($relatedClauses) {
2497 $clauses['id'] = 'IN (SELECT id FROM `' . $this->tableName() . '` WHERE (' . implode(') OR (', $relatedClauses) . '))';
2501 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
2506 * This returns the final permissioned query string for this entity
2508 * With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
2510 * @param string $tableAlias
2513 public static function getSelectWhereClause($tableAlias = NULL) {
2514 $bao = new static();
2515 if ($tableAlias === NULL) {
2516 $tableAlias = $bao->tableName();
2519 foreach ((array) $bao->addSelectWhereClause() as $field => $vals) {
2520 $clauses[$field] = NULL;
2522 $clauses[$field] = "`$tableAlias`.`$field` " . implode(" AND `$tableAlias`.`$field` ", (array) $vals);
2529 * ensure database name is 'safe', i.e. only contains word characters (includes underscores)
2530 * and dashes, and contains at least one [a-z] case insenstive.
2536 public static function requireSafeDBName($database) {
2539 "/^[\w\-]*[a-z]+[\w\-]*$/i",
2543 if (empty($matches)) {