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.
44 public static function &getValues($blockName, $params) {
48 $BAOString = 'CRM_Core_BAO_' . $blockName;
49 $block = new $BAOString();
52 if (!isset($params['entity_table'])) {
53 $block->contact_id
= $params['contact_id'];
54 if (!$block->contact_id
) {
55 CRM_Core_Error
::fatal();
57 $blocks = self
::retrieveBlock($block, $blockName);
60 $blockIds = self
::getBlockIds($blockName, NULL, $params);
62 if (empty($blockIds)) {
67 foreach ($blockIds as $blockId) {
68 $block = new $BAOString();
69 $block->id
= $blockId['id'];
70 $getBlocks = self
::retrieveBlock($block, $blockName);
71 $blocks[$count++
] = array_pop($getBlocks);
79 * Given the list of params in the params array, fetch the object
80 * and store the values in the values array
82 * @param Object $block
83 * Typically a Phone|Email|IM|OpenID object.
84 * @param string $blockName
85 * Name of the above object.
88 * Array of $block objects.
90 public static function retrieveBlock(&$block, $blockName) {
91 // we first get the primary location due to the order by clause
92 $block->orderBy('is_primary desc, id');
97 while ($block->fetch()) {
98 CRM_Core_DAO
::storeValues($block, $blocks[$count]);
99 //unset is_primary after first block. Due to some bug in earlier version
100 //there might be more than one primary blocks, hence unset is_primary other than first
102 unset($blocks[$count]['is_primary']);
111 * Check if the current block object has any valid data.
113 * @param array $blockFields
114 * Array of fields that are of interest for this object.
115 * @param array $params
116 * Associated array of submitted fields.
119 * true if the block has data, otherwise false
121 public static function dataExists($blockFields, &$params) {
122 foreach ($blockFields as $field) {
123 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value($field, $params))) {
131 * Check if the current block exits.
133 * @param string $blockName
135 * @param array $params
136 * Associated array of submitted fields.
139 * true if the block exits, otherwise false
141 public static function blockExists($blockName, &$params) {
142 // return if no data present
143 if (empty($params[$blockName]) ||
!is_array($params[$blockName])) {
151 * Get all block ids for a contact.
153 * @param string $blockName
155 * @param int $contactId
158 * @param null $entityElements
159 * @param bool $updateBlankLocInfo
162 * formatted array of block ids
165 public static function getBlockIds($blockName, $contactId = NULL, $entityElements = NULL, $updateBlankLocInfo = FALSE) {
168 $name = ucfirst($blockName);
169 if ($blockName == 'im') {
172 elseif ($blockName == 'openid') {
176 $baoString = 'CRM_Core_BAO_' . $name;
178 //@todo a cleverer way to do this would be to use the same fn name on each
179 // BAO rather than constructing the fn
180 // it would also be easier to grep for
181 // e.g $bao = new $baoString;
182 // $bao->getAllBlocks()
183 $baoFunction = 'all' . $name . 's';
184 $allBlocks = $baoString::$baoFunction($contactId, $updateBlankLocInfo);
186 elseif (!empty($entityElements) && $blockName != 'openid') {
187 $baoFunction = 'allEntity' . $name . 's';
188 $allBlocks = $baoString::$baoFunction($entityElements);
195 * Takes an associative array and creates a block.
197 * @param string $blockName
199 * @param array $params
200 * (reference ) an assoc array of name/value pairs.
201 * @param null $entity
202 * @param int $contactId
205 * CRM_Core_BAO_Block object on success, null otherwise
207 public static function create($blockName, &$params, $entity = NULL, $contactId = NULL) {
208 if (!self
::blockExists($blockName, $params)) {
212 $name = ucfirst($blockName);
213 $isPrimary = $isBilling = TRUE;
214 $entityElements = $blocks = [];
215 $resetPrimaryId = NULL;
220 'entity_table' => $params['entity_table'],
221 'entity_id' => $params['entity_id'],
225 $contactId = $params['contact_id'];
228 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
229 $isIdSet = CRM_Utils_Array
::value('isIdSet', $params[$blockName], FALSE);
231 //get existing block ids.
232 $blockIds = self
::getBlockIds($blockName, $contactId, $entityElements);
233 foreach ($params[$blockName] as $count => $value) {
234 $blockId = CRM_Utils_Array
::value('id', $value);
236 if (is_array($blockIds) && array_key_exists($blockId, $blockIds)) {
237 unset($blockIds[$blockId]);
243 //lets allow to update primary w/ more cleanly.
244 if (!$resetPrimaryId && !empty($value['is_primary'])) {
246 if (is_array($blockIds)) {
247 foreach ($blockIds as $blockId => $blockValue) {
248 if (!empty($blockValue['is_primary'])) {
249 $resetPrimaryId = $blockId;
254 if ($resetPrimaryId) {
255 $baoString = 'CRM_Core_BAO_' . $blockName;
256 $block = new $baoString();
258 $block->selectAdd("id, is_primary");
259 $block->id
= $resetPrimaryId;
260 if ($block->find(TRUE)) {
261 $block->is_primary
= FALSE;
268 foreach ($params[$blockName] as $count => $value) {
269 if (!is_array($value)) {
272 // if in some cases (eg. email used in Online Conribution Page, Profiles, etc.) id is not set
273 // lets try to add using the previous method to avoid any false creation of existing data.
274 foreach ($blockIds as $blockId => $blockValue) {
275 if (empty($value['id']) && $blockValue['locationTypeId'] == CRM_Utils_Array
::value('location_type_id', $value) && !$isIdSet) {
277 if ($blockName == 'phone') {
278 $phoneTypeBlockValue = CRM_Utils_Array
::value('phoneTypeId', $blockValue);
279 if ($phoneTypeBlockValue == CRM_Utils_Array
::value('phone_type_id', $value)) {
283 elseif ($blockName == 'im') {
284 $providerBlockValue = CRM_Utils_Array
::value('providerId', $blockValue);
285 if (!empty($value['provider_id']) && $providerBlockValue == $value['provider_id']) {
293 $value['id'] = $blockValue['id'];
294 if (!$primaryId && !empty($blockValue['is_primary'])) {
295 $value['is_primary'] = $blockValue['is_primary'];
301 $dataExists = self
::dataExists(self
::$requiredBlockFields[$blockName], $value);
302 // Note there could be cases when block info already exist ($value[id] is set) for a contact/entity
303 // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
304 // $updateBlankLocInfo will help take appropriate decision. CRM-5969
305 if (!empty($value['id']) && !$dataExists && $updateBlankLocInfo) {
306 //delete the existing record
307 self
::blockDelete($blockName, ['id' => $value['id']]);
310 elseif (!$dataExists) {
314 'contact_id' => $contactId,
315 'location_type_id' => $value['location_type_id'] ??
NULL,
318 $contactFields['is_primary'] = 0;
319 if ($isPrimary && !empty($value['is_primary'])) {
320 $contactFields['is_primary'] = $value['is_primary'];
324 $contactFields['is_billing'] = 0;
325 if ($isBilling && !empty($value['is_billing'])) {
326 $contactFields['is_billing'] = $value['is_billing'];
330 $blockFields = array_merge($value, $contactFields);
331 if ($name === 'Email') {
332 // @todo ideally all would call the api which is our main tested function,
333 // and towards that call the create rather than add which is preferred by the
334 // api. In order to be careful with change only email is swapped over here because it
335 // is specifically tested in testImportParserWithUpdateWithContactID
336 // and the primary handling is otherwise bypassed on importing an email update.
337 $blocks[] = CRM_Core_BAO_Email
::create($blockFields);
340 $baoString = 'CRM_Core_BAO_' . $name;
341 $blocks[] = $baoString::add($blockFields);
351 * @param string $blockName
356 public static function blockDelete($blockName, $params) {
357 $name = ucfirst($blockName);
358 if ($blockName == 'im') {
361 elseif ($blockName == 'openid') {
365 $baoString = 'CRM_Core_DAO_' . $name;
366 $block = new $baoString();
368 $block->copyValues($params);
370 // CRM-11006 add call to pre and post hook for delete action
371 CRM_Utils_Hook
::pre('delete', $name, $block->id
, CRM_Core_DAO
::$_nullArray);
373 CRM_Utils_Hook
::post('delete', $name, $block->id
, $block);
377 * Handling for is_primary.
378 * $params is_primary could be
379 * # 1 - find other entries with is_primary = 1 & reset them to 0
380 * # 0 - make sure at least one entry is set to 1
381 * - if no other entry is 1 change to 1
382 * - if one other entry exists change that to 1
383 * - if more than one other entry exists change first one to 1
384 * @fixme - perhaps should choose by location_type
385 * # empty - same as 0 as once we have checked first step
386 * we know if it should be 1 or 0
388 * if $params['id'] is set $params['contact_id'] may need to be retrieved
390 * @param array $params
393 * @throws API_Exception
395 public static function handlePrimary(&$params, $class) {
396 $table = CRM_Core_DAO_AllCoreTables
::getTableForClass($class);
398 throw new API_Exception("Failed to locate table for class [$class]");
401 // contact_id in params might be empty or the string 'null' so cast to integer
402 $contactId = (int) CRM_Utils_Array
::value('contact_id', $params);
403 // If id is set & we haven't been passed a contact_id, retrieve it
404 if (!empty($params['id']) && !isset($params['contact_id'])) {
405 $entity = new $class();
406 $entity->id
= $params['id'];
408 $contactId = $entity->contact_id
;
410 // If entity is not associated with contact, concept of is_primary not relevant
415 // if params is_primary then set all others to not be primary & exit out
417 if (!empty($params['is_primary'])) {
418 $sql = "UPDATE $table SET is_primary = 0 WHERE contact_id = %1";
419 $sqlParams = [1 => [$contactId, 'Integer']];
420 // we don't want to create unnecessary entries in the log_ tables so exclude the one we are working on
421 if (!empty($params['id'])) {
422 $sql .= " AND id <> %2";
423 $sqlParams[2] = [$params['id'], 'Integer'];
425 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
429 //Check what other emails exist for the contact
430 $existingEntities = new $class();
431 $existingEntities->contact_id
= $contactId;
432 $existingEntities->orderBy('is_primary DESC');
433 if (!$existingEntities->find(TRUE) ||
(!empty($params['id']) && $existingEntities->id
== $params['id'])) {
434 // ie. if no others is set to be primary then this has to be primary set to 1 so change
435 $params['is_primary'] = 1;
440 * If the only existing email is the one we are editing then we must set
444 if ($existingEntities->N
== 1 && $existingEntities->id
== CRM_Utils_Array
::value('id', $params)) {
445 $params['is_primary'] = 1;
449 if ($existingEntities->is_primary
== 1) {
452 // so at this point we are only dealing with ones explicity setting is_primary to 0
453 // since we have reverse sorted by email we can either set the first one to
454 // primary or return if is already is
455 $existingEntities->is_primary
= 1;
456 $existingEntities->save();
461 * Sort location array so primary element is first.
463 * @param array $locations
465 public static function sortPrimaryFirst(&$locations) {
466 uasort($locations, 'self::primaryComparison');
470 * compare 2 locations to see which should go first based on is_primary
471 * (sort function for sortPrimaryFirst)
472 * @param array $location1
473 * @param array $location2
476 public static function primaryComparison($location1, $location2) {
477 $l1 = CRM_Utils_Array
::value('is_primary', $location1);
478 $l2 = CRM_Utils_Array
::value('is_primary', $location2);
482 return ($l1 < $l2) ?
-1 : 1;