| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
External forum API
| Copyright: | 2012 Mark Nelson <markn@moodle.com> |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 1112 lines (50 kb) |
| Included or required: | 0 times |
| Referenced: | 8 times |
| Includes or requires: | 0 files |
mod_forum_external:: (24 methods):
get_forums_by_courses_parameters()
get_forums_by_courses()
get_forums_by_courses_returns()
get_forum_discussion_posts_parameters()
get_forum_discussion_posts()
get_forum_discussion_posts_returns()
get_forum_discussions_paginated_parameters()
get_forum_discussions_paginated()
get_forum_discussions_paginated_returns()
view_forum_parameters()
view_forum()
view_forum_returns()
view_forum_discussion_parameters()
view_forum_discussion()
view_forum_discussion_returns()
add_discussion_post_parameters()
add_discussion_post()
add_discussion_post_returns()
add_discussion_parameters()
add_discussion()
add_discussion_returns()
can_add_discussion_parameters()
can_add_discussion()
can_add_discussion_returns()
Class: mod_forum_external - X-Ref
| get_forums_by_courses_parameters() X-Ref |
| Describes the parameters for get_forum. return: external_external_function_parameters |
| get_forums_by_courses($courseids = array() X-Ref |
| Returns a list of forums in a provided list of courses, if no list is provided all forums that the user can view will be returned. param: array $courseids the course ids return: array the forum details |
| get_forums_by_courses_returns() X-Ref |
| Describes the get_forum return value. return: external_single_structure |
| get_forum_discussion_posts_parameters() X-Ref |
| Describes the parameters for get_forum_discussion_posts. return: external_external_function_parameters |
| get_forum_discussion_posts($discussionid, $sortby = "created", $sortdirection = "DESC") X-Ref |
| Returns a list of forum posts for a discussion param: int $discussionid the post ids param: string $sortby sort by this element (id, created or modified) param: string $sortdirection sort direction: ASC or DESC return: array the forum post details |
| get_forum_discussion_posts_returns() X-Ref |
| Describes the get_forum_discussion_posts return value. return: external_single_structure |
| get_forum_discussions_paginated_parameters() X-Ref |
| Describes the parameters for get_forum_discussions_paginated. return: external_external_function_parameters |
| get_forum_discussions_paginated($forumid, $sortby = 'timemodified', $sortdirection = 'DESC',$page = -1, $perpage = 0) X-Ref |
| Returns a list of forum discussions optionally sorted and paginated. param: int $forumid the forum instance id param: string $sortby sort by this element (id, timemodified, timestart or timeend) param: string $sortdirection sort direction: ASC or DESC param: int $page page number param: int $perpage items per page return: array the forum discussion details including warnings |
| get_forum_discussions_paginated_returns() X-Ref |
| Describes the get_forum_discussions_paginated return value. return: external_single_structure |
| view_forum_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| view_forum($forumid) X-Ref |
| 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 |
| view_forum_returns() X-Ref |
| Returns description of method result value return: external_description |
| view_forum_discussion_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| view_forum_discussion($discussionid) X-Ref |
| Trigger the discussion viewed event. param: int $discussionid the discussion id return: array of warnings and status result |
| view_forum_discussion_returns() X-Ref |
| Returns description of method result value return: external_description |
| add_discussion_post_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| add_discussion_post($postid, $subject, $message, $options = array() X-Ref |
| Create new posts into an existing discussion. param: int $postid the post id we are going to reply to param: string $subject new post subject param: string $message new post message (only html format allowed) param: array $options optional settings return: array of warnings and the new post id |
| add_discussion_post_returns() X-Ref |
| Returns description of method result value return: external_description |
| add_discussion_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| add_discussion($forumid, $subject, $message, $groupid = -1, $options = array() X-Ref |
| Add a new discussion into an existing forum. param: int $forumid the forum instance id param: string $subject new discussion subject param: string $message new discussion message (only html format allowed) param: int $groupid the user course group param: array $options optional settings return: array of warnings and the new discussion id |
| add_discussion_returns() X-Ref |
| Returns description of method result value return: external_description |
| can_add_discussion_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| can_add_discussion($forumid, $groupid = null) X-Ref |
| Check if the current user can add discussions in the given forum (and optionally for the given group). param: int $forumid the forum instance id param: int $groupid the group to check, default to active group. Use -1 to check if the user can post in all the groups. return: array of warnings and the status (true if the user can add discussions) |
| can_add_discussion_returns() X-Ref |
| Returns description of method result value return: external_description |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |