Commit b2b4ec30 authored by Rajesh Taneja's avatar Rajesh Taneja
Browse files

MDL-41283 report_participation: Added phpdoc about function not used

In new logging api, xxx_get_view_actions() and xxx_get_post_actions()
will not be used to identify the paticipation of user. Event's crud
and edulevel status will define user's participation.
parent ff6a853a
...@@ -827,6 +827,11 @@ function assign_scale_used_anywhere($scaleid) { ...@@ -827,6 +827,11 @@ function assign_scale_used_anywhere($scaleid) {
/** /**
* List the actions that correspond to a view of this module. * List the actions that correspond to a view of this module.
* This is used by the participation report. * This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function assign_get_view_actions() { function assign_get_view_actions() {
...@@ -836,6 +841,11 @@ function assign_get_view_actions() { ...@@ -836,6 +841,11 @@ function assign_get_view_actions() {
/** /**
* List the actions that correspond to a post of this module. * List the actions that correspond to a post of this module.
* This is used by the participation report. * This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function assign_get_post_actions() { function assign_get_post_actions() {
......
...@@ -222,6 +222,11 @@ function book_scale_used_anywhere($scaleid) { ...@@ -222,6 +222,11 @@ function book_scale_used_anywhere($scaleid) {
/** /**
* Return read actions. * Return read actions.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function book_get_view_actions() { function book_get_view_actions() {
...@@ -247,6 +252,11 @@ function book_get_view_actions() { ...@@ -247,6 +252,11 @@ function book_get_view_actions() {
/** /**
* Return write actions. * Return write actions.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function book_get_post_actions() { function book_get_post_actions() {
......
...@@ -52,6 +52,11 @@ function booktool_print_extend_settings_navigation(settings_navigation $settings ...@@ -52,6 +52,11 @@ function booktool_print_extend_settings_navigation(settings_navigation $settings
/** /**
* Return read actions. * Return read actions.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function booktool_print_get_view_actions() { function booktool_print_get_view_actions() {
......
...@@ -1103,6 +1103,13 @@ function chat_print_error($level, $msg) { ...@@ -1103,6 +1103,13 @@ function chat_print_error($level, $msg) {
} }
/** /**
* List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function chat_get_view_actions() { function chat_get_view_actions() {
...@@ -1110,6 +1117,13 @@ function chat_get_view_actions() { ...@@ -1110,6 +1117,13 @@ function chat_get_view_actions() {
} }
/** /**
* List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function chat_get_post_actions() { function chat_get_post_actions() {
......
...@@ -657,6 +657,13 @@ function choice_get_choice($choiceid) { ...@@ -657,6 +657,13 @@ function choice_get_choice($choiceid) {
} }
/** /**
* List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function choice_get_view_actions() { function choice_get_view_actions() {
...@@ -664,6 +671,13 @@ function choice_get_view_actions() { ...@@ -664,6 +671,13 @@ function choice_get_view_actions() {
} }
/** /**
* List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function choice_get_post_actions() { function choice_get_post_actions() {
......
...@@ -42,7 +42,7 @@ class record_created extends \core\event\base { ...@@ -42,7 +42,7 @@ class record_created extends \core\event\base {
protected function init() { protected function init() {
$this->data['objecttable'] = 'data_records'; $this->data['objecttable'] = 'data_records';
$this->data['crud'] = 'c'; $this->data['crud'] = 'c';
$this->data['edulevel'] = self::LEVEL_TEACHING; $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
} }
/** /**
......
...@@ -42,7 +42,7 @@ class record_deleted extends \core\event\base { ...@@ -42,7 +42,7 @@ class record_deleted extends \core\event\base {
protected function init() { protected function init() {
$this->data['objecttable'] = 'data_records'; $this->data['objecttable'] = 'data_records';
$this->data['crud'] = 'd'; $this->data['crud'] = 'd';
$this->data['edulevel'] = self::LEVEL_TEACHING; $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
} }
/** /**
......
...@@ -42,7 +42,7 @@ class record_updated extends \core\event\base { ...@@ -42,7 +42,7 @@ class record_updated extends \core\event\base {
protected function init() { protected function init() {
$this->data['objecttable'] = 'data_records'; $this->data['objecttable'] = 'data_records';
$this->data['crud'] = 'u'; $this->data['crud'] = 'u';
$this->data['edulevel'] = self::LEVEL_TEACHING; $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
} }
/** /**
......
...@@ -1722,7 +1722,12 @@ function data_print_ratings($data, $record) { ...@@ -1722,7 +1722,12 @@ function data_print_ratings($data, $record) {
} }
/** /**
* For Participantion Reports * List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
* *
* @return array * @return array
*/ */
...@@ -1731,6 +1736,13 @@ function data_get_view_actions() { ...@@ -1731,6 +1736,13 @@ function data_get_view_actions() {
} }
/** /**
* List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function data_get_post_actions() { function data_get_post_actions() {
......
...@@ -572,6 +572,13 @@ function feedback_scale_used_anywhere($scaleid) { ...@@ -572,6 +572,13 @@ function feedback_scale_used_anywhere($scaleid) {
} }
/** /**
* List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function feedback_get_view_actions() { function feedback_get_view_actions() {
...@@ -579,6 +586,13 @@ function feedback_get_view_actions() { ...@@ -579,6 +586,13 @@ function feedback_get_view_actions() {
} }
/** /**
* List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function feedback_get_post_actions() { function feedback_get_post_actions() {
......
...@@ -70,7 +70,13 @@ function folder_reset_userdata($data) { ...@@ -70,7 +70,13 @@ function folder_reset_userdata($data) {
} }
/** /**
* List of view style log actions * List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function folder_get_view_actions() { function folder_get_view_actions() {
...@@ -78,7 +84,13 @@ function folder_get_view_actions() { ...@@ -78,7 +84,13 @@ function folder_get_view_actions() {
} }
/** /**
* List of update style log actions * List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function folder_get_post_actions() { function folder_get_post_actions() {
......
...@@ -7073,6 +7073,13 @@ function forum_discussion_update_last_post($discussionid) { ...@@ -7073,6 +7073,13 @@ function forum_discussion_update_last_post($discussionid) {
/** /**
* List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function forum_get_view_actions() { function forum_get_view_actions() {
...@@ -7080,6 +7087,13 @@ function forum_get_view_actions() { ...@@ -7080,6 +7087,13 @@ function forum_get_view_actions() {
} }
/** /**
* List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function forum_get_post_actions() { function forum_get_post_actions() {
......
...@@ -2646,13 +2646,29 @@ function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpag ...@@ -2646,13 +2646,29 @@ function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpag
return $code; return $code;
} }
/** /**
* List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function glossary_get_view_actions() { function glossary_get_view_actions() {
return array('view','view all','view entry'); return array('view','view all','view entry');
} }
/** /**
* List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function glossary_get_post_actions() { function glossary_get_post_actions() {
......
...@@ -65,7 +65,13 @@ function imscp_reset_userdata($data) { ...@@ -65,7 +65,13 @@ function imscp_reset_userdata($data) {
} }
/** /**
* List of view style log actions * List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function imscp_get_view_actions() { function imscp_get_view_actions() {
...@@ -73,7 +79,13 @@ function imscp_get_view_actions() { ...@@ -73,7 +79,13 @@ function imscp_get_view_actions() {
} }
/** /**
* List of update style log actions * List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function imscp_get_post_actions() { function imscp_get_post_actions() {
......
...@@ -138,20 +138,6 @@ function label_get_coursemodule_info($coursemodule) { ...@@ -138,20 +138,6 @@ function label_get_coursemodule_info($coursemodule) {
} }
} }
/**
* @return array
*/
function label_get_view_actions() {
return array();
}
/**
* @return array
*/
function label_get_post_actions() {
return array();
}
/** /**
* This function is used by the reset_course_userdata function in moodlelib. * This function is used by the reset_course_userdata function in moodlelib.
* *
......
...@@ -527,6 +527,13 @@ function lesson_grade_item_delete($lesson) { ...@@ -527,6 +527,13 @@ function lesson_grade_item_delete($lesson) {
} }
/** /**
* List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function lesson_get_view_actions() { function lesson_get_view_actions() {
...@@ -534,6 +541,13 @@ function lesson_get_view_actions() { ...@@ -534,6 +541,13 @@ function lesson_get_view_actions() {
} }
/** /**
* List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function lesson_get_post_actions() { function lesson_get_post_actions() {
......
...@@ -63,7 +63,13 @@ function page_reset_userdata($data) { ...@@ -63,7 +63,13 @@ function page_reset_userdata($data) {
} }
/** /**
* List of view style log actions * List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function page_get_view_actions() { function page_get_view_actions() {
...@@ -71,7 +77,13 @@ function page_get_view_actions() { ...@@ -71,7 +77,13 @@ function page_get_view_actions() {
} }
/** /**
* List of update style log actions * List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function page_get_post_actions() { function page_get_post_actions() {
......
...@@ -1269,6 +1269,13 @@ function quiz_update_events($quiz, $override = null) { ...@@ -1269,6 +1269,13 @@ function quiz_update_events($quiz, $override = null) {
} }
/** /**
* List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function quiz_get_view_actions() { function quiz_get_view_actions() {
...@@ -1276,6 +1283,13 @@ function quiz_get_view_actions() { ...@@ -1276,6 +1283,13 @@ function quiz_get_view_actions() {
} }
/** /**
* List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function quiz_get_post_actions() { function quiz_get_post_actions() {
......
...@@ -63,7 +63,13 @@ function resource_reset_userdata($data) { ...@@ -63,7 +63,13 @@ function resource_reset_userdata($data) {
} }
/** /**
* List of view style log actions * List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function resource_get_view_actions() { function resource_get_view_actions() {
...@@ -71,7 +77,13 @@ function resource_get_view_actions() { ...@@ -71,7 +77,13 @@ function resource_get_view_actions() {
} }
/** /**
* List of update style log actions * List the actions that correspond to a post of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
* will be considered as post action.
*
* @return array * @return array
*/ */
function resource_get_post_actions() { function resource_get_post_actions() {
......
...@@ -712,6 +712,13 @@ function scorm_grade_item_delete($scorm) { ...@@ -712,6 +712,13 @@ function scorm_grade_item_delete($scorm) {
} }
/** /**
* List the actions that correspond to a view of this module.
* This is used by the participation report.
*
* Note: This is not used by new logging system. Event with
* crud = 'r' and edulevel = LEVEL_PARTICIPATING will
* be considered as view action.
*
* @return array * @return array
*/ */
function scorm_get_view_actions() { function scorm_get_view_actions() {
...@@ -719,6 +726,13 @@ function scorm_get_view_actions() { ...@@ -719,6 +726,13 @@ function scorm_get_view_actions() {
} }
/** /**
* List the actions that correspond to a post of this module.
* This is used by the participation report.