feature: add new event ResultTestVariablesAfterTransmissionEvent

helpers/class.TestSession.php

@@ -20,12 +20,15 @@
  */
 
 use oat\oatbox\event\EventManager;
+use oat\oatbox\service\exception\InvalidServiceManagerException;
 use oat\oatbox\service\ServiceManager;
 use oat\taoQtiTest\helpers\TestSessionMemento;
 use oat\taoQtiTest\models\classes\event\ResultTestVariablesTransmissionEvent;
 use oat\taoQtiTest\models\event\QtiTestChangeEvent;
 use oat\taoQtiTest\models\event\QtiTestStateChangeEvent;
 use oat\taoQtiTest\models\event\ResultItemVariablesTransmissionEvent;
+use oat\taoQtiTest\models\event\ResultTestVariablesAfterTransmissionEvent;
+use oat\taoResultServer\models\classes\implementation\ResultServerService;
 use oat\taoResultServer\models\classes\ResultStorageWrapper;
 use oat\taoTests\models\event\TestExecutionPausedEvent;
 use oat\taoTests\models\event\TestExecutionResumedEvent;
@@ -44,6 +47,7 @@
 use qtism\data\processing\OutcomeProcessing;
 use qtism\data\rules\OutcomeRuleCollection;
 use qtism\data\rules\SetOutcomeValue;
+use qtism\data\state\OutcomeDeclaration;
 use qtism\runtime\common\OutcomeVariable;
 use qtism\runtime\common\ProcessingException;
 use qtism\runtime\processing\OutcomeProcessingEngine;
@@ -57,6 +61,7 @@
 use qtism\runtime\tests\Route;
 use Symfony\Component\Lock\LockInterface;
 use Zend\ServiceManager\ServiceLocatorAwareInterface;
+use taoResultServer_models_classes_ReadableResultStorage as ReadableResultStorage;
 
 /**
  * A TAO Specific extension of QtiSm's AssessmentTestSession class.
@@ -814,14 +819,49 @@ private function triggerResultTestVariablesTransmissionEvent(
         array $variables,
         string $testUri = ''
     ): void {
-        $this->getEventManager()->trigger(new ResultTestVariablesTransmissionEvent(
+        $event = new ResultTestVariablesTransmissionEvent(
             $this->getSessionId(),
             $variables,
             $this->getSessionId(),
             $testUri
+        );
+
+        $this->getEventManager()->attach($event, [$this, 'attachToTransmissionEvent']);
+        $this->getEventManager()->trigger($event);
+    }
+
+    public function attachToTransmissionEvent(ResultTestVariablesTransmissionEvent $event): void
+    {
+        $scoreTotal = array_filter($event->getVariables(), function ($item) {
+            return $item->getIdentifier() === 'SCORE_TOTAL';
+        })[0];
+        if ($scoreTotal === null) {
+            return;
+        }
+        $outcomeVariables = $this->getResultsStorage()->getDeliveryVariables($event->getDeliveryExecutionId());
+        $this->getEventManager()->trigger(new ResultTestVariablesAfterTransmissionEvent(
+            $event->getDeliveryExecutionId(),
+            $outcomeVariables,
+            $this->isManualScored()
         ));
     }
 
+    private function isManualScored(): bool
+    {
+        /** @var AssessmentItemRef $itemRef */
+        foreach ($this->getRoute()->getAssessmentItemRefs() as $itemRef) {
+            foreach ($itemRef->getComponents() as $component) {
+                if ($component instanceof OutcomeDeclaration) {
+                    if ($component->isExternallyScored()) {
+                        return true;
+                    }
+                }
+            }
+        }
+
+        return false;
+    }
+
     /**
      * @param TestSessionMemento $sessionMemento
      */
@@ -882,4 +922,20 @@ protected function getSessionMemento()
     {
         return new TestSessionMemento($this);
     }
+
+    /**
+     * @throws common_exception_Error
+     * @throws InvalidServiceManagerException
+     */
+    private function getResultsStorage(): ReadableResultStorage
+    {
+        $resultServerService = $this->getServiceLocator()->get(ResultServerService::SERVICE_ID);
+        $storage = $resultServerService->getResultStorage();
+
+        if (!$storage instanceof ReadableResultStorage) {
+            throw new common_exception_Error('Configured result storage is not writable.');
+        }
+
+        return $storage;
+    }
 }

models/classes/event/ResultTestVariablesAfterTransmissionEvent.php

@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2023 (original work) Open Assessment Technologies SA;
+ */
+
+declare(strict_types=1);
+
+namespace oat\taoQtiTest\models\event;
+
+use oat\oatbox\event\Event;
+
+class ResultTestVariablesAfterTransmissionEvent implements Event
+{
+    private string $deliveryExecutionId;
+
+    private array $variables;
+    private bool $isManualScored;
+
+    public function __construct(
+        string $deliveryExecutionId,
+        array $variables,
+        bool $isManualScored
+    ) {
+        $this->deliveryExecutionId = $deliveryExecutionId;
+        $this->variables = $variables;
+        $this->isManualScored = $isManualScored;
+    }
+
+    public function getName(): string
+    {
+        return self::class;
+    }
+
+    public function getDeliveryExecutionId(): string
+    {
+        return $this->deliveryExecutionId;
+    }
+
+    public function getVariables(): array
+    {
+        return $this->variables;
+    }
+
+    public function getIsManualScored(): bool
+    {
+        return $this->isManualScored;
+    }
+}