redcap - phan

aces · Nov 17, 2024 · c647fea · c647fea
1 parent 92016d7
commit c647fea
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 10 deletions.
diff --git a/modules/redcap/php/configurations/redcapconfigurationparser.class.inc b/modules/redcap/php/configurations/redcapconfigurationparser.class.inc
@@ -27,9 +27,9 @@ use LORIS\redcap\configurations\RedcapConfiguration;
 class RedcapConfigurationParser
 {
     /**
-     * Instances defined in configuration.
+     * REDCap configuration.
      *
-     * @var array
+     * @var RedcapConfiguration
      */
     private RedcapConfiguration $_config;
 

diff --git a/modules/redcap/php/endpoints/notifications.class.inc b/modules/redcap/php/endpoints/notifications.class.inc
@@ -219,7 +219,7 @@ class Notifications extends Endpoint
      *
      * @param RedcapNotification $notif the REDCap notification.
      *
-     * @return true if the notification should be ignored, else false.
+     * @return bool if the notification should be ignored, else false.
      */
     private function _ignoreNotification(RedcapNotification $notif): bool
     {

diff --git a/modules/redcap/php/models/records/iredcaprecord.class.inc b/modules/redcap/php/models/records/iredcaprecord.class.inc
@@ -43,4 +43,11 @@ interface IRedcapRecord
      * @return array
      */
     public function getPropertyNames(): array;
+
+    /**
+     * Props array.
+     *
+     * @return array
+     */
+    public function toArray(): array;
 }
diff --git a/modules/redcap/php/notifications/redcapnotificationhandler.class.inc b/modules/redcap/php/notifications/redcapnotificationhandler.class.inc
@@ -167,15 +167,14 @@ class RedcapNotificationHandler
         if ($nNotUpdated > 0) {
             $recNotUp = array_map(
                 fn($k) => $records[$k]->getInstrumentName(),
-                $notUpdated
+                array_keys($notUpdated)
             );
             $recMsg   = implode(',', $recNotUp);
             $msg      = "[redcap] [pscid:$recordId][visit:$visitName]"
                 . " repeating instruments not updated: $recMsg.";
             throw new \LorisException($msg);
         }
-        sprintf(
-            STDOUT,
+        error_log(
             "[redcap] [pscid:$recordId][visit:$visitName]"
             ."[instrument:$instrumentName] instrument updated."
         );
@@ -205,7 +204,7 @@ class RedcapNotificationHandler
         // E.g. from 'form_name_and_field_name' to 'and_field_name'
         foreach ($instrument->getDataDictionary() as $field) {
             $dict_names[] = preg_replace(
-                "/^${instrument_name}_/",
+                "/^{$instrument_name}_/",
                 "",
                 $field->getName()
             );
@@ -507,9 +506,9 @@ class RedcapNotificationHandler
     /**
      * Get the 'redcap' examiner ID.
      *
-     * @return string the redcap examiner ID.
+     * @return ?string the redcap examiner ID.
      */
-    private function _getRedcapExaminerId(): string
+    private function _getRedcapExaminerId(): ?string
     {
         $db = $this->_loris->getDatabaseConnection();
         return $db->pselectOne(

diff --git a/modules/redcap/php/redcaphttpclient.class.inc b/modules/redcap/php/redcaphttpclient.class.inc
@@ -165,7 +165,7 @@ class REDCapHTTPClient
      *
      * @param array $data the data to send.
      *
-     * @return string string representation, data results
+     * @return ?string string representation, data results
      */
     private function _sendRequest(array $data): ?string
     {