quizaccess_openclosedate Class Reference

Inheritance diagram for quizaccess_openclosedate:

Collaboration diagram for quizaccess_openclosedate:

Public Member Functions
	description ()
	prevent_access ()
	is_finished ($numprevattempts, $lastattempt)
	time_left ($attempt, $timenow)
Static Public Member Functions
static	make (quiz $quizobj, $timenow, $canignoretimelimits)

---

Detailed Description

A rule enforcing open and close dates.

Copyright:

2009 Tim Hunt http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Definition at line 38 of file rule.php.

---

Member Function Documentation

description

(

)

Information, such as might be shown on the quiz view page, relating to this restriction. There is no obligation to return anything. If it is not appropriate to tell students about this rule, then just return ''.

Returns:

mixed a message, or array of messages, explaining the restriction (may be '' if no message is appropriate).

Reimplemented from quiz_access_rule_base.

Definition at line 45 of file rule.php.

Here is the call graph for this function:

is_finished	(	$	numprevattempts,
		$	lastattempt
	)

If this rule can determine that this user will never be allowed another attempt at this quiz, then return true. This is used so we can know whether to display a final grade on the view page. This will only be called if there is not a currently active attempt for this user.

Parameters:

int	$numattempts	the number of previous attempts this user has made.
object	$lastattempt	information about the user's last completed attempt.

Returns:

bool true if this rule means that this user will never be allowed another attempt at this quiz.

Reimplemented from quiz_access_rule_base.

Definition at line 74 of file rule.php.

static make	(	quiz $	quizobj,
		$	timenow,
		$	canignoretimelimits
	)		[static]

Return an appropriately configured instance of this rule, if it is applicable to the given quiz, otherwise return null.

Parameters:

quiz	$quizobj	information about the quiz in question.
int	$timenow	the time that should be considered as 'now'.
bool	$canignoretimelimits	whether the current user is exempt from time limits by the mod/quiz:ignoretimelimits capability.

Returns:

quiz_access_rule_base|null the rule, if applicable, else null.

Reimplemented from quiz_access_rule_base.

Definition at line 40 of file rule.php.

prevent_access

(

)

Whether the user should be blocked from starting a new attempt or continuing an attempt now.

Returns:

string false if access should be allowed, a message explaining the reason if access should be prevented.

Reimplemented from quiz_access_rule_base.

Definition at line 66 of file rule.php.

time_left	(	$	attempt,
		$	timenow
	)

If, because of this rule, the user has to finish their attempt by a certain time, you should override this method to return the amount of time left in seconds.

Parameters:

object	$attempt	the current attempt
int	$timenow	the time now. We don't use $this->timenow, so we can give the user a more accurate indication of how much time is left.

Returns:

mixed false if there is no deadline, of the time left in seconds if there is one.

Reimplemented from quiz_access_rule_base.

Definition at line 78 of file rule.php.

---

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

• C:/xampp/htdocs/moodle/mod/quiz/accessrule/openclosedate/rule.php