oat-sa/tao-core

TAO core extension

v54.28.4 2024-12-19 14:00 UTC

Requires

• ext-json: *
• ext-mbstring: *
• composer/package-versions-deprecated: ^1.11
• doctrine/collections: ^1.6.7
• doctrine/dbal: ^2.10
• doctrine/migrations: ^3.4
• ezyang/htmlpurifier: ^4.9
• flow/jsonpath: ~0.5
• guzzlehttp/guzzle: ^7.0
• guzzlehttp/psr7: ^1.8.4
• jtl-software/opsgenie-client: ^2.0.2
• justinrainbow/json-schema: ^5.2.1
• league/csv: ^9.6
• league/openapi-psr7-validator: ~0.18
• oat-sa/composer-npm-bridge: ~0.4.2||dev-master
• oat-sa/generis: >=16.0.0
• oat-sa/imsglobal-lti: ^4.0.1
• oat-sa/jig: ~0.2
• oat-sa/oatbox-extension-installer: ~1.1||dev-master
• paragonie/random_compat: ^2.0
• phpdocumentor/reflection-docblock: ^5.2
• pimple/pimple: ^3.0
• psr/http-message: ~1.0
• slim/slim: ^3.0
• symfony/dotenv: ~4.3

GPL-2.0-only

• Open Assessment Technologies S.A.
• Jérôme Bogaerts
• Joel Bout
• Bertrand Chevrier
• Lionel Lecaque
• Patrick Plichart
• Dieter Raber
• Somsack Sipasseuth

• OAT
• TAO
• computer-based-assessment

README

• Task Queue Doc
• Middlewares Doc
• Feature Flag
• CSRF Tokens
• Client Config

Webhooks

Description

Webhooks allow you to send a request to remote server based on triggered event

How to use it

Register event webhook.

use command \oat\tao\scripts\tools\RegisterEventWebhook to register events that are implementing \oat\tao\model\webhooks\configEntity\WebhookInterface interface.

i.e:

$ php index.php 'oat\tao\scripts\tools\RegisterEventWebhook'
    \ -u "https://example.com"
    \ -m "POST"
    \ -e "<<Class FQN>>"

Check ACL Permissions

In order to check ACL permissions, you can use the PermissionChecker:

$permissionChecker = $this->getServiceLocator()->get(oat\tao\model\accessControl\PermissionChecker::class);

$permissionChecker->hasWriteAccess('resourceId');
$permissionChecker->hasReadAccess('resourceId');
$permissionChecker->hasGrantAccess('resourceId');

Important: It takes into consideration the current user in the session, if no user is provided.

Roles Access (rules and action permissions)

Description

Script allow you to apply (add)/revoke (remove) list of rules and/or permissions to a specific roles and actions.

How to use it

Execute the following command to apply (add) new rules/permissions:

$ php index.php 'oat\tao\scripts\tools\accessControl\SetRolesAccess' \
--config [config.json|json_string]

If you want to revoke (remove) them, add --revoke flag:

$ php index.php 'oat\tao\scripts\tools\accessControl\SetRolesAccess' \
--revoke \
--config [config.json|json_string]

Config example

{
  "rules": {
    "role": [
      {
        "ext": "extensionIdentifier",
        "mod": "actionControllerName",
        "act": "actionMethodName"
      }
    ]
  },
  "permissions": {
    "controller": {
      "action": {
        "rule1": "READ",
        "rule2": "WRITE"
      }
    }
  }
}

Environment variables

Here you can find the environment variables including feature flags

Routing

Check more information about actions/controllers and routing here

Observer implementations

Check the current observer implementations here