[NFC] Fix var declarations in the test folder

diff --git a/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php b/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php
index 897ebbf453653238b0cd13a41875492b6fab4f6a..e4a7eb6a937a2907dad5a3c7c7cb6e3a5d80778a 100644 (file)
--- a/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php
+++ b/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php
@@ -240,7 +240,8 @@ class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {
   // *** Everything below this should be moved to parent class ****
 
   /**
-   * @var array(DAO_Name => array(int)) List of items to garbage-collect during tearDown
+   * @var array
+   * (DAO_Name => array(int)) List of items to garbage-collect during tearDown
    */
   private $_testObjects;
 

diff --git a/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php b/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php
index 247bced643a0e6967da4a336312e207ab2829f9b..b2fddc00aec6fc2770c762b4f799e76f14d589af 100644 (file)
--- a/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php
+++ b/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php
@@ -2154,7 +2154,8 @@ class CRM_Core_BAO_ActionScheduleTest extends CiviUnitTestCase {
   }
 
   /**
-   * @var array(DAO_Name => array(int)) List of items to garbage-collect during tearDown
+   * @var array
+   * (DAO_Name => array(int)) List of items to garbage-collect during tearDown
    */
   private $_testObjects;
 

diff --git a/tests/phpunit/CRM/Core/CommunityMessagesTest.php b/tests/phpunit/CRM/Core/CommunityMessagesTest.php
index c87cd6783cf412a4c1c98b222b64f606de15f740..6ebda73e487b7ae8904b8528f4ebc90ad92c1b6f 100644 (file)
--- a/tests/phpunit/CRM/Core/CommunityMessagesTest.php
+++ b/tests/phpunit/CRM/Core/CommunityMessagesTest.php
@@ -27,7 +27,8 @@ class CRM_Core_CommunityMessagesTest extends CiviUnitTestCase {
   protected $cache;
 
   /**
-   * @var array list of possible web responses
+   * @var array
+   * list of possible web responses
    */
   protected static $webResponses = NULL;
 

diff --git a/tests/phpunit/CRM/Core/Config/MailerTest.php b/tests/phpunit/CRM/Core/Config/MailerTest.php
index 5457f0b2b8ff021da1d2396061f4822f2b90088b..43c819117ce5c5e6a61c0ab5969129c4f7443358 100644 (file)
--- a/tests/phpunit/CRM/Core/Config/MailerTest.php
+++ b/tests/phpunit/CRM/Core/Config/MailerTest.php
@@ -24,7 +24,9 @@
 class CRM_Core_Config_MailerTest extends CiviUnitTestCase {
 
   /**
-   * @var array (string=>int) Keep count of the #times different functions are called
+   * Keep count of the #times different functions are called
+   * @var array
+   * (string=>int)
    */
   public $calls;
 

diff --git a/tests/phpunit/CRM/Core/ManagedEntitiesTest.php b/tests/phpunit/CRM/Core/ManagedEntitiesTest.php
index 6c61fc00838156148c2c799fd9de964f2ab3c5db..dc73e15f4afbf27f3d8792094475a72f96329bac 100644 (file)
--- a/tests/phpunit/CRM/Core/ManagedEntitiesTest.php
+++ b/tests/phpunit/CRM/Core/ManagedEntitiesTest.php
@@ -16,7 +16,7 @@ class CRM_Core_ManagedEntitiesTest extends CiviUnitTestCase {
   protected $adhocProvider;
 
   /**
-   * @var array(string
+   * @var String[]
    */
   protected $modules;
 

diff --git a/tests/phpunit/CRM/Core/ResourcesTest.php b/tests/phpunit/CRM/Core/ResourcesTest.php
index da2289c8ce55510fc62d108fbbec53badfb5476e..face0400d7063b0012e741c0c784d2b9e586edc6 100644 (file)
--- a/tests/phpunit/CRM/Core/ResourcesTest.php
+++ b/tests/phpunit/CRM/Core/ResourcesTest.php
@@ -26,7 +26,8 @@ class CRM_Core_ResourcesTest extends CiviUnitTestCase {
   protected $mapper;
 
   /**
-   * @var string for testing cache buster generation
+   * @var string
+   * For testing cache buster generation
    */
   protected $cacheBusterString = 'xBkdk3';
 

diff --git a/tests/phpunit/CRM/Core/TransactionTest.php b/tests/phpunit/CRM/Core/TransactionTest.php
index 9df2b95107fc5dda7928074d55a496f512690c92..069980a5337703ceba538e0868631532c91ad652 100644 (file)
--- a/tests/phpunit/CRM/Core/TransactionTest.php
+++ b/tests/phpunit/CRM/Core/TransactionTest.php
@@ -12,7 +12,8 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
   private $callbackLog;
 
   /**
-   * @var array (int $idx => int $contactId) list of contact IDs that have been created (in order of creation)
+   * @var array
+   * (int $idx => int $contactId) list of contact IDs that have been created (in order of creation)
    *
    * Note that ID this is all IDs created by the test-case -- even if the creation was subsequently rolled back
    */

diff --git a/tests/phpunit/CRM/Utils/HttpClientTest.php b/tests/phpunit/CRM/Utils/HttpClientTest.php
index 3dea0047dc907491b29412c5d943c8b910dba063..39ca92d8cb6a1a39edcdcf31c9e075255e82a74b 100644 (file)
--- a/tests/phpunit/CRM/Utils/HttpClientTest.php
+++ b/tests/phpunit/CRM/Utils/HttpClientTest.php
@@ -14,7 +14,8 @@ class CRM_Utils_HttpClientTest extends CiviUnitTestCase {
   const SELF_SIGNED_HTTPS_REGEX = '/This is httpclienttest-selfsign\./';
 
   /**
-   * @var string path to which we can store temp file
+   * @var string
+   * Path to which we can store temp file
    */
   protected $tmpFile;
 

diff --git a/tests/phpunit/Civi/API/KernelTest.php b/tests/phpunit/Civi/API/KernelTest.php
index 0dca67834ac3dfcc332d44f9941e2dae9e206285..63944f2e6da10f67420c3420f819d6972915bef9 100644 (file)
--- a/tests/phpunit/Civi/API/KernelTest.php
+++ b/tests/phpunit/Civi/API/KernelTest.php
@@ -9,7 +9,8 @@ class KernelTest extends \CiviUnitTestCase {
   const MOCK_VERSION = 3;
 
   /**
-   * @var array(int => array('name' => string $eventName, 'type' => string $className))
+   * @var array
+   * (int => array('name' => string $eventName, 'type' => string $className))
    */
   public $actualEventSequence;
 

diff --git a/tests/phpunit/Civi/ActionSchedule/AbstractMappingTest.php b/tests/phpunit/Civi/ActionSchedule/AbstractMappingTest.php
index 5483a2e58a80286b32458be79304434a88579f1b..65fe977ef9537452018c3fedc7458dd9df5a538e 100644 (file)
--- a/tests/phpunit/Civi/ActionSchedule/AbstractMappingTest.php
+++ b/tests/phpunit/Civi/ActionSchedule/AbstractMappingTest.php
@@ -71,9 +71,9 @@ abstract class AbstractMappingTest extends \CiviUnitTestCase {
 
   /**
    * When comparing timestamps, treat them as the same if they
-   * occur within a certain distance of each other.
+   * occur within a certain distance (seconds) of each other.
    *
-   * @var int seconds
+   * @var int
    */
   public $dateTolerance = 120;
 

diff --git a/tests/phpunit/CiviTest/CiviCaseTestCase.php b/tests/phpunit/CiviTest/CiviCaseTestCase.php
index 373274a0c376eca68818234378d5adb46af3b79c..44b03ad3170fa4c522106aa72774b1270e9f8c99 100644 (file)
--- a/tests/phpunit/CiviTest/CiviCaseTestCase.php
+++ b/tests/phpunit/CiviTest/CiviCaseTestCase.php
@@ -15,7 +15,8 @@
 class CiviCaseTestCase extends CiviUnitTestCase {
 
   /**
-   * @var string symbolic-name
+   * @var string
+   * Symbolic-name
    */
   protected $caseType;
 

diff --git a/tests/phpunit/CiviTest/CiviMailUtils.php b/tests/phpunit/CiviTest/CiviMailUtils.php
index d2986a2d2db46a525fd4f2292a563a17a21e7662..ec1c66579e7623a85af793ac3a626b023686ccf8 100644 (file)
--- a/tests/phpunit/CiviTest/CiviMailUtils.php
+++ b/tests/phpunit/CiviTest/CiviMailUtils.php
@@ -31,12 +31,14 @@
 class CiviMailUtils extends PHPUnit\Framework\TestCase {
 
   /**
-   * @var mixed current outbound email option
+   * Current outbound email option
+   * @var mixed
    */
   protected $_outBound_option = NULL;
 
   /**
-   * @var bool is this a webtest
+   * Is this a webtest
+   * @var bool
    */
   protected $_webtest = FALSE;
 

diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php
index 933c3fca80cae762b1e5378433c8cd802ab10017..170d7f410dbb511421b9ec6affbb348dee26ccea 100644 (file)
--- a/tests/phpunit/CiviTest/CiviUnitTestCase.php
+++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php
@@ -90,12 +90,14 @@ class CiviUnitTestCase extends PHPUnit\Framework\TestCase {
   protected $_tablesToTruncate = [];
 
   /**
-   * @var array of temporary directory names
+   * @var array
+   * Array of temporary directory names
    */
   protected $tempDirs;
 
   /**
-   * @var bool populateOnce allows to skip db resets in setUp
+   * @var bool
+   * populateOnce allows to skip db resets in setUp
    *
    *  WARNING! USE WITH CAUTION - IT'LL RENDER DATA DEPENDENCIES
    *  BETWEEN TESTS WHEN RUN IN SUITE. SUITABLE FOR LOCAL, LIMITED
@@ -103,21 +105,22 @@ class CiviUnitTestCase extends PHPUnit\Framework\TestCase {
    *
    *  IF POSSIBLE, USE $this->DBResetRequired = FALSE IN YOUR TEST CASE!
    *
-   *  see also: http://forum.civicrm.org/index.php/topic,18065.0.html
+   * @see http://forum.civicrm.org/index.php/topic,18065.0.html
    */
   public static $populateOnce = FALSE;
 
   /**
-   * @var bool DBResetRequired allows skipping DB reset
-   *               in specific test case. If you still need
-   *               to reset single test (method) of such case, call
-   *               $this->cleanDB() in the first line of this
-   *               test (method).
+   * DBResetRequired allows skipping DB reset
+   * in specific test case. If you still need
+   * to reset single test (method) of such case, call
+   * $this->cleanDB() in the first line of this
+   * test (method).
+   * @var bool
    */
   public $DBResetRequired = TRUE;
 
   /**
-   * @var CRM_Core_Transaction|NULL
+   * @var CRM_Core_Transaction|null
    */
   private $tx = NULL;
 
@@ -138,12 +141,13 @@ class CiviUnitTestCase extends PHPUnit\Framework\TestCase {
    *
    * $this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
    *
-   * @var CRM_Utils_Hook_UnitTests hookClass
+   * @var \CRM_Utils_Hook_UnitTests
    */
   public $hookClass = NULL;
 
   /**
-   * @var array common values to be re-used multiple times within a class - usually to create the relevant entity
+   * @var array
+   * Common values to be re-used multiple times within a class - usually to create the relevant entity
    */
   protected $_params = [];
 

diff --git a/tests/phpunit/E2E/Cache/TwoInstancesTest.php b/tests/phpunit/E2E/Cache/TwoInstancesTest.php
index 67f1295ebd4e584bdced8ec937b35e25ed9a1f4e..875e692a0343c95017efd4564563b71c7cd13cec 100644 (file)
--- a/tests/phpunit/E2E/Cache/TwoInstancesTest.php
+++ b/tests/phpunit/E2E/Cache/TwoInstancesTest.php
@@ -17,12 +17,12 @@
 class E2E_Cache_TwoInstancesTest extends CiviEndToEndTestCase {
 
   /**
-   * @var Psr\SimpleCache\CacheInterface;
+   * @var Psr\SimpleCache\CacheInterface
    */
   protected $a;
 
   /**
-   * @var Psr\SimpleCache\CacheInterface;
+   * @var Psr\SimpleCache\CacheInterface
    */
   protected $b;
 

diff --git a/tests/phpunit/api/v3/SyntaxConformanceTest.php b/tests/phpunit/api/v3/SyntaxConformanceTest.php
index 63a35cdef83a2f66bc8f6ad53ec61a73c8918b5f..30c4e9e51b046bcac1e12c8b1396634fa32561b1 100644 (file)
--- a/tests/phpunit/api/v3/SyntaxConformanceTest.php
+++ b/tests/phpunit/api/v3/SyntaxConformanceTest.php
@@ -25,7 +25,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
   protected $_apiversion = 3;
 
   /**
-   * @var array e.g. $this->deletes['CRM_Contact_DAO_Contact'][] = $contactID;
+   * @var array
+   * e.g. $this->deletes['CRM_Contact_DAO_Contact'][] = $contactID;
    */
   protected $deletableTestObjects;