ApiHook.php

Go to the documentation of this file.

<?php
 
namespace ILIAS\LTI\ToolProvider\ApiHook;
 
trait ApiHook
{
    public static string $USER_ID_HOOK = "UserId";
 
    public static string $CONTEXT_ID_HOOK = "ContextId";
 
    public static string $GROUPS_SERVICE_HOOK = "Groups";
 
    public static string $MEMBERSHIPS_SERVICE_HOOK = "Memberships";
 
    public static string $OUTCOMES_SERVICE_HOOK = "Outcomes";
 
    public static string $TOOL_SETTINGS_SERVICE_HOOK = "ToolSettings";
 
    public static string $ACCESS_TOKEN_SERVICE_HOOK = "AccessToken";
 
    private static array $API_HOOKS = array();
 
    public static function registerApiHook(string $hookName, string $familyCode, string $className)
    {
        $objectClass = get_class();
        self::$API_HOOKS["{$objectClass}-{$hookName}-{$familyCode}"] = $className;
    }
 
    private static function getApiHook(string $hookName, string $familyCode)
    {
        $class = self::class;
        return self::$API_HOOKS["{$class}-{$hookName}-{$familyCode}"];
    }
 
    private static function hasApiHook(string $hookName, string $familyCode): bool
    {
        $class = self::class;
        return isset(self::$API_HOOKS["{$class}-{$hookName}-{$familyCode}"]);
    }
 
    private static function hasConfiguredApiHook(string $hookName, string $familyCode, $sourceObject): bool
    {
        $ok = false;
        $class = self::class;
        if (isset(self::$API_HOOKS["{$class}-{$hookName}-{$familyCode}"])) {
            $className = self::$API_HOOKS["{$class}-{$hookName}-{$familyCode}"];
            $hook = new $className($sourceObject);
            $ok = $hook->isConfigured();
        }
 
        return $ok;
    }
}