ilCourseLPBadge Class Reference

Inheritance diagram for ilCourseLPBadge:

Collaboration diagram for ilCourseLPBadge:

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

Detailed Description

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

Member Function Documentation

evaluate()

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

Evaluate if given user has earned badge.

Parameters

int	$a_user_id
array	$a_params
array	$a_config

Returns

bool

Implements ilBadgeAuto.

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

References ilObject\_lookupObjId(), ilLPStatus\_lookupStatus(), and ilLPStatus\LP_STATUS_COMPLETED_NUM.

    {
        $subitem_obj_ids = array();
        foreach ($a_config["subitems"] as $ref_id) {
            $subitem_obj_ids[$ref_id] = ilObject::_lookupObjId($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
            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;
    }

Here is the call graph for this function:

getCaption()

ilCourseLPBadge::getCaption

(

)

Get caption.

Returns

string

Implements ilBadgeType.

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

References $DIC, and $lng.

    {
        global $DIC;

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

getConfigGUIInstance()

ilCourseLPBadge::getConfigGUIInstance

(

)

Get GUI config instance.

Returns

ilBadgeTypeGUI|null

Implements ilBadgeType.

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

    {
        include_once "Modules/Course/classes/Badges/class.ilCourseLPBadgeGUI.php";
        return new ilCourseLPBadgeGUI();
    }

getId()

ilCourseLPBadge::getId

(

)

Get typ id (unique for component)

Returns

string

Implements ilBadgeType.

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

    {
        return "course_lp";
    }

getValidObjectTypes()

ilCourseLPBadge::getValidObjectTypes

(

)

Get valid (repository) "parent" object types.

Returns

array

Implements ilBadgeType.

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

    {
        return array("crs");
    }

isSingleton()

ilCourseLPBadge::isSingleton

(

)

Can only be created once?

Returns

bool

Implements ilBadgeType.

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

    {
        return false;
    }

---

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

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