tool.md

ACS Tool - Assessment Control Service client

How to use the AcsServiceClient to perform authenticated ACS service calls as a tool.

Table of contents

• Features
• Usage

Features

This library provides a AcsServiceClient (based on the core LtiServiceClient) that allow sending ACS controls to a platform.

Usage

Send an ACS control

<?php

use OAT\Library\Lti1p3Core\Message\Payload\LtiMessagePayloadInterface;
use OAT\Library\Lti1p3Core\Registration\RegistrationRepositoryInterface;
use OAT\Library\Lti1p3Proctoring\Model\AcsControl;
use OAT\Library\Lti1p3Proctoring\Model\AcsControlResultInterface;
use OAT\Library\Lti1p3Proctoring\Service\Client\AcsServiceClient;

// Related registration
/** @var RegistrationRepositoryInterface $registrationRepository */
$registration = $registrationRepository->find(...);

// Related LTI 1.3 message payload
/** @var LtiMessagePayloadInterface $payload */
$payload  = ...;

$acsClient = new AcsServiceClient();

$control = new AcsControl(...);

/** @var AcsControlResultInterface $controlResult */
$controlResult = $acsClient->sendControlForPayload(
    $registration,  // [required] as the tool, it will call the platform of this registration
    $control,       // [required] with provided ACS control
    $payload        // [required] from the LTI message payload containing the ACS claim (got at LTI launch)

);

// you also can send a control for an ACS claim
$controlResult = $acsClient->sendControlForClaim(
    $registration,         // [required] as the tool, it will call the platform of this registration
    $control,              // [required] with provided ACS control
    $payload->getAcs()     // [required] from the ACS claim (got at LTI launch)

);

// or you also can send a control to an given URL
/** @var AcsControlResultInterface $controlResult */
$controlResult = $acsClient->sendControl(
    $registration,              // [required] as the tool, it will call the platform of this registration
    $control,                   // [required] with provided ACS control
    'https://platform.com/acs'  // [required] to a given ACS service url
);

// Control result status
echo $controlResult->getStatus();

// Control result extra time (if given)
echo $controlResult->getExtraTime();