ilCourseLPBadge Class Reference

Inheritance diagram for ilCourseLPBadge:

Collaboration diagram for ilCourseLPBadge:

Public Member Functions
	getId ()
	Get typ id (unique for component) More...
	getCaption ()
	isSingleton ()
	Can only be created once? More...
	getValidObjectTypes ()
	getConfigGUIInstance ()
	Get GUI config instance. More...
	evaluate (int $a_user_id, array $a_params, ?array $a_config)
	Evaluate if given user has earned badge. More...

Detailed Description

Definition at line 27 of file class.ilCourseLPBadge.php.

Member Function Documentation

evaluate()

ilCourseLPBadge::evaluate	(	int	$a_user_id,
		array	$a_params,
		?array	$a_config
	)

Evaluate if given user has earned badge.

Implements ilBadgeAuto.

Definition at line 60 of file class.ilCourseLPBadge.php.

References $ref_id, ilObject\_lookupObjId(), ilLPStatus\_lookupStatus(), ILIAS\Repository\int(), and ilLPStatus\LP_STATUS_COMPLETED_NUM.

                                                                               : 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 = (int) $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;
    }

Here is the call graph for this function:

getCaption()

ilCourseLPBadge::getCaption

(

)

Implements ilBadgeType.

Definition at line 34 of file class.ilCourseLPBadge.php.

References $DIC, and $lng.

                                : string
    {
        global $DIC;

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

getConfigGUIInstance()

ilCourseLPBadge::getConfigGUIInstance

(

)

Get GUI config instance.

Implements ilBadgeType.

Definition at line 55 of file class.ilCourseLPBadge.php.

                                          : ?ilBadgeTypeGUI
    {
        return new ilCourseLPBadgeGUI();
    }

getId()

ilCourseLPBadge::getId

(

)

Get typ id (unique for component)

Implements ilBadgeType.

Definition at line 29 of file class.ilCourseLPBadge.php.

                           : string
    {
        return 'course_lp';
    }

getValidObjectTypes()

ilCourseLPBadge::getValidObjectTypes

(

)

Returns

string[]

Implements ilBadgeType.

Definition at line 50 of file class.ilCourseLPBadge.php.

                                         : array
    {
        return ['crs'];
    }

isSingleton()

ilCourseLPBadge::isSingleton

(

)

Can only be created once?

Implements ilBadgeType.

Definition at line 42 of file class.ilCourseLPBadge.php.

                                 : bool
    {
        return false;
    }

---

The documentation for this class was generated from the following file:

• Modules/Course/classes/Badges/class.ilCourseLPBadge.php