gradereport_user

Files
file	access.php
	Defines capabilities for the user report.
file	externallib.php
	External grade report user API.
file	grade_report_viewed.php
	User report viewed event.
file	lib.php
	Definition of the grade_user_report class is defined.
file	provider.php
	Privacy Subsystem implementation for gradereport_user.
file	renderer.php
	Renderer for the grade user report.
file	services.php
	User grade report external functions and service definitions.
file	settings.php
	Defines site settings for the user gradebook report.
file	upgrade.php
	Gradereport user plugin upgrade code.
file	version.php
	Version details for the user gradebook report.

Namespaces
	gradereport_user\event
	gradereport_user\privacy

Classes
class	grade_report_user
	Class providing an API for the user report building and displaying. More...
class	gradereport_user\event\grade_report_viewed
	User report viewed event class. More...
class	gradereport_user\privacy\provider
	Privacy Subsystem for gradereport_user implementing null_provider. More...
class	gradereport_user_external
class	gradereport_user_renderer
	Custom renderer for the user grade report. More...

Functions
	grade_report_user_profilereport ($course, $user, $viewasuser=false)
	Profile report callback. More...
	grade_report_user_settings_definition (&$mform)
	gradereport_user_myprofile_navigation (core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course)
	Add nodes to myprofile page. More...
	xmldb_gradereport_user_upgrade ($oldversion)

Variables
	$capabilities
	$functions
$plugin	component = 'gradereport_user'
const	GRADE_REPORT_USER_HIDE_HIDDEN 0
const	GRADE_REPORT_USER_HIDE_UNTIL 1
const	GRADE_REPORT_USER_SHOW_HIDDEN 2
const	GRADE_REPORT_USER_VIEW_SELF 1
const	GRADE_REPORT_USER_VIEW_USER 2
$plugin	requires = 2019111200
$plugin	version = 2019111800

Detailed Description

Function Documentation

grade_report_user_profilereport()

grade_report_user_profilereport	(		$course,
			$user,
			$viewasuser = false
	)

Profile report callback.

Parameters

object	$course	The course.
object	$user	The user.
boolean	$viewasuser	True when we are viewing this as the targetted user sees it.

gradereport_user_myprofile_navigation()

gradereport_user_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_user_upgrade()

xmldb_gradereport_user_upgrade

(

$oldversion

)

Parameters

int

$oldversion

the version we are upgrading from

Return values

bool

result

Variable Documentation

$capabilities

$capabilities

Initial value:

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

$functions

$functions

Initial value:

= array(
 
    'gradereport_user_get_grades_table' => array(
        'classname' => 'gradereport_user_external',
        'methodname' => 'get_grades_table',
        'classpath' => 'grade/report/user/externallib.php',
        'description' => 'Get the user/s report grades table for a course',
        'type' => 'read',
        'capabilities' => 'gradereport/user:view',
        'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
    ),
    'gradereport_user_view_grade_report' => array(
        'classname' => 'gradereport_user_external',
        'methodname' => 'view_grade_report',
        'classpath' => 'grade/report/user/externallib.php',
        'description' => 'Trigger the report view event',
        'type' => 'write',
        'capabilities' => 'gradereport/user:view',
        'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
    ),
    'gradereport_user_get_grade_items' => array(
        'classname' => 'gradereport_user_external',
        'methodname' => 'get_grade_items',
        'classpath' => 'grade/report/user/externallib.php',
        'description' => 'Returns the complete list of grade items for users in a course',
        'type' => 'read',
        'capabilities' => 'gradereport/user:view',
        'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
    )
)