Fixed export issue, and fixed tests for PHP 7.2

Fixed format processing for exportRepeatingInstrumentsAndEvents, and made changes to the automated tests to get them to work for PHP7.2.

Author: mullen2

phpunit.xml

@@ -3,6 +3,7 @@
          bootstrap="vendor/autoload.php">
   <testsuites>
     <testsuite name="unit">
+      <file>tests/unit/ErrorHandlerTest.php</file>
       <file>tests/unit/FileUtilTest.php</file>
       <file>tests/unit/PhpCapExceptionTest.php</file>
       <file>tests/unit/RedCapApiConnectionTest.php</file>

src/ErrorHandler.php

@@ -22,12 +22,6 @@ public function throwException(
         $httpStatusCode = null,
         $previousException = null
     ) {
-        throw new PhpCapException(
-            $message,
-            $code,
-            $connectionErrorNumber,
-            $httpStatusCode,
-            $previousException
-        );
+        throw new PhpCapException($message, $code, $connectionErrorNumber, $httpStatusCode, $previousException);
     }
 }

src/RedCap.php

@@ -73,14 +73,7 @@ public function __construct(
             $errorHandler = null,
             $connection = null
         ) {
-            return new RedCapProject(
-                $apiUrl,
-                $apiToken,
-                $sslVerify,
-                $caCertificateFile,
-                $errorHandler,
-                $connection
-            );
+            return new RedCapProject($apiUrl, $apiToken, $sslVerify, $caCertificateFile, $errorHandler, $connection);
         };
     }
 
@@ -174,13 +167,17 @@ public function createProject(
 
         $projectConstructorCallback = $this->projectConstructorCallback;
 
+        # Note: due to an issue with Xdebug, arguments to multi-line function
+        #       calls, other than the last one, may not be handled correctly
+        #       for code coverage, so the code coverage ignore annotations
+        #       needed to be added below.
         $project = call_user_func(
-            $projectConstructorCallback,
-            $apiUrl = null,
-            $apiToken,
-            $sslVerify = null,
-            $caCertificateFile = null,
-            $errorHandler,
+            $projectConstructorCallback,  // @codeCoverageIgnore
+            $apiUrl = null,               // @codeCoverageIgnore
+            $apiToken,                    // @codeCoverageIgnore
+            $sslVerify = null,            // @codeCoverageIgnore
+            $caCertificateFile = null,    // @codeCoverageIgnore
+            $errorHandler,                // @codeCoverageIgnore
             $connection
         );
 
@@ -205,12 +202,12 @@ public function getProject($apiToken)
 
         # By default, this creates a RedCapProject
         $project = call_user_func(
-            $projectConstructorCallback,
-            $apiUrl = null,
-            $apiToken,
-            $sslVerify = null,
-            $caCertificateFile = null,
-            $errorHandler,
+            $projectConstructorCallback,   // @codeCoverageIgnore
+            $apiUrl = null,                // @codeCoverageIgnore
+            $apiToken,                     // @codeCoverageIgnore
+            $sslVerify = null,             // @codeCoverageIgnore
+            $caCertificateFile = null,     // @codeCoverageIgnore
+            $errorHandler,                 // @codeCoverageIgnore
             $connection
         );
 

src/RedCapProject.php

@@ -1422,7 +1422,7 @@ public function exportRepeatingInstrumentsAndEvents($format = 'php')
 
         $result = $this->connection->callWithArray($data);
 
-        $this->processNonExportResult($result);
+        $this->processExportResult($result, $format);
 
         return $result;
     }

tests/integration/RecordsTest.php

@@ -430,12 +430,11 @@ public function testExportRecordsAsCsv()
         $recordIds = array ('1001');
 
         $records = self::$basicDemographyProject->exportRecords($format = 'csv', $type = null, $recordIds);
-    
-        $this->assertEquals(count($records), 1, 'Correct number of records returned test.');
 
         $parser = \KzykHys\CsvParser\CsvParser::fromString($records);
         $csv = $parser->parse();
-        
+        $this->assertEquals(2, count($csv), 'Correct number of records returned test.');
+
         $firstDataRow = $csv[1];
 
         $csvRecordId = $firstDataRow[0];
@@ -453,7 +452,7 @@ public function testExportRecordsAsOdm()
 
         $records = self::$basicDemographyProject->exportRecords($format = 'odm', $type = null, $recordIds);
 
-        $this->assertEquals(count($records), 1, 'Correct number of records returned test.');
+        $this->assertTrue(is_string($records), 'Correct type for records returned test.');
 
         $xml = new \DomDocument();
         $xml->loadXML($records);
@@ -477,7 +476,7 @@ public function testExportRecordsAsXml()
 
         $records = self::$basicDemographyProject->exportRecords($format = 'xml', $type = null, $recordIds);
 
-        $this->assertEquals(count($records), 1, 'Correct number of records returned test.');
+        $this->assertTrue(is_string($records), 1, 'Correct type for records returned test.');
 
         $xml = simplexml_load_string($records);
 
@@ -841,7 +840,7 @@ public function testImportAndDeleteRecordsXmlFormat()
             .'</item> </records>';
 
         $result = self::$basicDemographyProject->importRecords($records, $format = 'xml');
-        $this->assertEquals(1, count($result), 'Record count.');
+        $this->assertEquals(1, $result, 'Import result value.');
 
         $result = self::$basicDemographyProject->exportRecords();
         $this->assertEquals(101, count($result), 'Record count after import.');

tests/unit/ErrorHandlerTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace IU\PHPCap;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * PHPUnit tests for ErrorHandler class.
+ */
+class ErrorHandlerTest extends TestCase
+{
+    public function test()
+    {
+        $errorHandler = new ErrorHandler();
+        $this->assertNotNull($errorHandler, 'Error handler not null.');
+        $this->assertTrue($errorHandler instanceof ErrorHandlerInterface);
+
+        $exceptionCaught = false;
+        $expectedMessage = 'Error handler test.';
+        $expectedCode = ErrorHandlerInterface::REDCAP_API_ERROR;
+        try {
+            $errorHandler->throwException($expectedMessage, $expectedCode);
+        } catch (\Exception $exception) {
+            $exceptionCaught = true;
+            $message = $exception->getMessage();
+            $code = $exception->getCode();
+        }
+
+        $this->assertTrue($exceptionCaught);
+        $this->assertEquals($expectedMessage, $message);
+        $this->assertEquals($expectedCode, $code);
+    }
+}