[MDL-80945] Update quizaccess page

Author: Michael Kotlyar

data/main/components.json

@@ -34,6 +34,7 @@
         "qbank": "public/question/bank",
         "qbehaviour": "public/question/behaviour",
         "qformat": "public/question/format",
+        "quizaccess": "public/mod/quiz/access",
         "plagiarism": "public/plagiarism",
         "tool": "public/admin/tool",
         "cachestore": "public/cache/stores",

docs/apis/plugintypes/quizaccess/_examples/override_rule.md

@@ -0,0 +1,4 @@
+<!-- markdownlint-disable first-line-heading -->
+Most quiz settings can be overridden on a per user and/or group level and you can extend this ability to your rule as well. To make your rule overridable, you must create the `override_rule` class extending `mod_quiz\local\access_override_rule_base`.
+
+Please refer to the inline phpdocs of the [mod_quiz::access_override_rule_base class](https://github.com/moodle/moodle/blob/main/mod/quiz/classes/local/access_override_rule_base.php) for detailed descriptions of the functions and meaning.

docs/apis/plugintypes/quizaccess/_examples/override_rule.php

@@ -0,0 +1,48 @@
+use mod_quiz\local\access_override_rule_base;
+use MoodleQuickForm;
+use context_module;
+use context;
+
+class override_rule extends access_override_rule_base {
+
+    /**
+     * All of the below access_override_rule_base functions to be implemented.
+     */
+
+    public static function add_form_fields(context_module $context, int $overrideid, object $quiz, MoodleQuickForm $mform): void {
+        // Do nothing.
+    }
+
+    public static function validate_form_fields(array $errors,
+            array $data, array $files, context_module $context): array {
+        return [];
+    }
+
+    public static function save_settings(array $override): void {
+        // Do nothing.
+    }
+
+    public static function delete_settings(int $quizid, array $overrides): void {
+        // Do nothing.
+    }
+
+    public static function get_settings(): array {
+        return [];
+    }
+
+    public static function get_required_settings(): array {
+        return [];
+    }
+
+    public static function get_settings_sql(string $overridetablename): array {
+        return [];
+    }
+
+    public static function add_table_fields(object $override, array $fields, array $values, context $context): array {
+        return [];
+    }
+
+    public static function clean_form_data(array $formdata): array {
+        return $formdata;
+    }
+}

docs/apis/plugintypes/quizaccess/_examples/rule.php

@@ -1,4 +1,3 @@
-use mod_quiz\form\edit_override_form;
 use mod_quiz\form\preflight_check_form;
 use mod_quiz\quiz_settings;
 use mod_quiz\local\access_rule_base;

docs/apis/plugintypes/quizaccess/_examples/rule_overridable.md

@@ -1,5 +1,5 @@
 ---
-title: Quiz access rule sub-plugins
+title: Quiz access rules
 tags:
   - Quiz
   - Access
@@ -11,7 +11,7 @@ tags:
 
 import { ComponentFileSummary } from '../../../_utils';
 
-Quiz access rule sub-plugins extend the ability to add conditions a user must meet to attempt a given quiz.
+Quiz access rules give the ability to add conditions a user must meet to attempt a given quiz.
 
 The following rules are readily available as part of Moodle core:
 
@@ -67,20 +67,22 @@ import RuleDescription from './_examples/rule.md';
     description={RuleDescription}
 />
 
-import RuleOverridableFile from '!!raw-loader!./_examples/rule_overridable.php';
-import RuleOverridableDescription from './_examples/rule_overridable.md';
+### classes/override_rule.php
+
+import OverrideRuleFile from '!!raw-loader!./_examples/override_rule.php';
+import OverrideRuleDescription from './_examples/override_rule.md';
 
 <ComponentFileSummary
-    filepath="/rule.php"
-    summary="Rule definition class with override"
+    filepath="/classes/override_rule.php"
+    summary="Override rule definition class"
     plugintype="quizaccessrule"
     pluginname="pluginname"
-    example={RuleOverridableFile}
-    description={RuleOverridableDescription}
+    example={OverrideRuleFile}
+    description={OverrideRuleDescription}
 />
 
 :::info
 
-Implementing `rule_overridable` is not required but can enhance the usability of the rule.
+Implementing `override_rule` is not required but can enhance the usability of the access rule.
 
 :::

docs/apis/plugintypes/quizaccess/_examples/rule_overridable.php

@@ -0,0 +1,4 @@
+<!-- markdownlint-disable first-line-heading -->
+Most quiz settings can be overridden on a per user and/or group level and you can extend this ability to your rule as well. To make your rule overridable, you must create the `override_rule` class extending `mod_quiz\local\access_override_rule_base`.
+
+Please refer to the inline phpdocs of the [mod_quiz::access_override_rule_base class](https://github.com/moodle/moodle/blob/main/mod/quiz/classes/local/access_override_rule_base.php) for detailed descriptions of the functions and meaning.

docs/apis/plugintypes/quizaccess/index.md

@@ -0,0 +1,49 @@
+use mod_quiz\form\edit_override_form;
+use mod_quiz\local\access_override_rule_base;
+use MoodleQuickForm;
+use context_module;
+use context;
+
+class override_rule extends access_override_rule_base {
+
+    /**
+     * All of the below access_override_rule_base be implemented below.
+     */
+
+    public static function add_form_fields(context_module $context, int $overrideid, object $quiz, MoodleQuickForm $mform): void {
+        // Do nothing.
+    }
+
+    public static function validate_form_fields(array $errors,
+            array $data, array $files, edit_override_form $quizform): array {
+        return [];
+    }
+
+    public static function save_settings(array $override): void {
+        // Do nothing.
+    }
+
+    public static function delete_settings(int $quizid, array $overrides): void {
+        // Do nothing.
+    }
+
+    public static function get_settings(): array {
+        return [];
+    }
+
+    public static function get_required_settings(): array {
+        return [];
+    }
+
+    public static function get_settings_sql(string $overridetablename): array {
+        return [];
+    }
+
+    public static function add_table_fields(object $override, array $fields, array $values, context $context): array {
+        return [];
+    }
+
+    public static function clean_form_data(array $formdata): array {
+        return $formdata;
+    }
+}

versioned_docs/version-5.0/apis/plugintypes/quizaccess/_examples/override_rule.md

@@ -1,4 +1,3 @@
-use mod_quiz\form\edit_override_form;
 use mod_quiz\form\preflight_check_form;
 use mod_quiz\quiz_settings;
 use mod_quiz\local\access_rule_base;