chamilo
/
chamilo-lms
mirror of https://github.com/chamilo/chamilo-lms/tree/1.11.x
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Webservices: add new webservices BT#18673

Browse Source 
Add UNSUBSCRIBE_USER_TO_COURSE, GET_COURSES_FROM_EXTRA_FIELD,
DELETE_COURSE
pull/3859/head
Julio Montoya 4 years ago
parent 18569f01a8
commit dac68b2bd4
2 changed files with 85 additions and 19 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 52
      main/inc/lib/webservices/Rest.php
  2. 50
      main/webservices/api/v2.php

52
main/inc/lib/webservices/Rest.php
Unescape View File

@ -48,6 +48,7 @@ class Rest extends WebService
const SAVE_USER = 'save_user';
const SAVE_USER_JSON = 'save_user_json';
const SUBSCRIBE_USER_TO_COURSE = 'subscribe_user_to_course';
const UNSUBSCRIBE_USER_TO_COURSE = 'unsubscribe_user_to_course';
const EXTRAFIELD_GCM_ID = 'gcm_registration_id';
const GET_USER_MESSAGES_RECEIVED = 'user_messages_received';
const GET_USER_MESSAGES_SENT = 'user_messages_sent';
@ -59,6 +60,7 @@ class Rest extends WebService
const SAVE_SESSION = 'save_session';
const GET_USERS = 'get_users';
const GET_COURSES = 'get_courses';
const GET_COURSES_FROM_EXTRA_FIELD = 'get_courses_from_extra_field';
const ADD_COURSES_SESSION = 'add_courses_session';
const ADD_USERS_SESSION = 'add_users_session';
const CREATE_SESSION_FROM_MODEL = 'create_session_from_model';
@ -68,6 +70,7 @@ class Rest extends WebService
const USERNAME_EXIST = 'username_exist';
const GET_COURSE_QUIZ_MDL_COMPAT = 'get_course_quiz_mdl_compat';
const UPDATE_USER_PAUSE_TRAINING = 'update_user_pause_training';
const DELETE_COURSE = 'delete_course';
/**
* @var Session
@ -312,16 +315,14 @@ class Rest extends WebService
/**
* Get the user courses.
*
* @throws \Doctrine\ORM\TransactionRequiredException
* @throws \Doctrine\ORM\ORMException
* @throws \Doctrine\ORM\OptimisticLockException
*
* @return array
*/
public function getUserCourses()
public function getUserCourses($userId = 0): array
{
$courses = CourseManager::get_courses_list_by_user_id($this->user->getId());
if (empty($userId)) {
$userId = $this->user->getId();
}
$courses = CourseManager::get_courses_list_by_user_id($userId);
$data = [];
foreach ($courses as $courseInfo) {
@ -1245,12 +1246,8 @@ class Rest extends WebService
return $out;
}
/**
* @return array
*/
public function addCourse(array $courseParam)
public function addCourse(array $courseParam): array
{
$results = [];
$idCampus = isset($courseParam['id_campus']) ? $courseParam['id_campus'] : 1;
$title = isset($courseParam['title']) ? $courseParam['title'] : '';
$wantedCode = isset($courseParam['wanted_code']) ? $courseParam['wanted_code'] : null;
@ -1275,6 +1272,7 @@ class Rest extends WebService
$courseInfo = CourseManager::create_course($params, $params['user_id'], $idCampus);
$results = [];
if (!empty($courseInfo)) {
$results['status'] = true;
$results['code_course'] = $courseInfo['code'];
@ -1422,24 +1420,46 @@ class Rest extends WebService
$course_id = $params['course_id'];
$course_code = $params['course_code'];
$user_id = $params['user_id'];
$status = $params['status'] ?? STUDENT;
if (!$course_id && !$course_code) {
return [false];
}
if (!$course_code) {
$course_code = CourseManager::get_course_code_from_course_id($course_id);
}
if (CourseManager::subscribeUser($user_id, $course_code)) {
if (CourseManager::subscribeUser($user_id, $course_code, $status)) {
return [true];
} else {
}
return [false];
}
public function unSubscribeUserToCourse(array $params): array
{
$courseId = $params['course_id'];
$courseCode = $params['course_code'];
$userId = $params['user_id'];
if (!$courseId && !$courseCode) {
return [false];
}
if (!$courseCode) {
$courseCode = CourseManager::get_course_code_from_course_id($courseId);
}
if (CourseManager::unsubscribe_user($userId, $courseCode)) {
return [true];
}
return [false];
}
public function deleteUserMessage($messageId, $messageType)
{
if ($messageType === "sent") {
if ($messageType === 'sent') {
return MessageManager::delete_message_by_user_sender($this->user->getId(), $messageId);
} else {
return MessageManager::delete_message_by_user_receiver($this->user->getId(), $messageId);

50
main/webservices/api/v2.php
Unescape View File

@ -84,7 +84,6 @@ try {
}
$messageStatus = $action === Rest::POST_USER_MESSAGE_READ ? MESSAGE_STATUS_NEW : MESSAGE_STATUS_UNREAD;
$data = array_flip($messagesId);
foreach ($messagesId as $messageId) {
@ -98,7 +97,8 @@ try {
$restResponse->setData($data);
break;
case Rest::GET_USER_COURSES:
$courses = $restApi->getUserCourses();
$userId = isset($_REQUEST['user_id']) ? (int) $_REQUEST['user_id'] : 0;
$courses = $restApi->getUserCourses($userId);
$restResponse->setData($courses);
break;
case Rest::GET_COURSE_INFO:
@ -184,6 +184,10 @@ try {
$data = $restApi->subscribeUserToCourse($_POST);
$restResponse->setData($data);
break;
case Rest::UNSUBSCRIBE_USER_TO_COURSE:
$data = $restApi->unSubscribeUserToCourse($_POST);
$restResponse->setData($data);
break;
case Rest::CREATE_CAMPUS:
$data = $restApi->createCampusURL($_POST);
$restResponse->setData($data);
@ -208,6 +212,48 @@ try {
$data = $restApi->getCoursesCampus($_POST);
$restResponse->setData($data);
break;
case Rest::GET_COURSES_FROM_EXTRA_FIELD:
$variable = $_REQUEST['extra_field_variable'] ?? '';
$urlId = $_REQUEST['id_campus'] ?? '';
$extraField = new ExtraField('course');
$extraFieldInfo = $extraField->get_handler_field_info_by_field_variable($variable);
if (empty($extraFieldInfo)) {
throw new Exception("$variable not found");
}
$extraFieldValue = new ExtraFieldValue('course');
$items = $extraFieldValue->getValuesByFieldId($extraFieldInfo['id']);
$courseList = [];
foreach ($items as $item) {
$courseId = $item['item_id'];
if (UrlManager::relation_url_course_exist($courseId, $urlId)) {
$courseList[] = api_get_course_info($courseId);
}
}
$restResponse->setData($courseList);
break;
case Rest::DELETE_COURSE:
$courseCode = $_REQUEST['course_code'] ?? '';
$courseId = $_REQUEST['course_id'] ?? 0;
$course = [];
if (!empty($courseCode)) {
$course = api_get_course_info($courseCode);
}
if (empty($course) && !empty($courseId)) {
$course = api_get_course_info_by_id($courseId);
}
if (empty($course)) {
throw new Exception("Course doesn't exists");
}
$result = CourseManager::delete_course($course['code']);
$restResponse->setData(['status' => $result]);
break;
case Rest::ADD_COURSES_SESSION:
$data = $restApi->addCoursesSession($_POST);
$restResponse->setData($data);

Write Preview
Loading…
Cancel
Save