MDL-49796 webservices: Fix the functions description

This commit is contained in:
Juan Leyva 2015-07-14 11:30:55 +02:00
parent 91a12bc64c
commit 1c2b788256
8 changed files with 11 additions and 11 deletions

View File

@ -2063,7 +2063,7 @@ class core_course_external extends external_api {
}
/**
* Simulate the view.php web interface page, logging events, completion, etc...
* Trigger the course viewed event.
*
* @param int $courseid id of course
* @param int $sectionnumber sectionnumber (0, 1, 2...)

View File

@ -150,7 +150,7 @@ $functions = array(
'classname' => 'mod_assign_external',
'methodname' => 'view_grading_table',
'classpath' => 'mod/assign/externallib.php',
'description' => 'Simulate the web interface grading table view',
'description' => 'Trigger the grading_table_viewed event.',
'type' => 'write',
'capabilities' => 'mod/assign:view, mod/assign:viewgrades'
),

View File

@ -2066,7 +2066,7 @@ class mod_assign_external extends external_api {
}
/**
* Simulate the web interface grading table view.
* Trigger the grading_table_viewed event.
*
* @param int $assignid the assign instance id
* @return array of warnings and status result

View File

@ -68,7 +68,7 @@ $functions = array(
'classname' => 'mod_forum_external',
'methodname' => 'view_forum',
'classpath' => 'mod/forum/externallib.php',
'description' => 'Simulate the view.php web interface page: trigger events, completion, etc...',
'description' => 'Trigger the course module viewed event and update the module completion status.',
'type' => 'write',
'capabilities' => 'mod/forum:viewdiscussion'
),
@ -77,7 +77,7 @@ $functions = array(
'classname' => 'mod_forum_external',
'methodname' => 'view_forum_discussion',
'classpath' => 'mod/forum/externallib.php',
'description' => 'Simulate the forum/discuss.php web interface page: trigger events, completion, etc...',
'description' => 'Trigger the forum discussion viewed event.',
'type' => 'write',
'capabilities' => 'mod/forum:viewdiscussion'
),

View File

@ -848,7 +848,7 @@ class mod_forum_external extends external_api {
}
/**
* Simulate the forum/view.php web interface page: trigger events, completion, etc...
* Trigger the course module viewed event and update the module completion status.
*
* @param int $forumid the forum instance id
* @return array of warnings and status result
@ -913,7 +913,7 @@ class mod_forum_external extends external_api {
}
/**
* Simulate the forum/discuss.php web interface page: trigger events
* Trigger the discussion viewed event.
*
* @param int $discussionid the discussion id
* @return array of warnings and status result

View File

@ -54,7 +54,7 @@ class mod_url_external extends external_api {
}
/**
* Simulate the url/view.php web interface page: trigger events, completion, etc...
* Trigger the course module viewed event and update the module completion status.
*
* @param int $urlid the url instance id
* @return array of warnings and status result

View File

@ -31,7 +31,7 @@ $functions = array(
'mod_url_view_url' => array(
'classname' => 'mod_url_external',
'methodname' => 'view_url',
'description' => 'Simulate the view.php web interface url: trigger events, completion, etc...',
'description' => 'Trigger the course module viewed event and update the module completion status.',
'type' => 'write',
'capabilities' => 'mod/url:view'
),

View File

@ -1258,7 +1258,7 @@ class core_user_external extends external_api {
}
/**
* Simulate the /user/index.php web interface page triggering events
* Trigger the user_list_viewed event.
*
* @param int $courseid id of course
* @return array of warnings and status result
@ -1334,7 +1334,7 @@ class core_user_external extends external_api {
}
/**
* Simulate the /user/index.php and /user/profile.php web interface page triggering events
* Trigger the user profile viewed event.
*
* @param int $userid id of user
* @param int $courseid id of course