Logging API - Revision history

Sarjona: This page will not be migrated to new devdocs

2023-08-25T11:43:57Z

This page will not be migrated to new devdocs

← Older revision		Revision as of 11:43, 25 August 2023
Line 1:		Line 1:
			{{Template:WillNotMigrate}}

	{{obsolete}}		{{obsolete}}
	See [[Migrating logging calls in plugins]], [[Logging 2]] and [[Events API]] for more up-to-date information.		See [[Migrating logging calls in plugins]], [[Logging 2]] and [[Events API]] for more up-to-date information.

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:39:01Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:39, 14 July 2021
				
Line 13:
Line 13:



Following are the functions that constitute the basic log API for Moodle. Following are the functions that constitute the basic log API for Moodle.
<code php> <syntaxhighlight lang="php">
  add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)   add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)
  user_accesstime_log($courseid=0)   user_accesstime_log($courseid=0)
Line 27:
Line 27:
===Adding data to Logs=== ===Adding data to Logs===
In Moodle basically we have two functions that take care of adding data to the logs table :- In Moodle basically we have two functions that take care of adding data to the logs table :-
<code php> <syntaxhighlight lang="php">
  add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)   add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)
  user_accesstime_log($courseid=0)   user_accesstime_log($courseid=0)
Line 35:
Line 35:
This function is basic core function which you should use to add all your logs to the Moodle Log table. While using this function to add data to logs, please remember that this function is more "Action" oriented rather than being based on "webserver hits", i.e the events should be logged with enough information that this data can be effectively used to regenerate the entire flow of events and action associated with any specific user. This function is basic core function which you should use to add all your logs to the Moodle Log table. While using this function to add data to logs, please remember that this function is more "Action" oriented rather than being based on "webserver hits", i.e the events should be logged with enough information that this data can be effectively used to regenerate the entire flow of events and action associated with any specific user.
This is a simple example:- This is a simple example:-
<code php> <syntaxhighlight lang="php">
  add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);   add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);
</syntaxhighlight> </syntaxhighlight>
Line 44:
Line 44:
user_accesstime_log() is used to record the last access time for courses and site. This is basically called when a user vists the site or a course page. user_accesstime_log() is used to record the last access time for courses and site. This is basically called when a user vists the site or a course page.
A simple example can be :- A simple example can be :-
<code php> <syntaxhighlight lang="php">
  $courseid = $course->id;   $courseid = $course->id;
  user_accesstime_log($courseid);   user_accesstime_log($courseid);
Line 51:
Line 51:
===Fetching Logs=== ===Fetching Logs===
we have three functions that can take care of all your needs to interact with the existing log data in the database. Following function can be used to effectively retrieve log data as per your needs:- we have three functions that can take care of all your needs to interact with the existing log data in the database. Following function can be used to effectively retrieve log data as per your needs:-
<code php> <syntaxhighlight lang="php">
  get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount)   get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount)
  get_logs_usercourse($userid, $courseid, $coursestart)   get_logs_usercourse($userid, $courseid, $coursestart)
Line 58:
Line 58:
====get_logs()==== ====get_logs()====
This is a generic function to fetch data based on a given SQL condition. This is a generic function to fetch data based on a given SQL condition.
<code php> <syntaxhighlight lang="php">
  $params = array();   $params = array();
  $selector = "l.course = :courseid";   $selector = "l.course = :courseid";
Line 67:
Line 67:
====get_logs_usercourse()==== ====get_logs_usercourse()====
get_logs_usercourse() returns logs data for a given specific course and user. get_logs_usercourse() returns logs data for a given specific course and user.
<code php> <syntaxhighlight lang="php">
  $coursestart = usergetmidnight($course->startdate);   $coursestart = usergetmidnight($course->startdate);
  $logs = get_logs_usercourse($user->id, $courseselect, $coursestart);   $logs = get_logs_usercourse($user->id, $courseselect, $coursestart);
Line 73:
Line 73:
====get_logs_userday()==== ====get_logs_userday()====
This function can return logs specific to a given user and course for a given date. This function can return logs specific to a given user and course for a given date.
<code php> <syntaxhighlight lang="php">
  $daystart = usergetmidnight(time());   $daystart = usergetmidnight(time());
  $logs = get_logs_userday($user->id, $courseselect, $daystart);   $logs = get_logs_userday($user->id, $courseselect, $daystart);
Line 123:
Line 123:
===Example=== ===Example===
This a simple example of what contents of log.php files can be. This a simple example of what contents of log.php files can be.
<code php> <syntaxhighlight lang="php">
  $logs = array(   $logs = array(
     array('module'=>'page', 'action'=>'view', 'mtable'=>'page', 'field'=>'name'),      array('module'=>'page', 'action'=>'view', 'mtable'=>'page', 'field'=>'name'),



Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""
2021-07-14T13:22:53Z
Text replacement - "class="nicetable"" to "class="wikitable""

				
				
				
				
				
				← Older revision
				Revision as of 13:22, 14 July 2021
				
Line 81:
Line 81:
These files specify what information should be associated with a log entry. To understand the working of these files better its necessary to understand the structure of database table 'prefix_log_display'. These files specify what information should be associated with a log entry. To understand the working of these files better its necessary to understand the structure of database table 'prefix_log_display'.



{| class="nicetable" {| class="wikitable"
|- |-
! Field ! Field

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:05:54Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:05, 14 July 2021
Line 19:		Line 19:
	get_logs_usercourse($userid, $courseid, $coursestart)		get_logs_usercourse($userid, $courseid, $coursestart)
	get_logs_userday($userid, $courseid, $daystart)		get_logs_userday($userid, $courseid, $daystart)
	</~~code~~>		</syntaxhighlight>
	The basic working of these functions can be categorized in two categories:-		The basic working of these functions can be categorized in two categories:-
	# Adding data to logs		# Adding data to logs
Line 30:		Line 30:
	add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)		add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)
	user_accesstime_log($courseid=0)		user_accesstime_log($courseid=0)
	</~~code~~>		</syntaxhighlight>

	==== add_to_log() ====		==== add_to_log() ====
Line 37:		Line 37:
	<code php>		<code php>
	add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);		add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);
	</~~code~~>		</syntaxhighlight>

	This system has been deprecated in Moodle 2.7. See [[Migrating logging calls in plugins]].		This system has been deprecated in Moodle 2.7. See [[Migrating logging calls in plugins]].
Line 47:		Line 47:
	$courseid = $course->id;		$courseid = $course->id;
	user_accesstime_log($courseid);		user_accesstime_log($courseid);
	</~~code~~>		</syntaxhighlight>

	===Fetching Logs===		===Fetching Logs===
Line 55:		Line 55:
	get_logs_usercourse($userid, $courseid, $coursestart)		get_logs_usercourse($userid, $courseid, $coursestart)
	get_logs_userday($userid, $courseid, $daystart)		get_logs_userday($userid, $courseid, $daystart)
	</~~code~~>		</syntaxhighlight>
	====get_logs()====		====get_logs()====
	This is a generic function to fetch data based on a given SQL condition.		This is a generic function to fetch data based on a given SQL condition.
Line 63:		Line 63:
	$params['courseid'] = $course->id;		$params['courseid'] = $course->id;
	$logs = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);		$logs = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
	</~~code~~>		</syntaxhighlight>

	====get_logs_usercourse()====		====get_logs_usercourse()====
Line 70:		Line 70:
	$coursestart = usergetmidnight($course->startdate);		$coursestart = usergetmidnight($course->startdate);
	$logs = get_logs_usercourse($user->id, $courseselect, $coursestart);		$logs = get_logs_usercourse($user->id, $courseselect, $coursestart);
	</~~code~~>		</syntaxhighlight>
	====get_logs_userday()====		====get_logs_userday()====
	This function can return logs specific to a given user and course for a given date.		This function can return logs specific to a given user and course for a given date.
Line 76:		Line 76:
	$daystart = usergetmidnight(time());		$daystart = usergetmidnight(time());
	$logs = get_logs_userday($user->id, $courseselect, $daystart);		$logs = get_logs_userday($user->id, $courseselect, $daystart);
	</~~code~~>		</syntaxhighlight>

	==Mod/*/db/log.php Files==		==Mod/*/db/log.php Files==
Line 130:		Line 130:
	array('module'=>'page', 'action'=>'add', 'mtable'=>'page', 'field'=>'name'),		array('module'=>'page', 'action'=>'add', 'mtable'=>'page', 'field'=>'name'),
	);		);
	</~~code~~>		</syntaxhighlight>

	==See Also==		==See Also==

Stronk7 at 11:24, 6 April 2020

2020-04-06T11:24:47Z

← Older revision		Revision as of 11:24, 6 April 2020
Line 1:		Line 1:
	{{obsolete}}		{{obsolete}}
	See [[Migrating logging calls in plugins]], [[Logging 2]] and [[~~Event 2~~]] for more up-to-date information.		See [[Migrating logging calls in plugins]], [[Logging 2]] and [[Events API]] for more up-to-date information.

	==Overview==		==Overview==

Quen: /* add_to_log() */

2014-08-21T12:00:05Z

add_to_log()

← Older revision		Revision as of 12:00, 21 August 2014
Line 38:		Line 38:
	add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);		add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);
	</code>		</code>

			This system has been deprecated in Moodle 2.7. See [[Migrating logging calls in plugins]].

	==== user_accesstime_log() ====		==== user_accesstime_log() ====

Tsala: Migrating logging calls in plugins link

2014-08-12T09:32:18Z

Migrating logging calls in plugins link

← Older revision		Revision as of 09:32, 12 August 2014
Line 1:		Line 1:
	{{obsolete}}		{{obsolete}}
	See [[Logging 2]] and [[Event 2]] for more up-to-date information. ~~--[[User:Eric Merrill\|Eric Merrill]] 17:00, 11 August 2014 (UTC)~~		See [[Migrating logging calls in plugins]], [[Logging 2]] and [[Event 2]] for more up-to-date information.

	==Overview==		==Overview==

Emerrill: Point people to the correct pages

2014-08-11T18:01:55Z

Point people to the correct pages

← Older revision		Revision as of 18:01, 11 August 2014
Line 1:		Line 1:
			{{obsolete}}
			See [[Logging 2]] and [[Event 2]] for more up-to-date information. --[[User:Eric Merrill\|Eric Merrill]] 17:00, 11 August 2014 (UTC)

	==Overview==		==Overview==

Tsala: /* Example */ code php tag fix

2014-06-04T06:46:27Z

Example: code php tag fix

← Older revision		Revision as of 06:46, 4 June 2014
Line 118:		Line 118:
	===Example===		===Example===
	This a simple example of what contents of log.php files can be.		This a simple example of what contents of log.php files can be.
	<code>		<code php>
	$logs = array(		$logs = array(
	array('module'=>'page', 'action'=>'view', 'mtable'=>'page', 'field'=>'name'),		array('module'=>'page', 'action'=>'view', 'mtable'=>'page', 'field'=>'name'),

Tsala: /* Functions and Examples */ code php tags

2014-06-04T06:43:17Z

Functions and Examples: code php tags

← Older revision		Revision as of 06:43, 4 June 2014
Line 10:		Line 10:

	Following are the functions that constitute the basic log API for Moodle.		Following are the functions that constitute the basic log API for Moodle.
	<code>		<code php>
	add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)		add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)
	user_accesstime_log($courseid=0)		user_accesstime_log($courseid=0)
Line 24:		Line 24:
	===Adding data to Logs===		===Adding data to Logs===
	In Moodle basically we have two functions that take care of adding data to the logs table :-		In Moodle basically we have two functions that take care of adding data to the logs table :-
	<code>		<code php>
	add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)		add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)
	user_accesstime_log($courseid=0)		user_accesstime_log($courseid=0)
Line 32:		Line 32:
	This function is basic core function which you should use to add all your logs to the Moodle Log table. While using this function to add data to logs, please remember that this function is more "Action" oriented rather than being based on "webserver hits", i.e the events should be logged with enough information that this data can be effectively used to regenerate the entire flow of events and action associated with any specific user.		This function is basic core function which you should use to add all your logs to the Moodle Log table. While using this function to add data to logs, please remember that this function is more "Action" oriented rather than being based on "webserver hits", i.e the events should be logged with enough information that this data can be effectively used to regenerate the entire flow of events and action associated with any specific user.
	This is a simple example:-		This is a simple example:-
	<code>		<code php>
	add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);		add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);
	</code>		</code>
Line 39:		Line 39:
	user_accesstime_log() is used to record the last access time for courses and site. This is basically called when a user vists the site or a course page.		user_accesstime_log() is used to record the last access time for courses and site. This is basically called when a user vists the site or a course page.
	A simple example can be :-		A simple example can be :-
	<code>		<code php>
	$courseid = $course->id;		$courseid = $course->id;
	user_accesstime_log($courseid);		user_accesstime_log($courseid);
Line 46:		Line 46:
	===Fetching Logs===		===Fetching Logs===
	we have three functions that can take care of all your needs to interact with the existing log data in the database. Following function can be used to effectively retrieve log data as per your needs:-		we have three functions that can take care of all your needs to interact with the existing log data in the database. Following function can be used to effectively retrieve log data as per your needs:-
	<code>		<code php>
	get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount)		get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount)
	get_logs_usercourse($userid, $courseid, $coursestart)		get_logs_usercourse($userid, $courseid, $coursestart)
Line 53:		Line 53:
	====get_logs()====		====get_logs()====
	This is a generic function to fetch data based on a given SQL condition.		This is a generic function to fetch data based on a given SQL condition.
	<code>		<code php>
	$params = array();		$params = array();
	$selector = "l.course = :courseid";		$selector = "l.course = :courseid";
Line 62:		Line 62:
	====get_logs_usercourse()====		====get_logs_usercourse()====
	get_logs_usercourse() returns logs data for a given specific course and user.		get_logs_usercourse() returns logs data for a given specific course and user.
	<code>		<code php>
	$coursestart = usergetmidnight($course->startdate);		$coursestart = usergetmidnight($course->startdate);
	$logs = get_logs_usercourse($user->id, $courseselect, $coursestart);		$logs = get_logs_usercourse($user->id, $courseselect, $coursestart);
Line 68:		Line 68:
	====get_logs_userday()====		====get_logs_userday()====
	This function can return logs specific to a given user and course for a given date.		This function can return logs specific to a given user and course for a given date.
	<code>		<code php>
	$daystart = usergetmidnight(time());		$daystart = usergetmidnight(time());
	$logs = get_logs_userday($user->id, $courseselect, $daystart);		$logs = get_logs_userday($user->id, $courseselect, $daystart);
	</code>		</code>

	==Mod/*/db/log.php Files==		==Mod/*/db/log.php Files==
	These files specify what information should be associated with a log entry. To understand the working of these files better its necessary to understand the structure of database table 'prefix_log_display'.		These files specify what information should be associated with a log entry. To understand the working of these files better its necessary to understand the structure of database table 'prefix_log_display'.

← Older revision		Revision as of 13:39, 14 July 2021
Line 13:		Line 13:

	Following are the functions that constitute the basic log API for Moodle.		Following are the functions that constitute the basic log API for Moodle.
	<~~code~~ php>		<syntaxhighlight lang="php">
	add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)		add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)
	user_accesstime_log($courseid=0)		user_accesstime_log($courseid=0)
Line 27:		Line 27:
	===Adding data to Logs===		===Adding data to Logs===
	In Moodle basically we have two functions that take care of adding data to the logs table :-		In Moodle basically we have two functions that take care of adding data to the logs table :-
	<~~code~~ php>		<syntaxhighlight lang="php">
	add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)		add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)
	user_accesstime_log($courseid=0)		user_accesstime_log($courseid=0)
Line 35:		Line 35:
	This function is basic core function which you should use to add all your logs to the Moodle Log table. While using this function to add data to logs, please remember that this function is more "Action" oriented rather than being based on "webserver hits", i.e the events should be logged with enough information that this data can be effectively used to regenerate the entire flow of events and action associated with any specific user.		This function is basic core function which you should use to add all your logs to the Moodle Log table. While using this function to add data to logs, please remember that this function is more "Action" oriented rather than being based on "webserver hits", i.e the events should be logged with enough information that this data can be effectively used to regenerate the entire flow of events and action associated with any specific user.
	This is a simple example:-		This is a simple example:-
	<~~code~~ php>		<syntaxhighlight lang="php">
	add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);		add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);
	</syntaxhighlight>		</syntaxhighlight>
Line 44:		Line 44:
	user_accesstime_log() is used to record the last access time for courses and site. This is basically called when a user vists the site or a course page.		user_accesstime_log() is used to record the last access time for courses and site. This is basically called when a user vists the site or a course page.
	A simple example can be :-		A simple example can be :-
	<~~code~~ php>		<syntaxhighlight lang="php">
	$courseid = $course->id;		$courseid = $course->id;
	user_accesstime_log($courseid);		user_accesstime_log($courseid);
Line 51:		Line 51:
	===Fetching Logs===		===Fetching Logs===
	we have three functions that can take care of all your needs to interact with the existing log data in the database. Following function can be used to effectively retrieve log data as per your needs:-		we have three functions that can take care of all your needs to interact with the existing log data in the database. Following function can be used to effectively retrieve log data as per your needs:-
	<~~code~~ php>		<syntaxhighlight lang="php">
	get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount)		get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount)
	get_logs_usercourse($userid, $courseid, $coursestart)		get_logs_usercourse($userid, $courseid, $coursestart)
Line 58:		Line 58:
	====get_logs()====		====get_logs()====
	This is a generic function to fetch data based on a given SQL condition.		This is a generic function to fetch data based on a given SQL condition.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$params = array();		$params = array();
	$selector = "l.course = :courseid";		$selector = "l.course = :courseid";
Line 67:		Line 67:
	====get_logs_usercourse()====		====get_logs_usercourse()====
	get_logs_usercourse() returns logs data for a given specific course and user.		get_logs_usercourse() returns logs data for a given specific course and user.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$coursestart = usergetmidnight($course->startdate);		$coursestart = usergetmidnight($course->startdate);
	$logs = get_logs_usercourse($user->id, $courseselect, $coursestart);		$logs = get_logs_usercourse($user->id, $courseselect, $coursestart);
Line 73:		Line 73:
	====get_logs_userday()====		====get_logs_userday()====
	This function can return logs specific to a given user and course for a given date.		This function can return logs specific to a given user and course for a given date.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$daystart = usergetmidnight(time());		$daystart = usergetmidnight(time());
	$logs = get_logs_userday($user->id, $courseselect, $daystart);		$logs = get_logs_userday($user->id, $courseselect, $daystart);
Line 123:		Line 123:
	===Example===		===Example===
	This a simple example of what contents of log.php files can be.		This a simple example of what contents of log.php files can be.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$logs = array(		$logs = array(
	array('module'=>'page', 'action'=>'view', 'mtable'=>'page', 'field'=>'name'),		array('module'=>'page', 'action'=>'view', 'mtable'=>'page', 'field'=>'name'),

← Older revision		Revision as of 13:22, 14 July 2021
Line 81:		Line 81:
	These files specify what information should be associated with a log entry. To understand the working of these files better its necessary to understand the structure of database table 'prefix_log_display'.		These files specify what information should be associated with a log entry. To understand the working of these files better its necessary to understand the structure of database table 'prefix_log_display'.

	{\| class="~~nicetable~~"		{\| class="wikitable"
	\|-		\|-
	! Field		! Field