Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
mod_quiz\output\view_page Class Reference

This class captures all the various information to render the front page of the quiz activity. More...

Public Attributes

access_manager $accessmanager
 $accessmanager contains various access rules.
 
int $attemptcolumn
 $attemptcolumn contains the number of attempts done.
 
quiz_attempt[] $attemptobjs
 $attemptobjs objects corresponding to $attempts.
 
array $attempts
 $attempts contains all the user's attempts at this quiz.
 
moodle_url $backtocourseurl
 $startattempturl URL for any Back to the course button.
 
string $buttontext
 $buttontext caption for the start attempt button.
 
bool $canedit
 $canedit whether the current user has the capability to edit the quiz.
 
bool $canreviewmine
 $canreviewmine whether the current user has the capability to review their own attempts.
 
moodle_url $editurl
 $editurl the URL for editing this quiz.
 
string $feedbackcolumn
 $feedbackcolumn contains any feedback for and attempt.
 
string $gradebookfeedback
 $gradebookfeedback contains any feedback for a gradebook.
 
int $gradecolumn
 $gradecolumn contains the grades of any attempts.
 
array $infomessages
 $infomessages of messages with information to display about the quiz.
 
stdClass $lastfinishedattempt
 $lastfinishedattempt the last attempt from the attempts array.
 
int $markcolumn
 $markcolumn contains the marks of any attempt.
 
bool $moreattempts
 $moreattempts whether this user is allowed more attempts.
 
float $mygrade
 $mygrade contains the user's final grade for a quiz.
 
int $mygradeoverridden
 $mygradeoverridden contains an overriden grade.
 
int $numattempts
 $numattempts contains the total number of attempts.
 
int $overallstats
 $overallstats contains all marks for any attempt.
 
array $popupoptions
 options to use for the popup window, if required.
 
bool $popuprequired
 whether the attempt must take place in a popup window.
 
preflight_check_form null $preflightcheckform
 $preflightcheckform confirmation form that must be submitted before an attempt is started, if required.
 
array $preventmessages
 $preventmessages of messages telling the user why they can't attempt the quiz now.
 
bool $quizhasquestions
 $quizhasquestions whether the quiz has any questions.
 
bool $showbacktocourse
 $showbacktocourse should we show a back to the course button?
 
moodle_url $startattempturl
 $startattempturl URL to start an attempt.
 
string $timenow
 $timenow contains a timestamp in string format.
 
bool $unfinished
 $unfinished contains 1 if an attempt is unfinished.
 

Detailed Description

This class captures all the various information to render the front page of the quiz activity.

This class is not currently renderable or templatable, but it very nearly could be, which is why it is in the output namespace. It is used to send data to the renderer.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Data Documentation

◆ $buttontext

string mod_quiz\output\view_page::$buttontext

$buttontext caption for the start attempt button.

If this is null, show no button, or if it is '' show a back to the course button.


The documentation for this class was generated from the following file: