require_once ($CFG->dirroot.'/mod/quiz/lib.php') (line 22)

Include those library functions that are also used by core Moodle or other modules

QUIZ_ATTEMPTLAST = "4" (line 34)

Options determining how the grades from individual attempts are combined to give

the overall grade for a user

QUIZ_GRADEHIGHEST = "1" (line 31)

Options determining how the grades from individual attempts are combined to give

the overall grade for a user

QUIZ_STATE_DURING = 'during' (line 40)

Constants to describe the various states a quiz attempt can be in.

QUIZ_STATE_OPEN = 'open' (line 42)

Constants to describe the various states a quiz attempt can be in.

quiz_calculate_best_attempt (line 526)

Return the attempt with the best grade for a quiz

Which attempt is the best depends on $quiz->grademethod. If the grade method is GRADEAVERAGE then this function simply returns the last attempt.

• return: attempt with the best grade

• object $quiz: The quiz for which the best grade is to be calculated
• array $attempts: An array of all the attempts of the user at the quiz

quiz_create_attempt (line 59)

Creates an object to represent a new attempt at a quiz

Creates an attempt object to represent an attempt at the quiz by the current user starting at the current time. The ->id field is not set. The object is NOT written to the database.

• return: newly created attempt object.

• object $quiz: The quiz to create an attempt for.
• integer $attemptnumber: The sequence number for the attempt.

quiz_feedback_for_grade (line 340)

Get the feedback text that should be show to a student who got this grade on this quiz. The feedback is processed ready for diplay.

• return: the comment that corresponds to this grade (empty string if there is not one.

• float $grade: a grade on this quiz.
• integer $quizid: the id of the quiz object.

quiz_get_all_question_grades (line 267)

Creates an array of maximum grades for a quiz

The grades are extracted from the quiz_question_instances table.

• return: Array of grades indexed by question id These are the maximum possible grades that students can achieve for each of the questions

• integer $quiz: The quiz object

quiz_get_combined_reviewoptions (line 754)

Combines the review options from a number of different quiz attempts.

Returns an array of two ojects, so he suggested way of calling this funciton is: list($someoptions, $alloptions) = quiz_get_combined_reviewoptions(...)

• return: of two options objects, one showing which options are true for at least one of the attempts, the other showing which options are true for all attempts.

• object $quiz: the quiz instance.
• array $attempts: an array of attempt objects.
• $context $context: the roles and permissions context, normally the context for the quiz module instance.

quiz_get_grading_option_name (line 571)

• return: lang string for that option.

• int $option: one of the values QUIZ_GRADEHIGHEST, QUIZ_GRADEAVERAGE, QUIZ_ATTEMPTFIRST or QUIZ_ATTEMPTLAST.

quiz_get_reviewoptions (line 689)

Determine review options

• return: object with boolean fields responses, scores, feedback, correct_responses, solutions and general feedback

• object $quiz: the quiz instance.
• object $attempt: the attempt in question.
• $context $context: the roles and permissions context, normally the context for the quiz module instance.

quiz_has_feedback (line 360)

• return: Whether this quiz has any non-blank feedback text.

• integer $quizid: the id of the quiz object.

quiz_parse_fieldname (line 581)

Parse field names used for the replace options on question edit forms

• $name
• $nameprefix

quiz_questions_in_quiz (line 160)

Returns a comma separated list of question ids for the quiz

• return: Comma separated list of question ids

• string $layout: The string representing the quiz layout. Each page is represented as a comma separated list of question ids and 0 indicating page breaks. So 5,2,0,3,0 means questions 5 and 2 on page 1 and question 3 on page 2

quiz_question_preview_button (line 630)

• return: HTML for a preview question icon.

• object $quiz: the quiz
• object $question: the question

quiz_rescale_grade (line 320)

Convert the raw grade stored in $attempt into a grade out of the maximum grade for this quiz.

• return: the rescaled grade.

• float $rawgrade: the unadjusted grade, fof example $attempt->sumgrades
• object $quiz: the quiz object. Only the fields grade, sumgrades and decimalpoints are used.
• $round

quiz_send_confirmation (line 781)

Sends confirmation email to the student taking the course

• return: result of email_to_user()

• stdClass $a: associative array of replaceable fields for the templates

quiz_send_notification_emails (line 835)

Takes a bunch of information to format into an email and send to the specified recipient.

• return: number of emails sent

• object $course: the course
• object $quiz: the quiz
• object $attempt: this attempt just finished
• object $context: the quiz context
• object $cm: the coursemodule for this quiz

quiz_upgrade_states (line 599)

Upgrade states for an attempt to Moodle 1.5 model

Any state that does not yet have its timestamp set to nonzero has not yet been upgraded from Moodle 1.4 The reason these are still around is that for large sites it would have taken too long to upgrade all states at once. This function sets the timestamp field and creates an entry in the question_sessions table.

• object $attempt: The attempt whose states need upgrading