[ref] Move copyCustomFields function from Event to Core_DAO for re-usability

[eileenmcnaughton]

Overview

Minor refactor - move function per #13470

Before

Less readable

After

More readable

Technical Details

Note this is JUST a file move to keep it reviewable - I think the function should not be static & some genericisation should happen

Comments

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[yashodha]

@eileenmcnaughton this would break https://github.com/civicrm/civicrm-core/blob/master/CRM/Event/BAO/Event.php#L989 though now that the function has been moved.

[eileenmcnaughton]

@yashodha - yeah - I guess it makes sense to make non-static - I just did that

But I realise the copy custom fields shouldn't be needed as it's also in generic. I think what happened is it got fixed in event first in an adhoc way
eileenmcnaughton@6350097

and then fixed generically in copyGeneric but we still have this adhoc stuff hanging around cos it wasn't done right the first time & now we have to clean up.

However the attempt was in 2016 & we have been raising the bar - I don't think that PR would have been accepted today without unit tests - #9407

[eileenmcnaughton]

@yashodha I added a second fix that brings back the genericness - hmm just checking it actually

OK that worked - it looks like with that PR merged then we actually only need to do this

--- a/CRM/Core/DAO.php
+++ b/CRM/Core/DAO.php
@@ -1670,9 +1670,7 @@ FROM civicrm_domain
}
}
$newObject->save();

•  if (!empty($newData['custom'])) {
  

•    CRM_Core_BAO_CustomValueTable::store($newData['custom'], $newObject::getTableName(), $newObject->id);
  

•  }
  

•  $newObject->copyCustomFields($object->id, $newObject->id);
   CRM_Utils_Hook::post('create', CRM_Core_DAO_AllCoreTables::getBriefName($daoName), $newObject->id, $newObject);
  

  }

To make the custom fields work - I used the test from #13470 but without the tag handling as that would need revisiting -so the test looks like

 /**
   * Testing Activity Generation through Entity Recursion with Custom Data and Tags.
   */
  public function testRecurringEntityGenerationWithCustomDataAndTags() {

    // Create custom group and field
    $customGroup = $this->customGroupCreate([
      'extends' => 'Activity',
    ]);
    $customField = $this->customFieldCreate([
        'custom_group_id' => $customGroup['id'],
        'default_value' => '',
      ]
    );

    // Create activity Tag
    $tag = $this->tagCreate([
      'used_for' => 'Activities',
    ]);

    // Create original activity
    $customFieldValue = 'Custom Value';
    $activityDateTime = date('YmdHis');
    $activityId = $this->activityCreate([
      'activity_date_time' => $activityDateTime,
      'custom_' . $customField['id'] => $customFieldValue,
    ]);

    $activityId = $activityId['id'];

    // Assign tag to a activity.
    $this->callAPISuccess('EntityTag', 'create', [
      'entity_table' => 'civicrm_activity',
      'entity_id' => $activityId,
      'tag_id' => $tag['id'],
    ]);

    // Create recurring activities.
    $recursion = new CRM_Core_BAO_RecurringEntity();
    $recursion->entity_id = $activityId;
    $recursion->entity_table = 'civicrm_activity';
    $recursion->dateColumns = ['activity_date_time'];
    $recursion->schedule = [
      'entity_value' => $activityId,
      'start_action_date' => $activityDateTime,
      'entity_status' => 'fourth saturday',
      'repetition_frequency_unit' => 'month',
      'repetition_frequency_interval' => 3,
      'start_action_offset' => 3,
      'used_for' => 'activity',
    ];

    $generatedEntities = $recursion->generate();
    $generatedActivities = $generatedEntities['civicrm_activity'];

    $this->assertEquals(3, count($generatedActivities), "Check if number of iterations are 3");

    foreach ($generatedActivities as $generatedActivityId) {

      /* Validate tag in recurring activity
      // @todo - refer https://github.com/civicrm/civicrm-core/pull/13470
      $this->callAPISuccess('EntityTag', 'getsingle', [
        'entity_table' => 'civicrm_activity',
        'entity_id' => $generatedActivityId,
      ]);
      */

      // Validate custom data in recurring activity
      $activity = $this->callAPISuccess('activity', 'getsingle', [
        'return' => [
          'custom_' . $customField['id'],
        ],
        'id' => $generatedActivityId,
      ]);

      $this->assertEquals($customFieldValue, $activity['custom_' . $customField['id']], 'Custom field value should be ' . $customFieldValue);

    }
  }

[mattwire]

Merging as test to follow in subsequent PR