/**
* Subscribe a specific user to a specific course. If this course is a session
* course, the user will also be subscribed to the source course.
*
* Helper for Claro_CourseUserRegistration
*
* @param int $userId user ID from the course_user table
* @param string $courseCode course code from the cours table
* @param boolean $admin
* @param boolean $tutor
* @param int $class_id
* @return boolean TRUE if it succeeds, FALSE otherwise
*/
function user_add_to_course($userId, $courseCode, $admin = false, $tutor = false, $class_id = null)
{
$courseObj = new Claro_Course($courseCode);
$courseObj->load();
$courseRegistration = new Claro_CourseUserRegistration(AuthProfileManager::getUserAuthProfile($userId), $courseObj, null, null);
if ($admin) {
$courseRegistration->setCourseAdmin();
}
if ($tutor) {
$courseRegistration->setCourseTutor();
}
if ($class_id) {
$claroClass = new Claro_Class();
$claroClass->load($class_id);
$courseRegistration->setClass($claroClass);
}
$courseRegistration->ignoreRegistrationKeyCheck();
if ($courseRegistration->addUser()) {
return true;
} else {
// @todo should throw an exception here
Console::error("Cannot register user {$userId} in course {$courseCode} [" . $courseRegistration->getStatus() . ":" . $courseRegistration->getErrorMessage() . "]");
return false;
}
}
/**
* insert or update course data
*
* @return boolean success
*/
public function save()
{
if (empty($this->courseId)) {
// Insert
$keys = define_course_keys($this->officialCode, '', get_conf('dbNamePrefix'));
$courseSysCode = trim($keys['currentCourseId']);
$courseDbName = trim($keys['currentCourseDbName']);
$courseDirectory = trim($keys['currentCourseRepository']);
if (empty($courseSysCode) || empty($courseDbName) || empty($courseDirectory)) {
throw new Exception("Error missing data for course {$this->officialCode}");
}
if (!$this->useExpirationDate) {
$this->expirationDate = 'NULL';
}
// Session courses are created without categories links:
// so we duplicate the source course's categories links
/*if ( !is_null($this->sourceCourseId) && !empty($this->sourceCourseId) )
{
$sourceCourse = new claroCourse();
$sourceCourse->load(claroCourse::getCodeFromId($this->sourceCourseId));
$this->categories = $sourceCourse->categories;
}*/
if (!is_null($this->sourceCourseId) && !empty($this->sourceCourseId)) {
$sourceCourse = new claroCourse();
$sourceCourse->load(claroCourse::getCodeFromId($this->sourceCourseId));
if ($sourceCourse->sourceCourseId) {
throw new Exception('You cannot create a course session from another course session');
}
}
if (prepare_course_repository($courseDirectory, $courseSysCode) && register_course($courseSysCode, $this->officialCode, $this->sourceCourseId, $courseDirectory, $courseDbName, $this->titular, $this->email, $this->categories, $this->title, $this->language, $GLOBALS['_uid'], $this->access, $this->registration, $this->registrationKey, $this->visibility, $this->departmentName, $this->extLinkUrl, $this->publicationDate, $this->expirationDate, $this->status, $this->userLimit) && install_course_database($courseDbName) && install_course_tools($courseDbName, $this->language, $courseDirectory)) {
$courseObj = new Claro_Course($courseSysCode);
$courseObj->load();
$courseRegistration = new Claro_CourseUserRegistration(AuthProfileManager::getUserAuthProfile($GLOBALS['_uid']), $courseObj, null, null);
$courseRegistration->ignoreRegistrationKeyCheck();
$courseRegistration->ignoreCategoryRegistrationCheck();
$courseRegistration->setCourseAdmin();
$courseRegistration->setCourseTutor();
$courseRegistration->forceSuperUser();
if ($courseRegistration->addUser()) {
// Set course id
$this->courseId = $courseSysCode;
// Notify event manager
$args['courseSysCode'] = $courseSysCode;
$args['courseDbName'] = $courseDbName;
$args['courseDirectory'] = $courseDirectory;
$args['courseCategory'] = $this->categories;
$GLOBALS['eventNotifier']->notifyEvent("course_created", $args);
return true;
} else {
$this->backlog->failure($courseRegistration->getErrorMessage());
return false;
}
} else {
$lastFailure = claro_failure::get_last_failure();
$this->backlog->failure('Error : ' . $lastFailure);
return false;
}
} else {
// Update
$tbl_mdb_names = claro_sql_get_main_tbl();
$tbl_course = $tbl_mdb_names['course'];
$tbl_cdb_names = claro_sql_get_course_tbl();
$tbl_course_properties = $tbl_cdb_names['course_properties'];
if (!$this->useExpirationDate) {
$this->expirationDate = null;
}
$sqlExpirationDate = is_null($this->expirationDate) ? 'NULL' : 'FROM_UNIXTIME(' . claro_sql_escape($this->expirationDate) . ')';
$sqlCreationDate = is_null($this->publicationDate) ? 'NULL' : 'FROM_UNIXTIME(' . claro_sql_escape($this->publicationDate) . ')';
$sql = "UPDATE `" . $tbl_course . "`\n SET `intitule` = '" . claro_sql_escape($this->title) . "',\n `titulaires` = '" . claro_sql_escape($this->titular) . "',\n `administrativeNumber` = '" . claro_sql_escape($this->officialCode) . "',\n `language` = '" . claro_sql_escape($this->language) . "',\n `extLinkName` = '" . claro_sql_escape($this->departmentName) . "',\n `extLinkUrl` = '" . claro_sql_escape($this->extLinkUrl) . "',\n `email` = '" . claro_sql_escape($this->email) . "',\n `visibility` = '" . ($this->visibility ? 'visible' : 'invisible') . "',\n `access` = '" . claro_sql_escape($this->access) . "',\n `registration` = '" . claro_sql_escape($this->registration) . "',\n `registrationKey` = '" . claro_sql_escape($this->registrationKey) . "',\n `lastEdit` = NOW(),\n `creationDate` = " . $sqlCreationDate . ",\n `expirationDate` = " . $sqlExpirationDate . ",\n `status` = '" . claro_sql_escape($this->status) . "',\n `userLimit` = '" . (int) $this->userLimit . "'\n WHERE code='" . claro_sql_escape($this->courseId) . "'";
// Handle categories
// 1/ Remove all links in database
$this->unlinkCategories();
// 2/ Link new categories selection
$this->linkCategories($this->categories);
// If it's a source course, do the same for all its session courses
if ($this->isSourceCourse) {
$sql2 = "SELECT cours_id FROM `" . $tbl_course . "`\n WHERE sourceCourseId = " . $this->id;
$sessionCourses = claro_sql_query_fetch_all_rows($sql2);
foreach ($sessionCourses as $sessionCourse) {
unlink_course_categories($sessionCourse['cours_id']);
link_course_categories($sessionCourse['cours_id'], $this->categories);
}
}
return claro_sql_query($sql);
}
}
// end if ($cmd == 'exUnreg')
/*----------------------------------------------------------------------------
Subscribe to a course
----------------------------------------------------------------------------*/
if ($cmd == 'exReg') {
$registrationKey = isset($_REQUEST['registrationKey']) ? $_REQUEST['registrationKey'] : null;
$categoryId = isset($_REQUEST['categoryId']) ? $_REQUEST['categoryId'] : null;
$courseObj = new Claro_Course($courseCode);
$courseObj->load();
$courseRegistration = new Claro_CourseUserRegistration(AuthProfileManager::getUserAuthProfile($userId), $courseObj, $registrationKey, $categoryId);
if (!empty($classId)) {
$claroClass = new Claro_Class();
$claroClass->load($classId);
$courseRegistration->setClass($claroClass);
}
if ($courseRegistration->addUser()) {
$claroline->log('COURSE_SUBSCRIBE', array('user' => $userId, 'course' => $courseCode));
$displayMode = DISPLAY_MESSAGE_SCREEN;
if (claro_get_current_user_id() != $uidToEdit) {
// Message for admin
$dialogBox->success(get_lang('The user has been enroled to the course'));
} else {
$dialogBox->success(get_lang('You\'ve been enroled on the course'));
}
$properties = array();
if ($asTeacher && claro_is_platform_admin()) {
$properties['isCourseManager'] = 1;
$properties['role'] = get_lang('Course manager');
$properties['tutor'] = 1;
user_set_course_properties($userId, $courseCode, $properties);
}
