L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-30072 - Notes, Webservices - adding Webservices for notes

Browse Source
This commit is contained in:
Jason Fowler
2013-02-22 13:58:11 +08:00
parent f29e62cb6c
commit 34348b2b43
9 changed files with 480 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
notes/externallib.php
+260 -22
View File
@@ -53,11 +53,7 @@ class core_notes_external extends external_api {
'publishstate' => new external_value(PARAM_ALPHA, '\'personal\', \'course\' or \'site\''),
'courseid' => new external_value(PARAM_INT, 'course id of the note (in Moodle a note can only be created into a course, even for site and personal notes)'),
'text' => new external_value(PARAM_RAW, 'the text of the message - text or HTML'),
'format' => new external_value(PARAM_ALPHANUMEXT, // For backward compatibility it can not be PARAM_INT, so we don't use external_format_value.
'text format (' . FORMAT_HTML . ' = HTML, '
. FORMAT_MOODLE . ' = MOODLE, '
. FORMAT_PLAIN . ' = PLAIN or '
. FORMAT_MARKDOWN . ' = MARKDOWN)', VALUE_DEFAULT, FORMAT_HTML),
'format' => new external_format_value('text', VALUE_DEFAULT),
'clientnoteid' => new external_value(PARAM_ALPHANUMEXT, 'your own client id for the note. If this id is provided, the fail message id will be returned to you', VALUE_OPTIONAL),
)
)
@@ -81,19 +77,19 @@ class core_notes_external extends external_api {
$params = self::validate_parameters(self::create_notes_parameters(), array('notes' => $notes));
//check if note system is enabled
// Check if note system is enabled.
if (!$CFG->enablenotes) {
throw new moodle_exception('notesdisabled', 'notes');
}
//retrieve all courses
// Retrieve all courses.
$courseids = array();
foreach($params['notes'] as $note) {
$courseids[] = $note['courseid'];
}
$courses = $DB->get_records_list("course", "id", $courseids);
//retrieve all users of the notes
// Retrieve all users of the notes.
$userids = array();
foreach($params['notes'] as $note) {
$userids[] = $note['userid'];
@@ -105,32 +101,32 @@ class core_notes_external extends external_api {
foreach ($params['notes'] as $note) {
$success = true;
$resultnote = array(); //the infos about the success of the operation
$resultnote = array(); // The infos about the success of the operation.
//check the course exists
// Check the course exists.
if (empty($courses[$note['courseid']])) {
$success = false;
$errormessage = get_string('invalidcourseid', 'error');
} else {
// Ensure the current user is allowed to run this function
// Ensure the current user is allowed to run this function.
$context = context_course::instance($note['courseid']);
self::validate_context($context);
require_capability('moodle/notes:manage', $context);
}
//check the user exists
// Check the user exists.
if (empty($users[$note['userid']])) {
$success = false;
$errormessage = get_string('invaliduserid', 'notes', $note['userid']);
}
//build the resultnote
// Build the resultnote.
if (isset($note['clientnoteid'])) {
$resultnote['clientnoteid'] = $note['clientnoteid'];
}
if ($success) {
//now we can create the note
// Now we can create the note.
$dbnote = new stdClass;
$dbnote->courseid = $note['courseid'];
$dbnote->userid = $note['userid'];
@@ -148,7 +144,7 @@ class core_notes_external extends external_api {
$dbnote->content = $note['text'];
$dbnote->format = $textformat;
//get the state ('personal', 'course', 'site')
// Get the state ('personal', 'course', 'site').
switch ($note['publishstate']) {
case 'personal':
$dbnote->publishstate = NOTES_STATE_DRAFT;
@@ -164,11 +160,8 @@ class core_notes_external extends external_api {
break;
}
//TODO MDL-31119 performance improvement - if possible create a bulk functions for saving multiple notes at once
if (note_save($dbnote)) { //note_save attribut an id in case of success
add_to_log($dbnote->courseid, 'notes', 'add',
'index.php?course='.$dbnote->courseid.'&user='.$dbnote->userid
. '#note-' . $dbnote->id , 'add note');
// TODO MDL-31119 performance improvement - if possible create a bulk functions for saving multiple notes at once
if (note_save($dbnote)) { // Note_save attribut an id in case of success.
$success = $dbnote->id;
}
@@ -198,13 +191,258 @@ class core_notes_external extends external_api {
new external_single_structure(
array(
'clientnoteid' => new external_value(PARAM_ALPHANUMEXT, 'your own id for the note', VALUE_OPTIONAL),
'noteid' => new external_value(PARAM_INT, 'test this to know if it success: id of the created note when successed, -1 when failed'),
'noteid' => new external_value(PARAM_INT, 'test this to know if it success: id of the created note when successed, -1 when failed'),
'errormessage' => new external_value(PARAM_TEXT, 'error message - if failed', VALUE_OPTIONAL)
)
)
);
}
/**
* Returns description of delete_notes parameters
*
* @return external_function_parameters
* @since Moodle 2.5
*/
public static function delete_notes_parameters() {
return new external_function_parameters(
array(
"notes"=> new external_multiple_structure(
new external_value(PARAM_INT, 'ID of the note to be retrieved'), 'Array of Note Ids to be deleted.'
)
)
);
}
/**
* Delete notes about users.
* Note: code should be matching the /notes/delete.php checks.
*
* @param array $notes An array of ids for the notes to delete.
* @return null
* @since Moodle 2.5
*/
public static function delete_notes($notes = array()) {
global $CFG;
require_once($CFG->dirroot . "/notes/lib.php");
$params = self::validate_parameters(self::delete_notes_parameters(), $notes);
// Check if note system is enabled.
if (!$CFG->enablenotes) {
throw new moodle_exception('notesdisabled', 'notes');
}
$warnings = array();
foreach ($params['notes'] as $noteid) {
$note = note_load($noteid);
if (isset($note->id)) {
// Ensure the current user is allowed to run this function.
$context = context_course::instance($note->courseid);
self::validate_context($context);
require_capability('moodle/notes:manage', $context);
if (!note_delete($note)) {
$warnings[] = array(array('item'=>'note', 'itemid'=>$noteid, 'warningcode'=>'savedfailed', 'message'=>'Note could not be modified'));
}
} else {
$warnings[] = array('item'=>'note', 'itemid'=>$noteid, 'warningcode'=>'badid', 'message'=>'Note does not exist');
}
}
return $warnings;
}
/**
* Returns description of delete_notes result value.
*
* @return external_description
* @since Moodle 2.5
*/
public static function delete_notes_returns() {
return new external_warnings('item is always \'note\'',
'When errorcode is savedfailed the note could not be modified.' .
'When errorcode is badparam, an incorrect parameter was provided.' .
'When errorcode is badid, the note does not exist',
'errorcode can be badparam (incorrect parameter), savedfailed (could not be modified), or badid (note does not exist)');
}
/**
* Returns description of get_notes parameters.
*
* @return external_function_parameters
* @since Moodle 2.5
*/
public static function get_notes_parameters() {
return new external_function_parameters(
array(
"notes"=> new external_multiple_structure(
new external_value(PARAM_INT, 'ID of the note to be retrieved'), 'Array of Note Ids to be retrieved.'
)
)
);
}
/**
* Get notes about users.
*
* @param array $notes An array of ids for the notes to retrieve.
* @return null
* @since Moodle 2.5
*/
public static function get_notes($notes) {
global $CFG;
require_once($CFG->dirroot . "/notes/lib.php");
$params = self::validate_parameters(self::get_notes_parameters(), $notes);
// Check if note system is enabled.
if (!$CFG->enablenotes) {
throw new moodle_exception('notesdisabled', 'notes');
}
$resultnotes = array();
foreach ($params['notes'] as $noteid) {
$resultnote = array();
$note = note_load($noteid);
if (isset($note->id)) {
// Ensure the current user is allowed to run this function.
$context = context_course::instance($note->courseid);
self::validate_context($context);
require_capability('moodle/notes:view', $context);
list($gotnote['text'], $gotnote['format']) = external_format_text($note->content, $note->format, $context->id, 'notes', '', '');
$gotnote['noteid'] = $note->id;
$gotnote['userid'] = $note->userid;
$gotnote['publishstate'] = $note->publishstate;
$gotnote['courseid'] = $note->courseid;
$resultnotes["notes"][] = $gotnote;
} else {
$resultnotes["warnings"][] = array('item'=>'note', 'itemid'=>$noteid, 'warningcode'=>'badid', 'message'=>'Note does not exist');
}
}
return $resultnotes;
}
/**
* Returns description of get_notes result value.
*
* @return external_description
* @since Moodle 2.5
*/
public static function get_notes_returns() {
return new external_single_structure(
array(
'notes' => new external_multiple_structure(
new external_single_structure(
array(
'noteid' => new external_value(PARAM_INT, 'id of the note', VALUE_OPTIONAL),
'userid' => new external_value(PARAM_INT, 'id of the user the note is about', VALUE_OPTIONAL),
'publishstate' => new external_value(PARAM_ALPHA, '\'personal\', \'course\' or \'site\'', VALUE_OPTIONAL),
'courseid' => new external_value(PARAM_INT, 'course id of the note', VALUE_OPTIONAL),
'text' => new external_value(PARAM_RAW, 'the text of the message - text or HTML', VALUE_OPTIONAL),
'format' => new external_format_value('text', VALUE_OPTIONAL),
), 'note'
)
),
'warnings' => new external_warnings('item is always \'note\'',
'When errorcode is savedfailed the note could not be modified.' .
'When errorcode is badparam, an incorrect parameter was provided.' .
'When errorcode is badid, the note does not exist',
'errorcode can be badparam (incorrect parameter), savedfailed (could not be modified), or badid (note does not exist)')
)
);
}
/**
* Returns description of update_notes parameters.
*
* @return external_function_parameters
* @since Moodle 2.5
*/
public static function update_notes_parameters() {
return new external_function_parameters(
array(
'notes' => new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'id of the note'),
'publishstate' => new external_value(PARAM_ALPHA, '\'personal\', \'course\' or \'site\''),
'text' => new external_value(PARAM_RAW, 'the text of the message - text or HTML'),
'format' => new external_format_value('text', VALUE_DEFAULT),
)
), "Array of Notes", VALUE_DEFAULT, array()
)
)
);
}
/**
* Update notes about users.
*
* @param array $notes An array of ids for the notes to update.
* @return array fail infos.
* @since Moodle 2.2
*/
public static function update_notes($notes = array()) {
global $CFG, $DB;
require_once($CFG->dirroot . "/notes/lib.php");
$params = self::validate_parameters(self::update_notes_parameters(), array('notes' => $notes));
// Check if note system is enabled.
if (!$CFG->enablenotes) {
throw new moodle_exception('notesdisabled', 'notes');
}
$warnings = array();
foreach ($params['notes'] as $note) {
$notedetails = note_load($note['id']);
if (isset($notedetails->id)) {
// Ensure the current user is allowed to run this function.
$context = context_course::instance($notedetails->courseid);
self::validate_context($context);
require_capability('moodle/notes:manage', $context);
$dbnote = new stdClass;
$dbnote->id = $note['id'];
$dbnote->content = $note['text'];
$dbnote->format = external_validate_format($note['format']);
// Get the state ('personal', 'course', 'site').
switch ($note['publishstate']) {
case 'personal':
$dbnote->publishstate = NOTES_STATE_DRAFT;
break;
case 'course':
$dbnote->publishstate = NOTES_STATE_PUBLIC;
break;
case 'site':
$dbnote->publishstate = NOTES_STATE_SITE;
$dbnote->courseid = SITEID;
break;
default:
$warnings[] = array('item'=>'note', 'itemid'=>$note["id"], 'warningcode'=>'badparam', 'message'=>'Provided publishstate incorrect');
break;
}
if (!note_save($dbnote)) {
$warnings[] = array('item'=>'note', 'itemid'=>$note["id"], 'warningcode'=>'savedfailed', 'message'=>'Note could not be modified');
}
} else {
$warnings[] = array('item'=>'note', 'itemid'=>$note["id"], 'warningcode'=>'badid', 'message'=>'Note does not exist');
}
}
return $warnings;
}
/**
* Returns description of update_notes result value.
*
* @return external_description
* @since Moodle 2.5
*/
public static function update_notes_returns() {
return new external_warnings('item is always \'note\'',
'When errorcode is savedfailed the note could not be modified.' .
'When errorcode is badparam, an incorrect parameter was provided.' .
'When errorcode is badid, the note does not exist',
'errorcode can be badparam (incorrect parameter), savedfailed (could not be modified), or badid (note does not exist)');
}
}
/**
@@ -262,4 +500,4 @@ class moodle_notes_external extends external_api {
return core_notes_external::create_notes_returns();
}
}
}