class.ilCmiXapiVerbList.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilCmiXapiVerbList
{
    public const COMPLETED = 'http://adlnet.gov/expapi/verbs/completed';
    public const PASSED = 'http://adlnet.gov/expapi/verbs/passed';
    public const FAILED = 'http://adlnet.gov/expapi/verbs/failed';
    public const SATISFIED = 'http://adlnet.gov/expapi/verbs/satisfied';
    public const PROGRESSED = 'http://adlnet.gov/expapi/verbs/progressed';
    public const EXPERIENCED = 'http://adlnet.gov/expapi/verbs/experienced';

    protected array $verbs = [
        'http://adlnet.gov/expapi/verbs/abandoned',
        'http://adlnet.gov/expapi/verbs/answered',
        'http://adlnet.gov/expapi/verbs/asked',
        'http://adlnet.gov/expapi/verbs/attempted',
        'http://adlnet.gov/expapi/verbs/attended',
        'http://adlnet.gov/expapi/verbs/commented',
        'http://adlnet.gov/expapi/verbs/completed',
        'http://adlnet.gov/expapi/verbs/exited',
        'http://adlnet.gov/expapi/verbs/experienced',
        'http://adlnet.gov/expapi/verbs/failed',
        'http://adlnet.gov/expapi/verbs/imported',
        'http://adlnet.gov/expapi/verbs/initialized',
        'http://adlnet.gov/expapi/verbs/interacted',
        'http://adlnet.gov/expapi/verbs/launched',
        'http://adlnet.gov/expapi/verbs/mastered',
        'http://adlnet.gov/expapi/verbs/passed',
        'http://adlnet.gov/expapi/verbs/preferred',
        'http://adlnet.gov/expapi/verbs/progressed',
        'http://adlnet.gov/expapi/verbs/registered',
        'http://adlnet.gov/expapi/verbs/responded',
        'http://adlnet.gov/expapi/verbs/resumed',
        'http://adlnet.gov/expapi/verbs/satisfied',
        'http://adlnet.gov/expapi/verbs/scored',
        'http://adlnet.gov/expapi/verbs/shared',
        'http://adlnet.gov/expapi/verbs/suspended',
        'http://adlnet.gov/expapi/verbs/terminated',
        'http://adlnet.gov/expapi/verbs/voided'
    ];

    public function isValidVerb(string $verb): bool
    {
        return true;//not necessary for dynamic verbs: in_array($verb, $this->verbs);
    }

    public function getVerbUri(string $verb): string
    {
        return 'http://adlnet.gov/expapi/verbs/' . $verb;
    }

    public function getDynamicSelectOptions(?array $verbs): array
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        $options = array(
            '' => $DIC->language()->txt('cmix_all_verbs')
        );

        if (is_array($verbs)) {
            foreach ($verbs as $verb) {
                $verb = $verb['_id'];
                $options[urlencode($verb)] = self::getVerbTranslation(
                    $DIC->language(),
                    $verb
                );
            }
        }

        return $options;
    }

    public function getSelectOptions(): array
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        $options = array(
            '' => $DIC->language()->txt('cmix_all_verbs')
        );

        foreach ($this->verbs as $verb) {
            $options[urlencode($verb)] = self::getVerbTranslation(
                $DIC->language(),
                $verb
            );
        }

        return $options;
    }

    public static function getVerbTranslation(ilLanguage $lng, string $verb): string
    {
        $verbMatch = preg_match('/\/([^\/]+)$/', $verb, $matches);
        $shortVerb = $matches[1];
        $langVar = preg_replace('/http(s)?:\/\//', '', $verb);
        $langVar = str_replace('.', '', $langVar);
        $langVar = str_replace('/', '_', $langVar);
        $langVar = 'cmix_' . $langVar;
        $translatedVerb = $lng->txt($langVar);
        // check no translation found?
        if (strpos($translatedVerb, '-cmix_') === 0) {
            return $shortVerb;
        } else {
            return $translatedVerb;
        }
    }

    public static function getInstance(): \ilCmiXapiVerbList
    {
        return new self();
    }
}