Course reports - Revision history

Sarjona: This page will not be migrated to new devdocs

2025-02-10T08:05:25Z

This page will not be migrated to new devdocs

← Older revision		Revision as of 08:05, 10 February 2025
Line 1:		Line 1:
			{{Template:WillNotMigrate}}

	A course report plugin is just another folder inside course/report/. It follows standard plugin practice and may have lang, db etc. sub-folders if these are required. A version.php file must be included.		A course report plugin is just another folder inside course/report/. It follows standard plugin practice and may have lang, db etc. sub-folders if these are required. A version.php file must be included.

Gallegre: Removed obsolete or incorrect documentation about mod.php

2012-07-20T18:50:30Z

Removed obsolete or incorrect documentation about mod.php

← Older revision		Revision as of 18:50, 20 July 2012
Line 9:		Line 9:
	}		}

	A mod.php file must be included. This is responsible for creating the HTML fragment that will appear on the course report page as one of the report options. This can be anything. Typically, it will simply generate a link to another page in the report folder (usually index.php) that produces the report. It may, like the logs report generate a form to be completed.

	[[Category:Plugins]]		[[Category:Plugins]]

Gallegre: added correct documentation for menu entries

2012-07-20T18:48:17Z

added correct documentation for menu entries

← Older revision		Revision as of 18:48, 20 July 2012
Line 1:		Line 1:
	A course report plugin is just another folder inside course/report/. It follows standard plugin practice and may have lang, db etc. sub-folders if these are required. A version.php file must be included.		A course report plugin is just another folder inside course/report/. It follows standard plugin practice and may have lang, db etc. sub-folders if these are required. A version.php file must be included.

			In order to add a menu entry for your plugin, you must define a function named ''FOOBAR_report_extend_navigation'' in your ''lib.php'' file, where FOOBAR is your plugin name.
			For example, for a module named ''synopsis'' (coursereport_synopsis in standardized form), the code will be :

			function synopsis_report_extend_navigation($reportnav, $course, $context) {
			$url = new moodle_url('/course/report/synopsis/index.php', array('id' => $course->id));
			$reportnav->add(get_string('Synopsis', 'coursereport_synopsis'), $url);
			}

	A mod.php file must be included. This is responsible for creating the HTML fragment that will appear on the course report page as one of the report options. This can be anything. Typically, it will simply generate a link to another page in the report folder (usually index.php) that produces the report. It may, like the logs report generate a form to be completed.		A mod.php file must be included. This is responsible for creating the HTML fragment that will appear on the course report page as one of the report options. This can be anything. Typically, it will simply generate a link to another page in the report folder (usually index.php) that produces the report. It may, like the logs report generate a form to be completed.

	[[Category:Plugins]]		[[Category:Plugins]]

Dougiamas: moved Course Report Plugins to Course reports

2012-01-30T05:29:50Z

moved Course Report Plugins to Course reports

← Older revision	Revision as of 05:29, 30 January 2012
(No difference)

Deraadt: Adding to a top level category

2011-11-04T09:04:12Z

Adding to a top level category

← Older revision		Revision as of 09:04, 4 November 2011
Line 2:		Line 2:

	A mod.php file must be included. This is responsible for creating the HTML fragment that will appear on the course report page as one of the report options. This can be anything. Typically, it will simply generate a link to another page in the report folder (usually index.php) that produces the report. It may, like the logs report generate a form to be completed.		A mod.php file must be included. This is responsible for creating the HTML fragment that will appear on the course report page as one of the report options. This can be anything. Typically, it will simply generate a link to another page in the report folder (usually index.php) that produces the report. It may, like the logs report generate a form to be completed.

			[[Category:Plugins]]

Howardsmiller at 11:48, 21 December 2010

2010-12-21T11:48:57Z

← Older revision		Revision as of 11:48, 21 December 2010
Line 1:		Line 1:
	A course report plugin is just another folder inside course/report/		A course report plugin is just another folder inside course/report/. It follows standard plugin practice and may have lang, db etc. sub-folders if these are required. A version.php file must be included.

	~~If there is a~~ mod.~~html~~ file ~~inside there, it will~~ be included ~~with~~ the ~~others when you visit~~ course/report.~~php?id={courseid} in your browser.~~		A mod.php file must be included. This is responsible for creating the HTML fragment that will appear on the course report page as one of the report options. This can be anything. Typically, it will simply generate a link to another page in the report folder (usually index.php) that produces the report. It may, like the logs report generate a form to be completed.

	~~That HTML fragment~~ can do anything ~~you like~~. ~~A common thing is to include~~ a link to ~~course/~~report~~/myreport/~~index.php. ~~That's all it is~~, ~~simple, and gives you almost unlimited flexibility~~.

Granludo: Course Report Plugins

2007-11-07T18:50:06Z

Course Report Plugins

New page

A course report plugin is just another folder inside course/report/

If there is a mod.html file inside there, it will be included with the others when you visit course/report.php?id={courseid} in your browser.

That HTML fragment can do anything you like. A common thing is to include a link to course/report/myreport/index.php. That's all it is, simple, and gives you almost unlimited flexibility.