/**
* unsubscribe a specific user from a specific course
*
*
* @param int $user_id user ID from the course_user table
* @param mixed (string or array) $courseCodeList course sys code
* @param boolean $force true possible to remove a course admin from course
* (default false)
* @param boolean $deleteTrackingData (default false)
*
* @return boolean TRUE if unsubscribtion succeed
* boolean FALSE otherwise.
*/
function user_remove_from_course($userId, $courseCodeList = array(), $force = false, $delTrackData = false, $class_id = null)
{
if (!is_array($courseCodeList)) {
$courseCodeList = array($courseCodeList);
}
if ($class_id) {
$claroClass = new Claro_Class();
$claroClass->load($class_id);
} else {
$claroClass = null;
}
$allWorksWell = true;
foreach ($courseCodeList as $courseCode) {
$course = new Claro_Course($courseCode);
$course->load();
$userCourseRegistration = new Claro_CourseUserRegistration(AuthProfileManager::getUserAuthProfile($userId), $course);
if ($force) {
$userCourseRegistration->forceUnregistrationOfManager();
}
if (!is_null($claroClass)) {
$userCourseRegistration->setClass($claroClass);
}
$keepTrackingData = !$delTrackData;
if (!$userCourseRegistration->removeUser($keepTrackingData, array())) {
Console::warning("Cannot remove user {$userId} from {$courseCode}");
$allWorksWell = false;
}
}
return $allWorksWell;
}
