Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

reportbuilder/API: Difference between revisions

From MoodleDocs
No edit summary
(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.)
 
(56 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[reportbuilder|Back to Index]]
#REDIRECT [[Report_builder_API]]
 
==Overview==
 
The report builder API enables plugin contributors and moodle core developers to create new sources that can be used by site administrators and teachers to generate and customise reports.
 
==How to create a source==
 
To create a source, create a file called rb_source_SOURCE_NAME.php in a subfolder of your plug-in, or the relevant core class. The class name must start with 'rb_source_', and the class name and filename must match. The class must be a child of rb_base_source.
 
The following is an example of a Report Builder source:
<pre>
<?php
 
class rb_source_example1 extends rb_base_source {
    public $base, $joinlist, $columnoptions, $filteroptions;
 
    function __construct() {
        $this->base = '{course}';
        $this->joinlist = array(
            new rb_join(
                'course_category',
                'LEFT',
                '{course_categories}',
                'course_category.id = base.category'
            )
        );
        $this->columnoptions = array(
            new rb_column_option(
                'course',
                'fullname',
                'Course Fullname',
                'base.fullname'
            )
        );
        $this->filteroptions = array();
        $this->sourcetitle  = "Example1";
 
        parent::__construct();
    }
}
?>
</pre>

Latest revision as of 06:41, 15 November 2022

Redirect to:

Retrieved from "https://docs.moodle.org/dev/index.php?title=reportbuilder/API&oldid=63683"
Powered by MediaWiki