[NFC] comments clean up in test classes.
authoreileen <emcnaughton@wikimedia.org>
Sun, 10 Sep 2017 22:47:30 +0000 (10:47 +1200)
committereileen <emcnaughton@wikimedia.org>
Sun, 10 Sep 2017 22:47:30 +0000 (10:47 +1200)
Also remove a few unused variables

tests/phpunit/CRM/Mailing/BaseMailingSystemTest.php
tests/phpunit/api/v3/GroupContactTest.php
tests/phpunit/api/v3/MailingGroupTest.php

index 37bf968c14041c289115c1b17138aca0a5c74498..080d3fd4c4aa8a412b5516c3a9de05d5e05a70e2 100644 (file)
@@ -32,8 +32,6 @@
  * @subpackage API_Job
  *
  * @copyright CiviCRM LLC (c) 2004-2017
- * @version $Id: Job.php 30879 2010-11-22 15:45:55Z shot $
- *
  */
 
 /**
@@ -57,7 +55,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase {
   public function setUp() {
     $this->useTransaction();
     parent::setUp();
-    CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
+    CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0;
 
     $this->_groupID = $this->groupCreate();
     $this->createContactsInGroup(2, $this->_groupID);
@@ -118,7 +116,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase {
       'open_tracking' => 1,
       // Note: open_tracking does nothing with text, but we'll just verify that it does nothing
     ));
-    foreach ($allMessages as $k => $message) {
+    foreach ($allMessages as $message) {
       /** @var ezcMail $message */
       /** @var ezcMailText $textPart */
 
@@ -146,7 +144,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase {
       'open_tracking' => 1,
       'url_tracking' => 0,
     ));
-    foreach ($allMessages as $k => $message) {
+    foreach ($allMessages as $message) {
       /** @var ezcMail $message */
       /** @var ezcMailText $htmlPart */
       /** @var ezcMailText $textPart */
@@ -196,7 +194,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase {
       'open_tracking' => 1,
       'url_tracking' => 1,
     ));
-    foreach ($allMessages as $k => $message) {
+    foreach ($allMessages as $message) {
       /** @var ezcMail $message */
       /** @var ezcMailText $htmlPart */
       /** @var ezcMailText $textPart */
@@ -239,17 +237,19 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase {
     }
   }
 
+  /**
+   * Each case comes in four parts:
+   * 1. Mailing HTML (body_html)
+   * 2. Regex to run against final HTML
+   * 3. Regex to run against final text
+   * 4. Additional mailing options
+   *
+   * @return array
+   */
   public function urlTrackingExamples() {
     $cases = array();
 
-    // Each case comes in four parts:
-    // 1. Mailing HTML (body_html)
-    // 2. Regex to run against final HTML
-    // 3. Regex to run against final text
-    // 4. Additional mailing options
-
     // Tracking disabled
-
     $cases[] = array(
       '<p><a href="http://example.net/">Foo</a></p>',
       ';<p><a href="http://example\.net/">Foo</a></p>;',
@@ -285,7 +285,6 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase {
     );
 
     // Tracking enabled
-
     $cases[] = array(
       '<p><a href="http://example.net/">Foo</a></p>',
       ';<p><a href=[\'"].*extern/url\.php\?u=\d+.*[\'"]>Foo</a></p>;',
@@ -338,7 +337,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase {
       'subject' => 'Example Subject',
       'body_html' => $inputHtml,
     ));
-    foreach ($allMessages as $k => $message) {
+    foreach ($allMessages as $message) {
       /** @var ezcMail $message */
       /** @var ezcMailText $htmlPart */
       /** @var ezcMailText $textPart */
index 39509f095ae89c0498da13887f8a1bd65432fbe6..33ab456dea67f20a057f673ef254a5f74e9de4ff 100644 (file)
@@ -86,8 +86,6 @@ class api_v3_GroupContactTest extends CiviUnitTestCase {
     );
   }
 
-  ///////////////// civicrm_group_contact_get methods
-
   /**
    * Test GroupContact.get by ID.
    */
@@ -168,8 +166,6 @@ class api_v3_GroupContactTest extends CiviUnitTestCase {
     $this->assertEquals($result['total_count'], 2);
   }
 
-  ///////////////// civicrm_group_contact_remove methods
-
   /**
    * Test GroupContact.delete by contact+group ID.
    */
index 75630204bec56cdd09754b5b35a270b561802fb8..814997fefb09623f14d4f4d3c611b609b62c411e 100644 (file)
@@ -44,8 +44,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase {
     $this->_email = 'test@test.test';
   }
 
-  //---------- civicrm_mailing_event_subscribe methods ---------
-
   /**
    * Test civicrm_mailing_group_event_subscribe with wrong params.
    */
@@ -85,8 +83,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase {
     $this->contactDelete($contactID);
   }
 
-  //-------- civicrm_mailing_group_event_unsubscribe methods-----------
-
   /**
    * Test civicrm_mailing_group_event_unsubscribe with wrong params.
    */
@@ -101,8 +97,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase {
     $this->callAPIFailure('mailing_event_unsubscribe', 'create', $params);
   }
 
-  //--------- civicrm_mailing_group_event_domain_unsubscribe methods -------
-
   /**
    * Test civicrm_mailing_group_event_domain_unsubscribe with wrong params.
    */
@@ -118,8 +112,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase {
     $this->callAPIFailure('mailing_event_unsubscribe', 'create', $params);
   }
 
-  //----------- civicrm_mailing_group_event_resubscribe methods--------
-
   /**
    * Test civicrm_mailing_group_event_resubscribe with wrong params type.
    */
@@ -138,8 +130,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase {
     $this->callAPIFailure('mailing_event_resubscribe', 'create', $params);
   }
 
-  //------------------------ success case ---------------------
-
   /**
    * Test civicrm_mailing_group_event_subscribe and civicrm_mailing_event_confirm functions - success expected.
    */
@@ -171,7 +161,7 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase {
       'event_subscribe_id' => $result['values'][$result['id']]['subscribe_id'],
     );
 
-    $result = $this->callAPISuccess('mailing_event_confirm', 'create', $params);
+    $this->callAPISuccess('mailing_event_confirm', 'create', $params);
     $this->contactDelete($contactID);
   }