gradereport_user

Directories
directory	classes

Files
file	access.php
	Defines capabilities for the user report.
file	action_bar.php
	Renderable class for the action bar elements in the user report page.
file	get_access_information.php
	External grade report API implementation.
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	user.php
	External grade report API implementation.
file	user.php
	Class providing an API for the user report building and displaying.
file	version.php
	Version details for the user gradebook report.

Namespaces
namespace	gradereport_user\event
namespace	gradereport_user\external
namespace	gradereport_user\output
namespace	gradereport_user\privacy
namespace	gradereport_user\report

Classes
class	gradereport_user\external\get_access_information
class	gradereport_user\external\user
class	gradereport_user\output\action_bar
class	gradereport_user\privacy\provider
	Privacy Subsystem for gradereport_user implementing null_provider. More...
class	gradereport_user\report\user
class	gradereport_user_renderer
	Custom renderer for the user grade report. More...

Functions
	grade_report_user_profilereport (object $course, object $user, bool $viewasuser=false)
	Profile report callback.
	grade_report_user_settings_definition (&$mform)
	gradereport_user_get_report_link (context_course $context, int $courseid, array $element, grade_plugin_return $gpr, string $mode, ?stdClass $templatecontext)
	Returns link to user report for the current element.
	gradereport_user_myprofile_navigation (tree $tree, stdClass $user, bool $iscurrentuser, ?stdClass $course)
	Add nodes to myprofile page.
	xmldb_gradereport_user_upgrade ($oldversion)

Variables
	$capabilities
global	gradereport_user\report::$CFG
	$functions
	$plugin = 2023041800
$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	version = 2023042400

Detailed Description

Function Documentation

grade_report_user_profilereport()

grade_report_user_profilereport	(	object	$course,
		object	$user,
		bool	$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_get_report_link()

gradereport_user_get_report_link	(	context_course	$context,
		int	$courseid,
		array	$element,
		grade_plugin_return	$gpr,
		string	$mode,
		?stdClass	$templatecontext
	)

Returns link to user report for the current element.

Parameters

context_course	$context	Course context
int	$courseid	Course ID
array	$element	An array representing an element in the grade_tree
grade_plugin_return	$gpr	A grade_plugin_return object
string	$mode	Mode - gradeitem or user
	?stdClass	$templatecontext Template context

Return values

stdClass|null

gradereport_user_myprofile_navigation()

gradereport_user_myprofile_navigation	(	tree	$tree,
		stdClass	$user,
		bool	$iscurrentuser,
		?stdClass	$course
	)

Add nodes to myprofile page.

Parameters

tree	$tree	Tree object
stdClass	$user	user object
bool	$iscurrentuser
null | 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:

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