3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 * Add static functions to include some common functionality used across location sub object BAO classes.
19 class CRM_Core_BAO_Block
{
22 * Fields that are required for a valid block.
25 public static $requiredBlockFields = [
29 'openid' => ['openid'],
33 * Given the list of params in the params array, fetch the object
34 * and store the values in the values array
36 * @param string $blockName
37 * Name of the above object.
38 * @param array $params
39 * Input parameters to find object.
42 * Array of $block objects.
43 * @throws CRM_Core_Exception
45 public static function &getValues($blockName, $params) {
49 $BAOString = 'CRM_Core_BAO_' . $blockName;
50 $block = new $BAOString();
53 if (!isset($params['entity_table'])) {
54 $block->contact_id
= $params['contact_id'];
55 if (!$block->contact_id
) {
56 throw new CRM_Core_Exception('Invalid Contact ID parameter passed');
58 $blocks = self
::retrieveBlock($block, $blockName);
61 $blockIds = self
::getBlockIds($blockName, NULL, $params);
63 if (empty($blockIds)) {
68 foreach ($blockIds as $blockId) {
69 $block = new $BAOString();
70 $block->id
= $blockId['id'];
71 $getBlocks = self
::retrieveBlock($block, $blockName);
72 $blocks[$count++
] = array_pop($getBlocks);
80 * Given the list of params in the params array, fetch the object
81 * and store the values in the values array
83 * @param Object $block
84 * Typically a Phone|Email|IM|OpenID object.
85 * @param string $blockName
86 * Name of the above object.
89 * Array of $block objects.
91 public static function retrieveBlock(&$block, $blockName) {
92 // we first get the primary location due to the order by clause
93 $block->orderBy('is_primary desc, id');
98 while ($block->fetch()) {
99 CRM_Core_DAO
::storeValues($block, $blocks[$count]);
100 //unset is_primary after first block. Due to some bug in earlier version
101 //there might be more than one primary blocks, hence unset is_primary other than first
103 unset($blocks[$count]['is_primary']);
112 * Check if the current block object has any valid data.
114 * @param array $blockFields
115 * Array of fields that are of interest for this object.
116 * @param array $params
117 * Associated array of submitted fields.
120 * true if the block has data, otherwise false
122 public static function dataExists($blockFields, &$params) {
123 foreach ($blockFields as $field) {
124 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value($field, $params))) {
132 * Check if the current block exits.
134 * @param string $blockName
136 * @param array $params
137 * Associated array of submitted fields.
140 * true if the block exits, otherwise false
142 public static function blockExists($blockName, &$params) {
143 // return if no data present
144 if (empty($params[$blockName]) ||
!is_array($params[$blockName])) {
152 * Get all block ids for a contact.
154 * @param string $blockName
156 * @param int $contactId
159 * @param null $entityElements
160 * @param bool $updateBlankLocInfo
163 * formatted array of block ids
166 public static function getBlockIds($blockName, $contactId = NULL, $entityElements = NULL, $updateBlankLocInfo = FALSE) {
169 $name = ucfirst($blockName);
170 if ($blockName == 'im') {
173 elseif ($blockName == 'openid') {
177 $baoString = 'CRM_Core_BAO_' . $name;
179 //@todo a cleverer way to do this would be to use the same fn name on each
180 // BAO rather than constructing the fn
181 // it would also be easier to grep for
182 // e.g $bao = new $baoString;
183 // $bao->getAllBlocks()
184 $baoFunction = 'all' . $name . 's';
185 $allBlocks = $baoString::$baoFunction($contactId, $updateBlankLocInfo);
187 elseif (!empty($entityElements) && $blockName != 'openid') {
188 $baoFunction = 'allEntity' . $name . 's';
189 $allBlocks = $baoString::$baoFunction($entityElements);
196 * Takes an associative array and creates a block.
198 * @param string $blockName
200 * @param array $params
201 * (reference ) an assoc array of name/value pairs.
202 * @param null $entity
203 * @param int $contactId
206 * CRM_Core_BAO_Block object on success, null otherwise
208 public static function create($blockName, &$params, $entity = NULL, $contactId = NULL) {
209 if (!self
::blockExists($blockName, $params)) {
213 $name = ucfirst($blockName);
214 $isPrimary = $isBilling = TRUE;
215 $entityElements = $blocks = [];
216 $resetPrimaryId = NULL;
221 'entity_table' => $params['entity_table'],
222 'entity_id' => $params['entity_id'],
226 $contactId = $params['contact_id'];
229 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
230 $isIdSet = CRM_Utils_Array
::value('isIdSet', $params[$blockName], FALSE);
232 //get existing block ids.
233 $blockIds = self
::getBlockIds($blockName, $contactId, $entityElements);
234 foreach ($params[$blockName] as $count => $value) {
235 $blockId = $value['id'] ??
NULL;
237 if (is_array($blockIds) && array_key_exists($blockId, $blockIds)) {
238 unset($blockIds[$blockId]);
244 //lets allow to update primary w/ more cleanly.
245 if (!$resetPrimaryId && !empty($value['is_primary'])) {
247 if (is_array($blockIds)) {
248 foreach ($blockIds as $blockId => $blockValue) {
249 if (!empty($blockValue['is_primary'])) {
250 $resetPrimaryId = $blockId;
255 if ($resetPrimaryId) {
256 $baoString = 'CRM_Core_BAO_' . $blockName;
257 $block = new $baoString();
259 $block->selectAdd("id, is_primary");
260 $block->id
= $resetPrimaryId;
261 if ($block->find(TRUE)) {
262 $block->is_primary
= FALSE;
269 foreach ($params[$blockName] as $count => $value) {
270 if (!is_array($value)) {
273 // if in some cases (eg. email used in Online Conribution Page, Profiles, etc.) id is not set
274 // lets try to add using the previous method to avoid any false creation of existing data.
275 foreach ($blockIds as $blockId => $blockValue) {
276 if (empty($value['id']) && $blockValue['locationTypeId'] == CRM_Utils_Array
::value('location_type_id', $value) && !$isIdSet) {
278 if ($blockName == 'phone') {
279 $phoneTypeBlockValue = $blockValue['phoneTypeId'] ??
NULL;
280 if ($phoneTypeBlockValue == CRM_Utils_Array
::value('phone_type_id', $value)) {
284 elseif ($blockName == 'im') {
285 $providerBlockValue = $blockValue['providerId'] ??
NULL;
286 if (!empty($value['provider_id']) && $providerBlockValue == $value['provider_id']) {
294 $value['id'] = $blockValue['id'];
295 if (!$primaryId && !empty($blockValue['is_primary'])) {
296 $value['is_primary'] = $blockValue['is_primary'];
302 $dataExists = self
::dataExists(self
::$requiredBlockFields[$blockName], $value);
303 // Note there could be cases when block info already exist ($value[id] is set) for a contact/entity
304 // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
305 // $updateBlankLocInfo will help take appropriate decision. CRM-5969
306 if (!empty($value['id']) && !$dataExists && $updateBlankLocInfo) {
307 //delete the existing record
308 self
::blockDelete($blockName, ['id' => $value['id']]);
311 elseif (!$dataExists) {
315 'contact_id' => $contactId,
316 'location_type_id' => $value['location_type_id'] ??
NULL,
319 $contactFields['is_primary'] = 0;
320 if ($isPrimary && !empty($value['is_primary'])) {
321 $contactFields['is_primary'] = $value['is_primary'];
325 $contactFields['is_billing'] = 0;
326 if ($isBilling && !empty($value['is_billing'])) {
327 $contactFields['is_billing'] = $value['is_billing'];
331 $blockFields = array_merge($value, $contactFields);
332 if ($name === 'Email') {
333 // @todo ideally all would call the api which is our main tested function,
334 // and towards that call the create rather than add which is preferred by the
335 // api. In order to be careful with change only email is swapped over here because it
336 // is specifically tested in testImportParserWithUpdateWithContactID
337 // and the primary handling is otherwise bypassed on importing an email update.
338 $blocks[] = CRM_Core_BAO_Email
::create($blockFields);
341 $baoString = 'CRM_Core_BAO_' . $name;
342 $blocks[] = $baoString::add($blockFields);
352 * @param string $blockName
357 public static function blockDelete($blockName, $params) {
358 $name = ucfirst($blockName);
359 if ($blockName == 'im') {
362 elseif ($blockName == 'openid') {
366 $baoString = 'CRM_Core_DAO_' . $name;
367 $block = new $baoString();
369 $block->copyValues($params);
371 // CRM-11006 add call to pre and post hook for delete action
372 CRM_Utils_Hook
::pre('delete', $name, $block->id
, CRM_Core_DAO
::$_nullArray);
374 CRM_Utils_Hook
::post('delete', $name, $block->id
, $block);
378 * Handling for is_primary.
379 * $params is_primary could be
380 * # 1 - find other entries with is_primary = 1 & reset them to 0
381 * # 0 - make sure at least one entry is set to 1
382 * - if no other entry is 1 change to 1
383 * - if one other entry exists change that to 1
384 * - if more than one other entry exists change first one to 1
385 * @fixme - perhaps should choose by location_type
386 * # empty - same as 0 as once we have checked first step
387 * we know if it should be 1 or 0
389 * if $params['id'] is set $params['contact_id'] may need to be retrieved
391 * @param array $params
394 * @throws API_Exception
396 public static function handlePrimary(&$params, $class) {
397 $table = CRM_Core_DAO_AllCoreTables
::getTableForClass($class);
399 throw new API_Exception("Failed to locate table for class [$class]");
402 // contact_id in params might be empty or the string 'null' so cast to integer
403 $contactId = (int) ($params['contact_id'] ??
0);
404 // If id is set & we haven't been passed a contact_id, retrieve it
405 if (!empty($params['id']) && !isset($params['contact_id'])) {
406 $entity = new $class();
407 $entity->id
= $params['id'];
409 $contactId = $entity->contact_id
;
411 // If entity is not associated with contact, concept of is_primary not relevant
416 // if params is_primary then set all others to not be primary & exit out
418 if (!empty($params['is_primary'])) {
419 $sql = "UPDATE $table SET is_primary = 0 WHERE contact_id = %1";
420 $sqlParams = [1 => [$contactId, 'Integer']];
421 // we don't want to create unnecessary entries in the log_ tables so exclude the one we are working on
422 if (!empty($params['id'])) {
423 $sql .= " AND id <> %2";
424 $sqlParams[2] = [$params['id'], 'Integer'];
426 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
430 //Check what other emails exist for the contact
431 $existingEntities = new $class();
432 $existingEntities->contact_id
= $contactId;
433 $existingEntities->orderBy('is_primary DESC');
434 if (!$existingEntities->find(TRUE) ||
(!empty($params['id']) && $existingEntities->id
== $params['id'])) {
435 // ie. if no others is set to be primary then this has to be primary set to 1 so change
436 $params['is_primary'] = 1;
441 * If the only existing email is the one we are editing then we must set
445 if ($existingEntities->N
== 1 && $existingEntities->id
== CRM_Utils_Array
::value('id', $params)) {
446 $params['is_primary'] = 1;
450 if ($existingEntities->is_primary
== 1) {
453 // so at this point we are only dealing with ones explicity setting is_primary to 0
454 // since we have reverse sorted by email we can either set the first one to
455 // primary or return if is already is
456 $existingEntities->is_primary
= 1;
457 $existingEntities->save();
462 * Sort location array so primary element is first.
464 * @param array $locations
466 public static function sortPrimaryFirst(&$locations) {
467 uasort($locations, 'self::primaryComparison');
471 * compare 2 locations to see which should go first based on is_primary
472 * (sort function for sortPrimaryFirst)
473 * @param array $location1
474 * @param array $location2
477 public static function primaryComparison($location1, $location2) {
478 $l1 = $location1['is_primary'] ??
NULL;
479 $l2 = $location2['is_primary'] ??
NULL;
483 return ($l1 < $l2) ?
-1 : 1;