mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-14 04:52:36 +02:00
Code Issues Projects Releases Wiki Activity

MDL-49203 webservices: Coding style fixes, ws added to the app service

Browse Source
This commit is contained in:
Juan Leyva 2015-03-16 12:31:53 +01:00
parent be9854162f
commit e77a0f368f
2 changed files with 30 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
comment/classes/external.php
View File

@ -47,29 +47,29 @@ class core_comment_external extends external_api {
return new external_function_parameters(
array(
'contextlevel' => new external_value(PARAM_ALPHA, 'contextlevel'),
'instanceid' => new external_value(PARAM_INT, 'The Instance id of item associated with the context level'),
'contextlevel' => new external_value(PARAM_ALPHA, 'contextlevel system, course, user...'),
'instanceid' => new external_value(PARAM_INT, 'the Instance id of item associated with the context level'),
'component' => new external_value(PARAM_COMPONENT, 'component'),
'itemid' => new external_value(PARAM_INT, 'associated id'),
'area' => new external_value(PARAM_TEXT, 'string comment area', VALUE_DEFAULT, ''),
'page' => new external_value(PARAM_INT, 'page number', VALUE_DEFAULT, 0),
'area' => new external_value(PARAM_AREA, 'string comment area', VALUE_DEFAULT, ''),
'page' => new external_value(PARAM_INT, 'page number (0 based)', VALUE_DEFAULT, 0),
)
);
}
/**
* Get comments
* Return a list of comments
*
* @param string $contextlevel ('context_course', etc..)
* @param int $instanceid (eg. the 'id' in the 'book' table)
* @param string $contextlevel ('system, course, user', etc..)
* @param int $instanceid
* @param string $component the name of the component
* @param int $itemid the item id
* @param string|null $area
* @param string $area comment area
* @param int $page page number
* @return array of comments and warnings
* @since Moodle 2.9
*/
public static function get_comments($contextlevel, $instanceid, $component, $itemid, $area='', $page=0) {
public static function get_comments($contextlevel, $instanceid, $component, $itemid, $area = '', $page = 0) {
$warnings = array();
$arrayparams = array(
@ -94,21 +94,21 @@ class core_comment_external extends external_api {
$args->component = $params['component'];
$commentobject = new comment($args);
$comments = $commentobject->get_comments($arrayparams['page']);
$comments = $commentobject->get_comments($params['page']);
// False means no permissions to see comments.
if ($comments === false) {
throw new moodle_exception('nopermissions', 'error', '', 'view comments');
}
foreach ($comments as &$comment) {
foreach ($comments as $key => $comment) {
list($comment->content, $comment->format) = external_format_text($comment->content,
$comment->format,
$context->id,
$params['component'],
'',
0);
$comment = (array)$comment;
list($comments[$key]->content, $comments[$key]->format) = external_format_text($comment->content,
$comment->format,
$context->id,
$params['component'],
'',
0);
}
$results = array(
@ -134,10 +134,10 @@ class core_comment_external extends external_api {
'content' => new external_value(PARAM_RAW, 'The content text formated'),
'format' => new external_format_value('content'),
'timecreated' => new external_value(PARAM_INT, 'Time created (timestamp)'),
'strftimeformat' => new external_value(PARAM_RAW, 'Time format'),
'strftimeformat' => new external_value(PARAM_NOTAGS, 'Time format'),
'profileurl' => new external_value(PARAM_URL, 'URL profile'),
'fullname' => new external_value(PARAM_TEXT, 'fullname'),
'time' => new external_value(PARAM_RAW, 'Time in human format'),
'fullname' => new external_value(PARAM_NOTAGS, 'fullname'),
'time' => new external_value(PARAM_NOTAGS, 'Time in human format'),
'avatar' => new external_value(PARAM_RAW, 'HTML user picture'),
'userid' => new external_value(PARAM_INT, 'User ID'),
'delete' => new external_value(PARAM_BOOL, 'Permission to delete=true/false', VALUE_OPTIONAL)

17
lib/db/services.php
View File

@ -102,13 +102,13 @@ $functions = array(
// Comments related functions.
'core_comment_get_comments' => array(
'classname' => 'core_comment_external',
'methodname' => 'get_comments',
'description' => 'Returns comments.',
'type' => 'read',
'capabilities'=> 'moodle/comment:view',
),
'classname' => 'core_comment_external',
'methodname' => 'get_comments',
'description' => 'Returns comments.',
'type' => 'read',
'capabilities' => 'moodle/comment:view',
),
// Grade related functions.
'core_grades_get_grades' => array(
@ -1033,7 +1033,8 @@ $services = array(
'core_user_remove_user_device',
'core_course_get_courses',
'core_completion_update_activity_completion_status_manually',
'mod_data_get_databases_by_courses'
'mod_data_get_databases_by_courses',
'core_comment_get_comments',
),
'enabled' => 0,
'restrictedusers' => 0,