Moodle APIs 4.2
Moodle 4.2.7 (Build: 20240422)
Directories | Files | Namespaces | Classes | Functions | Variables
gradereport_grader

Directories

directory classes
  
 
directory tests
  
 

Files

file  access.php
 Capability definition for the gradebook grader report.
 
file  action_bar.php
 Renderable class for the action bar elements in the grader report.
 
file  behat_gradereport_grader.php
 Behat steps definitions for drag and drop onto image.
 
file  behat_gradereport_grader_deprecated.php
 Steps definitions that are now deprecated and will be removed in the next releases.
 
file  get_users_in_report.php
 External grade report grader API.
 
file  grade_report_viewed.php
 Grader report viewed event.
 
file  lib.php
 Definition of the grader report class.
 
file  preferences_form.php
 Form for grader report preferences.
 
file  provider.php
 Privacy Subsystem implementation for gradereport_grader.
 
file  services.php
 Grader grade report external functions and service definitions.
 
file  settings.php
 Defines site config settings for the grader report.
 
file  upgrade.php
 Grader report upgrade steps.
 
file  version.php
 Version details for the grader report.
 

Namespaces

namespace  gradereport_grader\event
  
 
namespace  gradereport_grader\external
  
 
namespace  gradereport_grader\output
  
 
namespace  gradereport_grader\privacy
  
 

Classes

class  behat_gradereport_grader
 Steps definitions related with the drag and drop onto image question type. More...
 
class  behat_gradereport_grader_deprecated
 
class  grade_report_grader
 Class providing an API for the grader report building and displaying. More...
 
class  grader_report_preferences_form
 First implementation of the preferences in the form of a moodleform. More...
 
class  gradereport_grader\event\grade_report_viewed
 Grader report viewed event class. More...
 
class  gradereport_grader\external\get_users_in_report
 
class  gradereport_grader\output\action_bar
 
class  gradereport_grader\privacy\provider
 Privacy Subsystem for gradereport_grader implementing null_provider. More...
 

Functions

 gradereport_grader_get_report_link (context_course $context, int $courseid, array $element, grade_plugin_return $gpr, string $mode, ?stdClass $templatecontext)
 Adds report specific context variable.
 
 xmldb_gradereport_grader_upgrade (int $oldversion)
 Function to upgrade grader report.
 

Variables

 $capabilities
 
 $functions
 
 $plugin = 2023041800
 
$plugin component = 'gradereport_grader'
 
 if (!defined( 'MOODLE_INTERNAL'))
 
$plugin version = 2023042400
 

Detailed Description

Function Documentation

◆ gradereport_grader_get_report_link()

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

Adds report specific context variable.

Parameters
context_course$contextCourse context
int$courseidCourse ID
array$elementAn array representing an element in the grade_tree
grade_plugin_return$gprA grade_plugin_return object
string$modeNot used
stdClass | null$templatecontextTemplate context
Return values
stdClass|null

◆ xmldb_gradereport_grader_upgrade()

xmldb_gradereport_grader_upgrade ( int  $oldversion)

Function to upgrade grader report.

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

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= array(
'gradereport/grader:view' => array(
'riskbitmask' => RISK_PERSONAL,
'captype' => 'read',
'contextlevel' => CONTEXT_COURSE,
'archetypes' => array(
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'manager' => 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:
= [
'gradereport_grader_get_users_in_report' => [
'classname' => 'gradereport_grader\\external\\get_users_in_report',
'methodname' => 'execute',
'description' => 'Returns the dataset of users within the report',
'type' => 'read',
'ajax' => true,
'capabilities' => 'gradereport/grader:view',
],
]
const MOODLE_OFFICIAL_MOBILE_SERVICE
Moodle mobile app service name.
Definition moodlelib.php:530