gradereport_user

Topics
	external

Directories
directory	classes

Namespaces
namespace	gradereport_user\event
	User report viewed event.
namespace	gradereport_user\output
namespace	gradereport_user\privacy
	Privacy Subsystem implementation for gradereport_user.
namespace	gradereport_user\report

Classes
class	gradereport_user\output\action_bar
	Renderable class for the action bar elements in the user report page. More...
class	gradereport_user\privacy\provider
	Privacy Subsystem for gradereport_user implementing null_provider. More...
class	gradereport_user\report\user
	Class providing an API for the user report building and displaying. More...
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 = 2023100400
$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 = 2023100900

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
        ]
    ],
]