Make QueryEngines getCandidateData be CandID => DataInstance instead …

…of DataInstance[]
aces · Dec 7, 2022 · 1597f52 · 1597f52
1 parent cf9f16d
commit 1597f52
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/modules/instruments/php/instrumentqueryengine.class.inc b/modules/instruments/php/instrumentqueryengine.class.inc
@@ -280,7 +280,7 @@ class InstrumentQueryEngine implements \LORIS\Data\Query\QueryEngine
      * @param iterable $candidates Candidates whose data we want
      * @param ?array   $visitlist  List of visits that we want data for
      *
-     * @return \LORIS\Data\DataInstance[]
+     * @return iterable<string, \LORIS\Data\DataInstance>
      */
     public function getCandidateData(
         array $items,

diff --git a/src/Data/Query/QueryEngine.php b/src/Data/Query/QueryEngine.php
@@ -42,13 +42,16 @@ public function getCandidateMatches(
      * Retrieve the data for a given list of DictionaryItems from this
      * engine's data dictionary and a given list of CandIDs.
      *
+     * The returned value is a type where the key is the CandID (as
+     * a string) and the value is a DataInstance.
+     *
      * If visits is declared, only include data for those visits labels.
      *
      * @param DictionaryItem[] $items Data points to retrieve
      * @param CandID[] $candidates    Candidates to retrieve data for
      * @param ?string[] $visits       Visit labels to restrict data to
      *
-     * @return DataInstance[]
+     * @return iterable<string,DataInstance>
      */
     public function getCandidateData(array $items, iterable $candidates, ?array $visitlist) : iterable;