Moodle PHP Documentation 4.1
Moodle 4.1dev (Build: 20220512) (5e5e12e0)
Namespaces | Classes | Functions | Variables
quiz_statistics

Namespaces

namespace  quiz_statistics
  
 
namespace  quiz_statistics\privacy
  
 
namespace  quiz_statistics\task
  
 

Classes

class  quiz_statistics\calculated
 
class  quiz_statistics\calculator
 
class  quiz_statistics\privacy\provider
 Privacy Subsystem for quiz_statistics implementing null_provider. More...
 
class  quiz_statistics\task\quiz_statistics_cleanup
 Legacy Cron Quiz Reports Task. More...
 
class  quiz_statistics_question_table
 This table shows statistics about a particular question. More...
 
class  quiz_statistics_report
 The quiz statistics report provides summary information about each question in a quiz, compared to the whole quiz. More...
 
class  quiz_statistics_settings_form
 This is the settings form for the quiz statistics report. More...
 
class  quiz_statistics_table
 This table has one row for each question in the quiz, with sub-rows when random questions and variants appear. More...
 

Functions

 quiz_statistics_attempts_sql ($quizid, core\dml\sql_join $groupstudentsjoins, $whichattempts=QUIZ_GRADEAVERAGE, $includeungraded=false)
 SQL to fetch relevant 'quiz_attempts' records. More...
 
 quiz_statistics_graph_get_new_colour ()
 This helper function returns a sequence of colours each time it is called. More...
 
 quiz_statistics_qubaids_condition ($quizid, core\dml\sql_join $groupstudentsjoins, $whichattempts=QUIZ_GRADEAVERAGE, $includeungraded=false)
 Return a qubaid_condition from the values returned by quiz_statistics_attempts_sql. More...
 
 quiz_statistics_question_preview_pluginfile ($previewcontext, $questionid, $filecontext, $filecomponent, $filearea, $args, $forcedownload, $options=array())
 
 xmldb_quiz_statistics_install ()
 Post-install script.
 
 xmldb_quiz_statistics_upgrade ($oldversion)
 Quiz statistics report upgrade code.
 

Variables

 $capabilities
 
 $plugin = 2022041200
 
 $tasks
 
$plugin component = 'quiz_statistics'
 
$plugin version = 2022041900
 

Detailed Description

Function Documentation

◆ quiz_statistics_attempts_sql()

quiz_statistics_attempts_sql (   $quizid,
core\dml\sql_join  $groupstudentsjoins,
  $whichattempts = QUIZ_GRADEAVERAGE,
  $includeungraded = false 
)

SQL to fetch relevant 'quiz_attempts' records.

Parameters
int$quizidquiz id to get attempts for
core::dml::sql_join$groupstudentsjoinsContains joins, wheres, params, empty if not using groups
string$whichattemptswhich attempts to use, represented internally as one of the constants as used in $quiz->grademethod ie. QUIZ_GRADEAVERAGE, QUIZ_GRADEHIGHEST, QUIZ_ATTEMPTLAST or QUIZ_ATTEMPTFIRST we calculate stats based on which attempts would affect the grade for each student.
bool$includeungradedwhether to fetch ungraded attempts too
Return values
arrayFROM and WHERE sql fragments and sql params

◆ quiz_statistics_graph_get_new_colour()

quiz_statistics_graph_get_new_colour ( )

This helper function returns a sequence of colours each time it is called.

Used for choosing colours for graph data series.

Return values
stringcolour name.
Deprecated:
since Moodle 3.2

◆ quiz_statistics_qubaids_condition()

quiz_statistics_qubaids_condition (   $quizid,
core\dml\sql_join  $groupstudentsjoins,
  $whichattempts = QUIZ_GRADEAVERAGE,
  $includeungraded = false 
)

Return a qubaid_condition from the values returned by quiz_statistics_attempts_sql.

Parameters
int$quizid
core::dml::sql_join$groupstudentsjoinsContains joins, wheres, params
string$whichattemptswhich attempts to use, represented internally as one of the constants as used in $quiz->grademethod ie. QUIZ_GRADEAVERAGE, QUIZ_GRADEHIGHEST, QUIZ_ATTEMPTLAST or QUIZ_ATTEMPTFIRST we calculate stats based on which attempts would affect the grade for each student.
bool$includeungraded
Return values
qubaid_join

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= array(
'quiz/statistics:view' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'archetypes' => array(
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW
),
'clonepermissionsfrom' => 'mod/quiz:viewreports'
)
)
const CAP_ALLOW
Allow permission, overrides CAP_PREVENT defined in parent contexts.
Definition: accesslib.php:115
const CONTEXT_MODULE
Course module context level - one instance for each course module.
Definition: accesslib.php:130

◆ $tasks

$tasks
Initial value:
= [
[
'classname' => 'quiz_statistics\task\quiz_statistics_cleanup',
'blocking' => 0,
'minute' => 'R',
'hour' => '*/5',
'day' => '*',
'dayofweek' => '*',
'month' => '*'
]
]