Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
gradereport_overview

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
 External grade overview report API implementation. More...
 
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$treeTree object
stdClass$useruser object
bool$iscurrentuser
stdClass$courseCourse object

◆ xmldb_gradereport_overview_upgrade()

xmldb_gradereport_overview_upgrade ( $oldversion)

Function to upgrade grade overview report.

Parameters
int$oldversionthe version we are upgrading from
Return values
boolresult

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= array(
'gradereport/overview:view' => array(
'riskbitmask' => RISK_PERSONAL,
'captype' => 'read',
'contextlevel' => CONTEXT_COURSE,
'archetypes' => array(
'user' => CAP_ALLOW
)
)
)
const CONTEXT_COURSE
Course context level - one instances for each course.
Definition accesslib.php:128
const CAP_ALLOW
Allow permission, overrides CAP_PREVENT defined in parent contexts.
Definition accesslib.php:115
const RISK_PERSONAL
Capability allows access to personal user information - see
Definition accesslib.php:145

◆ $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),
)
)
const MOODLE_OFFICIAL_MOBILE_SERVICE
Moodle mobile app service name.
Definition moodlelib.php:530