[API] PUT and PATCH methods added to Candidates visit/instruments/flags

modules/api/php/endpoints/candidate/visit/instrument/flags.class.inc

@@ -95,9 +95,10 @@ class Flags extends Endpoint implements \LORIS\Middleware\ETagCalculator
             return $this->_handleGET($request);
 
         case 'PUT':
+            return $this->_handlePUT($request);
+
         case 'PATCH':
-            // TODO :: I don`t think this was working in v0.0.3
-            return new \LORIS\Http\Response\JSON\NotImplemented();
+            return $this->_handlePATCH($request);
 
         case 'OPTIONS':
             return (new \LORIS\Http\Response())
@@ -127,6 +128,108 @@ class Flags extends Endpoint implements \LORIS\Middleware\ETagCalculator
         );
     }
 
+    /**
+     * Handles a PUT request.
+     * Creates or updates all statuses for a given instrument with new values.
+     *
+     * @param ServerRequestInterface $request The incoming PSR7 request
+     *
+     * @return ResponseInterface The outgoing PSR7 response
+     */
+    private function _handlePUT(ServerRequestInterface $request) : ResponseInterface
+    {
+        // TODO :: Check permissions. How??
+        $this->_instrumentStatus = new \NDB_BVL_InstrumentStatus();
+        $this->_instrumentStatus->select($this->_instrument->commentID);
+
+        $data = json_decode((string) $request->getBody(), true);
+
+        try {
+
+            $requiredfields = [
+                'Data_entry',
+                'Administration',
+                'Validity',
+            ];
+
+            $diff = array_diff($requiredfields, array_keys($data['Flags']));
+            if (!empty($diff)) {
+                return new \LORIS\Http\Response\JSON\BadRequest(
+                    'Field(s) missing in Flags: ' . implode(', ', $diff)
+                );
+            }
+            $this->_instrumentStatus->setDataEntryStatus(
+                $data['Flags']['Data_entry']
+            );
+            $this->_instrumentStatus->setAdministrationStatus(
+                $data['Flags']['Administration']
+            );
+            $this->_instrumentStatus->setValidityStatus(
+                $data['Flags']['Validity']
+            );
+
+        } catch (\Throwable $e) {
+            error_log($e->getMessage());
+            return new \LORIS\Http\Response\JSON\InternalServerError();
+        }
+        return (new \LORIS\Http\Response())
+            ->withStatus(204);
+    }
+
+    /**
+     * Handles a PATCH request.
+     * Creates or updates some or all statuses for a given instrument. If all
+     * statuses are requested to be changed, this method is equivalent to handlePUT.
+     *
+     * @param ServerRequestInterface $request The incoming PSR7 request
+     *
+     * @return ResponseInterface The outgoing PSR7 response
+     */
+    private function _handlePATCH(ServerRequestInterface $request): ResponseInterface
+    {
+        // TODO :: Check permissions. How??
+        $this->_instrumentStatus = new \NDB_BVL_InstrumentStatus();
+        $this->_instrumentStatus->select($this->_instrument->commentID);
+
+        if (!$this->_instrument->determineDataEntryAllowed()) {
+            return new \LORIS\Http\Response\JSON\Forbidden(
+                'Can not update instruments that are flagged as complete.'
+            );
+        }
+
+        $data = json_decode((string) $request->getBody(), true);
+
+        if (!$this->_instrument->validate($data)) {
+            return new \LORIS\Http\Response\JSON\Forbidden(
+                'Could not update.'
+            );
+        }
+
+        try {
+            if (array_key_exists('Data_entry', $data['Flags'])) {
+                $this->_instrumentStatus->setDataEntryStatus(
+                    $data['Flags']['Data_entry']
+                );
+            }
+            if (array_key_exists('Administration', $data['Flags'])) {
+                $this->_instrumentStatus->setAdministrationStatus(
+                    $data['Flags']['Administration']
+                );
+            }
+            if (array_key_exists('Validity', $data['Flags'])) {
+                $this->_instrumentStatus->setValidityStatus(
+                    $data['Flags']['Validity']
+                );
+            }
+        } catch (\Throwable $e) {
+            error_log($e->getMessage());
+            return new \LORIS\Http\Response\JSON\InternalServerError();
+        }
+        return (new \LORIS\Http\Response())
+            ->withStatus(204);
+    }
+
+
     /**
      * Implements the ETagCalculator interface
      *

php/libraries/NDB_BVL_Instrument.class.inc

@@ -2261,7 +2261,10 @@ abstract class NDB_BVL_Instrument extends NDB_Page
         foreach ($columns as $row) {
             switch ($row['COLUMN_NAME']) {
             case 'CommentID':
+            case 'ID':
+            case 'SessionID':
             case 'UserID':
+            case 'Test_name':
                 continue 2;
             case 'Data_entry_completion_status':
                 $values[$row['COLUMN_NAME']] = 'Incomplete';

php/libraries/NDB_BVL_InstrumentStatus.class.inc

@@ -160,12 +160,12 @@ class NDB_BVL_InstrumentStatus
     /**
      * Sets the current data entry status of the instrument
      *
-     * @param string $status the new status from the set (NULL,
-     *                       'In Progress','Not Complete','Complete')
+     * @param ?string $status the new status from the set (NULL,
+     *                        'In Progress','Not Complete','Complete')
      *
      * @return void
      */
-    function setDataEntryStatus(string $status): void
+    function setDataEntryStatus(?string $status): void
     {
         if (!isset($this->_commentID)) {
             throw new Exception("No instrument instance selected");
@@ -236,12 +236,12 @@ class NDB_BVL_InstrumentStatus
     /**
      * Sets the current administration status of the instrument
      *
-     * @param string $status the new status from the set
-     *                       (NULL, 'None','Partial','All')
+     * @param ?string $status the new status from the set
+     *                        (NULL, 'None','Partial','All')
      *
      * @return void
      */
-    function setAdministrationStatus(string $status): void
+    function setAdministrationStatus(?string $status): void
     {
         if (!isset($this->_commentID)) {
             throw new Exception("No instrument instance selected");
@@ -262,12 +262,12 @@ class NDB_BVL_InstrumentStatus
     /**
      * Sets the current validity status of the instrument
      *
-     * @param string $status the new status from the set
-     *                       (NULL, 'Questionable', 'Invalid', 'Valid')
+     * @param ?string $status the new status from the set
+     *                        (NULL, 'Questionable', 'Invalid', 'Valid')
      *
      * @return void
      */
-    function setValidityStatus(string $status): void
+    function setValidityStatus(?string $status): void
     {
         if (!isset($this->_commentID)) {
             throw new Exception("No instrument instance selected");