• Plugins
  • Content Plugins
    • Dialog
    • Exit Messages
    • Feedback Modal Message
    • Feedback Inline Message
    • Modal Feedback
    • Feedback
    • Loading Bar
    • Overlay
    • Collapser
    • Rubric Block
  • Control Plugins
    • Connectivity Check
    • Duration Record
    • Progress Indicator
    • Test State
    • Timer Indicator
    • Title Indicator
  • Navigation Plugins
    • Navigation and review panel
    • Next button
    • Previous button
    • Skip button
    • Next section button
  • Security Plugins
    • Disable right click
  • Tools Plugins
    • Comment tool
    • Document Viewer
    • Item themes switcher
    • Calculator
    • Zoom
    • Highlighter
• Registry
  • Registry API
• Features

Plugins

Thanks to the modular architecture of the new Test Runner, most of the features are provided through plugins.

Plugins are gathered by categories, in order to facilitate their management. There is also a system of tags to complete the categories. Here is a list of the standard categories:

• content: plugins that deal with the test content
• controls: plugins that control the test
• navigation: plugins that provide tha navigation within the test
• security: plugins related to the test security
• tools: general purpose tools the test may offer

Some plugins can be configured through the platform options, as described in the dedicated chapter. The options related to each plugins are detailed with the documentation of the concerned plugin.

Plugins must be registered into a config file, that is managed by a TAO registry. Through the registry, plugins can be enabled or disabled for the whole platform.

A system of features also allows to enable/disable plugins per deliveries.

Content Plugins

Those plugins are intended to be related to the test content.

Dialog

Displays popups that requires user interactions. This plugin is required since it is responsible of the messages display.

• Since: v2.18.0
• Identifier: dialog
• Namespace: taoQtiTest/views/js/runner/plugins/content/dialog/dialog

• Events:

Exit Messages

Displays messages when a test taker leaves the test.

• Since: v2.30.0
• Identifier: exitMessages
• Namespace: taoQtiTest/runner/plugins/content/dialog/exitMessages

• Events:

Feedback Modal Message

Sub-plugin used by the QTI Feedback feature. Displays the feedback using a modal alert.

• Since: v5.10.0
• Identifier: itemAlertMessage
• Namespace: taoQtiTest/views/js/runner/plugins/content/dialog/itemAlertMessage

• Config: Set the TAO registry entry ['taoQtiItem/qtiRunner/core/QtiRunner']['inlineModalFeedback'] to false
• Events:

Feedback Inline Message

Sub-plugin used by the QTI Feedback feature. Displays the feedback by injecting inline messages inside the item.

• Since: v5.10.0
• Identifier: itemInlineMessage
• Namespace: taoQtiTest/views/js/runner/plugins/content/dialog/itemInlineMessage

• Config: Set the TAO registry entry ['taoQtiItem/qtiRunner/core/QtiRunner']['inlineModalFeedback'] to true
• Events:

Modal Feedback

Displays QTI feedback

• Since: v5.10.0
• Identifier: modalFeedback
• Namespace: taoQtiTest/runner/plugins/content/modalFeedback/modalFeedback

• Config:
  • Set the TAO registry entry ['taoQtiItem/qtiRunner/core/QtiRunner']['inlineModalFeedback'] either to true or false (for item authoring)
  • Set the TAO registry entry ['taoQtiTest/runner/plugins/content/modalFeedback/modalFeedback']['inlineModalFeedback'] either to true or false (for test runner)
• Events:

Feedback

Displays notifications into feedback popups.

• Since: v2.18.0
• Identifier: feedback
• Namespace: taoQtiTest/views/js/runner/plugins/content/feedback/feedback

• Events:

Loading Bar

Shows a loading bar when the test is loading

• Since: v2.32.0
• Identifier: loading
• Namespace: taoQtiTest/views/js/runner/plugins/content/loading/loading

• Events:

Overlay

Add an overlay over items when disabled

• Since: v2.18.0
• Identifier: overlay
• Namespace: taoQtiTest/runner/plugins/content/overlay/overlay

• Config:

  • plugins:
    • overlay: @since 2.26.0
      • full: When set to true, completely obfuscate the current item when displayed (default: false)

      'plugins' => [
          'overlay' => [
              'full' => false
          ],
      ],

• Events:

Collapser

Reduce the size of the tools when the available space is not enough

• Since: v5.5.0
• Identifier: collapser
• Namespace: taoQtiTest/runner/plugins/content/responsiveness/collapser

• Config:

  • plugins:
    • collapser:
      • collapseTools: When set to true, manage the size of the tools bar (default: true)
      • collapseNavigation: When set to true, manage the size of the navigation bar (default: false)
      • hover: When the buttons are reduced, allow an expand when the mouse is over a button (default: false)

      'plugins' => [
          'collapser' => [
              'collapseTools' => true,
              'collapseNavigation' => false,
              'hover' => false
          ]
      ],

• Events:

Rubric Block

Displays the test rubric blocks

• Since: v2.18.0
• Identifier: rubricBlock
• Namespace: taoQtiTest/runner/plugins/content/rubricBlock/rubricBlock

• Events:

Control Plugins

Those plugins are intended to provide a control on the test

Connectivity Check

Pauses the test when the network looses the connection

• Since: v2.32.0
• Identifier: connectivity
• Namespace: taoQtiTest/runner/plugins/controls/connectivity/connectivity

• Events:

Duration Record

Record accurately time spent by the test taker

• Since: v2.24.0
• Identifier: duration
• Namespace: taoQtiTest/runner/plugins/controls/duration/duration

• Events:

Progress Indicator

Displays the current progression within the test by using a progress bar.

• Since: v2.17.0
• Identifier: progressbar
• Namespace: taoQtiTest/runner/plugins/controls/progressbar/progressbar

• Config: Please refer to the Test Runner Options chapter
• Events:

Test State

Manage the test state. Detects if the test has been paused or finished, and then leave it. Also detects state inconsistency, then leave immediately the test.

• Since: v2.29.0
• Identifier: testState
• Namespace: taoQtiTest/runner/plugins/controls/testState/testState

• Events:

Timer Indicator

Manage the timers, triggers timeout Add countdown when remaining time

• Since: v2.18.0
• Identifier: timer
• Namespace: taoQtiTest/runner/plugins/controls/timer/timer

• Config: Please refer to the Test Runner Options chapter
• Events:

Title Indicator

Display the title of current test element

• Since: v2.17.0
• Identifier: title
• Namespace: taoQtiTest/runner/plugins/controls/title/title

• Events:

Navigation Plugins

Those plugins are intended to manage the navigation inside the test

Navigation and review panel

Displays and manage the navigation and review panel. It allows to jump to any reachable item, shows info and statistics about a particular scope. See the dedicated chapter about the options. It also allows to mark an item for later reviews.

• Since: v2.18.0
• Identifier: review
• Namespace: taoQtiTest/runner/plugins/navigation/review/review

• Events:

• API:

Next button

Moves to the next available item or finishes the test

• Since: v2.17.0
• Identifier: next
• Namespace: taoQtiTest/runner/plugins/navigation/next

• Events:

• API:

Previous button

Moves to the previously available item

• Since: v2.17.0
• Identifier: previous
• Namespace: taoQtiTest/runner/plugins/navigation/previous

• Events:

• API:

Skip button

Skips the current item, and move to the next available item or finishes the test. The button is displayed only if the current item does allow to skip (Authoring config).

• Since: v2.17.0
• Identifier: skip
• Namespace: taoQtiTest/runner/plugins/navigation/skip

• Events:

• API:

Next section button

Moves to the next available section or finishes the test. This plugin is configurable through platform and test options.

• Since: v2.17.0
• Identifier: nextSection
• Namespace: taoQtiTest/runner/plugins/navigation/nextSection

• Events:

• API:

Security Plugins

Those plugins are intended to enforce the security of the assessment test

Disable right click

Disables the right click and the context menu on items.

• Since: v3.1.0
• Identifier: disableRightClick
• Namespace: taoQtiTest/runner/plugins/security/disableRightClick

Tools Plugins

Those plugins are intended to provide a better user experience

Comment tool

Allows the test taker to comment an item. The button is displayed only if the current item does allow to comment (Authoring config).

• Since: v2.18.0
• Identifier: comment
• Namespace: taoQtiTest/runner/plugins/tools/comment/comment

• Events:

• API:

Document Viewer

Displays a document as requested by an event.

• Since: v5.29.0
• Identifier: documentViewer
• Namespace: taoQtiTest/runner/plugins/tools/documentViewer/documentViewer

• Events:

Item themes switcher

Allows to switch between themes through a menu listing the available themes. The list of available themes is configured on the platform.

• Since: v3.1.0
• Identifier: itemThemeSwitcher
• Namespace: taoQtiTest/runner/plugins/tools/itemThemeSwitcher/itemThemeSwitcher

• Events:

Calculator

Gives the student access to a basic calculator. The enabling of the calculator is done through a test option.

• Since: v2.28.0
• Identifier: calculator
• Namespace: taoQtiTest/runner/plugins/tools/calculator

• Events:

Zoom

Zoom in and out the item content

• Since: v3.1.0
• Identifier: zoom
• Namespace: taoQtiTest/runner/plugins/tools/zoom

• Events:

Highlighter

Allows a Test-Taker to mark passages of text in an Item.

• Since: v5.37.0
• Identifier: highlighter
• Namespace: taoQtiTest/runner/plugins/tools/highlighter

• Events:

Registry

• Since: v5.0.0

The plugins are now managed through a platform registry. This allows to manage the plugins platform wide and provide different plugins set per customer.

To register a plugin, through an install/update script (replace the content by yours):

use oat\taoTests\models\runner\plugins\PluginRegistry;
...
$registry = PluginRegistry::getRegistry();
$registry->register(TestPlugin::fromArray([
    'id' => 'pluginID',
    'name' => 'pluginName',
    'module' => 'path/to/the/plugin',
    'description' => 'The description of the plugin',
    'category' => 'aMainCategory',
    'active' => true|false,
    'tags' => [ 'some', 'tags' ]
]));
...

To gets the list of available and enabled plugins, you can now rely on the plugins service:

use oat\oatbox\service\ServiceManager;
use oat\taoTests\models\runner\plugins\TestPluginService;
...
$serviceManager = ServiceManager::getServiceManager();
$pluginService = $serviceManager->get(TestPluginService::CONFIG_ID);
...
$allPlugins = $pluginService->getAllPlugins();
...

Registry API

TestPluginService->getAllPlugins()

Retrieve the list of all available plugins (from the registry).

Returns: an array of TestPlugin instances

TestPluginService->getPlugin(string $id)

Retrieve a plugin by its identifier from the registry

Returns: The TestPlugin or null

TestPluginService->loadPlugin(array $data)

Load a test plugin from the given data.

Returns: The TestPlugin or null

TestPluginService->activatePlugin(TestPlugin $plugin)

Change the state of a plugin to active.

Returns: true if the process succeed, or false

TestPluginService->deactivatePlugin(TestPlugin $plugin)

Change the state of a plugin to inactive.

Returns: true if the process succeed, or false

Features

• Since: v5.28.O

In addition to the platform registry, it is possible to assign a set of plugins per deliveries through a features management. The features are also managed through a platform registry.

A the delivery level, the list of available features allow to enable/disable them. When a feature is disabled, the related plugins are removed for this delivery.

A feature is represented by a PHP class that lists the plugins targeted by the feature.

To create a feature you must inherit the class from \oat\taoTests\models\runner\features\TestRunnerFeature.

use oat\oatbox\service\ServiceManager;
use oat\taoTests\models\runner\features\TestRunnerFeature;
use oat\taoTests\models\runner\plugins\TestPluginService;

class MyFeature extends TestRunnerFeature
{
    public function __construct() {
        $serviceManager = ServiceManager::getServiceManager();
        $pluginService = $serviceManager->get(TestPluginService::CONFIG_ID);

        parent::__construct(
            'myFeature',                    // the inner name of the feature
            ['myPlugin'],                   // the list of plugins the feature contains
            true,                           // enabled by default
            $pluginService->getAllPlugins() // the list of available plugins provided by the plugins registry
        );
    }

    public function getLabel()
    {
        return __('MyFeature');
    }

    public function getDescription()
    {
        return __('A simple feature that rocks!');
    }
}

Then to publish your new feature, you still need to register it:

use oat\taoTests\models\runner\features\TestRunnerFeatureService;

class RegisterTestRunnerFeatures extends \common_ext_action_InstallAction
{
    public function __invoke($params)
    {
        $serviceManager = $this->getServiceManager();

        $testRunnerFeatureService = $serviceManager->get(TestRunnerFeatureService::SERVICE_ID);
        $testRunnerFeatureService->register(new MyFeature());

        $serviceManager->register(TestRunnerFeatureService::SERVICE_ID, $testRunnerFeatureService);

        return new \common_report_Report(\common_report_Report::TYPE_SUCCESS, 'Test runner features registered');
    }
}