gradereport_overview

Files
file	access.php
	Defines capabilities for the overview report.
file	external.php
	External grade report overview API.
file	grade_report_viewed.php
	Overview report viewed event.
file	lib.php
	Definition of the grade_overview_report class.
file	provider.php
	Privacy Subsystem implementation for gradereport_overview.
file	renderer.php
	Renderer for the gradebook overview report.
file	services.php
	Overview grade report external functions and service definitions.
file	settings.php
	Defines site settings for the overview gradebook report.
file	upgrade.php
	Grade overview report upgrade steps.
file	version.php
	Version details for the overview gradebook report.

Namespaces
namespace	gradereport_overview\event
namespace	gradereport_overview\privacy

Classes
class	grade_report_overview
	Class providing an API for the overview report building and displaying. More...
class	gradereport_overview\privacy\provider
	Privacy Subsystem for gradereport_overview implementing null_provider. More...
class	gradereport_overview_external
class	gradereport_overview_renderer
	Custom renderer for the user grade report. More...

Functions
	grade_report_overview_settings_definition (&$mform)
	gradereport_overview_myprofile_navigation (core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course)
	Add nodes to myprofile page.
	xmldb_gradereport_overview_upgrade ($oldversion)
	Function to upgrade grade overview report.

Variables
	$capabilities
	$functions
	$plugin = 2023041800
$plugin	component = 'gradereport_overview'
$plugin	version = 2023042400

Detailed Description

Function Documentation

gradereport_overview_myprofile_navigation()

gradereport_overview_myprofile_navigation	(	core_user\output\myprofile\tree	$tree,
			$user,
			$iscurrentuser,
			$course
	)

Add nodes to myprofile page.

Parameters

core_user::output::myprofile::tree	$tree	Tree object
stdClass	$user	user object
bool	$iscurrentuser
stdClass	$course	Course object

xmldb_gradereport_overview_upgrade()

xmldb_gradereport_overview_upgrade

(

$oldversion

)

Function to upgrade grade overview report.

Parameters

int

$oldversion

the version we are upgrading from

Return values

bool

result

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
 
    'gradereport/overview:view' => array(
        'riskbitmask' => RISK_PERSONAL,
        'captype' => 'read',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => array(
            'user' => CAP_ALLOW
        )
    )
 
)

$functions

$functions

Initial value:

= array(
 
    'gradereport_overview_get_course_grades' => array(
        'classname' => 'gradereport_overview_external',
        'methodname' => 'get_course_grades',
        'description' => 'Get the given user courses final grades',
        'type' => 'read',
        'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
    ),
    'gradereport_overview_view_grade_report' => array(
        'classname' => 'gradereport_overview_external',
        'methodname' => 'view_grade_report',
        'description' => 'Trigger the report view event',
        'type' => 'write',
        'capabilities' => 'gradereport/overview:view',
        'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
    )
)