Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
bc77d7c0 TO |
3 | +--------------------------------------------------------------------+ |
4 | | Copyright CiviCRM LLC. All rights reserved. | | |
5 | | | | |
6 | | This work is published under the GNU AGPLv3 license with some | | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
9 | +--------------------------------------------------------------------+ | |
ced9bfed | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
44ce4aa3 CW |
13 | * Base Database Access Object class. |
14 | * | |
15 | * All DAO classes should inherit from this class. | |
6a488035 TO |
16 | * |
17 | * @package CRM | |
ca5cec67 | 18 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
19 | */ |
20 | ||
b3029f89 SL |
21 | if (!defined('DB_DSN_MODE')) { |
22 | define('DB_DSN_MODE', 'auto'); | |
23 | } | |
24 | ||
6a488035 TO |
25 | require_once 'PEAR.php'; |
26 | require_once 'DB/DataObject.php'; | |
27 | ||
28 | require_once 'CRM/Core/I18n.php'; | |
28518c90 EM |
29 | |
30 | /** | |
31 | * Class CRM_Core_DAO | |
32 | */ | |
6a488035 TO |
33 | class CRM_Core_DAO extends DB_DataObject { |
34 | ||
eda5da74 CW |
35 | /** |
36 | * Primary key field(s). | |
37 | * | |
38 | * @var string[] | |
39 | */ | |
40 | public static $_primaryKey = ['id']; | |
41 | ||
ffcc1d11 | 42 | /** |
43 | * How many times has this instance been cloned. | |
44 | * | |
45 | * @var int | |
46 | */ | |
47 | protected $resultCopies = 0; | |
48 | ||
6a488035 | 49 | /** |
1273d77c CW |
50 | * @var null |
51 | * @deprecated | |
6a488035 | 52 | */ |
518fa0ee | 53 | public static $_nullObject = NULL; |
449c4e6b CW |
54 | |
55 | /** | |
56 | * Icon associated with this entity. | |
57 | * | |
58 | * @var string | |
59 | */ | |
60 | public static $_icon = NULL; | |
61 | ||
8ab43c93 CW |
62 | /** |
63 | * Field to show when displaying a record. | |
64 | * | |
65 | * @var string | |
66 | */ | |
67 | public static $_labelField = NULL; | |
68 | ||
1273d77c CW |
69 | /** |
70 | * @var array | |
71 | * @deprecated | |
72 | */ | |
518fa0ee | 73 | public static $_nullArray = []; |
6a488035 | 74 | |
518fa0ee | 75 | public static $_dbColumnValueCache = NULL; |
7da04cde | 76 | const NOT_NULL = 1, IS_NULL = 2, |
353ffa53 TO |
77 | DB_DAO_NOTNULL = 128, |
78 | VALUE_SEPARATOR = "\ 1", | |
79 | BULK_INSERT_COUNT = 200, | |
80 | BULK_INSERT_HIGH_COUNT = 200, | |
353ffa53 | 81 | QUERY_FORMAT_WILDCARD = 1, |
2a5c9b4d | 82 | QUERY_FORMAT_NO_QUOTES = 2, |
168c8704 CW |
83 | |
84 | /** | |
85 | * Serialized string separated by and bookended with VALUE_SEPARATOR | |
86 | */ | |
2a5c9b4d | 87 | SERIALIZE_SEPARATOR_BOOKEND = 1, |
168c8704 CW |
88 | /** |
89 | * @deprecated format separated by VALUE_SEPARATOR | |
90 | */ | |
2a5c9b4d | 91 | SERIALIZE_SEPARATOR_TRIMMED = 2, |
168c8704 CW |
92 | /** |
93 | * Recommended serialization format | |
94 | */ | |
95 | SERIALIZE_JSON = 3, | |
96 | /** | |
97 | * @deprecated format using php serialize() | |
98 | */ | |
dd3ec98b CW |
99 | SERIALIZE_PHP = 4, |
100 | /** | |
101 | * Comma separated string, no quotes, no spaces | |
102 | */ | |
103 | SERIALIZE_COMMA = 5; | |
887a4028 | 104 | |
d424ffde | 105 | /** |
6a488035 | 106 | * Define entities that shouldn't be created or deleted when creating/ deleting |
d424ffde CW |
107 | * test objects - this prevents world regions, countries etc from being added / deleted |
108 | * @var array | |
6a488035 | 109 | */ |
518fa0ee | 110 | public static $_testEntitiesToSkip = []; |
6a488035 | 111 | /** |
fe482240 | 112 | * The factory class for this application. |
6a488035 TO |
113 | * @var object |
114 | */ | |
518fa0ee | 115 | public static $_factory = NULL; |
6a488035 | 116 | |
33092c89 SB |
117 | /** |
118 | * https://issues.civicrm.org/jira/browse/CRM-17748 | |
119 | * internal variable for DAO to hold per-query settings | |
518fa0ee | 120 | * @var array |
33092c89 | 121 | */ |
be2fb01f | 122 | protected $_options = []; |
33092c89 | 123 | |
6a488035 | 124 | /** |
fe482240 | 125 | * Class constructor. |
6a488035 | 126 | * |
e0f5b841 | 127 | * @return static |
6a488035 | 128 | */ |
00be9182 | 129 | public function __construct() { |
6a488035 TO |
130 | $this->initialize(); |
131 | $this->__table = $this->getTableName(); | |
132 | } | |
133 | ||
449c4e6b CW |
134 | /** |
135 | * Returns localized title of this entity. | |
7b66c3b5 | 136 | * |
449c4e6b CW |
137 | * @return string |
138 | */ | |
139 | public static function getEntityTitle() { | |
140 | $className = static::class; | |
51feb18e | 141 | CRM_Core_Error::deprecatedWarning("$className needs to be regenerated. Missing getEntityTitle method."); |
449c4e6b CW |
142 | return CRM_Core_DAO_AllCoreTables::getBriefName($className); |
143 | } | |
144 | ||
2562d09a CW |
145 | /** |
146 | * Returns user-friendly description of this entity. | |
147 | * | |
148 | * @return string|null | |
149 | */ | |
150 | public static function getEntityDescription() { | |
151 | return NULL; | |
152 | } | |
153 | ||
ffcc1d11 | 154 | public function __clone() { |
155 | if (!empty($this->_DB_resultid)) { | |
156 | $this->resultCopies++; | |
157 | } | |
158 | } | |
159 | ||
160 | /** | |
161 | * Class destructor. | |
162 | */ | |
163 | public function __destruct() { | |
164 | if ($this->resultCopies === 0) { | |
165 | $this->free(); | |
166 | } | |
167 | $this->resultCopies--; | |
168 | } | |
169 | ||
6a488035 | 170 | /** |
9d89b14d CW |
171 | * Returns the name of this table |
172 | * | |
173 | * @return string | |
6a488035 | 174 | */ |
00be9182 | 175 | public static function getTableName() { |
9d89b14d CW |
176 | return self::getLocaleTableName(static::$_tableName ?? NULL); |
177 | } | |
178 | ||
179 | /** | |
180 | * Returns if this table needs to be logged | |
181 | * | |
182 | * @return bool | |
183 | */ | |
184 | public function getLog() { | |
185 | return static::$_log ?? FALSE; | |
6a488035 TO |
186 | } |
187 | ||
188 | /** | |
fe482240 | 189 | * Initialize the DAO object. |
6a488035 | 190 | * |
6a0b768e TO |
191 | * @param string $dsn |
192 | * The database connection string. | |
6a488035 | 193 | */ |
00be9182 | 194 | public static function init($dsn) { |
3a036b15 | 195 | Civi::$statics[__CLASS__]['init'] = 1; |
6a488035 | 196 | $options = &PEAR::getStaticProperty('DB_DataObject', 'options'); |
58d1e21e | 197 | $dsn = CRM_Utils_SQL::autoSwitchDSN($dsn); |
6a488035 | 198 | $options['database'] = $dsn; |
078428c7 | 199 | $options['quote_identifiers'] = TRUE; |
fa1e300b | 200 | if (CRM_Utils_SQL::isSSLDSN($dsn)) { |
6f738dbf | 201 | // There are two different options arrays. |
202 | $other_options = &PEAR::getStaticProperty('DB', 'options'); | |
203 | $other_options['ssl'] = TRUE; | |
204 | } | |
6a488035 TO |
205 | if (defined('CIVICRM_DAO_DEBUG')) { |
206 | self::DebugLevel(CIVICRM_DAO_DEBUG); | |
207 | } | |
f720cdf0 | 208 | $factory = new CRM_Contact_DAO_Factory(); |
209 | CRM_Core_DAO::setFactory($factory); | |
d10ba6cb | 210 | CRM_Core_DAO::executeQuery('SET NAMES utf8mb4'); |
be2fb01f | 211 | CRM_Core_DAO::executeQuery('SET @uniqueID = %1', [1 => [CRM_Utils_Request::id(), 'String']]); |
6a488035 TO |
212 | } |
213 | ||
e95fbe72 TO |
214 | /** |
215 | * @return DB_common | |
216 | */ | |
217 | public static function getConnection() { | |
218 | global $_DB_DATAOBJECT; | |
219 | $dao = new CRM_Core_DAO(); | |
220 | return $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5]; | |
221 | } | |
222 | ||
84cb7d10 SL |
223 | /** |
224 | * Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary | |
225 | */ | |
226 | public static function disableFullGroupByMode() { | |
227 | $currentModes = CRM_Utils_SQL::getSqlModes(); | |
63dc1f23 | 228 | if (in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL::isGroupByModeInDefault()) { |
84cb7d10 SL |
229 | $key = array_search('ONLY_FULL_GROUP_BY', $currentModes); |
230 | unset($currentModes[$key]); | |
be2fb01f | 231 | CRM_Core_DAO::executeQuery("SET SESSION sql_mode = %1", [1 => [implode(',', $currentModes), 'String']]); |
84cb7d10 SL |
232 | } |
233 | } | |
234 | ||
235 | /** | |
2f68ef20 | 236 | * Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary.. |
84cb7d10 | 237 | */ |
2f68ef20 | 238 | public static function reenableFullGroupByMode() { |
84cb7d10 | 239 | $currentModes = CRM_Utils_SQL::getSqlModes(); |
63dc1f23 | 240 | if (!in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL::isGroupByModeInDefault()) { |
84cb7d10 | 241 | $currentModes[] = 'ONLY_FULL_GROUP_BY'; |
be2fb01f | 242 | CRM_Core_DAO::executeQuery("SET SESSION sql_mode = %1", [1 => [implode(',', $currentModes), 'String']]); |
84cb7d10 SL |
243 | } |
244 | } | |
245 | ||
e1b64aab | 246 | /** |
100fef9d | 247 | * @param string $fieldName |
e1b64aab | 248 | * @param $fieldDef |
c490a46a | 249 | * @param array $params |
e1b64aab | 250 | */ |
e79cd558 | 251 | protected function assignTestFK($fieldName, $fieldDef, $params) { |
9c1bc317 CW |
252 | $required = $fieldDef['required'] ?? NULL; |
253 | $FKClassName = $fieldDef['FKClassName'] ?? NULL; | |
e1b64aab | 254 | $dbName = $fieldDef['name']; |
2444854d | 255 | $daoName = str_replace('_BAO_', '_DAO_', get_class($this)); |
e1b64aab TO |
256 | |
257 | // skip the FK if it is not required | |
258 | // if it's contact id we should create even if not required | |
259 | // we'll have a go @ fetching first though | |
260 | // we WILL create campaigns though for so tests with a campaign pseudoconstant will complete | |
261 | if ($FKClassName === 'CRM_Campaign_DAO_Campaign' && $daoName != $FKClassName) { | |
262 | $required = TRUE; | |
263 | } | |
264 | if (!$required && $dbName != 'contact_id') { | |
795492f3 | 265 | $fkDAO = new $FKClassName(); |
e1b64aab | 266 | if ($fkDAO->find(TRUE)) { |
e79cd558 | 267 | $this->$dbName = $fkDAO->id; |
e1b64aab | 268 | } |
e1b64aab TO |
269 | } |
270 | ||
271 | elseif (in_array($FKClassName, CRM_Core_DAO::$_testEntitiesToSkip)) { | |
272 | $depObject = new $FKClassName(); | |
273 | $depObject->find(TRUE); | |
e79cd558 | 274 | $this->$dbName = $depObject->id; |
e1b64aab TO |
275 | } |
276 | elseif ($daoName == 'CRM_Member_DAO_MembershipType' && $fieldName == 'member_of_contact_id') { | |
277 | // FIXME: the fields() metadata is not specific enough | |
be2fb01f | 278 | $depObject = CRM_Core_DAO::createTestObject($FKClassName, ['contact_type' => 'Organization']); |
e79cd558 | 279 | $this->$dbName = $depObject->id; |
e1b64aab TO |
280 | } |
281 | else { | |
282 | //if it is required we need to generate the dependency object first | |
283 | $depObject = CRM_Core_DAO::createTestObject($FKClassName, CRM_Utils_Array::value($dbName, $params, 1)); | |
e79cd558 | 284 | $this->$dbName = $depObject->id; |
e1b64aab TO |
285 | } |
286 | } | |
287 | ||
288 | /** | |
e79cd558 TO |
289 | * Generate and assign an arbitrary value to a field of a test object. |
290 | * | |
291 | * @param string $fieldName | |
292 | * @param array $fieldDef | |
6a0b768e TO |
293 | * @param int $counter |
294 | * The globally-unique ID of the test object. | |
7c58994a | 295 | * |
296 | * @throws \CRM_Core_Exception | |
e1b64aab | 297 | */ |
e79cd558 TO |
298 | protected function assignTestValue($fieldName, &$fieldDef, $counter) { |
299 | $dbName = $fieldDef['name']; | |
300 | $daoName = get_class($this); | |
e1b64aab TO |
301 | $handled = FALSE; |
302 | ||
c7966b21 EM |
303 | if (in_array($dbName, ['contact_sub_type', 'email_greeting_id', 'postal_greeting_id', 'addressee_id'], TRUE)) { |
304 | //coming up with a rule to set these is too complex - skip | |
305 | return; | |
e1b64aab TO |
306 | } |
307 | ||
308 | // Pick an option value if needed | |
309 | if (!$handled && $fieldDef['type'] !== CRM_Utils_Type::T_BOOLEAN) { | |
310 | $options = $daoName::buildOptions($dbName, 'create'); | |
311 | if ($options) { | |
e79cd558 | 312 | $this->$dbName = key($options); |
e1b64aab TO |
313 | $handled = TRUE; |
314 | } | |
315 | } | |
316 | ||
317 | if (!$handled) { | |
318 | switch ($fieldDef['type']) { | |
319 | case CRM_Utils_Type::T_INT: | |
320 | case CRM_Utils_Type::T_FLOAT: | |
321 | case CRM_Utils_Type::T_MONEY: | |
322 | if (isset($fieldDef['precision'])) { | |
323 | // $object->$dbName = CRM_Utils_Number::createRandomDecimal($value['precision']); | |
e79cd558 | 324 | $this->$dbName = CRM_Utils_Number::createTruncatedDecimal($counter, $fieldDef['precision']); |
e1b64aab TO |
325 | } |
326 | else { | |
e79cd558 | 327 | $this->$dbName = $counter; |
e1b64aab TO |
328 | } |
329 | break; | |
330 | ||
331 | case CRM_Utils_Type::T_BOOLEAN: | |
332 | if (isset($fieldDef['default'])) { | |
e79cd558 | 333 | $this->$dbName = $fieldDef['default']; |
e1b64aab TO |
334 | } |
335 | elseif ($fieldDef['name'] == 'is_deleted' || $fieldDef['name'] == 'is_test') { | |
e79cd558 | 336 | $this->$dbName = 0; |
e1b64aab TO |
337 | } |
338 | else { | |
e79cd558 | 339 | $this->$dbName = 1; |
e1b64aab TO |
340 | } |
341 | break; | |
342 | ||
343 | case CRM_Utils_Type::T_DATE: | |
e1b64aab | 344 | case CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME: |
e79cd558 | 345 | $this->$dbName = '19700101'; |
e1b64aab TO |
346 | if ($dbName == 'end_date') { |
347 | // put this in the future | |
e79cd558 | 348 | $this->$dbName = '20200101'; |
e1b64aab TO |
349 | } |
350 | break; | |
351 | ||
2149f4bd | 352 | case CRM_Utils_Type::T_TIMESTAMP: |
353 | $this->$dbName = '19700201000000'; | |
354 | break; | |
355 | ||
e1b64aab | 356 | case CRM_Utils_Type::T_TIME: |
7c58994a | 357 | throw new CRM_Core_Exception('T_TIME shouldn\'t be used.'); |
358 | ||
e1b64aab | 359 | case CRM_Utils_Type::T_CCNUM: |
e79cd558 | 360 | $this->$dbName = '4111 1111 1111 1111'; |
e1b64aab TO |
361 | break; |
362 | ||
363 | case CRM_Utils_Type::T_URL: | |
e79cd558 | 364 | $this->$dbName = 'http://www.civicrm.org'; |
e1b64aab TO |
365 | break; |
366 | ||
367 | case CRM_Utils_Type::T_STRING: | |
368 | case CRM_Utils_Type::T_BLOB: | |
369 | case CRM_Utils_Type::T_MEDIUMBLOB: | |
370 | case CRM_Utils_Type::T_TEXT: | |
371 | case CRM_Utils_Type::T_LONGTEXT: | |
372 | case CRM_Utils_Type::T_EMAIL: | |
373 | default: | |
374 | // WAS: if (isset($value['enumValues'])) { | |
375 | // TODO: see if this works with all pseudoconstants | |
376 | if (isset($fieldDef['pseudoconstant'], $fieldDef['pseudoconstant']['callback'])) { | |
377 | if (isset($fieldDef['default'])) { | |
e79cd558 | 378 | $this->$dbName = $fieldDef['default']; |
e1b64aab TO |
379 | } |
380 | else { | |
381 | $options = CRM_Core_PseudoConstant::get($daoName, $fieldName); | |
382 | if (is_array($options)) { | |
e79cd558 | 383 | $this->$dbName = $options[0]; |
e1b64aab TO |
384 | } |
385 | else { | |
386 | $defaultValues = explode(',', $options); | |
e79cd558 | 387 | $this->$dbName = $defaultValues[0]; |
e1b64aab TO |
388 | } |
389 | } | |
390 | } | |
391 | else { | |
e79cd558 | 392 | $this->$dbName = $dbName . '_' . $counter; |
9c1bc317 | 393 | $maxlength = $fieldDef['maxlength'] ?? NULL; |
e79cd558 TO |
394 | if ($maxlength > 0 && strlen($this->$dbName) > $maxlength) { |
395 | $this->$dbName = substr($this->$dbName, 0, $fieldDef['maxlength']); | |
e1b64aab TO |
396 | } |
397 | } | |
398 | } | |
399 | } | |
400 | } | |
401 | ||
6a488035 | 402 | /** |
8eedd10a | 403 | * Reset the DAO object. |
6a488035 | 404 | * |
8eedd10a | 405 | * DAO is kinda crappy in that there is an unwritten rule of one query per DAO. |
406 | * | |
407 | * We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution | |
6a488035 | 408 | */ |
00be9182 | 409 | public function reset() { |
6a488035 TO |
410 | |
411 | foreach (array_keys($this->table()) as $field) { | |
412 | unset($this->$field); | |
413 | } | |
414 | ||
415 | /** | |
416 | * reset the various DB_DAO structures manually | |
417 | */ | |
be2fb01f | 418 | $this->_query = []; |
6a488035 TO |
419 | $this->whereAdd(); |
420 | $this->selectAdd(); | |
421 | $this->joinAdd(); | |
422 | } | |
423 | ||
a0ee3941 | 424 | /** |
100fef9d | 425 | * @param string $tableName |
a0ee3941 EM |
426 | * |
427 | * @return string | |
428 | */ | |
00be9182 | 429 | public static function getLocaleTableName($tableName) { |
6a488035 TO |
430 | global $dbLocale; |
431 | if ($dbLocale) { | |
432 | $tables = CRM_Core_I18n_Schema::schemaStructureTables(); | |
433 | if (in_array($tableName, $tables)) { | |
434 | return $tableName . $dbLocale; | |
435 | } | |
436 | } | |
437 | return $tableName; | |
438 | } | |
439 | ||
440 | /** | |
441 | * Execute a query by the current DAO, localizing it along the way (if needed). | |
442 | * | |
6a0b768e TO |
443 | * @param string $query |
444 | * The SQL query for execution. | |
445 | * @param bool $i18nRewrite | |
446 | * Whether to rewrite the query. | |
6a488035 | 447 | * |
a6c01b45 CW |
448 | * @return object |
449 | * the current DAO object after the query execution | |
6a488035 | 450 | */ |
00be9182 | 451 | public function query($query, $i18nRewrite = TRUE) { |
6a488035 | 452 | // rewrite queries that should use $dbLocale-based views for multi-language installs |
33092c89 SB |
453 | global $dbLocale, $_DB_DATAOBJECT; |
454 | ||
96f346f8 | 455 | if (empty($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) { |
456 | // Will force connection to be populated per CRM-20541. | |
457 | new CRM_Core_DAO(); | |
458 | } | |
459 | ||
33092c89 SB |
460 | $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]; |
461 | $orig_options = $conn->options; | |
462 | $this->_setDBOptions($this->_options); | |
463 | ||
6a488035 TO |
464 | if ($i18nRewrite and $dbLocale) { |
465 | $query = CRM_Core_I18n_Schema::rewriteQuery($query); | |
466 | } | |
467 | ||
33092c89 SB |
468 | $ret = parent::query($query); |
469 | ||
470 | $this->_setDBOptions($orig_options); | |
471 | return $ret; | |
6a488035 TO |
472 | } |
473 | ||
474 | /** | |
475 | * Static function to set the factory instance for this class. | |
476 | * | |
6a0b768e TO |
477 | * @param object $factory |
478 | * The factory application object. | |
6a488035 | 479 | */ |
00be9182 | 480 | public static function setFactory(&$factory) { |
6a488035 TO |
481 | self::$_factory = &$factory; |
482 | } | |
483 | ||
484 | /** | |
485 | * Factory method to instantiate a new object from a table name. | |
486 | * | |
da6b46f4 | 487 | * @param string $table |
44ce4aa3 | 488 | * @return \DataObject|\PEAR_Error |
6a488035 | 489 | */ |
00be9182 | 490 | public function factory($table = '') { |
6a488035 TO |
491 | if (!isset(self::$_factory)) { |
492 | return parent::factory($table); | |
493 | } | |
494 | ||
495 | return self::$_factory->create($table); | |
496 | } | |
497 | ||
498 | /** | |
499 | * Initialization for all DAO objects. Since we access DB_DO programatically | |
500 | * we need to set the links manually. | |
6a488035 | 501 | */ |
00be9182 | 502 | public function initialize() { |
6a488035 | 503 | $this->_connect(); |
3a036b15 TO |
504 | if (empty(Civi::$statics[__CLASS__]['init'])) { |
505 | // CRM_Core_DAO::init() must be called before CRM_Core_DAO->initialize(). | |
506 | // This occurs very early in bootstrap - error handlers may not be wired up. | |
507 | echo "Inconsistent system initialization sequence. Premature access of (" . get_class($this) . ")"; | |
508 | CRM_Utils_System::civiExit(); | |
509 | } | |
6a488035 TO |
510 | } |
511 | ||
512 | /** | |
513 | * Defines the default key as 'id'. | |
514 | * | |
6a488035 TO |
515 | * @return array |
516 | */ | |
00be9182 | 517 | public function keys() { |
6a488035 TO |
518 | static $keys; |
519 | if (!isset($keys)) { | |
be2fb01f | 520 | $keys = ['id']; |
6a488035 TO |
521 | } |
522 | return $keys; | |
523 | } | |
524 | ||
525 | /** | |
526 | * Tells DB_DataObject which keys use autoincrement. | |
527 | * 'id' is autoincrementing by default. | |
528 | * | |
6a488035 TO |
529 | * |
530 | * @return array | |
531 | */ | |
00be9182 | 532 | public function sequenceKey() { |
6a488035 TO |
533 | static $sequenceKeys; |
534 | if (!isset($sequenceKeys)) { | |
be2fb01f | 535 | $sequenceKeys = ['id', TRUE]; |
6a488035 TO |
536 | } |
537 | return $sequenceKeys; | |
538 | } | |
539 | ||
540 | /** | |
fe482240 | 541 | * Returns list of FK relationships. |
6a488035 | 542 | * |
c5368b3b | 543 | * @return CRM_Core_Reference_Basic[] |
6a488035 | 544 | */ |
00be9182 | 545 | public static function getReferenceColumns() { |
2bc9422f CW |
546 | if (!isset(Civi::$statics[static::class]['links'])) { |
547 | Civi::$statics[static::class]['links'] = static::createReferenceColumns(static::class); | |
548 | CRM_Core_DAO_AllCoreTables::invoke(static::class, 'links_callback', Civi::$statics[static::class]['links']); | |
549 | } | |
550 | return Civi::$statics[static::class]['links']; | |
6a488035 TO |
551 | } |
552 | ||
553 | /** | |
fe482240 | 554 | * Returns all the column names of this table. |
6a488035 | 555 | * |
6a488035 TO |
556 | * |
557 | * @return array | |
558 | */ | |
795492f3 | 559 | public static function &fields() { |
6a488035 TO |
560 | $result = NULL; |
561 | return $result; | |
562 | } | |
563 | ||
2ca7273b CW |
564 | /** |
565 | * Returns all usable fields, indexed by name. | |
566 | * | |
567 | * This function differs from fields() in that it indexes by name rather than unique_name. | |
568 | * | |
569 | * It excludes fields not added yet by pending upgrades. | |
570 | * This avoids problems with trying to SELECT a field that exists in code but has not yet been added to the db. | |
571 | * | |
572 | * @param bool $checkPermissions | |
573 | * Filter by field permissions. | |
574 | * @return array | |
575 | */ | |
576 | public static function getSupportedFields($checkPermissions = FALSE) { | |
577 | $fields = array_column((array) static::fields(), NULL, 'name'); | |
578 | ||
579 | // Exclude fields yet not added by pending upgrades | |
580 | $dbVer = \CRM_Core_BAO_Domain::version(); | |
633a8dbc | 581 | $daoExt = defined(static::class . '::EXT') ? constant(static::class . '::EXT') : NULL; |
9162496e | 582 | if ($fields && $daoExt === 'civicrm' && version_compare($dbVer, \CRM_Utils_System::version()) < 0) { |
2ca7273b CW |
583 | $fields = array_filter($fields, function($field) use ($dbVer) { |
584 | $add = $field['add'] ?? '1.0.0'; | |
585 | if (substr_count($add, '.') < 2) { | |
586 | $add .= '.alpha1'; | |
587 | } | |
588 | return version_compare($dbVer, $add, '>='); | |
589 | }); | |
590 | } | |
591 | ||
592 | // Exclude fields the user does not have permission for | |
593 | if ($checkPermissions) { | |
594 | $fields = array_filter($fields, function($field) { | |
595 | return empty($field['permission']) || CRM_Core_Permission::check($field['permission']); | |
596 | }); | |
597 | } | |
598 | ||
599 | return $fields; | |
600 | } | |
601 | ||
b5c2afd0 | 602 | /** |
100fef9d | 603 | * Get/set an associative array of table columns |
b5c2afd0 | 604 | * |
a6c01b45 CW |
605 | * @return array |
606 | * (associative) | |
b5c2afd0 | 607 | */ |
00be9182 | 608 | public function table() { |
44ce4aa3 | 609 | $fields = $this->fields(); |
6a488035 | 610 | |
be2fb01f | 611 | $table = []; |
6a488035 TO |
612 | if ($fields) { |
613 | foreach ($fields as $name => $value) { | |
614 | $table[$value['name']] = $value['type']; | |
a7488080 | 615 | if (!empty($value['required'])) { |
6a488035 TO |
616 | $table[$value['name']] += self::DB_DAO_NOTNULL; |
617 | } | |
618 | } | |
619 | } | |
620 | ||
6a488035 TO |
621 | return $table; |
622 | } | |
623 | ||
a0ee3941 | 624 | /** |
ea3ddccf | 625 | * Save DAO object. |
626 | * | |
627 | * @param bool $hook | |
628 | * | |
14069c56 | 629 | * @return CRM_Core_DAO |
a0ee3941 | 630 | */ |
9f35e05d | 631 | public function save($hook = TRUE) { |
148d475e | 632 | $eventID = uniqid(); |
6a488035 | 633 | if (!empty($this->id)) { |
e232c68f CW |
634 | if ($hook) { |
635 | $preEvent = new \Civi\Core\DAO\Event\PreUpdate($this); | |
148d475e | 636 | $preEvent->eventID = $eventID; |
4162ab6f | 637 | \Civi::dispatcher()->dispatch("civi.dao.preUpdate", $preEvent); |
e232c68f CW |
638 | } |
639 | ||
640 | $result = $this->update(); | |
8498c2b7 | 641 | |
9f35e05d | 642 | if ($hook) { |
e232c68f | 643 | $event = new \Civi\Core\DAO\Event\PostUpdate($this, $result); |
148d475e | 644 | $event->eventID = $eventID; |
4162ab6f | 645 | \Civi::dispatcher()->dispatch("civi.dao.postUpdate", $event); |
9f35e05d | 646 | } |
10cac951 | 647 | $this->clearDbColumnValueCache(); |
6a488035 TO |
648 | } |
649 | else { | |
e232c68f CW |
650 | if ($hook) { |
651 | $preEvent = new \Civi\Core\DAO\Event\PreUpdate($this); | |
148d475e | 652 | $preEvent->eventID = $eventID; |
4162ab6f | 653 | \Civi::dispatcher()->dispatch("civi.dao.preInsert", $preEvent); |
e232c68f CW |
654 | } |
655 | ||
656 | $result = $this->insert(); | |
8498c2b7 | 657 | |
9f35e05d | 658 | if ($hook) { |
e232c68f | 659 | $event = new \Civi\Core\DAO\Event\PostUpdate($this, $result); |
148d475e | 660 | $event->eventID = $eventID; |
4162ab6f | 661 | \Civi::dispatcher()->dispatch("civi.dao.postInsert", $event); |
9f35e05d | 662 | } |
6a488035 TO |
663 | } |
664 | $this->free(); | |
665 | ||
9f35e05d TO |
666 | if ($hook) { |
667 | CRM_Utils_Hook::postSave($this); | |
668 | } | |
6a488035 TO |
669 | |
670 | return $this; | |
671 | } | |
672 | ||
1cd3ffa9 | 673 | /** |
fe482240 | 674 | * Deletes items from table which match current objects variables. |
1cd3ffa9 EM |
675 | * |
676 | * Returns the true on success | |
677 | * | |
678 | * for example | |
679 | * | |
680 | * Designed to be extended | |
681 | * | |
682 | * $object = new mytable(); | |
683 | * $object->ID=123; | |
684 | * echo $object->delete(); // builds a conditon | |
685 | * | |
686 | * $object = new mytable(); | |
687 | * $object->whereAdd('age > 12'); | |
688 | * $object->limit(1); | |
689 | * $object->orderBy('age DESC'); | |
690 | * $object->delete(true); // dont use object vars, use the conditions, limit and order. | |
691 | * | |
692 | * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then | |
693 | * we will build the condition only using the whereAdd's. Default is to | |
694 | * build the condition only using the object parameters. | |
695 | * | |
3fd42bb5 BT |
696 | * @return int|false |
697 | * Int (No. of rows affected) on success, false on failure, 0 on no data affected | |
1cd3ffa9 | 698 | */ |
00be9182 | 699 | public function delete($useWhere = FALSE) { |
7b83ea83 | 700 | $preEvent = new \Civi\Core\DAO\Event\PreDelete($this); |
4162ab6f | 701 | \Civi::dispatcher()->dispatch("civi.dao.preDelete", $preEvent); |
7b83ea83 | 702 | |
97c4fe76 | 703 | $result = parent::delete($useWhere); |
8498c2b7 | 704 | |
48d849b1 | 705 | $event = new \Civi\Core\DAO\Event\PostDelete($this, $result); |
4162ab6f | 706 | \Civi::dispatcher()->dispatch("civi.dao.postDelete", $event); |
37eb13b2 | 707 | $this->free(); |
8498c2b7 | 708 | |
10cac951 CW |
709 | $this->clearDbColumnValueCache(); |
710 | ||
97c4fe76 | 711 | return $result; |
712 | } | |
713 | ||
a0ee3941 EM |
714 | /** |
715 | * @param bool $created | |
716 | */ | |
00be9182 | 717 | public function log($created = FALSE) { |
6a488035 TO |
718 | static $cid = NULL; |
719 | ||
720 | if (!$this->getLog()) { | |
721 | return; | |
722 | } | |
723 | ||
724 | if (!$cid) { | |
725 | $session = CRM_Core_Session::singleton(); | |
726 | $cid = $session->get('userID'); | |
727 | } | |
728 | ||
729 | // return is we dont have handle to FK | |
730 | if (!$cid) { | |
731 | return; | |
732 | } | |
733 | ||
353ffa53 TO |
734 | $dao = new CRM_Core_DAO_Log(); |
735 | $dao->entity_table = $this->getTableName(); | |
736 | $dao->entity_id = $this->id; | |
737 | $dao->modified_id = $cid; | |
6a488035 TO |
738 | $dao->modified_date = date("YmdHis"); |
739 | $dao->insert(); | |
740 | } | |
741 | ||
742 | /** | |
743 | * Given an associative array of name/value pairs, extract all the values | |
744 | * that belong to this object and initialize the object with said values | |
745 | * | |
6a0b768e | 746 | * @param array $params |
fc944198 | 747 | * Array of name/value pairs to save. |
6a488035 | 748 | * |
795492f3 TO |
749 | * @return bool |
750 | * Did we copy all null values into the object | |
6a488035 | 751 | */ |
fc944198 | 752 | public function copyValues($params) { |
6a488035 | 753 | $allNull = TRUE; |
fc944198 CW |
754 | foreach ($this->fields() as $uniqueName => $field) { |
755 | $dbName = $field['name']; | |
6a488035 | 756 | if (array_key_exists($dbName, $params)) { |
fc944198 | 757 | $value = $params[$dbName]; |
6a488035 TO |
758 | $exists = TRUE; |
759 | } | |
fc944198 CW |
760 | elseif (array_key_exists($uniqueName, $params)) { |
761 | $value = $params[$uniqueName]; | |
6a488035 TO |
762 | $exists = TRUE; |
763 | } | |
764 | else { | |
765 | $exists = FALSE; | |
766 | } | |
767 | ||
768 | // if there is no value then make the variable NULL | |
769 | if ($exists) { | |
fc944198 | 770 | if ($value === '') { |
6a488035 TO |
771 | $this->$dbName = 'null'; |
772 | } | |
fc944198 CW |
773 | elseif (is_array($value) && !empty($field['serialize'])) { |
774 | $this->$dbName = CRM_Core_DAO::serializeField($value, $field['serialize']); | |
30208fab | 775 | $allNull = FALSE; |
776 | } | |
6a488035 | 777 | else { |
9c1bc317 | 778 | $maxLength = $field['maxlength'] ?? NULL; |
fc944198 | 779 | if (!is_array($value) && $maxLength && mb_strlen($value) > $maxLength && empty($field['pseudoconstant'])) { |
c6447b08 | 780 | // No ts() since this is a sysadmin-y string not seen by general users. |
781 | Civi::log()->warning('A string for field {dbName} has been truncated. The original string was {value}.', ['dbName' => $dbName, 'value' => $value]); | |
782 | // The string is too long - what to do what to do? Well losing data is generally bad so let's truncate | |
fc944198 | 783 | $value = CRM_Utils_String::ellipsify($value, $maxLength); |
809e1a83 | 784 | } |
fc944198 | 785 | $this->$dbName = $value; |
6a488035 TO |
786 | $allNull = FALSE; |
787 | } | |
788 | } | |
789 | } | |
790 | return $allNull; | |
791 | } | |
792 | ||
793 | /** | |
794 | * Store all the values from this object in an associative array | |
795 | * this is a destructive store, calling function is responsible | |
796 | * for keeping sanity of id's. | |
797 | * | |
6a0b768e TO |
798 | * @param object $object |
799 | * The object that we are extracting data from. | |
800 | * @param array $values | |
801 | * (reference ) associative array of name/value pairs. | |
6a488035 | 802 | */ |
00be9182 | 803 | public static function storeValues(&$object, &$values) { |
44ce4aa3 | 804 | $fields = $object->fields(); |
6a488035 TO |
805 | foreach ($fields as $name => $value) { |
806 | $dbName = $value['name']; | |
807 | if (isset($object->$dbName) && $object->$dbName !== 'null') { | |
808 | $values[$dbName] = $object->$dbName; | |
809 | if ($name != $dbName) { | |
810 | $values[$name] = $object->$dbName; | |
811 | } | |
812 | } | |
813 | } | |
814 | } | |
815 | ||
816 | /** | |
100fef9d | 817 | * Create an attribute for this specific field. We only do this for strings and text |
6a488035 | 818 | * |
6a0b768e TO |
819 | * @param array $field |
820 | * The field under task. | |
6a488035 | 821 | * |
72b3a70c CW |
822 | * @return array|null |
823 | * the attributes for the object | |
6a488035 | 824 | */ |
00be9182 | 825 | public static function makeAttribute($field) { |
6a488035 TO |
826 | if ($field) { |
827 | if (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_STRING) { | |
9c1bc317 CW |
828 | $maxLength = $field['maxlength'] ?? NULL; |
829 | $size = $field['size'] ?? NULL; | |
6a488035 | 830 | if ($maxLength || $size) { |
be2fb01f | 831 | $attributes = []; |
6a488035 TO |
832 | if ($maxLength) { |
833 | $attributes['maxlength'] = $maxLength; | |
834 | } | |
835 | if ($size) { | |
836 | $attributes['size'] = $size; | |
837 | } | |
838 | return $attributes; | |
839 | } | |
840 | } | |
841 | elseif (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_TEXT) { | |
9c1bc317 | 842 | $rows = $field['rows'] ?? NULL; |
6a488035 TO |
843 | if (!isset($rows)) { |
844 | $rows = 2; | |
845 | } | |
9c1bc317 | 846 | $cols = $field['cols'] ?? NULL; |
6a488035 TO |
847 | if (!isset($cols)) { |
848 | $cols = 80; | |
849 | } | |
850 | ||
be2fb01f | 851 | $attributes = []; |
6a488035 TO |
852 | $attributes['rows'] = $rows; |
853 | $attributes['cols'] = $cols; | |
854 | return $attributes; | |
855 | } | |
856 | 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) { | |
857 | $attributes['size'] = 6; | |
858 | $attributes['maxlength'] = 14; | |
859 | return $attributes; | |
860 | } | |
861 | } | |
862 | return NULL; | |
863 | } | |
864 | ||
865 | /** | |
d09edf64 | 866 | * Get the size and maxLength attributes for this text field. |
6a488035 TO |
867 | * (or for all text fields) in the DAO object. |
868 | * | |
6a0b768e TO |
869 | * @param string $class |
870 | * Name of DAO class. | |
871 | * @param string $fieldName | |
872 | * Field that i'm interested in or null if. | |
6a488035 TO |
873 | * you want the attributes for all DAO text fields |
874 | * | |
a6c01b45 CW |
875 | * @return array |
876 | * assoc array of name => attribute pairs | |
6a488035 | 877 | */ |
00be9182 | 878 | public static function getAttribute($class, $fieldName = NULL) { |
353ffa53 | 879 | $object = new $class(); |
44ce4aa3 | 880 | $fields = $object->fields(); |
6a488035 | 881 | if ($fieldName != NULL) { |
9c1bc317 | 882 | $field = $fields[$fieldName] ?? NULL; |
6a488035 TO |
883 | return self::makeAttribute($field); |
884 | } | |
885 | else { | |
be2fb01f | 886 | $attributes = []; |
6a488035 TO |
887 | foreach ($fields as $name => $field) { |
888 | $attribute = self::makeAttribute($field); | |
889 | if ($attribute) { | |
890 | $attributes[$name] = $attribute; | |
891 | } | |
892 | } | |
893 | ||
894 | if (!empty($attributes)) { | |
895 | return $attributes; | |
896 | } | |
897 | } | |
898 | return NULL; | |
899 | } | |
900 | ||
2ee9afab CW |
901 | /** |
902 | * Create or update a record from supplied params. | |
903 | * | |
904 | * If 'id' is supplied, an existing record will be updated | |
905 | * Otherwise a new record will be created. | |
906 | * | |
907 | * @param array $record | |
4cdd873a | 908 | * |
236f858e | 909 | * @return static |
4cdd873a | 910 | * @throws \CRM_Core_Exception |
2ee9afab | 911 | */ |
4cdd873a | 912 | public static function writeRecord(array $record): CRM_Core_DAO { |
bf46adf0 | 913 | $op = empty($record['id']) ? 'create' : 'edit'; |
2ee9afab CW |
914 | $className = CRM_Core_DAO_AllCoreTables::getCanonicalClassName(static::class); |
915 | if ($className === 'CRM_Core_DAO') { | |
916 | throw new CRM_Core_Exception('Function writeRecord must be called on a subclass of CRM_Core_DAO'); | |
917 | } | |
918 | $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($className); | |
919 | ||
bf46adf0 | 920 | \CRM_Utils_Hook::pre($op, $entityName, $record['id'] ?? NULL, $record); |
eba57f7d CW |
921 | $fields = static::getSupportedFields(); |
922 | $instance = new static(); | |
47555d7f | 923 | // Ensure fields exist before attempting to write to them |
eba57f7d | 924 | $values = array_intersect_key($record, $fields); |
47555d7f | 925 | $instance->copyValues($values); |
ddba05d3 CW |
926 | if (empty($values['id']) && array_key_exists('name', $fields) && empty($values['name'])) { |
927 | $instance->makeNameFromLabel(!empty($fields['name']['required'])); | |
eba57f7d | 928 | } |
2ee9afab | 929 | $instance->save(); |
bf46adf0 CW |
930 | |
931 | if (!empty($record['custom']) && is_array($record['custom'])) { | |
932 | CRM_Core_BAO_CustomValueTable::store($record['custom'], static::$_tableName, $instance->id, $op); | |
933 | } | |
934 | ||
935 | \CRM_Utils_Hook::post($op, $entityName, $instance->id, $instance); | |
2ee9afab CW |
936 | |
937 | return $instance; | |
938 | } | |
939 | ||
236f858e CW |
940 | /** |
941 | * Bulk save multiple records | |
942 | * | |
943 | * @param array[] $records | |
944 | * @return static[] | |
945 | * @throws CRM_Core_Exception | |
946 | */ | |
78b7cb89 | 947 | public static function writeRecords(array $records): array { |
236f858e CW |
948 | $results = []; |
949 | foreach ($records as $record) { | |
950 | $results[] = static::writeRecord($record); | |
951 | } | |
952 | return $results; | |
953 | } | |
954 | ||
2ee9afab CW |
955 | /** |
956 | * Delete a record from supplied params. | |
957 | * | |
958 | * @param array $record | |
959 | * 'id' is required. | |
236f858e | 960 | * @return static |
2ee9afab CW |
961 | * @throws CRM_Core_Exception |
962 | */ | |
963 | public static function deleteRecord(array $record) { | |
964 | $className = CRM_Core_DAO_AllCoreTables::getCanonicalClassName(static::class); | |
965 | if ($className === 'CRM_Core_DAO') { | |
966 | throw new CRM_Core_Exception('Function deleteRecord must be called on a subclass of CRM_Core_DAO'); | |
967 | } | |
968 | $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($className); | |
969 | if (empty($record['id'])) { | |
970 | throw new CRM_Core_Exception("Cannot delete {$entityName} with no id."); | |
971 | } | |
1d4cebf3 | 972 | CRM_Utils_Type::validate($record['id'], 'Positive'); |
2ee9afab CW |
973 | |
974 | CRM_Utils_Hook::pre('delete', $entityName, $record['id'], $record); | |
975 | $instance = new $className(); | |
976 | $instance->id = $record['id']; | |
7a592535 CW |
977 | // Load complete object for the sake of hook_civicrm_post, below |
978 | $instance->find(TRUE); | |
979 | if (!$instance || !$instance->delete()) { | |
2ee9afab CW |
980 | throw new CRM_Core_Exception("Could not delete {$entityName} id {$record['id']}"); |
981 | } | |
7a592535 CW |
982 | // For other operations this hook is passed an incomplete object and hook listeners can load if needed. |
983 | // But that's not possible with delete because it's gone from the database by the time this hook is called. | |
984 | // So in this case the object has been pre-loaded so hook listeners have access to the complete record. | |
2ee9afab CW |
985 | CRM_Utils_Hook::post('delete', $entityName, $record['id'], $instance); |
986 | ||
987 | return $instance; | |
988 | } | |
989 | ||
236f858e CW |
990 | /** |
991 | * Bulk delete multiple records. | |
992 | * | |
993 | * @param array[] $records | |
994 | * @return static[] | |
995 | * @throws CRM_Core_Exception | |
996 | */ | |
997 | public static function deleteRecords(array $records) { | |
998 | $results = []; | |
999 | foreach ($records as $record) { | |
1000 | $results[] = static::deleteRecord($record); | |
1001 | } | |
1002 | return $results; | |
1003 | } | |
1004 | ||
6a488035 | 1005 | /** |
fe482240 | 1006 | * Check if there is a record with the same name in the db. |
6a488035 | 1007 | * |
6a0b768e TO |
1008 | * @param string $value |
1009 | * The value of the field we are checking. | |
1010 | * @param string $daoName | |
1011 | * The dao object name. | |
1012 | * @param string $daoID | |
1013 | * The id of the object being updated. u can change your name. | |
6a488035 | 1014 | * as long as there is no conflict |
6a0b768e TO |
1015 | * @param string $fieldName |
1016 | * The name of the field in the DAO. | |
6a488035 | 1017 | * |
35b63106 DS |
1018 | * @param string $domainID |
1019 | * The id of the domain. Object exists only for the given domain. | |
1020 | * | |
795492f3 | 1021 | * @return bool |
a6c01b45 | 1022 | * true if object exists |
6a488035 | 1023 | */ |
35b63106 | 1024 | public static function objectExists($value, $daoName, $daoID, $fieldName = 'name', $domainID = NULL) { |
353ffa53 | 1025 | $object = new $daoName(); |
6a488035 | 1026 | $object->$fieldName = $value; |
35b63106 DS |
1027 | if ($domainID) { |
1028 | $object->domain_id = $domainID; | |
1029 | } | |
6a488035 TO |
1030 | |
1031 | if ($object->find(TRUE)) { | |
63d76404 | 1032 | return $daoID && $object->id == $daoID; |
6a488035 TO |
1033 | } |
1034 | else { | |
1035 | return TRUE; | |
1036 | } | |
1037 | } | |
1038 | ||
1039 | /** | |
fe482240 | 1040 | * Check if there is a given column in a specific table. |
6a488035 | 1041 | * |
eed7e803 CW |
1042 | * @deprecated |
1043 | * @see CRM_Core_BAO_SchemaHandler::checkIfFieldExists | |
1044 | * | |
6a488035 TO |
1045 | * @param string $tableName |
1046 | * @param string $columnName | |
6a0b768e TO |
1047 | * @param bool $i18nRewrite |
1048 | * Whether to rewrite the query on multilingual setups. | |
6a488035 | 1049 | * |
795492f3 | 1050 | * @return bool |
a6c01b45 | 1051 | * true if exists, else false |
6a488035 | 1052 | */ |
00be9182 | 1053 | public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) { |
fdc2e63a | 1054 | CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_SchemaHandler::checkIfFieldExists'); |
eed7e803 | 1055 | return CRM_Core_BAO_SchemaHandler::checkIfFieldExists($tableName, $columnName, $i18nRewrite); |
6a488035 TO |
1056 | } |
1057 | ||
1058 | /** | |
3fa9688a | 1059 | * Scans all the tables using a slow query and table name. |
2a6da8d7 | 1060 | * |
6a488035 | 1061 | * @return array |
6a488035 | 1062 | */ |
3fa9688a | 1063 | public static function getTableNames() { |
1064 | $dao = CRM_Core_DAO::executeQuery( | |
1065 | "SELECT TABLE_NAME | |
1066 | FROM information_schema.TABLES | |
1067 | WHERE TABLE_SCHEMA = '" . CRM_Core_DAO::getDatabaseName() . "' | |
1068 | AND TABLE_NAME LIKE 'civicrm_%' | |
1069 | AND TABLE_NAME NOT LIKE 'civicrm_import_job_%' | |
2475b550 | 1070 | AND TABLE_NAME NOT LIKE '%_temp%' |
3fa9688a | 1071 | "); |
6a488035 | 1072 | |
6a488035 | 1073 | while ($dao->fetch()) { |
3fa9688a | 1074 | $values[] = $dao->TABLE_NAME; |
6a488035 | 1075 | } |
6a488035 TO |
1076 | return $values; |
1077 | } | |
1078 | ||
a0ee3941 EM |
1079 | /** |
1080 | * @param int $maxTablesToCheck | |
1081 | * | |
1082 | * @return bool | |
1083 | */ | |
00be9182 | 1084 | public static function isDBMyISAM($maxTablesToCheck = 10) { |
3fa9688a | 1085 | return CRM_Core_DAO::singleValueQuery( |
1086 | "SELECT count(*) | |
1087 | FROM information_schema.TABLES | |
1088 | WHERE ENGINE = 'MyISAM' | |
1089 | AND TABLE_SCHEMA = '" . CRM_Core_DAO::getDatabaseName() . "' | |
1090 | AND TABLE_NAME LIKE 'civicrm_%' | |
1091 | AND TABLE_NAME NOT LIKE 'civicrm_import_job_%' | |
2475b550 | 1092 | AND TABLE_NAME NOT LIKE '%_temp%' |
0cb1aeab | 1093 | AND TABLE_NAME NOT LIKE 'civicrm_tmp_%' |
3fa9688a | 1094 | "); |
1095 | } | |
1096 | ||
1097 | /** | |
1098 | * Get the name of the CiviCRM database. | |
1099 | * | |
1100 | * @return string | |
1101 | */ | |
1102 | public static function getDatabaseName() { | |
1103 | $daoObj = new CRM_Core_DAO(); | |
1104 | return $daoObj->database(); | |
6a488035 TO |
1105 | } |
1106 | ||
1107 | /** | |
1108 | * Checks if a constraint exists for a specified table. | |
1109 | * | |
1110 | * @param string $tableName | |
1111 | * @param string $constraint | |
1112 | * | |
795492f3 | 1113 | * @return bool |
a6c01b45 | 1114 | * true if constraint exists, false otherwise |
7c58994a | 1115 | * |
1116 | * @throws \CRM_Core_Exception | |
6a488035 | 1117 | */ |
00be9182 | 1118 | public static function checkConstraintExists($tableName, $constraint) { |
be2fb01f | 1119 | static $show = []; |
6a488035 TO |
1120 | |
1121 | if (!array_key_exists($tableName, $show)) { | |
1122 | $query = "SHOW CREATE TABLE $tableName"; | |
220d454c | 1123 | $dao = CRM_Core_DAO::executeQuery($query, [], TRUE, NULL, FALSE, FALSE); |
6a488035 TO |
1124 | |
1125 | if (!$dao->fetch()) { | |
7c58994a | 1126 | throw new CRM_Core_Exception('query failed'); |
6a488035 TO |
1127 | } |
1128 | ||
6a488035 TO |
1129 | $show[$tableName] = $dao->Create_Table; |
1130 | } | |
1131 | ||
63d76404 | 1132 | return (bool) preg_match("/\b$constraint\b/i", $show[$tableName]); |
6a488035 TO |
1133 | } |
1134 | ||
1135 | /** | |
1136 | * Checks if CONSTRAINT keyword exists for a specified table. | |
1137 | * | |
2a6da8d7 EM |
1138 | * @param array $tables |
1139 | * | |
7c58994a | 1140 | * @throws CRM_Core_Exception |
6a488035 | 1141 | * |
795492f3 | 1142 | * @return bool |
a6c01b45 | 1143 | * true if CONSTRAINT keyword exists, false otherwise |
6a488035 | 1144 | */ |
be2fb01f CW |
1145 | public static function schemaRequiresRebuilding($tables = ["civicrm_contact"]) { |
1146 | $show = []; | |
9b873358 | 1147 | foreach ($tables as $tableName) { |
6a488035 TO |
1148 | if (!array_key_exists($tableName, $show)) { |
1149 | $query = "SHOW CREATE TABLE $tableName"; | |
220d454c | 1150 | $dao = CRM_Core_DAO::executeQuery($query, [], TRUE, NULL, FALSE, FALSE); |
6a488035 TO |
1151 | |
1152 | if (!$dao->fetch()) { | |
7c58994a | 1153 | throw new CRM_Core_Exception('Show create table failed.'); |
6a488035 TO |
1154 | } |
1155 | ||
6a488035 TO |
1156 | $show[$tableName] = $dao->Create_Table; |
1157 | } | |
1158 | ||
63d76404 | 1159 | $result = (bool) preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]); |
9b873358 | 1160 | if ($result == TRUE) { |
6a488035 TO |
1161 | continue; |
1162 | } | |
c490a46a | 1163 | else { |
6a488035 TO |
1164 | return FALSE; |
1165 | } | |
1166 | } | |
1167 | return TRUE; | |
1168 | } | |
1169 | ||
1170 | /** | |
1171 | * Checks if the FK constraint name is in the format 'FK_tableName_columnName' | |
1172 | * for a specified column of a table. | |
1173 | * | |
1174 | * @param string $tableName | |
1175 | * @param string $columnName | |
1176 | * | |
795492f3 | 1177 | * @return bool |
a6c01b45 | 1178 | * true if in format, false otherwise |
7c58994a | 1179 | * |
1180 | * @throws \CRM_Core_Exception | |
6a488035 | 1181 | */ |
00be9182 | 1182 | public static function checkFKConstraintInFormat($tableName, $columnName) { |
be2fb01f | 1183 | static $show = []; |
6a488035 TO |
1184 | |
1185 | if (!array_key_exists($tableName, $show)) { | |
1186 | $query = "SHOW CREATE TABLE $tableName"; | |
1187 | $dao = CRM_Core_DAO::executeQuery($query); | |
1188 | ||
1189 | if (!$dao->fetch()) { | |
7c58994a | 1190 | throw new CRM_Core_Exception('query failed'); |
6a488035 TO |
1191 | } |
1192 | ||
6a488035 TO |
1193 | $show[$tableName] = $dao->Create_Table; |
1194 | } | |
1195 | $constraint = "`FK_{$tableName}_{$columnName}`"; | |
1196 | $pattern = "/\bCONSTRAINT\b\s+%s\s+\bFOREIGN\s+KEY\b\s/i"; | |
63d76404 | 1197 | return (bool) preg_match(sprintf($pattern, $constraint), $show[$tableName]); |
6a488035 TO |
1198 | } |
1199 | ||
1200 | /** | |
fe482240 | 1201 | * Check whether a specific column in a specific table has always the same value. |
6a488035 TO |
1202 | * |
1203 | * @param string $tableName | |
1204 | * @param string $columnName | |
1205 | * @param string $columnValue | |
1206 | * | |
795492f3 | 1207 | * @return bool |
a6c01b45 | 1208 | * true if the value is always $columnValue, false otherwise |
6a488035 | 1209 | */ |
00be9182 | 1210 | public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) { |
353ffa53 TO |
1211 | $query = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'"; |
1212 | $dao = CRM_Core_DAO::executeQuery($query); | |
6a488035 | 1213 | $result = $dao->fetch() ? FALSE : TRUE; |
6a488035 TO |
1214 | return $result; |
1215 | } | |
1216 | ||
1217 | /** | |
fe482240 | 1218 | * Check whether a specific column in a specific table is always NULL. |
6a488035 TO |
1219 | * |
1220 | * @param string $tableName | |
1221 | * @param string $columnName | |
1222 | * | |
795492f3 | 1223 | * @return bool |
a6c01b45 | 1224 | * true if if the value is always NULL, false otherwise |
6a488035 | 1225 | */ |
00be9182 | 1226 | public static function checkFieldIsAlwaysNull($tableName, $columnName) { |
353ffa53 TO |
1227 | $query = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL"; |
1228 | $dao = CRM_Core_DAO::executeQuery($query); | |
6a488035 | 1229 | $result = $dao->fetch() ? FALSE : TRUE; |
6a488035 TO |
1230 | return $result; |
1231 | } | |
1232 | ||
06f83d5c CW |
1233 | /** |
1234 | * Checks if this DAO's table ought to exist. | |
1235 | * | |
1236 | * If there are pending DB updates, this function compares the CiviCRM version of the table to the current schema version. | |
1237 | * | |
1238 | * @return bool | |
1239 | * @throws CRM_Core_Exception | |
1240 | */ | |
1241 | public static function tableHasBeenAdded() { | |
1242 | if (CRM_Utils_System::version() === CRM_Core_BAO_Domain::version()) { | |
1243 | return TRUE; | |
1244 | } | |
633a8dbc CW |
1245 | $daoExt = defined(static::class . '::EXT') ? constant(static::class . '::EXT') : NULL; |
1246 | $daoVersion = defined(static::class . '::TABLE_ADDED') ? constant(static::class . '::TABLE_ADDED') : '1.0'; | |
06f83d5c CW |
1247 | return !($daoExt === 'civicrm' && version_compare(CRM_Core_BAO_Domain::version(), $daoVersion, '<')); |
1248 | } | |
1249 | ||
6a488035 | 1250 | /** |
fe482240 | 1251 | * Check if there is a given table in the database. |
6a488035 TO |
1252 | * |
1253 | * @param string $tableName | |
1254 | * | |
795492f3 | 1255 | * @return bool |
a6c01b45 | 1256 | * true if exists, else false |
6a488035 | 1257 | */ |
00be9182 | 1258 | public static function checkTableExists($tableName) { |
6a488035 TO |
1259 | $query = " |
1260 | SHOW TABLES | |
1261 | LIKE %1 | |
1262 | "; | |
be2fb01f | 1263 | $params = [1 => [$tableName, 'String']]; |
6a488035 TO |
1264 | |
1265 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
63d76404 | 1266 | return (bool) $dao->fetch(); |
6a488035 TO |
1267 | } |
1268 | ||
66f5e240 TO |
1269 | /** |
1270 | * Check if a given table has data. | |
1271 | * | |
1272 | * @param string $tableName | |
1273 | * @return bool | |
1274 | * TRUE if $tableName has at least one record. | |
1275 | */ | |
1276 | public static function checkTableHasData($tableName) { | |
1277 | $c = CRM_Core_DAO::singleValueQuery(sprintf('SELECT count(*) c FROM `%s`', $tableName)); | |
1278 | return $c > 0; | |
1279 | } | |
1280 | ||
a0ee3941 EM |
1281 | /** |
1282 | * @param $version | |
895e3d81 | 1283 | * @deprecated |
a0ee3941 EM |
1284 | * @return bool |
1285 | */ | |
00be9182 | 1286 | public function checkVersion($version) { |
895e3d81 CW |
1287 | CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_Domain::version'); |
1288 | $dbVersion = CRM_Core_BAO_Domain::version(); | |
63d76404 | 1289 | return trim($version) == trim($dbVersion); |
6a488035 TO |
1290 | } |
1291 | ||
47ff2df7 AN |
1292 | /** |
1293 | * Find a DAO object for the given ID and return it. | |
1294 | * | |
6a0b768e TO |
1295 | * @param int $id |
1296 | * Id of the DAO object being searched for. | |
47ff2df7 | 1297 | * |
44ce4aa3 | 1298 | * @return CRM_Core_DAO |
a6c01b45 | 1299 | * Object of the type of the class that called this function. |
44ce4aa3 CW |
1300 | * |
1301 | * @throws Exception | |
47ff2df7 | 1302 | */ |
00be9182 | 1303 | public static function findById($id) { |
47ff2df7 AN |
1304 | $object = new static(); |
1305 | $object->id = $id; | |
1306 | if (!$object->find(TRUE)) { | |
1307 | throw new Exception("Unable to find a " . get_called_class() . " with id {$id}."); | |
1308 | } | |
1309 | return $object; | |
1310 | } | |
1311 | ||
63782ba4 TO |
1312 | /** |
1313 | * Returns all results as array-encoded records. | |
1314 | * | |
1315 | * @return array | |
1316 | */ | |
2fabb51b | 1317 | public function fetchAll($k = FALSE, $v = FALSE, $method = FALSE) { |
be2fb01f | 1318 | $result = []; |
63782ba4 TO |
1319 | while ($this->fetch()) { |
1320 | $result[] = $this->toArray(); | |
1321 | } | |
1322 | return $result; | |
1323 | } | |
b5bbb074 | 1324 | |
41d41c91 TO |
1325 | /** |
1326 | * Return the results as PHP generator. | |
1327 | * | |
1328 | * @param string $type | |
1329 | * Whether the generator yields 'dao' objects or 'array's. | |
1330 | */ | |
1331 | public function fetchGenerator($type = 'dao') { | |
1332 | while ($this->fetch()) { | |
1333 | switch ($type) { | |
1334 | case 'dao': | |
1335 | yield $this; | |
1336 | break; | |
1337 | ||
1338 | case 'array': | |
1339 | yield $this->toArray(); | |
1340 | break; | |
1341 | ||
1342 | default: | |
1343 | throw new \RuntimeException("Invalid record type ($type)"); | |
1344 | } | |
1345 | } | |
1346 | } | |
1347 | ||
77e74ae1 TO |
1348 | /** |
1349 | * Returns a singular value. | |
1350 | * | |
1351 | * @return mixed|NULL | |
1352 | */ | |
1353 | public function fetchValue() { | |
1354 | $result = $this->getDatabaseResult(); | |
1355 | $row = $result->fetchRow(); | |
1356 | $ret = NULL; | |
1357 | if ($row) { | |
1358 | $ret = $row[0]; | |
1359 | } | |
1360 | $this->free(); | |
1361 | return $ret; | |
1362 | } | |
1363 | ||
b5bbb074 TO |
1364 | /** |
1365 | * Get all the result records as mapping between columns. | |
1366 | * | |
1367 | * @param string $keyColumn | |
1368 | * Ex: "name" | |
1369 | * @param string $valueColumn | |
1370 | * Ex: "label" | |
1371 | * @return array | |
1372 | * Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"] | |
1373 | */ | |
1374 | public function fetchMap($keyColumn, $valueColumn) { | |
be2fb01f | 1375 | $result = []; |
b5bbb074 TO |
1376 | while ($this->fetch()) { |
1377 | $result[$this->{$keyColumn}] = $this->{$valueColumn}; | |
1378 | } | |
1379 | return $result; | |
1380 | } | |
63782ba4 | 1381 | |
6a488035 TO |
1382 | /** |
1383 | * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record | |
1384 | * | |
6a0b768e TO |
1385 | * @param string $daoName |
1386 | * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact). | |
1387 | * @param int $searchValue | |
1388 | * Value of the column you want to search by. | |
1389 | * @param string $returnColumn | |
1390 | * Name of the column you want to GET the value of. | |
1391 | * @param string $searchColumn | |
1392 | * Name of the column you want to search by. | |
1393 | * @param bool $force | |
1394 | * Skip use of the cache. | |
6a488035 | 1395 | * |
f4b8bef7 | 1396 | * @return string|int|null |
72b3a70c | 1397 | * Value of $returnColumn in the retrieved record |
7c58994a | 1398 | * |
1399 | * @throws \CRM_Core_Exception | |
6a488035 | 1400 | */ |
00be9182 | 1401 | public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) { |
6a488035 TO |
1402 | if ( |
1403 | empty($searchValue) || | |
1404 | trim(strtolower($searchValue)) == 'null' | |
1405 | ) { | |
cf79ac58 | 1406 | // adding this here since developers forget to check for an id |
6a488035 TO |
1407 | // or for the 'null' (which is a bad DAO kludge) |
1408 | // and hence we get the first value in the db | |
7c58994a | 1409 | throw new CRM_Core_Exception('getFieldValue failed'); |
6a488035 TO |
1410 | } |
1411 | ||
10cac951 CW |
1412 | self::$_dbColumnValueCache = self::$_dbColumnValueCache ?? []; |
1413 | ||
1414 | while (strpos($daoName, '_BAO_') !== FALSE) { | |
1415 | $daoName = get_parent_class($daoName); | |
6a488035 TO |
1416 | } |
1417 | ||
10cac951 CW |
1418 | if ($force || |
1419 | empty(self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue]) || | |
1420 | !array_key_exists($returnColumn, self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue]) | |
1421 | ) { | |
353ffa53 | 1422 | $object = new $daoName(); |
6a488035 TO |
1423 | $object->$searchColumn = $searchValue; |
1424 | $object->selectAdd(); | |
1425 | $object->selectAdd($returnColumn); | |
1426 | ||
1427 | $result = NULL; | |
1428 | if ($object->find(TRUE)) { | |
1429 | $result = $object->$returnColumn; | |
1430 | } | |
6a488035 | 1431 | |
10cac951 | 1432 | self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn] = $result; |
6a488035 | 1433 | } |
10cac951 | 1434 | return self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn]; |
6a488035 TO |
1435 | } |
1436 | ||
1437 | /** | |
1438 | * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record | |
1439 | * | |
6a0b768e TO |
1440 | * @param string $daoName |
1441 | * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact). | |
1442 | * @param int $searchValue | |
1443 | * Value of the column you want to search by. | |
1444 | * @param string $setColumn | |
1445 | * Name of the column you want to SET the value of. | |
1446 | * @param string $setValue | |
1447 | * SET the setColumn to this value. | |
1448 | * @param string $searchColumn | |
1449 | * Name of the column you want to search by. | |
6a488035 | 1450 | * |
795492f3 | 1451 | * @return bool |
a6c01b45 | 1452 | * true if we found and updated the object, else false |
6a488035 | 1453 | */ |
00be9182 | 1454 | public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') { |
353ffa53 | 1455 | $object = new $daoName(); |
6a488035 TO |
1456 | $object->selectAdd(); |
1457 | $object->selectAdd("$searchColumn, $setColumn"); | |
1458 | $object->$searchColumn = $searchValue; | |
1459 | $result = FALSE; | |
1460 | if ($object->find(TRUE)) { | |
1461 | $object->$setColumn = $setValue; | |
1462 | if ($object->save()) { | |
1463 | $result = TRUE; | |
1464 | } | |
1465 | } | |
1466 | $object->free(); | |
1467 | return $result; | |
1468 | } | |
1469 | ||
1470 | /** | |
fe482240 | 1471 | * Get sort string. |
6a488035 TO |
1472 | * |
1473 | * @param array|object $sort either array or CRM_Utils_Sort | |
6a0b768e TO |
1474 | * @param string $default |
1475 | * Default sort value. | |
6a488035 | 1476 | * |
a6c01b45 | 1477 | * @return string |
6a488035 | 1478 | */ |
00be9182 | 1479 | public static function getSortString($sort, $default = NULL) { |
6a488035 TO |
1480 | // check if sort is of type CRM_Utils_Sort |
1481 | if (is_a($sort, 'CRM_Utils_Sort')) { | |
1482 | return $sort->orderBy(); | |
1483 | } | |
1484 | ||
44ce4aa3 CW |
1485 | $sortString = ''; |
1486 | ||
6a488035 TO |
1487 | // is it an array specified as $field => $sortDirection ? |
1488 | if ($sort) { | |
1489 | foreach ($sort as $k => $v) { | |
1490 | $sortString .= "$k $v,"; | |
1491 | } | |
1492 | return rtrim($sortString, ','); | |
1493 | } | |
1494 | return $default; | |
1495 | } | |
1496 | ||
1497 | /** | |
fe482240 | 1498 | * Fetch object based on array of properties. |
6a488035 | 1499 | * |
6a0b768e | 1500 | * @param string $daoName |
4f940304 | 1501 | * Name of the dao class. |
6a0b768e | 1502 | * @param array $params |
fa3fdebc | 1503 | * (reference) an assoc array of name/value pairs. |
6a0b768e | 1504 | * @param array $defaults |
fa3fdebc | 1505 | * (reference) an assoc array to hold the flattened values. |
6a0b768e | 1506 | * @param array $returnProperities |
4f940304 | 1507 | * An assoc array of fields that need to be returned, e.g. ['first_name', 'last_name']. |
6a488035 | 1508 | * |
4233c9a1 | 1509 | * @return static|null |
6a488035 | 1510 | */ |
00be9182 | 1511 | public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) { |
353ffa53 | 1512 | $object = new $daoName(); |
6a488035 TO |
1513 | $object->copyValues($params); |
1514 | ||
1515 | // return only specific fields if returnproperties are sent | |
1516 | if (!empty($returnProperities)) { | |
1517 | $object->selectAdd(); | |
1518 | $object->selectAdd(implode(',', $returnProperities)); | |
1519 | } | |
1520 | ||
1521 | if ($object->find(TRUE)) { | |
1522 | self::storeValues($object, $defaults); | |
1523 | return $object; | |
1524 | } | |
1525 | return NULL; | |
1526 | } | |
1527 | ||
1528 | /** | |
fe482240 | 1529 | * Delete the object records that are associated with this contact. |
6a488035 | 1530 | * |
866a98be CW |
1531 | * @deprecated |
1532 | * | |
6a0b768e TO |
1533 | * @param string $daoName |
1534 | * Name of the dao object. | |
1535 | * @param int $contactId | |
1536 | * Id of the contact to delete. | |
6a488035 | 1537 | */ |
00be9182 | 1538 | public static function deleteEntityContact($daoName, $contactId) { |
866a98be | 1539 | CRM_Core_Error::deprecatedFunctionWarning('APIv4'); |
353ffa53 | 1540 | $object = new $daoName(); |
6a488035 TO |
1541 | |
1542 | $object->entity_table = 'civicrm_contact'; | |
1543 | $object->entity_id = $contactId; | |
1544 | $object->delete(); | |
1545 | } | |
1546 | ||
67cae873 | 1547 | /** |
bf48aa29 | 1548 | * Execute an unbuffered query. |
1549 | * | |
1550 | * This is a wrapper around new functionality exposed with CRM-17748. | |
67cae873 SB |
1551 | * |
1552 | * @param string $query query to be executed | |
3a8ce9d6 | 1553 | * |
bf48aa29 | 1554 | * @param array $params |
1555 | * @param bool $abort | |
1556 | * @param null $daoName | |
1557 | * @param bool $freeDAO | |
1558 | * @param bool $i18nRewrite | |
1559 | * @param bool $trapException | |
1560 | * | |
1561 | * @return CRM_Core_DAO | |
1562 | * Object that points to an unbuffered result set | |
67cae873 | 1563 | */ |
518fa0ee | 1564 | public static function executeUnbufferedQuery( |
67cae873 | 1565 | $query, |
be2fb01f | 1566 | $params = [], |
3a8ce9d6 SB |
1567 | $abort = TRUE, |
1568 | $daoName = NULL, | |
1569 | $freeDAO = FALSE, | |
1570 | $i18nRewrite = TRUE, | |
67cae873 SB |
1571 | $trapException = FALSE |
1572 | ) { | |
67cae873 | 1573 | |
4d1368d8 | 1574 | return self::executeQuery( |
1575 | $query, | |
1576 | $params, | |
1577 | $abort, | |
1578 | $daoName, | |
1579 | $freeDAO, | |
1580 | $i18nRewrite, | |
1581 | $trapException, | |
be2fb01f | 1582 | ['result_buffering' => 0] |
4d1368d8 | 1583 | ); |
67cae873 SB |
1584 | } |
1585 | ||
6a488035 | 1586 | /** |
fe482240 | 1587 | * Execute a query. |
6a488035 | 1588 | * |
6a0b768e TO |
1589 | * @param string $query |
1590 | * Query to be executed. | |
6a488035 | 1591 | * |
2a6da8d7 EM |
1592 | * @param array $params |
1593 | * @param bool $abort | |
1594 | * @param null $daoName | |
1595 | * @param bool $freeDAO | |
1596 | * @param bool $i18nRewrite | |
1597 | * @param bool $trapException | |
4d1368d8 | 1598 | * @param array $options |
2a6da8d7 | 1599 | * |
5f1ebaec | 1600 | * @return CRM_Core_DAO|object |
16b10e64 | 1601 | * object that holds the results of the query |
5f1ebaec EM |
1602 | * NB - if this is defined as just returning a DAO phpstorm keeps pointing |
1603 | * out all the properties that are not part of the DAO | |
6a488035 | 1604 | */ |
795492f3 | 1605 | public static function &executeQuery( |
6a488035 | 1606 | $query, |
be2fb01f | 1607 | $params = [], |
353ffa53 TO |
1608 | $abort = TRUE, |
1609 | $daoName = NULL, | |
1610 | $freeDAO = FALSE, | |
1611 | $i18nRewrite = TRUE, | |
4d1368d8 | 1612 | $trapException = FALSE, |
be2fb01f | 1613 | $options = [] |
6a488035 TO |
1614 | ) { |
1615 | $queryStr = self::composeQuery($query, $params, $abort); | |
6a488035 TO |
1616 | |
1617 | if (!$daoName) { | |
1618 | $dao = new CRM_Core_DAO(); | |
1619 | } | |
1620 | else { | |
353ffa53 | 1621 | $dao = new $daoName(); |
6a488035 TO |
1622 | } |
1623 | ||
1624 | if ($trapException) { | |
41ac4ae1 | 1625 | CRM_Core_Error::deprecatedFunctionWarning('calling functions should handle exceptions'); |
6a4257d4 | 1626 | $errorScope = CRM_Core_TemporaryErrorScope::ignoreException(); |
6a488035 TO |
1627 | } |
1628 | ||
4d1368d8 | 1629 | if ($dao->isValidOption($options)) { |
1630 | $dao->setOptions($options); | |
1631 | } | |
1632 | ||
6a488035 TO |
1633 | $result = $dao->query($queryStr, $i18nRewrite); |
1634 | ||
4d1368d8 | 1635 | // since it is unbuffered, ($dao->N==0) is true. This blocks the standard fetch() mechanism. |
1636 | if (CRM_Utils_Array::value('result_buffering', $options) === 0) { | |
1637 | $dao->N = TRUE; | |
1638 | } | |
1639 | ||
6a488035 | 1640 | if (is_a($result, 'DB_Error')) { |
41ac4ae1 | 1641 | CRM_Core_Error::deprecatedFunctionWarning('calling functions should handle exceptions'); |
6a488035 TO |
1642 | return $result; |
1643 | } | |
1644 | ||
6a488035 TO |
1645 | return $dao; |
1646 | } | |
1647 | ||
4d1368d8 | 1648 | /** |
1649 | * Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level | |
1650 | * | |
1651 | * @param array $options | |
1652 | * | |
1653 | * @return bool | |
1654 | * Provided options are valid | |
1655 | */ | |
1656 | public function isValidOption($options) { | |
1657 | $isValid = FALSE; | |
be2fb01f | 1658 | $validOptions = [ |
4d1368d8 | 1659 | 'result_buffering', |
1660 | 'persistent', | |
1661 | 'ssl', | |
1662 | 'portability', | |
be2fb01f | 1663 | ]; |
4d1368d8 | 1664 | |
1665 | if (empty($options)) { | |
1666 | return $isValid; | |
1667 | } | |
1668 | ||
1669 | foreach (array_keys($options) as $option) { | |
1670 | if (!in_array($option, $validOptions)) { | |
1671 | return FALSE; | |
1672 | } | |
1673 | $isValid = TRUE; | |
1674 | } | |
1675 | ||
1676 | return $isValid; | |
1677 | } | |
1678 | ||
6a488035 | 1679 | /** |
fe482240 | 1680 | * Execute a query and get the single result. |
6a488035 | 1681 | * |
6a0b768e TO |
1682 | * @param string $query |
1683 | * Query to be executed. | |
e869b07d CW |
1684 | * @param array $params |
1685 | * @param bool $abort | |
1686 | * @param bool $i18nRewrite | |
72b3a70c CW |
1687 | * @return string|null |
1688 | * the result of the query if any | |
6a488035 | 1689 | * |
6a488035 | 1690 | */ |
795492f3 | 1691 | public static function &singleValueQuery( |
f9f40af3 | 1692 | $query, |
be2fb01f | 1693 | $params = [], |
353ffa53 | 1694 | $abort = TRUE, |
6a488035 TO |
1695 | $i18nRewrite = TRUE |
1696 | ) { | |
1697 | $queryStr = self::composeQuery($query, $params, $abort); | |
1698 | ||
1699 | static $_dao = NULL; | |
1700 | ||
1701 | if (!$_dao) { | |
1702 | $_dao = new CRM_Core_DAO(); | |
1703 | } | |
1704 | ||
1705 | $_dao->query($queryStr, $i18nRewrite); | |
1706 | ||
1707 | $result = $_dao->getDatabaseResult(); | |
1708 | $ret = NULL; | |
1709 | if ($result) { | |
1710 | $row = $result->fetchRow(); | |
1711 | if ($row) { | |
1712 | $ret = $row[0]; | |
1713 | } | |
1714 | } | |
1715 | $_dao->free(); | |
1716 | return $ret; | |
1717 | } | |
1718 | ||
a0ee3941 | 1719 | /** |
edc8adfc | 1720 | * Compose the query by merging the parameters into it. |
1721 | * | |
1722 | * @param string $query | |
c490a46a | 1723 | * @param array $params |
a0ee3941 EM |
1724 | * @param bool $abort |
1725 | * | |
1726 | * @return string | |
22b4a080 | 1727 | * @throws CRM_Core_Exception |
a0ee3941 | 1728 | */ |
a954b445 | 1729 | public static function composeQuery($query, $params = [], $abort = TRUE) { |
be2fb01f | 1730 | $tr = []; |
6a488035 TO |
1731 | foreach ($params as $key => $item) { |
1732 | if (is_numeric($key)) { | |
1733 | if (CRM_Utils_Type::validate($item[0], $item[1]) !== NULL) { | |
1734 | $item[0] = self::escapeString($item[0]); | |
1735 | if ($item[1] == 'String' || | |
1736 | $item[1] == 'Memo' || | |
1737 | $item[1] == 'Link' | |
1738 | ) { | |
887a4028 A |
1739 | // Support class constants stipulating wildcard characters and/or |
1740 | // non-quoting of strings. Also support legacy code which may be | |
1741 | // passing in TRUE or 1 for $item[2], which used to indicate the | |
1742 | // use of wildcard characters. | |
1743 | if (!empty($item[2])) { | |
1744 | if ($item[2] & CRM_Core_DAO::QUERY_FORMAT_WILDCARD || $item[2] === TRUE) { | |
1745 | $item[0] = "'%{$item[0]}%'"; | |
1746 | } | |
1747 | elseif (!($item[2] & CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES)) { | |
1748 | $item[0] = "'{$item[0]}'"; | |
1749 | } | |
6a488035 TO |
1750 | } |
1751 | else { | |
1752 | $item[0] = "'{$item[0]}'"; | |
1753 | } | |
1754 | } | |
1755 | ||
1756 | if (($item[1] == 'Date' || $item[1] == 'Timestamp') && | |
1757 | strlen($item[0]) == 0 | |
1758 | ) { | |
1759 | $item[0] = 'null'; | |
1760 | } | |
1761 | ||
1762 | $tr['%' . $key] = $item[0]; | |
1763 | } | |
1764 | elseif ($abort) { | |
d8bf477d | 1765 | throw new CRM_Core_Exception("{$item[0]} is not of type {$item[1]}"); |
6a488035 TO |
1766 | } |
1767 | } | |
1768 | } | |
1769 | ||
e2508c90 | 1770 | return strtr($query, $tr); |
6a488035 TO |
1771 | } |
1772 | ||
a0ee3941 EM |
1773 | /** |
1774 | * @param null $ids | |
1775 | */ | |
00be9182 | 1776 | public static function freeResult($ids = NULL) { |
6a488035 TO |
1777 | global $_DB_DATAOBJECT; |
1778 | ||
6a488035 TO |
1779 | if (!$ids) { |
1780 | if (!$_DB_DATAOBJECT || | |
1781 | !isset($_DB_DATAOBJECT['RESULTS']) | |
1782 | ) { | |
1783 | return; | |
1784 | } | |
1785 | $ids = array_keys($_DB_DATAOBJECT['RESULTS']); | |
1786 | } | |
1787 | ||
1788 | foreach ($ids as $id) { | |
1789 | if (isset($_DB_DATAOBJECT['RESULTS'][$id])) { | |
8f56d1f5 | 1790 | $_DB_DATAOBJECT['RESULTS'][$id]->free(); |
6a488035 TO |
1791 | unset($_DB_DATAOBJECT['RESULTS'][$id]); |
1792 | } | |
1793 | ||
1794 | if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$id])) { | |
1795 | unset($_DB_DATAOBJECT['RESULTFIELDS'][$id]); | |
1796 | } | |
1797 | } | |
1798 | } | |
1799 | ||
1800 | /** | |
44ce4aa3 | 1801 | * Make a shallow copy of an object and all the fields in the object. |
6a488035 | 1802 | * |
6a0b768e TO |
1803 | * @param string $daoName |
1804 | * Name of the dao. | |
1805 | * @param array $criteria | |
1806 | * Array of all the fields & values. | |
44ce4aa3 | 1807 | * on which basis to copy |
6a0b768e TO |
1808 | * @param array $newData |
1809 | * Array of all the fields & values. | |
44ce4aa3 | 1810 | * to be copied besides the other fields |
6a0b768e TO |
1811 | * @param string $fieldsFix |
1812 | * Array of fields that you want to prefix/suffix/replace. | |
1813 | * @param string $blockCopyOfDependencies | |
1814 | * Fields that you want to block from. | |
44ce4aa3 | 1815 | * getting copied |
8c605c27 MD |
1816 | * @param bool $blockCopyofCustomValues |
1817 | * Case when you don't want to copy the custom values set in a | |
1818 | * template as it will override/ignore the submitted custom values | |
6a488035 | 1819 | * |
3fec1adc | 1820 | * @return CRM_Core_DAO|bool |
1821 | * the newly created copy of the object. False if none created. | |
6a488035 | 1822 | */ |
8c605c27 | 1823 | public static function copyGeneric($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL, $blockCopyofCustomValues = FALSE) { |
353ffa53 | 1824 | $object = new $daoName(); |
3fec1adc | 1825 | $newObject = FALSE; |
6a488035 TO |
1826 | if (!$newData) { |
1827 | $object->id = $criteria['id']; | |
1828 | } | |
1829 | else { | |
1830 | foreach ($criteria as $key => $value) { | |
1831 | $object->$key = $value; | |
1832 | } | |
1833 | } | |
1834 | ||
1835 | $object->find(); | |
1836 | while ($object->fetch()) { | |
1837 | ||
1838 | // all the objects except with $blockCopyOfDependencies set | |
1839 | // be copied - addresses #CRM-1962 | |
1840 | ||
1841 | if ($blockCopyOfDependencies && $object->$blockCopyOfDependencies) { | |
1842 | break; | |
1843 | } | |
1844 | ||
353ffa53 | 1845 | $newObject = new $daoName(); |
6a488035 | 1846 | |
44ce4aa3 | 1847 | $fields = $object->fields(); |
1366362a SV |
1848 | $fieldsToPrefix = []; |
1849 | $fieldsToSuffix = []; | |
1850 | $fieldsToReplace = []; | |
a7488080 | 1851 | if (!empty($fieldsFix['prefix'])) { |
6a488035 TO |
1852 | $fieldsToPrefix = $fieldsFix['prefix']; |
1853 | } | |
a7488080 | 1854 | if (!empty($fieldsFix['suffix'])) { |
6a488035 TO |
1855 | $fieldsToSuffix = $fieldsFix['suffix']; |
1856 | } | |
a7488080 | 1857 | if (!empty($fieldsFix['replace'])) { |
6a488035 TO |
1858 | $fieldsToReplace = $fieldsFix['replace']; |
1859 | } | |
1860 | ||
db0ed8af | 1861 | $localizableFields = FALSE; |
6a488035 TO |
1862 | foreach ($fields as $name => $value) { |
1863 | if ($name == 'id' || $value['name'] == 'id') { | |
1864 | // copy everything but the id! | |
1865 | continue; | |
1866 | } | |
1867 | ||
1868 | $dbName = $value['name']; | |
a1305c92 | 1869 | $type = CRM_Utils_Type::typeToString($value['type']); |
6a488035 TO |
1870 | $newObject->$dbName = $object->$dbName; |
1871 | if (isset($fieldsToPrefix[$dbName])) { | |
1872 | $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName; | |
1873 | } | |
1874 | if (isset($fieldsToSuffix[$dbName])) { | |
1875 | $newObject->$dbName .= $fieldsToSuffix[$dbName]; | |
1876 | } | |
1877 | if (isset($fieldsToReplace[$dbName])) { | |
1878 | $newObject->$dbName = $fieldsToReplace[$dbName]; | |
1879 | } | |
1880 | ||
6c71f6c7 | 1881 | if ($type == 'Timestamp' || $type == 'Date') { |
6a488035 TO |
1882 | $newObject->$dbName = CRM_Utils_Date::isoToMysql($newObject->$dbName); |
1883 | } | |
1884 | ||
db0ed8af SV |
1885 | if (!empty($value['localizable'])) { |
1886 | $localizableFields = TRUE; | |
1887 | } | |
1888 | ||
6a488035 | 1889 | if ($newData) { |
2e45b2f8 | 1890 | $newObject->copyValues($newData); |
6a488035 TO |
1891 | } |
1892 | } | |
1893 | $newObject->save(); | |
db0ed8af SV |
1894 | |
1895 | // ensure we copy all localized fields as well | |
1896 | if (CRM_Core_I18n::isMultilingual() && $localizableFields) { | |
1897 | global $dbLocale; | |
1898 | $locales = CRM_Core_I18n::getMultilingual(); | |
1899 | $curLocale = CRM_Core_I18n::getLocale(); | |
1900 | // loop on other locales | |
1901 | foreach ($locales as $locale) { | |
1902 | if ($locale != $curLocale) { | |
1903 | // setLocale doesn't seems to be reliable to set dbLocale and we only need to change the db locale | |
1904 | $dbLocale = '_' . $locale; | |
1905 | $newObject->copyLocalizable($object->id, $newObject->id, $fieldsToPrefix, $fieldsToSuffix, $fieldsToReplace); | |
1906 | } | |
1907 | } | |
1908 | // restore dbLocale to starting value | |
1909 | $dbLocale = '_' . $curLocale; | |
1910 | } | |
1911 | ||
8c605c27 MD |
1912 | if (!$blockCopyofCustomValues) { |
1913 | $newObject->copyCustomFields($object->id, $newObject->id); | |
1914 | } | |
3d182a04 | 1915 | CRM_Utils_Hook::post('create', CRM_Core_DAO_AllCoreTables::getBriefName($daoName), $newObject->id, $newObject); |
6a488035 | 1916 | } |
ae70f47e | 1917 | |
6a488035 TO |
1918 | return $newObject; |
1919 | } | |
1920 | ||
db0ed8af SV |
1921 | /** |
1922 | * Method that copies localizable fields from an old entity to a new one. | |
1923 | * | |
1924 | * Fixes bug dev/core#2479, | |
1925 | * where non current locale fields are copied from current locale losing translation when copying | |
1926 | * | |
1927 | * @param int $entityID | |
1928 | * @param int $newEntityID | |
47751a2a SV |
1929 | * @param array $fieldsToPrefix |
1930 | * @param array $fieldsToSuffix | |
1931 | * @param array $fieldsToReplace | |
db0ed8af SV |
1932 | */ |
1933 | protected function copyLocalizable($entityID, $newEntityID, $fieldsToPrefix, $fieldsToSuffix, $fieldsToReplace) { | |
1934 | $entity = get_class($this); | |
1935 | $object = new $entity(); | |
1936 | $object->id = $entityID; | |
1937 | $object->find(); | |
1938 | ||
1939 | $newObject = new $entity(); | |
1940 | $newObject->id = $newEntityID; | |
1941 | ||
1942 | $newObject->find(); | |
1943 | ||
1944 | if ($object->fetch() && $newObject->fetch()) { | |
1945 | ||
1946 | $fields = $object->fields(); | |
1947 | foreach ($fields as $name => $value) { | |
1948 | ||
1949 | if ($name == 'id' || $value['name'] == 'id') { | |
1950 | // copy everything but the id! | |
1951 | continue; | |
1952 | } | |
1953 | ||
1954 | // only copy localizable fields | |
1955 | if (!$value['localizable']) { | |
1956 | continue; | |
1957 | } | |
1958 | ||
1959 | $dbName = $value['name']; | |
1960 | $type = CRM_Utils_Type::typeToString($value['type']); | |
1961 | $newObject->$dbName = $object->$dbName; | |
1962 | if (isset($fieldsToPrefix[$dbName])) { | |
1963 | $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName; | |
1964 | } | |
1965 | if (isset($fieldsToSuffix[$dbName])) { | |
1966 | $newObject->$dbName .= $fieldsToSuffix[$dbName]; | |
1967 | } | |
1968 | if (isset($fieldsToReplace[$dbName])) { | |
1969 | $newObject->$dbName = $fieldsToReplace[$dbName]; | |
1970 | } | |
1971 | ||
1972 | if ($type == 'Timestamp' || $type == 'Date') { | |
1973 | $newObject->$dbName = CRM_Utils_Date::isoToMysql($newObject->$dbName); | |
1974 | } | |
1975 | ||
1976 | } | |
1977 | $newObject->save(); | |
1978 | ||
1979 | } | |
1980 | } | |
1981 | ||
50182f0e | 1982 | /** |
e60bcca6 | 1983 | * Method that copies custom fields values from an old entity to a new one. |
1984 | * | |
1985 | * Fixes bug CRM-19302, | |
50182f0e | 1986 | * where if a custom field of File type was present, left both events using the same file, |
1987 | * breaking download URL's for the old event. | |
1988 | * | |
1989 | * @todo the goal here is to clean this up so that it works for any entity. Copy Generic already DOES some custom field stuff | |
e60bcca6 | 1990 | * but it seems to be bypassed & perhaps less good than this (or this just duplicates it...) |
50182f0e | 1991 | * |
e60bcca6 | 1992 | * @param int $entityID |
1993 | * @param int $newEntityID | |
29b23231 | 1994 | * @param string $parentOperation |
50182f0e | 1995 | */ |
29b23231 | 1996 | public function copyCustomFields($entityID, $newEntityID, $parentOperation = NULL) { |
e60bcca6 | 1997 | $entity = CRM_Core_DAO_AllCoreTables::getBriefName(get_class($this)); |
1998 | $tableName = CRM_Core_DAO_AllCoreTables::getTableForClass(get_class($this)); | |
11201e17 | 1999 | // Obtain custom values for the old entity. |
50182f0e | 2000 | $customParams = $htmlType = []; |
e60bcca6 | 2001 | $customValues = CRM_Core_BAO_CustomValueTable::getEntityValues($entityID, $entity); |
50182f0e | 2002 | |
2003 | // If custom values present, we copy them | |
2004 | if (!empty($customValues)) { | |
2005 | // Get Field ID's and identify File type attributes, to handle file copying. | |
2006 | $fieldIds = implode(', ', array_keys($customValues)); | |
2007 | $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )"; | |
2008 | $result = CRM_Core_DAO::executeQuery($sql); | |
2009 | ||
2010 | // Build array of File type fields | |
2011 | while ($result->fetch()) { | |
2012 | $htmlType[] = $result->id; | |
2013 | } | |
2014 | ||
2015 | // Build params array of custom values | |
2016 | foreach ($customValues as $field => $value) { | |
2017 | if ($value !== NULL) { | |
2018 | // Handle File type attributes | |
2019 | if (in_array($field, $htmlType)) { | |
e60bcca6 | 2020 | $fileValues = CRM_Core_BAO_File::path($value, $entityID); |
50182f0e | 2021 | $customParams["custom_{$field}_-1"] = [ |
2022 | 'name' => CRM_Utils_File::duplicate($fileValues[0]), | |
2023 | 'type' => $fileValues[1], | |
2024 | ]; | |
2025 | } | |
2026 | // Handle other types | |
2027 | else { | |
2028 | $customParams["custom_{$field}_-1"] = $value; | |
2029 | } | |
2030 | } | |
2031 | } | |
2032 | ||
11201e17 | 2033 | // Save Custom Fields for new Entity. |
29b23231 | 2034 | CRM_Core_BAO_CustomValueTable::postProcess($customParams, $tableName, $newEntityID, $entity, $parentOperation ?? 'create'); |
50182f0e | 2035 | } |
2036 | ||
2037 | // copy activity attachments ( if any ) | |
e60bcca6 | 2038 | CRM_Core_BAO_File::copyEntityFile($tableName, $entityID, $tableName, $newEntityID); |
50182f0e | 2039 | } |
2040 | ||
7a9ab499 EM |
2041 | /** |
2042 | * Cascade update through related entities. | |
2043 | * | |
2044 | * @param string $daoName | |
2045 | * @param $fromId | |
2046 | * @param $toId | |
2047 | * @param array $newData | |
2048 | * | |
1273d77c | 2049 | * @return CRM_Core_DAO|null |
7a9ab499 | 2050 | */ |
be2fb01f | 2051 | public static function cascadeUpdate($daoName, $fromId, $toId, $newData = []) { |
353ffa53 | 2052 | $object = new $daoName(); |
62933949 | 2053 | $object->id = $fromId; |
2054 | ||
2055 | if ($object->find(TRUE)) { | |
353ffa53 | 2056 | $newObject = new $daoName(); |
62933949 | 2057 | $newObject->id = $toId; |
2058 | ||
2059 | if ($newObject->find(TRUE)) { | |
44ce4aa3 | 2060 | $fields = $object->fields(); |
62933949 | 2061 | foreach ($fields as $name => $value) { |
2062 | if ($name == 'id' || $value['name'] == 'id') { | |
2063 | // copy everything but the id! | |
2064 | continue; | |
2065 | } | |
2066 | ||
2067 | $colName = $value['name']; | |
2068 | $newObject->$colName = $object->$colName; | |
2069 | ||
2070 | if (substr($name, -5) == '_date' || | |
2071 | substr($name, -10) == '_date_time' | |
2072 | ) { | |
2073 | $newObject->$colName = CRM_Utils_Date::isoToMysql($newObject->$colName); | |
2074 | } | |
2075 | } | |
2076 | foreach ($newData as $k => $v) { | |
2077 | $newObject->$k = $v; | |
2078 | } | |
2079 | $newObject->save(); | |
2080 | return $newObject; | |
2081 | } | |
2082 | } | |
1273d77c | 2083 | return NULL; |
62933949 | 2084 | } |
2085 | ||
6a488035 TO |
2086 | /** |
2087 | * Given the component id, compute the contact id | |
2088 | * since its used for things like send email | |
b3342109 EM |
2089 | * |
2090 | * @param $componentIDs | |
100fef9d | 2091 | * @param string $tableName |
d94a02b4 | 2092 | * @param string $idField |
6e3090fb | 2093 | * |
b3342109 | 2094 | * @return array |
6a488035 | 2095 | */ |
d94a02b4 | 2096 | public static function getContactIDsFromComponent($componentIDs, $tableName, $idField = 'id') { |
be2fb01f | 2097 | $contactIDs = []; |
6a488035 TO |
2098 | |
2099 | if (empty($componentIDs)) { | |
2100 | return $contactIDs; | |
2101 | } | |
2102 | ||
2103 | $IDs = implode(',', $componentIDs); | |
2104 | $query = " | |
2105 | SELECT contact_id | |
2106 | FROM $tableName | |
d94a02b4 | 2107 | WHERE $idField IN ( $IDs ) |
6a488035 TO |
2108 | "; |
2109 | ||
2110 | $dao = CRM_Core_DAO::executeQuery($query); | |
2111 | while ($dao->fetch()) { | |
2112 | $contactIDs[] = $dao->contact_id; | |
2113 | } | |
2114 | return $contactIDs; | |
2115 | } | |
2116 | ||
2117 | /** | |
fe482240 | 2118 | * Fetch object based on array of properties. |
6a488035 | 2119 | * |
6a0b768e TO |
2120 | * @param string $daoName |
2121 | * Name of the dao object. | |
dd244018 | 2122 | * @param string $fieldIdName |
100fef9d | 2123 | * @param int $fieldId |
dd244018 | 2124 | * @param $details |
6a0b768e TO |
2125 | * @param array $returnProperities |
2126 | * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name'). | |
dd244018 | 2127 | * |
a6c01b45 CW |
2128 | * @return object |
2129 | * an object of type referenced by daoName | |
6a488035 | 2130 | */ |
b05a7478 | 2131 | public static function commonRetrieveAll($daoName, $fieldIdName, $fieldId, &$details, $returnProperities = NULL) { |
353ffa53 | 2132 | $object = new $daoName(); |
6a488035 TO |
2133 | $object->$fieldIdName = $fieldId; |
2134 | ||
2135 | // return only specific fields if returnproperties are sent | |
2136 | if (!empty($returnProperities)) { | |
2137 | $object->selectAdd(); | |
2138 | $object->selectAdd('id'); | |
2139 | $object->selectAdd(implode(',', $returnProperities)); | |
2140 | } | |
2141 | ||
2142 | $object->find(); | |
2143 | while ($object->fetch()) { | |
be2fb01f | 2144 | $defaults = []; |
6a488035 TO |
2145 | self::storeValues($object, $defaults); |
2146 | $details[$object->id] = $defaults; | |
2147 | } | |
2148 | ||
2149 | return $details; | |
2150 | } | |
2151 | ||
44ce4aa3 CW |
2152 | /** |
2153 | * Drop all CiviCRM tables. | |
2154 | * | |
ff48e573 | 2155 | * @throws \CRM_Core_Exception |
44ce4aa3 | 2156 | */ |
00be9182 | 2157 | public static function dropAllTables() { |
6a488035 TO |
2158 | |
2159 | // first drop all the custom tables we've created | |
2160 | CRM_Core_BAO_CustomGroup::dropAllTables(); | |
2161 | ||
2162 | // drop all multilingual views | |
2163 | CRM_Core_I18n_Schema::dropAllViews(); | |
2164 | ||
2165 | CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, | |
2166 | dirname(__FILE__) . DIRECTORY_SEPARATOR . | |
2167 | '..' . DIRECTORY_SEPARATOR . | |
2168 | '..' . DIRECTORY_SEPARATOR . | |
2169 | 'sql' . DIRECTORY_SEPARATOR . | |
2170 | 'civicrm_drop.mysql' | |
2171 | ); | |
2172 | } | |
2173 | ||
a0ee3941 EM |
2174 | /** |
2175 | * @param $string | |
2176 | * | |
2177 | * @return string | |
2178 | */ | |
00be9182 | 2179 | public static function escapeString($string) { |
6a488035 | 2180 | static $_dao = NULL; |
6a488035 | 2181 | if (!$_dao) { |
8f56d1f5 MM |
2182 | // If this is an atypical case (e.g. preparing .sql file before CiviCRM |
2183 | // has been installed), then we fallback DB-less str_replace escaping, as | |
2184 | // we can't use mysqli_real_escape_string, as there is no DB connection. | |
2185 | // Note: In typical usage, escapeString() will only check one conditional | |
2186 | // ("if !$_dao") rather than two conditionals ("if !defined(DSN)") | |
74032946 | 2187 | if (!defined('CIVICRM_DSN')) { |
8f56d1f5 MM |
2188 | // See http://php.net/manual/en/mysqli.real-escape-string.php for the |
2189 | // list of characters mysqli_real_escape_string escapes. | |
be2fb01f CW |
2190 | $search = ["\\", "\x00", "\n", "\r", "'", '"', "\x1a"]; |
2191 | $replace = ["\\\\", "\\0", "\\n", "\\r", "\'", '\"', "\\Z"]; | |
8f56d1f5 | 2192 | return str_replace($search, $replace, $string); |
74032946 | 2193 | } |
6a488035 TO |
2194 | $_dao = new CRM_Core_DAO(); |
2195 | } | |
6a488035 TO |
2196 | return $_dao->escape($string); |
2197 | } | |
2198 | ||
2199 | /** | |
2200 | * Escape a list of strings for use with "WHERE X IN (...)" queries. | |
2201 | * | |
5a4f6742 CW |
2202 | * @param array $strings |
2203 | * @param string $default | |
2204 | * the value to use if $strings has no elements. | |
a6c01b45 CW |
2205 | * @return string |
2206 | * eg "abc","def","ghi" | |
6a488035 | 2207 | */ |
00be9182 | 2208 | public static function escapeStrings($strings, $default = NULL) { |
6a488035 TO |
2209 | static $_dao = NULL; |
2210 | if (!$_dao) { | |
2211 | $_dao = new CRM_Core_DAO(); | |
2212 | } | |
2213 | ||
2214 | if (empty($strings)) { | |
2215 | return $default; | |
2216 | } | |
2217 | ||
be2fb01f | 2218 | $escapes = array_map([$_dao, 'escape'], $strings); |
6a488035 TO |
2219 | return '"' . implode('","', $escapes) . '"'; |
2220 | } | |
2221 | ||
a0ee3941 EM |
2222 | /** |
2223 | * @param $string | |
2224 | * | |
2225 | * @return string | |
2226 | */ | |
00be9182 | 2227 | public static function escapeWildCardString($string) { |
6a488035 TO |
2228 | // CRM-9155 |
2229 | // ensure we escape the single characters % and _ which are mysql wild | |
2230 | // card characters and could come in via sortByCharacter | |
2231 | // note that mysql does not escape these characters | |
2232 | if ($string && in_array($string, | |
be2fb01f | 2233 | ['%', '_', '%%', '_%'] |
353ffa53 TO |
2234 | ) |
2235 | ) { | |
6a488035 TO |
2236 | return '\\' . $string; |
2237 | } | |
2238 | ||
2239 | return self::escapeString($string); | |
2240 | } | |
2241 | ||
92b83508 EM |
2242 | /** |
2243 | * Creates a test object, including any required objects it needs via recursion | |
b3342109 EM |
2244 | * createOnly: only create in database, do not store or return the objects (useful for perf testing) |
2245 | * ONLY USE FOR TESTING | |
2246 | * | |
c490a46a | 2247 | * @param string $daoName |
b3342109 EM |
2248 | * @param array $params |
2249 | * @param int $numObjects | |
2250 | * @param bool $createOnly | |
2251 | * | |
795492f3 TO |
2252 | * @return object|array|NULL |
2253 | * NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects. | |
92b83508 | 2254 | */ |
795492f3 | 2255 | public static function createTestObject( |
6a488035 | 2256 | $daoName, |
be2fb01f | 2257 | $params = [], |
6a488035 TO |
2258 | $numObjects = 1, |
2259 | $createOnly = FALSE | |
2260 | ) { | |
b6262a4c EM |
2261 | //this is a test function also backtrace is set for the test suite it sometimes unsets itself |
2262 | // so we re-set here in case | |
2263 | $config = CRM_Core_Config::singleton(); | |
2264 | $config->backtrace = TRUE; | |
2265 | ||
6a488035 | 2266 | static $counter = 0; |
be2fb01f | 2267 | CRM_Core_DAO::$_testEntitiesToSkip = [ |
6a488035 TO |
2268 | 'CRM_Core_DAO_Worldregion', |
2269 | 'CRM_Core_DAO_StateProvince', | |
2270 | 'CRM_Core_DAO_Country', | |
2271 | 'CRM_Core_DAO_Domain', | |
795492f3 | 2272 | 'CRM_Financial_DAO_FinancialType', |
353ffa53 | 2273 | //because valid ones exist & we use pick them due to pseudoconstant can't reliably create & delete these |
be2fb01f | 2274 | ]; |
6a488035 | 2275 | |
2069d1b7 TO |
2276 | // Prefer to instantiate BAO's instead of DAO's (when possible) |
2277 | // so that assignTestValue()/assignTestFK() can be overloaded. | |
2278 | $baoName = str_replace('_DAO_', '_BAO_', $daoName); | |
a494d7a3 | 2279 | if ($baoName === 'CRM_Financial_BAO_FinancialTrxn') { |
2280 | // OMG OMG OMG this is so incredibly bad. The BAO is insanely named. | |
2281 | // @todo create a new class called what the BAO SHOULD be | |
2282 | // that extends BAO-crazy-name.... migrate. | |
2283 | $baoName = 'CRM_Core_BAO_FinancialTrxn'; | |
2284 | } | |
2069d1b7 TO |
2285 | if (class_exists($baoName)) { |
2286 | $daoName = $baoName; | |
2287 | } | |
2288 | ||
6a488035 TO |
2289 | for ($i = 0; $i < $numObjects; ++$i) { |
2290 | ||
2291 | ++$counter; | |
e79cd558 | 2292 | /** @var CRM_Core_DAO $object */ |
ab9aa379 | 2293 | $object = new $daoName(); |
6a488035 | 2294 | |
44ce4aa3 | 2295 | $fields = $object->fields(); |
e1b64aab TO |
2296 | foreach ($fields as $fieldName => $fieldDef) { |
2297 | $dbName = $fieldDef['name']; | |
9c1bc317 | 2298 | $FKClassName = $fieldDef['FKClassName'] ?? NULL; |
f290b6ef | 2299 | |
015ba54e | 2300 | if (isset($params[$dbName]) && !is_array($params[$dbName])) { |
6a488035 TO |
2301 | $object->$dbName = $params[$dbName]; |
2302 | } | |
2303 | ||
2304 | elseif ($dbName != 'id') { | |
f290b6ef | 2305 | if ($FKClassName != NULL) { |
e79cd558 | 2306 | $object->assignTestFK($fieldName, $fieldDef, $params); |
6a488035 | 2307 | continue; |
0db6c3e1 TO |
2308 | } |
2309 | else { | |
f290b6ef | 2310 | $object->assignTestValue($fieldName, $fieldDef, $counter); |
6a488035 | 2311 | } |
6a488035 TO |
2312 | } |
2313 | } | |
b3342109 | 2314 | |
6a488035 TO |
2315 | $object->save(); |
2316 | ||
2317 | if (!$createOnly) { | |
6a488035 | 2318 | $objects[$i] = $object; |
6a488035 | 2319 | } |
f290b6ef TO |
2320 | else { |
2321 | unset($object); | |
2322 | } | |
6a488035 TO |
2323 | } |
2324 | ||
2325 | if ($createOnly) { | |
795492f3 | 2326 | return NULL; |
6a488035 | 2327 | } |
f290b6ef TO |
2328 | elseif ($numObjects == 1) { |
2329 | return $objects[0]; | |
2330 | } | |
2331 | else { | |
2332 | return $objects; | |
2333 | } | |
6a488035 TO |
2334 | } |
2335 | ||
92b83508 | 2336 | /** |
fe482240 | 2337 | * Deletes the this object plus any dependent objects that are associated with it. |
92b83508 | 2338 | * ONLY USE FOR TESTING |
b3342109 | 2339 | * |
c490a46a | 2340 | * @param string $daoName |
b3342109 | 2341 | * @param array $params |
92b83508 | 2342 | */ |
be2fb01f | 2343 | public static function deleteTestObjects($daoName, $params = []) { |
b6262a4c EM |
2344 | //this is a test function also backtrace is set for the test suite it sometimes unsets itself |
2345 | // so we re-set here in case | |
2346 | $config = CRM_Core_Config::singleton(); | |
2347 | $config->backtrace = TRUE; | |
6a488035 | 2348 | |
b6262a4c | 2349 | $object = new $daoName(); |
9c1bc317 | 2350 | $object->id = $params['id'] ?? NULL; |
6a488035 | 2351 | |
518fa0ee SL |
2352 | // array(array(0 => $daoName, 1 => $daoParams)) |
2353 | $deletions = []; | |
6a488035 TO |
2354 | if ($object->find(TRUE)) { |
2355 | ||
44ce4aa3 | 2356 | $fields = $object->fields(); |
6a488035 TO |
2357 | foreach ($fields as $name => $value) { |
2358 | ||
2359 | $dbName = $value['name']; | |
2360 | ||
9c1bc317 CW |
2361 | $FKClassName = $value['FKClassName'] ?? NULL; |
2362 | $required = $value['required'] ?? NULL; | |
6a488035 TO |
2363 | if ($FKClassName != NULL |
2364 | && $object->$dbName | |
2365 | && !in_array($FKClassName, CRM_Core_DAO::$_testEntitiesToSkip) | |
806e9b71 EM |
2366 | && ($required || $dbName == 'contact_id') |
2367 | //I'm a bit stuck on this one - we might need to change the singleValueAlter so that the entities don't share a contact | |
2368 | // to make this test process pass - line below makes pass for now | |
353ffa53 TO |
2369 | && $dbName != 'member_of_contact_id' |
2370 | ) { | |
518fa0ee SL |
2371 | // x |
2372 | $deletions[] = [$FKClassName, ['id' => $object->$dbName]]; | |
6a488035 TO |
2373 | } |
2374 | } | |
2375 | } | |
2376 | ||
2377 | $object->delete(); | |
2378 | ||
2379 | foreach ($deletions as $deletion) { | |
2380 | CRM_Core_DAO::deleteTestObjects($deletion[0], $deletion[1]); | |
353ffa53 | 2381 | } |
6a488035 TO |
2382 | } |
2383 | ||
64d24a64 | 2384 | /** |
fe482240 | 2385 | * Set defaults when creating new entity. |
64d24a64 EM |
2386 | * (don't call this set defaults as already in use with different signature in some places) |
2387 | * | |
c490a46a | 2388 | * @param array $params |
64d24a64 EM |
2389 | * @param $defaults |
2390 | */ | |
00be9182 | 2391 | public static function setCreateDefaults(&$params, $defaults) { |
16e268ad | 2392 | if (!empty($params['id'])) { |
64d24a64 EM |
2393 | return; |
2394 | } | |
2395 | foreach ($defaults as $key => $value) { | |
2396 | if (!array_key_exists($key, $params) || $params[$key] === NULL) { | |
2397 | $params[$key] = $value; | |
2398 | } | |
2399 | } | |
2400 | } | |
2401 | ||
a0ee3941 EM |
2402 | /** |
2403 | * @param string $prefix | |
2404 | * @param bool $addRandomString | |
2405 | * @param null $string | |
2406 | * | |
2407 | * @return string | |
00f8d61b TO |
2408 | * @deprecated |
2409 | * @see CRM_Utils_SQL_TempTable | |
a0ee3941 | 2410 | */ |
00be9182 | 2411 | public static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) { |
5b508244 | 2412 | CRM_Core_Error::deprecatedFunctionWarning('Use CRM_Utils_SQL_TempTable interface to create temporary tables'); |
6a488035 TO |
2413 | $tableName = $prefix . "_temp"; |
2414 | ||
2415 | if ($addRandomString) { | |
2416 | if ($string) { | |
2417 | $tableName .= "_" . $string; | |
2418 | } | |
2419 | else { | |
2420 | $tableName .= "_" . md5(uniqid('', TRUE)); | |
2421 | } | |
2422 | } | |
2423 | return $tableName; | |
2424 | } | |
2425 | ||
a0ee3941 EM |
2426 | /** |
2427 | * @param bool $view | |
2428 | * @param bool $trigger | |
2429 | * | |
2430 | * @return bool | |
2431 | */ | |
00be9182 | 2432 | public static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) { |
344b05bc | 2433 | if (\Civi::settings()->get('logging_no_trigger_permission')) { |
2434 | return TRUE; | |
2435 | } | |
1c67b989 | 2436 | // test for create view and trigger permissions and if allowed, add the option to go multilingual and logging |
6a488035 | 2437 | $dao = new CRM_Core_DAO(); |
1c67b989 MW |
2438 | try { |
2439 | if ($view) { | |
2440 | $dao->query('CREATE OR REPLACE VIEW civicrm_domain_view AS SELECT * FROM civicrm_domain'); | |
2441 | $dao->query('DROP VIEW IF EXISTS civicrm_domain_view'); | |
6a488035 | 2442 | } |
6a488035 | 2443 | |
1c67b989 MW |
2444 | if ($trigger) { |
2445 | $dao->query('CREATE TRIGGER civicrm_domain_trigger BEFORE INSERT ON civicrm_domain FOR EACH ROW BEGIN END'); | |
2446 | $dao->query('DROP TRIGGER IF EXISTS civicrm_domain_trigger'); | |
6a488035 TO |
2447 | } |
2448 | } | |
1c67b989 MW |
2449 | catch (Exception $e) { |
2450 | return FALSE; | |
6a488035 | 2451 | } |
6a488035 TO |
2452 | |
2453 | return TRUE; | |
2454 | } | |
2455 | ||
a0ee3941 EM |
2456 | /** |
2457 | * @param null $message | |
2458 | * @param bool $printDAO | |
2459 | */ | |
00be9182 | 2460 | public static function debugPrint($message = NULL, $printDAO = TRUE) { |
6a488035 TO |
2461 | CRM_Utils_System::xMemory("{$message}: "); |
2462 | ||
2463 | if ($printDAO) { | |
2464 | global $_DB_DATAOBJECT; | |
be2fb01f | 2465 | $q = []; |
6a488035 TO |
2466 | foreach (array_keys($_DB_DATAOBJECT['RESULTS']) as $id) { |
2467 | $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query; | |
2468 | } | |
2469 | CRM_Core_Error::debug('_DB_DATAOBJECT', $q); | |
2470 | } | |
2471 | } | |
2472 | ||
77b97be7 EM |
2473 | /** |
2474 | * Build a list of triggers via hook and add them to (err, reconcile them | |
2475 | * with) the database. | |
2476 | * | |
5a4f6742 CW |
2477 | * @param string $tableName |
2478 | * the specific table requiring a rebuild; or NULL to rebuild all tables. | |
77b97be7 | 2479 | * @param bool $force |
4ed867e0 | 2480 | * @deprecated |
77b97be7 EM |
2481 | * |
2482 | * @see CRM-9716 | |
2483 | */ | |
00be9182 | 2484 | public static function triggerRebuild($tableName = NULL, $force = FALSE) { |
4ed867e0 | 2485 | Civi::service('sql_triggers')->rebuild($tableName, $force); |
6a488035 TO |
2486 | } |
2487 | ||
2488 | /** | |
fe482240 | 2489 | * Wrapper function to drop triggers. |
6a488035 | 2490 | * |
5a4f6742 CW |
2491 | * @param string $tableName |
2492 | * the specific table requiring a rebuild; or NULL to rebuild all tables. | |
4ed867e0 | 2493 | * @deprecated |
6a488035 | 2494 | */ |
00be9182 | 2495 | public static function dropTriggers($tableName = NULL) { |
4ed867e0 | 2496 | Civi::service('sql_triggers')->dropTriggers($tableName); |
6a488035 TO |
2497 | } |
2498 | ||
2499 | /** | |
5a4f6742 CW |
2500 | * @param array $info |
2501 | * per hook_civicrm_triggerInfo. | |
2502 | * @param string $onlyTableName | |
2503 | * the specific table requiring a rebuild; or NULL to rebuild all tables. | |
4ed867e0 | 2504 | * @deprecated |
6a488035 | 2505 | */ |
00be9182 | 2506 | public static function createTriggers(&$info, $onlyTableName = NULL) { |
4ed867e0 | 2507 | Civi::service('sql_triggers')->createTriggers($info, $onlyTableName); |
6a488035 TO |
2508 | } |
2509 | ||
ffcef054 TO |
2510 | /** |
2511 | * Given a list of fields, create a list of references. | |
2512 | * | |
6a0b768e TO |
2513 | * @param string $className |
2514 | * BAO/DAO class name. | |
ffcef054 TO |
2515 | * @return array<CRM_Core_Reference_Interface> |
2516 | */ | |
00be9182 | 2517 | public static function createReferenceColumns($className) { |
be2fb01f | 2518 | $result = []; |
ffcef054 TO |
2519 | $fields = $className::fields(); |
2520 | foreach ($fields as $field) { | |
2521 | if (isset($field['pseudoconstant'], $field['pseudoconstant']['optionGroupName'])) { | |
2522 | $result[] = new CRM_Core_Reference_OptionValue( | |
2523 | $className::getTableName(), | |
2524 | $field['name'], | |
2525 | 'civicrm_option_value', | |
2526 | CRM_Utils_Array::value('keyColumn', $field['pseudoconstant'], 'value'), | |
2527 | $field['pseudoconstant']['optionGroupName'] | |
2528 | ); | |
2529 | } | |
2530 | } | |
2531 | return $result; | |
2532 | } | |
2533 | ||
6a488035 | 2534 | /** |
71e5aa5c ARW |
2535 | * Find all records which refer to this entity. |
2536 | * | |
4d8c2629 | 2537 | * @return CRM_Core_DAO[] |
71e5aa5c | 2538 | */ |
00be9182 | 2539 | public function findReferences() { |
71e5aa5c ARW |
2540 | $links = self::getReferencesToTable(static::getTableName()); |
2541 | ||
be2fb01f | 2542 | $occurrences = []; |
71e5aa5c | 2543 | foreach ($links as $refSpec) { |
11626cf1 | 2544 | /** @var $refSpec CRM_Core_Reference_Interface */ |
31bed28c | 2545 | $daoName = CRM_Core_DAO_AllCoreTables::getClassForTable($refSpec->getReferenceTable()); |
de49f39c | 2546 | $result = $refSpec->findReferences($this); |
ffcef054 TO |
2547 | if ($result) { |
2548 | while ($result->fetch()) { | |
2549 | $obj = new $daoName(); | |
2550 | $obj->id = $result->id; | |
2551 | $occurrences[] = $obj; | |
2552 | } | |
71e5aa5c ARW |
2553 | } |
2554 | } | |
2555 | ||
2556 | return $occurrences; | |
2557 | } | |
2558 | ||
a0ee3941 | 2559 | /** |
04309075 | 2560 | * @return array{name: string, type: string, count: int, table: string|null, key: string|null}[] |
a6c01b45 | 2561 | * each item has keys: |
16b10e64 CW |
2562 | * - name: string |
2563 | * - type: string | |
2564 | * - count: int | |
2565 | * - table: string|null SQL table name | |
2566 | * - key: string|null SQL column name | |
a0ee3941 | 2567 | */ |
00be9182 | 2568 | public function getReferenceCounts() { |
1256c139 TO |
2569 | $links = self::getReferencesToTable(static::getTableName()); |
2570 | ||
be2fb01f | 2571 | $counts = []; |
1256c139 TO |
2572 | foreach ($links as $refSpec) { |
2573 | /** @var $refSpec CRM_Core_Reference_Interface */ | |
2574 | $count = $refSpec->getReferenceCount($this); | |
052cd546 | 2575 | if (!empty($count['count'])) { |
1256c139 TO |
2576 | $counts[] = $count; |
2577 | } | |
2578 | } | |
2579 | ||
91dee34b TO |
2580 | foreach (CRM_Core_Component::getEnabledComponents() as $component) { |
2581 | /** @var $component CRM_Core_Component_Info */ | |
2582 | $counts = array_merge($counts, $component->getReferenceCounts($this)); | |
2583 | } | |
2584 | CRM_Utils_Hook::referenceCounts($this, $counts); | |
2585 | ||
1256c139 TO |
2586 | return $counts; |
2587 | } | |
2588 | ||
71e5aa5c ARW |
2589 | /** |
2590 | * List all tables which have hard foreign keys to this table. | |
6a488035 | 2591 | * |
71e5aa5c ARW |
2592 | * For now, this returns a description of every entity_id/entity_table |
2593 | * reference. | |
2594 | * TODO: filter dynamic entity references on the $tableName, based on | |
2595 | * schema metadata in dynamicForeignKey which enumerates a restricted | |
2596 | * set of possible entity_table's. | |
6a488035 | 2597 | * |
6a0b768e TO |
2598 | * @param string $tableName |
2599 | * Table referred to. | |
6a488035 | 2600 | * |
44eead20 | 2601 | * @return CRM_Core_Reference_Interface[] |
a6c01b45 | 2602 | * structure of table and column, listing every table with a |
16b10e64 | 2603 | * foreign key reference to $tableName, and the column where the key appears. |
6a488035 | 2604 | */ |
00be9182 | 2605 | public static function getReferencesToTable($tableName) { |
be2fb01f | 2606 | $refsFound = []; |
31bed28c | 2607 | foreach (CRM_Core_DAO_AllCoreTables::getClasses() as $daoClassName) { |
71e5aa5c | 2608 | $links = $daoClassName::getReferenceColumns(); |
71e5aa5c ARW |
2609 | |
2610 | foreach ($links as $refSpec) { | |
11626cf1 TO |
2611 | /** @var $refSpec CRM_Core_Reference_Interface */ |
2612 | if ($refSpec->matchesTargetTable($tableName)) { | |
71e5aa5c ARW |
2613 | $refsFound[] = $refSpec; |
2614 | } | |
6a488035 TO |
2615 | } |
2616 | } | |
71e5aa5c | 2617 | return $refsFound; |
6a488035 | 2618 | } |
032c9d10 | 2619 | |
e3e87c73 | 2620 | /** |
2621 | * Get all references to contact table. | |
2622 | * | |
2623 | * This includes core tables, custom group tables, tables added by the merge | |
2624 | * hook and the entity_tag table. | |
2625 | * | |
2626 | * Refer to CRM-17454 for information on the danger of querying the information | |
2627 | * schema to derive this. | |
eca28463 | 2628 | * |
2629 | * @throws \CiviCRM_API3_Exception | |
e3e87c73 | 2630 | */ |
2631 | public static function getReferencesToContactTable() { | |
2632 | if (isset(\Civi::$statics[__CLASS__]) && isset(\Civi::$statics[__CLASS__]['contact_references'])) { | |
2633 | return \Civi::$statics[__CLASS__]['contact_references']; | |
2634 | } | |
2635 | $contactReferences = []; | |
2636 | $coreReferences = CRM_Core_DAO::getReferencesToTable('civicrm_contact'); | |
2637 | foreach ($coreReferences as $coreReference) { | |
44eead20 CW |
2638 | if ( |
2639 | // Exclude option values | |
2640 | !is_a($coreReference, 'CRM_Core_Reference_Dynamic') && | |
2641 | // Exclude references to other columns | |
2642 | $coreReference->getTargetKey() === 'id' | |
2643 | ) { | |
e3e87c73 | 2644 | $contactReferences[$coreReference->getReferenceTable()][] = $coreReference->getReferenceKey(); |
2645 | } | |
2646 | } | |
2647 | self::appendCustomTablesExtendingContacts($contactReferences); | |
4c7e5001 | 2648 | self::appendCustomContactReferenceFields($contactReferences); |
e3e87c73 | 2649 | \Civi::$statics[__CLASS__]['contact_references'] = $contactReferences; |
2650 | return \Civi::$statics[__CLASS__]['contact_references']; | |
2651 | } | |
2652 | ||
eca28463 | 2653 | /** |
2654 | * Get all dynamic references to the given table. | |
2655 | * | |
2656 | * @param string $tableName | |
2657 | * | |
2658 | * @return array | |
2659 | */ | |
2660 | public static function getDynamicReferencesToTable($tableName) { | |
2661 | if (!isset(\Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName])) { | |
2662 | \Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName] = []; | |
2663 | $coreReferences = CRM_Core_DAO::getReferencesToTable($tableName); | |
2664 | foreach ($coreReferences as $coreReference) { | |
2665 | if ($coreReference instanceof \CRM_Core_Reference_Dynamic) { | |
9811efd4 | 2666 | \Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName][$coreReference->getReferenceTable()][] = [$coreReference->getReferenceKey(), $coreReference->getTypeColumn()]; |
eca28463 | 2667 | } |
2668 | } | |
2669 | } | |
2670 | return \Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName]; | |
2671 | } | |
2672 | ||
e3e87c73 | 2673 | /** |
2674 | * Add custom tables that extend contacts to the list of contact references. | |
2675 | * | |
2676 | * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish | |
2677 | * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples | |
2678 | * - the down side is it is not cached. | |
2679 | * | |
2680 | * Further changes should be include tests in the CRM_Core_MergerTest class | |
2681 | * to ensure that disabled, subtype, multiple etc groups are still captured. | |
2682 | * | |
2683 | * @param array $cidRefs | |
2684 | */ | |
2685 | public static function appendCustomTablesExtendingContacts(&$cidRefs) { | |
2686 | $customValueTables = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity('Contact'); | |
2687 | $customValueTables->find(); | |
2688 | while ($customValueTables->fetch()) { | |
4c7e5001 PF |
2689 | $cidRefs[$customValueTables->table_name][] = 'entity_id'; |
2690 | } | |
2691 | } | |
2692 | ||
2693 | /** | |
2694 | * Add custom ContactReference fields to the list of contact references | |
2695 | * | |
2696 | * This includes active and inactive fields/groups | |
2697 | * | |
2698 | * @param array $cidRefs | |
2699 | * | |
2700 | * @throws \CiviCRM_API3_Exception | |
2701 | */ | |
2702 | public static function appendCustomContactReferenceFields(&$cidRefs) { | |
2703 | $fields = civicrm_api3('CustomField', 'get', [ | |
2704 | 'return' => ['column_name', 'custom_group_id.table_name'], | |
2705 | 'data_type' => 'ContactReference', | |
fe3b8caf | 2706 | 'options' => ['limit' => 0], |
4c7e5001 PF |
2707 | ])['values']; |
2708 | foreach ($fields as $field) { | |
2709 | $cidRefs[$field['custom_group_id.table_name']][] = $field['column_name']; | |
e3e87c73 | 2710 | } |
2711 | } | |
2712 | ||
032c9d10 TO |
2713 | /** |
2714 | * Lookup the value of a MySQL global configuration variable. | |
2715 | * | |
6a0b768e TO |
2716 | * @param string $name |
2717 | * E.g. "thread_stack". | |
032c9d10 TO |
2718 | * @param mixed $default |
2719 | * @return mixed | |
2720 | */ | |
2721 | public static function getGlobalSetting($name, $default = NULL) { | |
2722 | // Alternatively, SELECT @@GLOBAL.thread_stack, but | |
2723 | // that has been reported to fail under MySQL 5.0 for OS X | |
2724 | $escapedName = self::escapeString($name); | |
2725 | $dao = CRM_Core_DAO::executeQuery("SHOW VARIABLES LIKE '$escapedName'"); | |
2726 | if ($dao->fetch()) { | |
2727 | return $dao->Value; | |
ab00f69d DL |
2728 | } |
2729 | else { | |
032c9d10 TO |
2730 | return $default; |
2731 | } | |
2732 | } | |
dc86f881 | 2733 | |
9d5c7f14 | 2734 | /** |
2735 | * Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields. | |
2736 | * | |
2737 | * This is relevant where we want to offer both the ID field and the label field | |
2738 | * as an option, e.g. search builder. | |
2739 | * | |
b55d81b4 | 2740 | * It is currently limited for optionGroupName & id+ name+ FK combos for purposes keeping the scope of the |
9d5c7f14 | 2741 | * change small, but is appropriate for other sorts of pseudoconstants. |
2742 | * | |
2743 | * @param array $fields | |
2744 | */ | |
a0090e6b | 2745 | public static function appendPseudoConstantsToFields(&$fields) { |
6b051312 | 2746 | foreach ($fields as $fieldUniqueName => $field) { |
b55d81b4 | 2747 | if (!empty($field['pseudoconstant'])) { |
2748 | $pseudoConstant = $field['pseudoconstant']; | |
2749 | if (!empty($pseudoConstant['optionGroupName'])) { | |
2750 | $fields[$pseudoConstant['optionGroupName']] = [ | |
2751 | 'title' => CRM_Core_BAO_OptionGroup::getTitleByName($pseudoConstant['optionGroupName']), | |
2752 | 'name' => $pseudoConstant['optionGroupName'], | |
2753 | 'data_type' => CRM_Utils_Type::T_STRING, | |
6b051312 | 2754 | 'is_pseudofield_for' => $fieldUniqueName, |
b55d81b4 | 2755 | ]; |
2756 | } | |
2757 | // We restrict to id + name + FK as we are extending this a bit, but cautiously. | |
2758 | elseif ( | |
2759 | !empty($field['FKClassName']) | |
2760 | && CRM_Utils_Array::value('keyColumn', $pseudoConstant) === 'id' | |
2761 | && CRM_Utils_Array::value('labelColumn', $pseudoConstant) === 'name' | |
2762 | ) { | |
2763 | $pseudoFieldName = str_replace('_' . $pseudoConstant['keyColumn'], '', $field['name']); | |
2764 | // This if is just an extra caution when adding change. | |
2765 | if (!isset($fields[$pseudoFieldName])) { | |
2766 | $daoName = $field['FKClassName']; | |
2767 | $fkFields = $daoName::fields(); | |
2768 | foreach ($fkFields as $fkField) { | |
2769 | if ($fkField['name'] === $pseudoConstant['labelColumn']) { | |
2770 | $fields[$pseudoFieldName] = [ | |
2771 | 'name' => $pseudoFieldName, | |
2772 | 'is_pseudofield_for' => $field['name'], | |
2773 | 'title' => $fkField['title'], | |
2774 | 'data_type' => $fkField['type'], | |
2775 | 'where' => $field['where'], | |
2776 | ]; | |
2777 | } | |
2778 | } | |
2779 | } | |
2780 | } | |
9d5c7f14 | 2781 | } |
2782 | } | |
2783 | } | |
2784 | ||
dc86f881 CW |
2785 | /** |
2786 | * Get options for the called BAO object's field. | |
167bcb5f | 2787 | * |
dc86f881 | 2788 | * This function can be overridden by each BAO to add more logic related to context. |
2158332a | 2789 | * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get |
dc86f881 | 2790 | * |
2a3f958d | 2791 | * @param string $fieldName |
6a0b768e | 2792 | * @param string $context |
795492f3 | 2793 | * @see CRM_Core_DAO::buildOptionsContext |
6a0b768e | 2794 | * @param array $props |
39868387 CW |
2795 | * Raw field values; whatever is known about this bao object. |
2796 | * | |
2797 | * Note: $props can contain unsanitized input and should not be passed directly to CRM_Core_PseudoConstant::get | |
9a1b1948 | 2798 | * |
795492f3 | 2799 | * @return array|bool |
dc86f881 | 2800 | */ |
be2fb01f | 2801 | public static function buildOptions($fieldName, $context = NULL, $props = []) { |
2158332a | 2802 | // If a given bao does not override this function |
dc86f881 | 2803 | $baoName = get_called_class(); |
39868387 | 2804 | return CRM_Core_PseudoConstant::get($baoName, $fieldName, [], $context); |
dc86f881 | 2805 | } |
786ad6e1 | 2806 | |
2a3f958d CW |
2807 | /** |
2808 | * Populate option labels for this object's fields. | |
2809 | * | |
2810 | * @throws exception if called directly on the base class | |
2811 | */ | |
2812 | public function getOptionLabels() { | |
2813 | $fields = $this->fields(); | |
2814 | if ($fields === NULL) { | |
795492f3 | 2815 | throw new Exception('Cannot call getOptionLabels on CRM_Core_DAO'); |
2a3f958d CW |
2816 | } |
2817 | foreach ($fields as $field) { | |
9c1bc317 | 2818 | $name = $field['name'] ?? NULL; |
2a3f958d | 2819 | if ($name && isset($this->$name)) { |
a8c23526 | 2820 | $label = CRM_Core_PseudoConstant::getLabel(get_class($this), $name, $this->$name); |
2a3f958d CW |
2821 | if ($label !== FALSE) { |
2822 | // Append 'label' onto the field name | |
2823 | $labelName = $name . '_label'; | |
2824 | $this->$labelName = $label; | |
2825 | } | |
2826 | } | |
2827 | } | |
2828 | } | |
2829 | ||
786ad6e1 CW |
2830 | /** |
2831 | * Provides documentation and validation for the buildOptions $context param | |
2832 | * | |
6a0b768e | 2833 | * @param string $context |
77b97be7 | 2834 | * |
d1d108ee | 2835 | * @throws CRM_Core_Exception |
77b97be7 | 2836 | * @return array |
786ad6e1 CW |
2837 | */ |
2838 | public static function buildOptionsContext($context = NULL) { | |
be2fb01f | 2839 | $contexts = [ |
a2407bc0 CW |
2840 | 'get' => "get: all options are returned, even if they are disabled; labels are translated.", |
2841 | 'create' => "create: options are filtered appropriately for the object being created/updated; labels are translated.", | |
2842 | 'search' => "search: searchable options are returned; labels are translated.", | |
2843 | 'validate' => "validate: all options are returned, even if they are disabled; machine names are used in place of labels.", | |
2844 | 'abbreviate' => "abbreviate: enabled options are returned; labels are replaced with abbreviations.", | |
2845 | 'match' => "match: enabled options are returned using machine names as keys; labels are translated.", | |
be2fb01f | 2846 | ]; |
786ad6e1 CW |
2847 | // Validation: enforce uniformity of this param |
2848 | if ($context !== NULL && !isset($contexts[$context])) { | |
d1d108ee | 2849 | throw new CRM_Core_Exception("'$context' is not a valid context for buildOptions."); |
786ad6e1 CW |
2850 | } |
2851 | return $contexts; | |
2852 | } | |
2853 | ||
5fafc9b0 | 2854 | /** |
100fef9d | 2855 | * @param string $fieldName |
5fafc9b0 CW |
2856 | * @return bool|array |
2857 | */ | |
00be9182 | 2858 | public function getFieldSpec($fieldName) { |
5fafc9b0 | 2859 | $fields = $this->fields(); |
5fafc9b0 CW |
2860 | |
2861 | // Support "unique names" as well as sql names | |
2862 | $fieldKey = $fieldName; | |
2863 | if (empty($fields[$fieldKey])) { | |
9d89b14d | 2864 | $fieldKeys = $this->fieldKeys(); |
9c1bc317 | 2865 | $fieldKey = $fieldKeys[$fieldName] ?? NULL; |
5fafc9b0 CW |
2866 | } |
2867 | // If neither worked then this field doesn't exist. Return false. | |
2868 | if (empty($fields[$fieldKey])) { | |
2869 | return FALSE; | |
2870 | } | |
2871 | return $fields[$fieldKey]; | |
2872 | } | |
2873 | ||
faf8c53b | 2874 | /** |
bb05da0c | 2875 | * Get SQL where clause for SQL filter syntax input parameters. |
2876 | * | |
faf8c53b | 2877 | * SQL version of api function to assign filters to the DAO based on the syntax |
2878 | * $field => array('IN' => array(4,6,9)) | |
2879 | * OR | |
2880 | * $field => array('LIKE' => array('%me%)) | |
2881 | * etc | |
2882 | * | |
6a0b768e TO |
2883 | * @param string $fieldName |
2884 | * Name of fields. | |
5a4f6742 CW |
2885 | * @param array $filter |
2886 | * filter to be applied indexed by operator. | |
2887 | * @param string $type | |
2888 | * type of field (not actually used - nor in api @todo ). | |
2889 | * @param string $alias | |
2890 | * alternative field name ('as') @todo- not actually used. | |
6a0b768e TO |
2891 | * @param bool $returnSanitisedArray |
2892 | * Return a sanitised array instead of a clause. | |
16b10e64 | 2893 | * this is primarily so we can add filters @ the api level to the Query object based fields |
9a1b1948 EM |
2894 | * |
2895 | * @throws Exception | |
c490a46a | 2896 | * |
72b3a70c CW |
2897 | * @return NULL|string|array |
2898 | * a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL | |
06f48f96 | 2899 | * depending on whether it is supported as yet |
9a1b1948 | 2900 | */ |
e47bcddb | 2901 | public static function createSQLFilter($fieldName, $filter, $type = NULL, $alias = NULL, $returnSanitisedArray = FALSE) { |
faf8c53b | 2902 | foreach ($filter as $operator => $criteria) { |
9787e1bb SL |
2903 | $emojiFilter = CRM_Utils_SQL::handleEmojiInQuery($criteria); |
2904 | if ($emojiFilter === '0 = 1') { | |
2905 | return $emojiFilter; | |
91f1ab62 | 2906 | } |
2907 | ||
6e23130a | 2908 | if (in_array($operator, self::acceptedSQLOperators(), TRUE)) { |
faf8c53b | 2909 | switch ($operator) { |
2910 | // unary operators | |
faf8c53b | 2911 | case 'IS NULL': |
2912 | case 'IS NOT NULL': | |
c490a46a | 2913 | if (!$returnSanitisedArray) { |
78c0bfc0 | 2914 | return (sprintf('%s %s', $fieldName, $operator)); |
2915 | } | |
c490a46a | 2916 | else { |
a75c13cc | 2917 | return (sprintf('%s %s ', $fieldName, $operator)); |
06f48f96 | 2918 | } |
faf8c53b | 2919 | break; |
2920 | ||
2921 | // ternary operators | |
2922 | case 'BETWEEN': | |
2923 | case 'NOT BETWEEN': | |
d03a02d9 | 2924 | if ((empty($criteria[0]) && !in_array($criteria[0], ['0', 0]))|| (empty($criteria[1]) && !in_array($criteria[1], ['0', 0]))) { |
395d8dc6 | 2925 | throw new Exception("invalid criteria for $operator"); |
faf8c53b | 2926 | } |
c490a46a | 2927 | if (!$returnSanitisedArray) { |
78c0bfc0 | 2928 | return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO::escapeString($criteria[0]), CRM_Core_DAO::escapeString($criteria[1]))); |
2929 | } | |
c490a46a | 2930 | else { |
518fa0ee SL |
2931 | // not yet implemented (tests required to implement) |
2932 | return NULL; | |
06f48f96 | 2933 | } |
faf8c53b | 2934 | break; |
2935 | ||
2936 | // n-ary operators | |
2937 | case 'IN': | |
2938 | case 'NOT IN': | |
2939 | if (empty($criteria)) { | |
395d8dc6 | 2940 | throw new Exception("invalid criteria for $operator"); |
faf8c53b | 2941 | } |
be2fb01f | 2942 | $escapedCriteria = array_map([ |
faf8c53b | 2943 | 'CRM_Core_DAO', |
795492f3 | 2944 | 'escapeString', |
be2fb01f | 2945 | ], $criteria); |
c490a46a | 2946 | if (!$returnSanitisedArray) { |
78c0bfc0 | 2947 | return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria))); |
2948 | } | |
2949 | return $escapedCriteria; | |
faf8c53b | 2950 | |
2951 | // binary operators | |
6a488035 | 2952 | |
faf8c53b | 2953 | default: |
c490a46a | 2954 | if (!$returnSanitisedArray) { |
353ffa53 | 2955 | return (sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO::escapeString($criteria))); |
78c0bfc0 | 2956 | } |
c490a46a | 2957 | else { |
518fa0ee SL |
2958 | // not yet implemented (tests required to implement) |
2959 | return NULL; | |
06f48f96 | 2960 | } |
faf8c53b | 2961 | } |
2962 | } | |
2963 | } | |
2964 | } | |
6842bb53 | 2965 | |
e4176358 CW |
2966 | /** |
2967 | * @see http://issues.civicrm.org/jira/browse/CRM-9150 | |
2968 | * support for other syntaxes is discussed in ticket but being put off for now | |
9d2afe25 | 2969 | * @return string[] |
e4176358 CW |
2970 | */ |
2971 | public static function acceptedSQLOperators() { | |
be2fb01f | 2972 | return [ |
353ffa53 TO |
2973 | '=', |
2974 | '<=', | |
2975 | '>=', | |
2976 | '>', | |
2977 | '<', | |
2978 | 'LIKE', | |
2979 | "<>", | |
2980 | "!=", | |
2981 | "NOT LIKE", | |
2982 | 'IN', | |
2983 | 'NOT IN', | |
2984 | 'BETWEEN', | |
2985 | 'NOT BETWEEN', | |
2986 | 'IS NOT NULL', | |
795492f3 | 2987 | 'IS NULL', |
be2fb01f | 2988 | ]; |
e4176358 CW |
2989 | } |
2990 | ||
6842bb53 DL |
2991 | /** |
2992 | * SQL has a limit of 64 characters on various names: | |
2993 | * table name, trigger name, column name ... | |
2994 | * | |
2995 | * For custom groups and fields we generated names from user entered input | |
2996 | * which can be longer than this length, this function helps with creating | |
2997 | * strings that meet various criteria. | |
2998 | * | |
6a0b768e TO |
2999 | * @param string $string |
3000 | * The string to be shortened. | |
3001 | * @param int $length | |
3002 | * The max length of the string. | |
9a1b1948 EM |
3003 | * |
3004 | * @param bool $makeRandom | |
3005 | * | |
3006 | * @return string | |
6842bb53 DL |
3007 | */ |
3008 | public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) { | |
3009 | // early return for strings that meet the requirements | |
3010 | if (strlen($string) <= $length) { | |
3011 | return $string; | |
3012 | } | |
3013 | ||
3014 | // easy return for calls that dont need a randomized uniq string | |
c490a46a | 3015 | if (!$makeRandom) { |
6842bb53 DL |
3016 | return substr($string, 0, $length); |
3017 | } | |
3018 | ||
3019 | // the string is longer than the length and we need a uniq string | |
b44e3f84 | 3020 | // for the same tablename we need the same uniq string every time |
6842bb53 | 3021 | // hence we use md5 on the string, which is not random |
a8dd306e DL |
3022 | // we'll append 8 characters to the end of the tableName |
3023 | $md5string = substr(md5($string), 0, 8); | |
3024 | return substr($string, 0, $length - 8) . "_{$md5string}"; | |
6842bb53 DL |
3025 | } |
3026 | ||
a0ee3941 | 3027 | /** |
33092c89 SB |
3028 | * https://issues.civicrm.org/jira/browse/CRM-17748 |
3029 | * Sets the internal options to be used on a query | |
3030 | * | |
3031 | * @param array $options | |
3032 | * | |
3033 | */ | |
6232119d | 3034 | public function setOptions($options) { |
33092c89 SB |
3035 | if (is_array($options)) { |
3036 | $this->_options = $options; | |
3037 | } | |
3038 | } | |
3039 | ||
3040 | /** | |
3041 | * https://issues.civicrm.org/jira/browse/CRM-17748 | |
3042 | * wrapper to pass internal DAO options down to DB_mysql/DB_Common level | |
3043 | * | |
3044 | * @param array $options | |
3045 | * | |
3046 | */ | |
3047 | protected function _setDBOptions($options) { | |
3048 | global $_DB_DATAOBJECT; | |
3049 | ||
3050 | if (is_array($options) && count($options)) { | |
3051 | $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5]; | |
3052 | foreach ($options as $option_name => $option_value) { | |
3053 | $conn->setOption($option_name, $option_value); | |
3054 | } | |
3055 | } | |
3056 | } | |
3057 | ||
6232119d | 3058 | /** |
d343069c | 3059 | * @deprecated |
c490a46a | 3060 | * @param array $params |
a0ee3941 | 3061 | */ |
353ffa53 TO |
3062 | public function setApiFilter(&$params) { |
3063 | } | |
6e1bb60c | 3064 | |
d343069c | 3065 | /** |
20e41014 | 3066 | * Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity |
d343069c | 3067 | * |
b53bcc5d | 3068 | * Return format is in the form of fieldname => clauses starting with an operator. e.g.: |
0b882a86 | 3069 | * ``` |
b53bcc5d CW |
3070 | * array( |
3071 | * 'location_type_id' => array('IS NOT NULL', 'IN (1,2,3)') | |
3072 | * ) | |
0b882a86 | 3073 | * ``` |
b53bcc5d CW |
3074 | * |
3075 | * Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values. | |
3076 | * | |
3077 | * @return array | |
d343069c | 3078 | */ |
20e41014 | 3079 | public function addSelectWhereClause() { |
be2fb01f | 3080 | $clauses = []; |
c6835264 CW |
3081 | $fields = $this->fields(); |
3082 | foreach ($fields as $fieldName => $field) { | |
3083 | // Clause for contact-related entities like Email, Relationship, etc. | |
56f5e9db EM |
3084 | if (strpos($field['name'], 'contact_id') === 0 && CRM_Utils_Array::value('FKClassName', $field) == 'CRM_Contact_DAO_Contact') { |
3085 | $contactClause = CRM_Utils_SQL::mergeSubquery('Contact'); | |
3086 | if (!empty($contactClause)) { | |
3087 | $clauses[$field['name']] = $contactClause; | |
3088 | } | |
0b80f0b4 | 3089 | } |
c6835264 | 3090 | // Clause for an entity_table/entity_id combo |
56f5e9db | 3091 | if ($field['name'] === 'entity_id' && isset($fields['entity_table'])) { |
be2fb01f | 3092 | $relatedClauses = []; |
c6835264 CW |
3093 | $relatedEntities = $this->buildOptions('entity_table', 'get'); |
3094 | foreach ((array) $relatedEntities as $table => $ent) { | |
fb1c6b2c | 3095 | if (!empty($ent)) { |
11ee29de | 3096 | $ent = CRM_Core_DAO_AllCoreTables::getEntityNameForTable($table); |
fb1c6b2c SL |
3097 | $subquery = CRM_Utils_SQL::mergeSubquery($ent); |
3098 | if ($subquery) { | |
3099 | $relatedClauses[] = "(entity_table = '$table' AND entity_id " . implode(' AND entity_id ', $subquery) . ")"; | |
3100 | } | |
3101 | else { | |
3102 | $relatedClauses[] = "(entity_table = '$table')"; | |
3103 | } | |
c6835264 CW |
3104 | } |
3105 | } | |
3106 | if ($relatedClauses) { | |
3107 | $clauses['id'] = 'IN (SELECT id FROM `' . $this->tableName() . '` WHERE (' . implode(') OR (', $relatedClauses) . '))'; | |
3108 | } | |
3109 | } | |
d343069c | 3110 | } |
032346cc CW |
3111 | CRM_Utils_Hook::selectWhereClause($this, $clauses); |
3112 | return $clauses; | |
d343069c CW |
3113 | } |
3114 | ||
6c051493 | 3115 | /** |
0b80f0b4 CW |
3116 | * This returns the final permissioned query string for this entity |
3117 | * | |
3118 | * With acls from related entities + additional clauses from hook_civicrm_selectWhereClause | |
3119 | * | |
6c051493 CW |
3120 | * @param string $tableAlias |
3121 | * @return array | |
3122 | */ | |
20e41014 | 3123 | public static function getSelectWhereClause($tableAlias = NULL) { |
6c051493 CW |
3124 | $bao = new static(); |
3125 | if ($tableAlias === NULL) { | |
3126 | $tableAlias = $bao->tableName(); | |
3127 | } | |
be2fb01f | 3128 | $clauses = []; |
20e41014 | 3129 | foreach ((array) $bao->addSelectWhereClause() as $field => $vals) { |
6c051493 CW |
3130 | $clauses[$field] = NULL; |
3131 | if ($vals) { | |
8db05db8 | 3132 | $clauses[$field] = "(`$tableAlias`.`$field` IS NULL OR (`$tableAlias`.`$field` " . implode(" AND `$tableAlias`.`$field` ", (array) $vals) . '))'; |
6c051493 CW |
3133 | } |
3134 | } | |
3135 | return $clauses; | |
3136 | } | |
3137 | ||
a00fe575 | 3138 | /** |
ee17d64d | 3139 | * ensure database name is 'safe', i.e. only contains word characters (includes underscores) |
9cef6066 | 3140 | * and dashes, and contains at least one [a-z] case insensitive. |
a00fe575 PN |
3141 | * |
3142 | * @param $database | |
a00fe575 PN |
3143 | * |
3144 | * @return bool | |
3145 | */ | |
ee17d64d | 3146 | public static function requireSafeDBName($database) { |
be2fb01f | 3147 | $matches = []; |
a00fe575 | 3148 | preg_match( |
ee17d64d | 3149 | "/^[\w\-]*[a-z]+[\w\-]*$/i", |
a00fe575 PN |
3150 | $database, |
3151 | $matches | |
3152 | ); | |
3153 | if (empty($matches)) { | |
a00fe575 PN |
3154 | return FALSE; |
3155 | } | |
a00fe575 PN |
3156 | return TRUE; |
3157 | } | |
3158 | ||
2a5c9b4d CW |
3159 | /** |
3160 | * Transform an array to a serialized string for database storage. | |
3161 | * | |
e97c66ff | 3162 | * @param array|null $value |
3163 | * @param int $serializationType | |
3164 | * @return string|null | |
3165 | * | |
dd3ec98b | 3166 | * @throws \Exception |
2a5c9b4d CW |
3167 | */ |
3168 | public static function serializeField($value, $serializationType) { | |
3169 | if ($value === NULL) { | |
3170 | return NULL; | |
3171 | } | |
3172 | switch ($serializationType) { | |
3173 | case self::SERIALIZE_SEPARATOR_BOOKEND: | |
be2fb01f | 3174 | return $value === [] ? '' : CRM_Utils_Array::implodePadded($value); |
2a5c9b4d CW |
3175 | |
3176 | case self::SERIALIZE_SEPARATOR_TRIMMED: | |
3177 | return is_array($value) ? implode(self::VALUE_SEPARATOR, $value) : $value; | |
3178 | ||
2a5c9b4d CW |
3179 | case self::SERIALIZE_JSON: |
3180 | return is_array($value) ? json_encode($value) : $value; | |
3181 | ||
3182 | case self::SERIALIZE_PHP: | |
3183 | return is_array($value) ? serialize($value) : $value; | |
dd3ec98b CW |
3184 | |
3185 | case self::SERIALIZE_COMMA: | |
3186 | return is_array($value) ? implode(',', $value) : $value; | |
3187 | ||
3188 | default: | |
3189 | throw new Exception('Unknown serialization method for field.'); | |
2a5c9b4d CW |
3190 | } |
3191 | } | |
3192 | ||
3193 | /** | |
3194 | * Transform a serialized string from the database into an array. | |
3195 | * | |
3196 | * @param string|null $value | |
3197 | * @param $serializationType | |
8cec96dc | 3198 | * |
2a5c9b4d | 3199 | * @return array|null |
8cec96dc | 3200 | * @throws CRM_Core_Exception |
2a5c9b4d CW |
3201 | */ |
3202 | public static function unSerializeField($value, $serializationType) { | |
3203 | if ($value === NULL) { | |
3204 | return NULL; | |
3205 | } | |
3206 | if ($value === '') { | |
be2fb01f | 3207 | return []; |
2a5c9b4d CW |
3208 | } |
3209 | switch ($serializationType) { | |
3210 | case self::SERIALIZE_SEPARATOR_BOOKEND: | |
3211 | return (array) CRM_Utils_Array::explodePadded($value); | |
3212 | ||
3213 | case self::SERIALIZE_SEPARATOR_TRIMMED: | |
3214 | return explode(self::VALUE_SEPARATOR, trim($value)); | |
3215 | ||
2a5c9b4d | 3216 | case self::SERIALIZE_JSON: |
be2fb01f | 3217 | return strlen($value) ? json_decode($value, TRUE) : []; |
2a5c9b4d CW |
3218 | |
3219 | case self::SERIALIZE_PHP: | |
f24846d5 | 3220 | return strlen($value) ? CRM_Utils_String::unserialize($value) : []; |
dd3ec98b CW |
3221 | |
3222 | case self::SERIALIZE_COMMA: | |
3223 | return explode(',', trim(str_replace(', ', '', $value))); | |
3224 | ||
3225 | default: | |
8cec96dc | 3226 | throw new CRM_Core_Exception('Unknown serialization method for field.'); |
2a5c9b4d CW |
3227 | } |
3228 | } | |
3229 | ||
1d6f94ab CW |
3230 | /** |
3231 | * @return array | |
3232 | */ | |
3233 | public static function getEntityRefFilters() { | |
3234 | return []; | |
3235 | } | |
3236 | ||
304dc580 | 3237 | /** |
3238 | * Get exportable fields with pseudoconstants rendered as an extra field. | |
3239 | * | |
3240 | * @param string $baoClass | |
3241 | * | |
3242 | * @return array | |
3243 | */ | |
3244 | public static function getExportableFieldsWithPseudoConstants($baoClass) { | |
3245 | if (method_exists($baoClass, 'exportableFields')) { | |
3246 | $fields = $baoClass::exportableFields(); | |
3247 | } | |
3248 | else { | |
3249 | $fields = $baoClass::export(); | |
3250 | } | |
3251 | CRM_Core_DAO::appendPseudoConstantsToFields($fields); | |
3252 | return $fields; | |
3253 | } | |
3254 | ||
10cac951 CW |
3255 | /** |
3256 | * Remove item from static cache during update/delete operations | |
3257 | */ | |
3258 | private function clearDbColumnValueCache() { | |
3259 | $daoName = get_class($this); | |
3260 | while (strpos($daoName, '_BAO_') !== FALSE) { | |
3261 | $daoName = get_parent_class($daoName); | |
3262 | } | |
3263 | if (isset($this->id)) { | |
3264 | unset(self::$_dbColumnValueCache[$daoName]['id'][$this->id]); | |
3265 | } | |
3266 | if (isset($this->name)) { | |
3267 | unset(self::$_dbColumnValueCache[$daoName]['name'][$this->name]); | |
3268 | } | |
3269 | } | |
3270 | ||
9d89b14d CW |
3271 | /** |
3272 | * Return a mapping from field-name to the corresponding key (as used in fields()). | |
3273 | * | |
3274 | * @return array | |
3275 | * Array(string $name => string $uniqueName). | |
3276 | */ | |
3277 | public static function fieldKeys() { | |
3278 | return array_flip(CRM_Utils_Array::collect('name', static::fields())); | |
3279 | } | |
3280 | ||
a7bd99ff CW |
3281 | /** |
3282 | * Returns system paths related to this entity (as defined in the xml schema) | |
3283 | * | |
3284 | * @return array | |
3285 | */ | |
3286 | public static function getEntityPaths() { | |
3287 | return static::$_paths ?? []; | |
3288 | } | |
3289 | ||
eba57f7d CW |
3290 | /** |
3291 | * When creating a record without a supplied name, | |
3292 | * create a unique, clean name derived from the label. | |
3293 | * | |
3294 | * Note: this function does nothing unless a unique index exists for "name" column. | |
ddba05d3 CW |
3295 | * |
3296 | * @var bool $isRequired | |
eba57f7d | 3297 | */ |
ddba05d3 | 3298 | private function makeNameFromLabel(bool $isRequired): void { |
eba57f7d CW |
3299 | $indexNameWith = NULL; |
3300 | // Look for a unique index which includes the "name" field | |
3301 | if (method_exists($this, 'indices')) { | |
3302 | foreach ($this->indices(FALSE) as $index) { | |
3303 | if (!empty($index['unique']) && in_array('name', $index['field'], TRUE)) { | |
3304 | $indexNameWith = $index['field']; | |
3305 | } | |
3306 | } | |
3307 | } | |
3308 | if (!$indexNameWith) { | |
3309 | // No unique index on "name", do nothing | |
3310 | return; | |
3311 | } | |
ddba05d3 CW |
3312 | $label = $this->label ?? $this->title ?? NULL; |
3313 | if (!$label && $label !== '0' && !$isRequired) { | |
3314 | // No label supplied and name not required, do nothing | |
3315 | return; | |
3316 | } | |
3317 | $maxLen = static::getSupportedFields()['name']['maxlength'] ?? 255; | |
3318 | // Strip unsafe characters and trim to max length (-3 characters leaves room for a unique suffix) | |
3319 | $name = CRM_Utils_String::munge($label, '_', $maxLen - 3); | |
eba57f7d CW |
3320 | |
3321 | // Find existing records with the same name | |
3322 | $sql = new CRM_Utils_SQL_Select($this::getTableName()); | |
3323 | $sql->select(['id', 'name']); | |
3324 | $sql->where('name LIKE @name', ['@name' => $name . '%']); | |
3325 | // Include all fields that are part of the index | |
3326 | foreach (array_diff($indexNameWith, ['name']) as $field) { | |
3327 | $sql->where("`$field` = @val", ['@val' => $this->$field]); | |
3328 | } | |
3329 | $query = $sql->toSQL(); | |
3330 | $existing = self::executeQuery($query)->fetchMap('id', 'name'); | |
3331 | $dupes = 0; | |
3332 | $suffix = ''; | |
ddba05d3 | 3333 | // Add unique suffix if existing records have the same name |
eba57f7d | 3334 | while (in_array($name . $suffix, $existing)) { |
ddba05d3 | 3335 | $suffix = '_' . ++$dupes; |
eba57f7d CW |
3336 | } |
3337 | $this->name = $name . $suffix; | |
3338 | } | |
3339 | ||
232624b1 | 3340 | } |