class.ilCourseLPBadge.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilCourseLPBadge implements ilBadgeType, ilBadgeAuto
{
    public function getId(): string
    {
        return 'course_lp';
    }

    public function getCaption(): string
    {
        global $DIC;

        $lng = $DIC['lng'];
        return $lng->txt('badge_course_lp');
    }

    public function isSingleton(): bool
    {
        return false;
    }

    public function getValidObjectTypes(): array
    {
        return ['crs'];
    }

    public function getConfigGUIInstance(): ?ilBadgeTypeGUI
    {
        return new ilCourseLPBadgeGUI();
    }

    public function evaluate(int $a_user_id, array $a_params, ?array $a_config): bool
    {
        $subitem_obj_ids = [];

        if ($a_config !== null && isset($a_config['subitems'])) {
            foreach ($a_config['subitems'] as $ref_id) {
                $subitem_obj_ids[$ref_id] = ilObject::_lookupObjId((int) $ref_id);
            }
        }

        $trigger_subitem_id = $a_params['obj_id'];

        // relevant for current badge instance?
        if (in_array($trigger_subitem_id, $subitem_obj_ids)) {
            $completed = true;

            // check if all subitems are completed now
            if ($a_config !== null && isset($a_config['subitems'])) {
                foreach ($a_config['subitems'] as $subitem_id) {
                    $subitem_obj_id = $subitem_obj_ids[$subitem_id];
                    if (ilLPStatus::_lookupStatus($subitem_obj_id, $a_user_id) !== ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                        $completed = false;
                        break;
                    }
                }
            }

            return $completed;
        }

        return false;
    }
}