Merge pull request #21855 from eileenmcnaughton/part

Add test for selvsvctransfer, remove use of `$contact` from template
civicrm · Oct 29, 2021 · 88d97cc · 88d97cc
2 parents a51a14d + 6c43827
commit 88d97cc
Show file tree

Hide file tree

Showing 11 changed files with 3,883 additions and 3,792 deletions.
diff --git a/CRM/Contact/DAO/RelationshipCache.php b/CRM/Contact/DAO/RelationshipCache.php
@@ -386,7 +386,7 @@ public static function &fields() {
           'title' => ts('Case ID'),
           'description' => ts('FK to civicrm_case'),
           'where' => 'civicrm_relationship_cache.case_id',
-          'default' => 'NULL',
+          'default' => NULL,
           'table_name' => 'civicrm_relationship_cache',
           'entity' => 'RelationshipCache',
           'bao' => 'CRM_Contact_BAO_RelationshipCache',

diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php
@@ -1406,12 +1406,18 @@ public static function sendTransitionParticipantMail(
     $participantValues,
     $eventDetails,
     $contactDetails,
-    &$domainValues,
+    $domainValues,
     $mailType
   ) {
     //send emails.
     $mailSent = FALSE;
 
+    if (!$contactDetails) {
+      $contactDetails = civicrm_api3('Contact', 'getsingle', [
+        'id' => $participantValues['contact_id'],
+        'return' => ['email', 'display_name'],
+      ]);
+    }
     //don't send confirmation mail to additional
     //since only primary able to confirm registration.
     if (!empty($participantValues['registered_by_id']) &&

diff --git a/CRM/Event/Form/SelfSvcTransfer.php b/CRM/Event/Form/SelfSvcTransfer.php
@@ -458,23 +458,13 @@ public function sendCancellation() {
     //get the location info
     $locParams = ['entity_id' => $this->_event_id, 'entity_table' => 'civicrm_event'];
     $eventDetails[$this->_event_id]['location'] = CRM_Core_BAO_Location::getValues($locParams, TRUE);
-    //get contact details
-    $contactIds[$this->_from_contact_id] = $this->_from_contact_id;
-    list($currentContactDetails) = CRM_Utils_Token::getTokenDetails($contactIds, NULL,
-      FALSE, FALSE, NULL, [],
-      'CRM_Event_BAO_Participant'
-    );
-    foreach ($currentContactDetails as $contactId => $contactValues) {
-      $contactDetails[$this->_from_contact_id] = $contactValues;
-    }
     //send a 'cancelled' email to user, and cc the event's cc_confirm email
-    $mail = CRM_Event_BAO_Participant::sendTransitionParticipantMail($this->_from_participant_id,
+    CRM_Event_BAO_Participant::sendTransitionParticipantMail($this->_from_participant_id,
       $participantDetails[$this->_from_participant_id],
       $eventDetails[$this->_event_id],
-      $contactDetails[$this->_from_contact_id],
+      NULL,
       $domainValues,
-      "Transferred",
-      ""
+      'Transferred'
     );
     $statusMsg = ts('Event registration information for %1 has been updated.', [1 => $this->_contact_name]);
     $statusMsg .= ' ' . ts('A cancellation email has been sent to %1.', [1 => $this->_contact_email]);

diff --git a/CRM/Event/WorkflowMessage/ParticipantTransferred.php b/CRM/Event/WorkflowMessage/ParticipantTransferred.php
@@ -0,0 +1,25 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+use Civi\WorkflowMessage\GenericWorkflowMessage;
+
+/**
+ * Notification that a registration has been transferred to a different person.
+ *
+ * @support template-only
+ *
+ * @see CRM_Event_BAO_Participant::sendTransitionParticipantMail
+ */
+class CRM_Event_WorkflowMessage_ParticipantTransferred extends GenericWorkflowMessage {
+
+  public const WORKFLOW = 'participant_transferred';
+
+}
diff --git a/CRM/Upgrade/Incremental/MessageTemplates.php b/CRM/Upgrade/Incremental/MessageTemplates.php
@@ -277,6 +277,15 @@ protected function getTemplateUpdates() {
           ['name' => 'pledge_reminder', 'type' => 'html'],
         ],
       ],
+      [
+        'version' => '5.44.alpha1',
+        'upgrade_descriptor' => ts('Use domain and contact tokens instead of smarty values'),
+        'label' => ts('Pledge Transferred'),
+        'templates' => [
+          ['name' => 'participant_transferred', 'type' => 'text'],
+          ['name' => 'participant_transferred', 'type' => 'html'],
+        ],
+      ],
     ];
   }
 

diff --git a/install/langs.php b/install/langs.php
@@ -48,4 +48,4 @@
   'tr_TR' => 'Turkish',
   'uk_UA' => 'Ukrainian',
   'vi_VN' => 'Vietnamese',
-);
+);
diff --git a/sql/civicrm_generated.mysql b/sql/civicrm_generated.mysql
diff --git a/tests/phpunit/CRM/Event/Form/SelfSvcTransferTest.php b/tests/phpunit/CRM/Event/Form/SelfSvcTransferTest.php
@@ -0,0 +1,37 @@
+<?php
+
+/**
+ *  Test CRM_Event_Form_Registration functions.
+ *
+ * @package   CiviCRM
+ * @group headless
+ */
+class CRM_Event_Form_SelfSvcTransferTest extends CiviUnitTestCase {
+
+  /**
+   * Test cancellation.
+   *
+   * @throws \CRM_Core_Exception
+   * @throws \CiviCRM_API3_Exception
+   */
+  public function testCancel(): void {
+    $_REQUEST['pid'] = $this->participantCreate(['status_id' => 'Registered']);
+    $_REQUEST['is_backoffice'] = 1;
+    $this->addLocationBlockToDomain();
+    $this->individualCreate(['email' => '[email protected]']);
+    $mut = new CiviMailUtils($this);
+    /* @var CRM_Event_Form_SelfSvcTransfer $form*/
+    $form = $this->getFormObject('CRM_Event_Form_SelfSvcTransfer', [
+      'email' => '[email protected]',
+    ]);
+    $form->buildForm();
+    $form->postProcess();
+    $emails = $mut->getAllMessages();
+    $this->assertStringContainsString('Registration Confirmation - Annual CiviCRM meet - Mr. Anthony', $emails[0]);
+    $this->assertStringContainsString('<p>Dear Anthony,</p>    <p>Your Event Registration has been Transferred to Anthony Anderson.</p>', $emails[1]);
+    $this->assertStringContainsString('[email protected]', $emails[1]);
+    $this->assertStringContainsString('123', $emails[1]);
+    $this->assertStringContainsString('[email protected]', $emails[1]);
+  }
+
+}
diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php
@@ -858,7 +858,7 @@ public function paymentProcessorAuthorizeNetCreate($params = []) {
    */
   public function participantCreate(array $params = []) {
     if (empty($params['contact_id'])) {
-      $params['contact_id'] = $this->individualCreate();
+      $this->ids['Contact']['participant'] = $params['contact_id'] = $this->individualCreate();
     }
     if (empty($params['event_id'])) {
       $event = $this->eventCreate();

diff --git a/xml/templates/message_templates/participant_transferred_html.tpl b/xml/templates/message_templates/participant_transferred_html.tpl
@@ -87,15 +87,15 @@
       {/foreach}
      {/if}
 
-     {if $contact.email}
+     {if '{contact.email}'}
       <tr>
        <th {$headerStyle}>
         {ts}Registered Email{/ts}
        </th>
       </tr>
       <tr>
        <td colspan="2" {$valueStyle}>
-        {$contact.email}
+        {contact.email}
        </td>
       </tr>
      {/if}
@@ -117,7 +117,7 @@
 
   <tr>
    <td>
-    <p>{ts 1=$domain.phone 2=$domain.email}Please contact us at %1 or send email to %2 if you have questions.{/ts}</p>
+    <p>{ts 1='{domain.phone}' 2='{domain.email}'}Please contact us at %1 or send email to %2 if you have questions.{/ts}</p>
    </td>
   </tr>
 

diff --git a/xml/templates/message_templates/participant_transferred_text.tpl b/xml/templates/message_templates/participant_transferred_text.tpl
@@ -29,17 +29,17 @@
 {ts}Email{/ts}: {$eventEmail.email}{/if}{/foreach}
 {/if}
 
-{if $contact.email}
+{if '{contact.email}'}
 
 ===========================================================
 {ts}Registered Email{/ts}
 
 ===========================================================
-{$contact.email}
+{contact.email}
 {/if}
 
 {if $register_date}
 {ts}Registration Date{/ts}: {$participant.register_date|crmDate}
 {/if}
 
-{ts 1=$domain.phone 2=$domain.email}Please contact us at %1 or send email to %2 if you have questions.{/ts}
+{ts 1='{domain.phone}' 2='{domain.email}'}Please contact us at %1 or send email to %2 if you have questions.{/ts}