Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Files | Namespaces | Classes | Functions | Variables
report_participation

Files

file  access.php
 Capabilities.
 
file  locallib.php
 This file contains functions used by the participation reports.
 
file  provider.php
 Privacy Subsystem implementation for report_participation.
 
file  report_viewed.php
 The report_participation report viewed event.
 

Namespaces

namespace  report_participation\event
  
 
namespace  report_participation\privacy
  
 

Classes

class  report_participation\event\report_viewed
 
class  report_participation\privacy\provider
 Privacy Subsystem for report_participation implementing null_provider. More...
 

Functions

 report_participation_get_action_options ()
 List of action filters. More...
 
 report_participation_get_action_sql ($action, $modname)
 Return action sql and params. More...
 
 report_participation_get_crud_sql ($action)
 Return crud sql and params. More...
 
 report_participation_get_log_table_name ()
 Returns log table name of preferred reader, if leagcy then return empty string. More...
 
 report_participation_get_time_options ($minlog)
 Return time options, which should be shown for record filtering. More...
 
 report_participation_print_filter_form ($course, $timefrom, $minlog, $action, $roleid, $instanceid)
 Print filter form. More...
 

Variables

 $capabilities
 

Detailed Description

Function Documentation

◆ report_participation_get_action_options()

report_participation_get_action_options ( )

List of action filters.

Return values
array

◆ report_participation_get_action_sql()

report_participation_get_action_sql (   $action,
  $modname 
)

Return action sql and params.

Parameters
string$actionaction to be filtered.
string$modnamemodule name.
Return values
arrayactionsql and actionparams.

◆ report_participation_get_crud_sql()

report_participation_get_crud_sql (   $action)

Return crud sql and params.

Parameters
string$actionaction to be filtered.
Return values
arraycrudsql and crudparams.

◆ report_participation_get_log_table_name()

report_participation_get_log_table_name ( )

Returns log table name of preferred reader, if leagcy then return empty string.

Return values
stringtable name

◆ report_participation_get_time_options()

report_participation_get_time_options (   $minlog)

Return time options, which should be shown for record filtering.

Parameters
int$minlogTime of first log record available.
Return values
arraytime options.

◆ report_participation_print_filter_form()

report_participation_print_filter_form (   $course,
  $timefrom,
  $minlog,
  $action,
  $roleid,
  $instanceid 
)

Print filter form.

Parameters
stdClass$coursecourse object.
int$timefromTime from which records should be fetched.
int$minlogTime of first record present in log store.
string$actionaction to be filtered.
int$roleidRole to be filtered.
int$instanceidInstance id of module.

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= array(
'report/participation:view' => array(
'riskbitmask' => RISK_PERSONAL,
'captype' => 'read',
'contextlevel' => CONTEXT_COURSE,
'archetypes' => array(
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW
),
'clonepermissionsfrom' => 'coursereport/participation:view',
)
)
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