[api] Add cohorts to project info

modules/api/docs/LorisRESTAPI_v0.0.4-dev.md

@@ -410,7 +410,7 @@ The JSON object is of the form:
         "CandID" : CandID,
         "Visit"  : VisitLabel,
         "Site"   : SiteName,
-        "Battery": "NameOfCohort",
+        "Cohort": "NameOfCohort",
         "Project" : ProjectName
     },
     "Stages" : {

modules/api/php/endpoints/candidate/visit/visit_0_0_4_dev.class.inc

@@ -180,7 +180,7 @@ class Visit_0_0_4_Dev extends Endpoint implements \LORIS\Middleware\ETagCalculat
         }
 
         return new \LORIS\Http\Response\JsonResponse(
-            (new \LORIS\api\Views\Visit($this->_visit))
+            (new \LORIS\api\Views\Visit($this->_visit, 'v0.0.4-dev'))
                 ->toArray()
         );
     }
@@ -208,7 +208,7 @@ class Visit_0_0_4_Dev extends Endpoint implements \LORIS\Middleware\ETagCalculat
             'CandID',
             'Visit',
             'Site',
-            'Battery',
+            'Cohort',
             'Project',
         ];
 
@@ -278,7 +278,7 @@ class Visit_0_0_4_Dev extends Endpoint implements \LORIS\Middleware\ETagCalculat
         }
 
         $cohortid = array_search(
-            $visitinfo['Battery'],
+            $visitinfo['Cohort'],
             \Utility::getCohortList()
         );
 

modules/api/php/endpoints/project/project.class.inc

@@ -81,11 +81,13 @@ class Project extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     public function handle(ServerRequestInterface $request) : ResponseInterface
     {
-        $pathparts = $request->getAttribute('pathparts');
+        $apiversion = $request->getAttribute("LORIS-API-Version") ?? "unknown";
+        $pathparts  = $request->getAttribute('pathparts');
+
         if (count($pathparts) === 0) {
             switch ($request->getMethod()) {
             case 'GET':
-                return $this->_handleGET($request);
+                return $this->_handleGET($apiversion);
 
             case 'OPTIONS':
                 return (new \LORIS\Http\Response())
@@ -133,15 +135,17 @@ class Project extends Endpoint implements \LORIS\Middleware\ETagCalculator
      * Generates a JSON representation of this project following the API
      * specification.
      *
+     * @param string $version The version of the API the GET is for.
+     *
      * @return ResponseInterface
      */
-    private function _handleGET(): ResponseInterface
+    private function _handleGET($version): ResponseInterface
     {
         if (isset($this->_cache)) {
             return $this->_cache;
         }
 
-        $array = (new \LORIS\api\Views\Project($this->_project))
+        $array = (new \LORIS\api\Views\Project($this->_project, $version))
             ->toArray();
 
         $this->_cache = new \LORIS\Http\Response\JsonResponse($array);
@@ -158,6 +162,7 @@ class Project extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     public function ETag(ServerRequestInterface $request) : string
     {
-        return md5(json_encode($this->_handleGET($request)->getBody()));
+        $apiversion = $request->getAttribute("LORIS-API-Version") ?? "unknown";
+        return md5(json_encode($this->_handleGET($apiversion)->getBody()));
     }
 }

modules/api/php/views/project.class.inc

@@ -34,9 +34,10 @@ class Project
     /**
      * Constructor
      *
-     * @param \Project $project The project to format
+     * @param \Project $project    The project to format
+     * @param string   $apiversion The version of the API being accessed
      */
-    public function __construct(\Project $project)
+    public function __construct(\Project $project, private string $apiversion = '')
     {
         $this->_project = $project;
     }
@@ -51,12 +52,21 @@ class Project
     {
         $meta = ['Project' => $this->_project->getName()];
 
-        return [
+        $obj = [
             'Meta'        => $meta,
             'Candidates'  => $this->_project->getCandidateIds(),
             'Instruments' => array_keys(\Utility::getAllInstruments()),
             'Visits'      => $this->_getVisits(),
         ];
+        if ($this->apiversion == 'v0.0.4-dev') {
+            $obj['Cohorts'] = array_map(
+                function ($cohort) {
+                    return $cohort['title'];
+                },
+                $this->_project->getCohorts()
+            );
+        }
+        return $obj;
     }
 
     /**

modules/api/php/views/visit.class.inc

@@ -29,10 +29,13 @@ class Visit
     /**
      * Constructor which sets the instance variables based on the provided timepoint
      *
-     * @param \Timepoint $timepoint The timepoint to represent
+     * @param \Timepoint $timepoint  The timepoint to represent
+     * @param string     $apiversion The version of the API being used
      */
-    public function __construct(\Timepoint $timepoint)
-    {
+    public function __construct(
+        \Timepoint $timepoint,
+        private string $apiversion = 'v0.0.3'
+    ) {
         $this->_timepoint = $timepoint;
     }
 
@@ -43,12 +46,13 @@ class Visit
      */
     public function toArray(): array
     {
-        $meta = [
-            'CandID'  => $this->_timepoint->getCandID(),
-            'Visit'   => $this->_timepoint->getVisitLabel(),
-            'Site'    => $this->_timepoint->getPSC(),
-            'Battery' => $this->_timepoint->getData('CohortTitle'),
-            'Project' => $this->_timepoint->getProject(),
+        $cohortKey = $this->apiversion == 'v0.0.4-dev' ? 'Cohort' : 'Battery';
+        $meta      = [
+            'CandID'   => $this->_timepoint->getCandID(),
+            'Visit'    => $this->_timepoint->getVisitLabel(),
+            'Site'     => $this->_timepoint->getPSC(),
+            $cohortKey => $this->_timepoint->getData('CohortTitle'),
+            'Project'  => $this->_timepoint->getProject(),
         ];
 
         $stages = [];

raisinbread/test/api/LorisApiVisitsTest.php

@@ -66,7 +66,7 @@ public function testGetCandidatesCandidVisit(): void
             'string'
         );
         $this->assertSame(
-            gettype($candidatesVisitArray['Meta']['Battery']),
+            gettype($candidatesVisitArray['Meta']['Cohort']),
             'string'
         );
         $this->assertSame(
@@ -90,7 +90,7 @@ public function testGetCandidatesCandidVisit(): void
         $this->assertArrayHasKey('CandID', $candidatesVisitArray['Meta']);
         $this->assertArrayHasKey('Project', $candidatesVisitArray['Meta']);
         $this->assertArrayHasKey('Site', $candidatesVisitArray['Meta']);
-        $this->assertArrayHasKey('Battery', $candidatesVisitArray['Meta']);
+        $this->assertArrayHasKey('Cohort', $candidatesVisitArray['Meta']);
         $this->assertArrayHasKey('Project', $candidatesVisitArray['Meta']);
         $this->assertArrayHasKey('Stages', $candidatesVisitArray);
         $this->assertArrayHasKey(
@@ -119,7 +119,7 @@ public function testPutCandidatesCandidVisit(): void
         $json     = ['CandID'  => '900000',
             'Visit'   => "V1",
             'Site'    => "Data Coordinating Center",
-            'Battery' => "High Yeast",
+            'Cohort' => "High Yeast",
             'Project' => "Rye",
         ];
         $response = $this->client->request(
@@ -172,7 +172,7 @@ public function testPutCandidatesCandidVisit(): void
         $json     = ['CandID'  => "115788",
             'Visit'   => "V3",
             'Site'    => "Data Coordinating Center",
-            'Battery' => "Stale",
+            'Cohort' => "Stale",
             'Project' => "Pumpernickel",
         ];
         $response = $this->client->request(
@@ -196,7 +196,7 @@ public function testPutCandidatesCandidVisit(): void
         $json     = ['CandID'  => '900000',
             'Visit'   => "V1",
             'Site'    => "Montreal",
-            'Battery' => "Stale",
+            'Cohort' => "Stale",
             'Project' => "Pumpernickel",
         ];
         $response = $this->client->request(