reportbuilder/API - Revision history

Danmarsden: This has confused multiple staff members at Catalyst - it relates to old Totara backport of Rerportbuilder and is often the first page found in google - redirecting it to the correct Moodle API page as this content is no longer relevant.

2022-11-15T06:41:34Z

This has confused multiple staff members at Catalyst - it relates to old Totara backport of Rerportbuilder and is often the first page found in google - redirecting it to the correct Moodle API page as this content is no longer relevant.

Show changes

Davidmatamoros at 13:38, 14 October 2021

2021-10-14T13:38:15Z

← Older revision		Revision as of 13:38, 14 October 2021
Line 1:		Line 1:
	[[reportbuilder\|Back to Index]]		[[reportbuilder\|Back to Index]]

			{{obsolete}}

	{{Work in progress}}		{{Work in progress}}

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


2021-07-14T20:39:05Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"
Show changes

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

2021-07-14T20:24:07Z

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

Show changes

Aldoparadiso: /* Sources */

2016-07-15T08:07:24Z

Sources

← Older revision		Revision as of 08:07, 15 July 2016
Line 26:		Line 26:

	A source consists of:		A source consists of:
	* '''A base table''': Defines what table all reports from this source will be based of (base).		* '''A base table''': Defines what table all reports from this source will be based on (base).
	* '''A join list''': Defines what tables should be joined to the base table (joinlist).		* '''A join list''': Defines what tables should be joined to the base table (joinlist).
	* '''Column options''': Defines which columns from each table should be available in the report (columnoptions).		* '''Column options''': Defines which columns from each table should be available in the report (columnoptions).

Aldoparadiso: /* Sources */

2016-07-15T08:06:37Z

Sources

← Older revision		Revision as of 08:06, 15 July 2016
Line 26:		Line 26:

	A source consists of:		A source consists of:
	* '''A base table''': Defines what table all reports from this source will be based ~~off~~ (base).		* '''A base table''': Defines what table all reports from this source will be based of (base).
	* '''A join list''': Defines what tables should be joined to the base table (joinlist).		* '''A join list''': Defines what tables should be joined to the base table (joinlist).
	* '''Column options''': Defines which columns from each table should be available in the report (columnoptions).		* '''Column options''': Defines which columns from each table should be available in the report (columnoptions).

Gavinn: corrected return values in examples and closed curly braces in base source description example

2015-10-15T15:52:37Z

corrected return values in examples and closed curly braces in base source description example

← Older revision		Revision as of 15:52, 15 October 2015
Line 54:		Line 54:
	</code>		</code>

	When constructing a source, you can set the 'base' variable to a table name with no prefix in braces, e.g. "{choice_answers", or you can use an SQL statement.		When constructing a source, you can set the 'base' variable to a table name with no prefix in braces, e.g. "{choice_answers}", or you can use an SQL statement.
	<code php>		<code php>
	$this->base = '(SELECT * FROM {choice_answers} WHERE choiceid <> 2)';		$this->base = '(SELECT * FROM {choice_answers} WHERE choiceid <> 2)';
Line 290:		Line 290:
	);		);

	return $~~defaultcolumns~~;		return $requiredcolumns;
	}		}
	</code>		</code>
Line 492:		Line 492:
	);		);

	return $~~embeddedparams~~;		return $contentsettings;
	}		}
	}		}

Johnok: Fix get_embedded_report call

2014-06-27T04:54:24Z

Fix get_embedded_report call

← Older revision		Revision as of 04:54, 27 June 2014
Line 516:		Line 516:
	First you will need to include the necessary libraries to embed a report. Most notably reporting/lib.php and admin/tool/reportbuilder/lib.php. At this point you should also require any capabilities that the user should have in order to be able to view the report. A number of optional params must be included, the 'sid' for handling saved searches and the 'format' for exporting.		First you will need to include the necessary libraries to embed a report. Most notably reporting/lib.php and admin/tool/reportbuilder/lib.php. At this point you should also require any capabilities that the user should have in order to be able to view the report. A number of optional params must be included, the 'sid' for handling saved searches and the 'format' for exporting.
	<code php>		<code php>
	$report = \core\tool\reporting->get_embedded_report('choice', null, false, $sid);		$report = \core\tool\reporting\get_embedded_report('choice', null, false, $sid);
	</code>		</code>
	Here the actual report is created. This should be the same name as your embedded report class \core\reporting\choice_embedded		Here the actual report is created. This should be the same name as your embedded report class \core\reporting\choice_embedded

Abgreeve: /* Construction */ constructor update

2014-06-27T04:45:14Z

Construction: constructor update

← Older revision		Revision as of 04:45, 27 June 2014
Line 408:		Line 408:

	class \core\reporting\choice_embedded extends \core\reporting\base_embedded {		class \core\reporting\choice_embedded extends \core\reporting\base_embedded {

	~~public $url, $source, $fullname, $columns, $filters;~~
	~~public $contentmode, $embeddedparams;~~

	public function __construct() {		public function __construct() {

Johnok: Small fixes to embedded report section

2014-06-27T04:01:10Z

Small fixes to embedded report section

← Older revision		Revision as of 04:01, 27 June 2014
Line 508:		Line 508:
	<code php>		<code php>
	require('../../config.php');		require('../../config.php');
	~~require_once($CFG->libdir.'/adminlib.php');~~
	~~require_once($CFG->dirroot.'/cohort/lib.php');~~
	~~require_once($CFG->dirroot.'/reporting/lib.php');~~
	~~require_once($CFG->dirroot.'/admin/tool/reportbuilder/lib.php');~~

	$context = context_system::instance();		$context = context_system::instance();
Line 523:		Line 519:
	First you will need to include the necessary libraries to embed a report. Most notably reporting/lib.php and admin/tool/reportbuilder/lib.php. At this point you should also require any capabilities that the user should have in order to be able to view the report. A number of optional params must be included, the 'sid' for handling saved searches and the 'format' for exporting.		First you will need to include the necessary libraries to embed a report. Most notably reporting/lib.php and admin/tool/reportbuilder/lib.php. At this point you should also require any capabilities that the user should have in order to be able to view the report. A number of optional params must be included, the 'sid' for handling saved searches and the 'format' for exporting.
	<code php>		<code php>
	$report = ~~reportbuilder_get_embedded_report~~('choice', null, false, $sid);		$report = \core\tool\reporting->get_embedded_report('choice', null, false, $sid);
	</code>		</code>
	Here the actual report is created. This should be the same name as your embedded report class \core\reporting\choice_embedded		Here the actual report is created. This should be the same name as your embedded report class \core\reporting\choice_embedded
Line 536:		Line 532:
	<code php>		<code php>
	echo $OUTPUT->header();		echo $OUTPUT->header();
	echo $OUTPUT->heading(get_string('~~orphanedusers~~', '~~totara_cohort~~'));		echo $OUTPUT->heading(get_string('name', 'mod_choice'));
	echo $OUTPUT->container(get_string('~~orphanhelptext~~', '~~totara_cohort~~'));		echo $OUTPUT->container(get_string('choiceoptions_help', 'mod_choice'));
	</code>		</code>
	Will display the site header and headings and the content container. Required on any Moodle page.		Will display the site header and headings and the content container. Required on any Moodle page.
Line 553:		Line 549:
	$output->export_select($report->_id, $sid);		$output->export_select($report->_id, $sid);
	</code>		</code>
	This code will display the controls that allow a user to		This code will display the controls that allow a user to export the report.
	<code php>		<code php>
	echo $OUTPUT->footer();		echo $OUTPUT->footer();
	</code>		</code>
	Will display the site footer. Required on any Moodle page.		Will display the site footer. Required on any Moodle page.

reportbuilder/API - Revision history

Danmarsden: This has confused multiple staff members at Catalyst - it relates to old Totara backport of Rerportbuilder and is often the first page found in google - redirecting it to the correct Moodle API page as this content is no longer relevant.

Davidmatamoros at 13:38, 14 October 2021

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Aldoparadiso: /* Sources */

Aldoparadiso: /* Sources */

Gavinn: corrected return values in examples and closed curly braces in base source description example

Johnok: Fix get_embedded_report call

Abgreeve: /* Construction */ constructor update

Johnok: Small fixes to embedded report section

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

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