Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Static Public Member Functions | |
static | get_analysis ($feedbackid, $groupid=0, $courseid=0) |
Retrieves the feedback analysis. | |
static | get_analysis_parameters () |
Describes the parameters for get_analysis. | |
static | get_analysis_returns () |
Describes the get_analysis return value. | |
static | get_current_completed_tmp ($feedbackid, $courseid=0) |
Returns the temporary completion record for the current user. | |
static | get_current_completed_tmp_parameters () |
Describes the parameters for get_current_completed_tmp. | |
static | get_current_completed_tmp_returns () |
Describes the get_current_completed_tmp return value. | |
static | get_feedback_access_information ($feedbackid, $courseid=0) |
Return access information for a given feedback. | |
static | get_feedback_access_information_parameters () |
Describes the parameters for get_feedback_access_information. | |
static | get_feedback_access_information_returns () |
Describes the get_feedback_access_information return value. | |
static | get_feedbacks_by_courses ($courseids=array()) |
Returns a list of feedbacks in a provided list of courses. | |
static | get_feedbacks_by_courses_parameters () |
Describes the parameters for get_feedbacks_by_courses. | |
static | get_feedbacks_by_courses_returns () |
Describes the get_feedbacks_by_courses return value. | |
static | get_finished_responses ($feedbackid, $courseid=0) |
Retrieves responses from the last finished attempt. | |
static | get_finished_responses_parameters () |
Describes the parameters for get_finished_responses. | |
static | get_finished_responses_returns () |
Describes the get_finished_responses return value. | |
static | get_items ($feedbackid, $courseid=0) |
Returns the items (questions) in the given feedback. | |
static | get_items_parameters () |
Describes the parameters for get_items. | |
static | get_items_returns () |
Describes the get_items return value. | |
static | get_last_completed ($feedbackid, $courseid=0) |
Retrieves the last completion record for the current user. | |
static | get_last_completed_parameters () |
Describes the parameters for get_last_completed. | |
static | get_last_completed_returns () |
Describes the get_last_completed return value. | |
static | get_non_respondents ($feedbackid, $groupid=0, $sort='lastaccess', $page=0, $perpage=0, $courseid=0) |
Retrieves a list of students who didn't submit the feedback. | |
static | get_non_respondents_parameters () |
Describes the parameters for get_non_respondents. | |
static | get_non_respondents_returns () |
Describes the get_non_respondents return value. | |
static | get_page_items ($feedbackid, $page, $courseid=0) |
Get a single feedback page items. | |
static | get_page_items_parameters () |
Describes the parameters for get_page_items. | |
static | get_page_items_returns () |
Describes the get_page_items return value. | |
static | get_responses_analysis ($feedbackid, $groupid=0, $page=0, $perpage=0, $courseid=0) |
Return the feedback user responses. | |
static | get_responses_analysis_parameters () |
Describes the parameters for get_responses_analysis. | |
static | get_responses_analysis_returns () |
Describes the get_responses_analysis return value. | |
static | get_unfinished_responses ($feedbackid, $courseid=0) |
Retrieves responses from the current unfinished attempt. | |
static | get_unfinished_responses_parameters () |
Describes the parameters for get_unfinished_responses. | |
static | get_unfinished_responses_returns () |
Describes the get_unfinished_responses return value. | |
static | launch_feedback ($feedbackid, $courseid=0) |
Starts or continues a feedback submission. | |
static | launch_feedback_parameters () |
Describes the parameters for launch_feedback. | |
static | launch_feedback_returns () |
Describes the launch_feedback return value. | |
static | process_page ($feedbackid, $page, $responses=[], $goprevious=false, $courseid=0) |
Process a jump between pages. | |
static | process_page_parameters () |
Describes the parameters for process_page. | |
static | process_page_returns () |
Describes the process_page return value. | |
static | view_feedback ($feedbackid, $moduleviewed=false, $courseid=0) |
Trigger the course module viewed event and update the module completion status. | |
static | view_feedback_parameters () |
Describes the parameters for view_feedback. | |
static | view_feedback_returns () |
Describes the view_feedback return value. | |
Static Protected Member Functions | |
static | validate_feedback ($feedbackid, $courseid=0) |
Utility function for validating a feedback. | |
static | validate_feedback_access ($feedback, $course, $cm, $context, $checksubmit=false) |
Utility function for validating access to feedback. | |
|
static |
Retrieves the feedback analysis.
array | $feedbackid | feedback instance id |
int | $groupid | group id, 0 means that the function will determine the user group |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and launch information |
|
static |
Describes the parameters for get_analysis.
external_function_parameters |
|
static |
|
static |
Returns the temporary completion record for the current user.
int | $feedbackid | feedback instance id |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and status result |
moodle_exception |
|
static |
Describes the parameters for get_current_completed_tmp.
external_function_parameters |
|
static |
Describes the get_current_completed_tmp return value.
external_single_structure |
|
static |
Return access information for a given feedback.
int | $feedbackid | feedback instance id |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and the access information |
moodle_exception |
|
static |
Describes the parameters for get_feedback_access_information.
external_external_function_parameters |
|
static |
Describes the get_feedback_access_information return value.
external_single_structure |
|
static |
Returns a list of feedbacks in a provided list of courses.
If no list is provided all feedbacks that the user can view will be returned.
array | $courseids | course ids |
array | of warnings and feedbacks |
|
static |
Describes the parameters for get_feedbacks_by_courses.
external_function_parameters |
|
static |
Describes the get_feedbacks_by_courses return value.
external_single_structure |
|
static |
Retrieves responses from the last finished attempt.
array | $feedbackid | feedback instance id |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and the responses |
|
static |
Describes the parameters for get_finished_responses.
external_function_parameters |
|
static |
Describes the get_finished_responses return value.
external_single_structure |
|
static |
Returns the items (questions) in the given feedback.
int | $feedbackid | feedback instance id |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and feedbacks |
|
static |
|
static |
|
static |
Retrieves the last completion record for the current user.
int | $feedbackid | feedback instance id |
array | of warnings and the last completed record |
moodle_exception |
|
static |
Describes the parameters for get_last_completed.
external_function_parameters |
|
static |
Describes the get_last_completed return value.
external_single_structure |
|
static |
Retrieves a list of students who didn't submit the feedback.
int | $feedbackid | feedback instance id |
int | $groupid | Group id, 0 means that the function will determine the user group' |
str | $sort | sort param, must be firstname, lastname or lastaccess (default) |
int | $page | the page of records to return |
int | $perpage | the number of records to return per page |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and users ids |
|
static |
Describes the parameters for get_non_respondents.
external_function_parameters |
|
static |
Describes the get_non_respondents return value.
external_single_structure |
|
static |
Get a single feedback page items.
int | $feedbackid | feedback instance id |
int | $page | the page to get starting by 0 |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and launch information |
|
static |
Describes the parameters for get_page_items.
external_function_parameters |
|
static |
|
static |
Return the feedback user responses.
int | $feedbackid | feedback instance id |
int | $groupid | Group id, 0 means that the function will determine the user group |
int | $page | the page of records to return |
int | $perpage | the number of records to return per page |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and users attemps and responses |
moodle_exception |
|
static |
Describes the parameters for get_responses_analysis.
external_function_parameters |
|
static |
Describes the get_responses_analysis return value.
external_single_structure |
|
static |
Retrieves responses from the current unfinished attempt.
array | $feedbackid | feedback instance id |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and launch information |
|
static |
Describes the parameters for get_unfinished_responses.
external_function_parameters |
|
static |
Describes the get_unfinished_responses return value.
external_single_structure |
|
static |
Starts or continues a feedback submission.
array | $feedbackid | feedback instance id |
int | $courseid | course where user completes a feedback (for site feedbacks only). |
array | of warnings and launch information |
|
static |
Describes the parameters for launch_feedback.
external_function_parameters |
|
static |
|
static |
Process a jump between pages.
array | $feedbackid | feedback instance id |
array | $page | the page being processed |
array | $responses | the responses to be processed |
bool | $goprevious | whether we want to jump to previous page |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and launch information |
|
static |
Describes the parameters for process_page.
external_function_parameters |
|
static |
|
staticprotected |
Utility function for validating a feedback.
int | $feedbackid | feedback instance id |
int | $courseid | courseid course where user completes the feedback (for site feedbacks only) |
array | containing the feedback, feedback course, context, course module and the course where is being completed. |
moodle_exception |
|
staticprotected |
Utility function for validating access to feedback.
stdClass | $feedback | feedback object |
stdClass | $course | course where user completes the feedback (for site feedbacks only) |
stdClass | $cm | course module |
stdClass | $context | context object |
moodle_exception |
mod_feedback_completion | feedback completion instance |
|
static |
Trigger the course module viewed event and update the module completion status.
int | $feedbackid | feedback instance id |
bool | $moduleviewed | If we need to mark the module as viewed for completion |
int | $courseid | course where user completes the feedback (for site feedbacks only) |
array | of warnings and status result |
moodle_exception |
|
static |
Describes the parameters for view_feedback.
external_function_parameters |
|
static |