 |
Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
|
Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
This class efficiently finds questions at random from the question bank. More...
Public Member Functions | |
| __construct (\qubaid_condition $qubaids, array $usedquestions=[]) | |
| Constructor. | |
| count_filtered_questions (array $filters) | |
| Count number of filtered questions. | |
| count_questions ($categoryid, $includesubcategories, $tagids=[]) | |
| Count the number of available questions for the given criteria. | |
| get_filtered_questions ($filters, $limit=100, $offset=0, $fields=[]) | |
| Get the list of available questions for the given criteria. | |
| get_next_filtered_question_id (array $filters) | |
| Pick a random question based on filter conditions. | |
| get_next_question_id ($categoryid, $includesubcategories, $tagids=[]) | |
| Pick a question at random from the given category, from among those with the fewest uses. | |
| get_questions ($categoryid, $includesubcategories, $tagids=[], $limit=100, $offset=0, $fields=[]) | |
| Get the list of available questions for the given criteria. | |
| is_filtered_question_available (array $filters, int $questionid) | |
| Check whether a given question is available in a given category. | |
| is_question_available ($categoryid, $includesubcategories, $questionid, $tagids=[]) | |
| Check whether a given question is available in a given category. | |
Protected Member Functions | |
| ensure_filtered_questions_loaded (array $filters) | |
| Populate {. | |
| ensure_questions_for_category_loaded ($categoryid, $includesubcategories, $tagids=[]) | |
| Populate {. | |
| get_category_key ($categoryid, $includesubcategories, $tagids=[]) | |
| Get the key into {. | |
| get_filtered_question_ids (array $filters) | |
| Get filtered questions. | |
| get_filtered_questions_key (array $filters) | |
| Key for filtered questions. | |
| get_question_ids ($categoryid, $includesubcategories, $tagids=[]) | |
| Get the list of available question ids for the given criteria. | |
| use_question ($questionid) | |
| Update the internal data structures to indicate that a given question has been used one more time. | |
Protected Attributes | |
| array | $availablequestionscache = [] |
| categoryid & include subcategories => num previous uses => questionid => 1. | |
| array | $excludedqtypes |
| qtypes that cannot be used by random questions. | |
| qubaid_condition | $qubaids |
| which usages to consider previous attempts from. | |
| array | $recentlyusedquestions |
| questionid => num recent uses. | |
This class efficiently finds questions at random from the question bank.
You can ask for questions at random one at a time. Each time you ask, you pass a category id, and whether to pick from that category and all subcategories or just that category.
The number of teams each question has been used is tracked, and we will always return a question from among those elegible that has been used the fewest times. So, if there are questions that have not been used yet in the category asked for, one of those will be returned. However, within one instantiation of this class, we will never return a given question more than once, and we will never return questions passed into the constructor as $usedquestions.
| core_question\local\bank\random_question_loader::__construct | ( | \qubaid_condition | $qubaids, |
| array | $usedquestions = [] ) |
Constructor.
| qubaid_condition | $qubaids | the usages to consider when counting previous uses of each question. |
| array | $usedquestions | questionid => number of times used count. If we should allow for further existing uses of a question in addition to the ones in $qubaids. |
| core_question\local\bank\random_question_loader::count_filtered_questions | ( | array | $filters | ) |
Count number of filtered questions.
| array | $filters | filter array |
| int | number of question |
| core_question\local\bank\random_question_loader::count_questions | ( | $categoryid, | |
| $includesubcategories, | |||
| $tagids = [] ) |
Count the number of available questions for the given criteria.
| int | $categoryid | The id of a category in the question bank. |
| bool | $includesubcategories | Whether to pick a question from exactly that category, or that category and subcategories. |
| array | $tagids | An array of tag ids. If an array is provided, then only the questions that are tagged with ALL the provided tagids will be loaded. |
| int | The number of questions matching the criteria. |
|
protected |
Populate {.
| array | $filters | filter array |
| void |
|
protected |
Populate {.
| int | $categoryid | The id of a category in the question bank. |
| bool | $includesubcategories | Whether to pick a question from exactly that category, or that category and subcategories. |
| array | $tagids | An array of tag ids. If an array is provided, then only the questions that are tagged with ALL the provided tagids will be loaded. |
|
protected |
Get the key into {.
| int | $categoryid | the id of a category in the question bank. |
| bool | $includesubcategories | wether to pick a question from exactly that category, or that category and subcategories. |
| array | $tagids | an array of tag ids. |
| string | the cache key. |
|
protected |
Get filtered questions.
| array | $filters | filter array |
| array | list of filtered questions |
| core_question\local\bank\random_question_loader::get_filtered_questions | ( | $filters, | |
| $limit = 100, | |||
| $offset = 0, | |||
| $fields = [] ) |
Get the list of available questions for the given criteria.
| array | $filters | filter array |
| int | $limit | Maximum number of results to return. |
| int | $offset | Number of items to skip from the begging of the result set. |
| string[] | $fields | The fields to return for each question. |
| stdClass[] | The list of question records |
|
protected |
Key for filtered questions.
This function replace get_category_key
| array | $filters | filter array |
| String |
| core_question\local\bank\random_question_loader::get_next_filtered_question_id | ( | array | $filters | ) |
Pick a random question based on filter conditions.
| array | $filters | filter array |
| int|null |
| core_question\local\bank\random_question_loader::get_next_question_id | ( | $categoryid, | |
| $includesubcategories, | |||
| $tagids = [] ) |
Pick a question at random from the given category, from among those with the fewest uses.
If an array of tag ids are specified, then only the questions that are tagged with ALL those tags will be selected.
It is up the the caller to verify that the cateogry exists. An unknown category behaves like an empty one.
| int | $categoryid | the id of a category in the question bank. |
| bool | $includesubcategories | wether to pick a question from exactly that category, or that category and subcategories. |
| array | $tagids | An array of tag ids. A question has to be tagged with all the provided tagids (if any) in order to be eligible for being picked. |
| int|null | the id of the question picked, or null if there aren't any. |
|
protected |
Get the list of available question ids for the given criteria.
| int | $categoryid | The id of a category in the question bank. |
| bool | $includesubcategories | Whether to pick a question from exactly that category, or that category and subcategories. |
| array | $tagids | An array of tag ids. If an array is provided, then only the questions that are tagged with ALL the provided tagids will be loaded. |
| int[] | The list of question ids |
| core_question\local\bank\random_question_loader::get_questions | ( | $categoryid, | |
| $includesubcategories, | |||
| $tagids = [], | |||
| $limit = 100, | |||
| $offset = 0, | |||
| $fields = [] ) |
Get the list of available questions for the given criteria.
| int | $categoryid | The id of a category in the question bank. |
| bool | $includesubcategories | Whether to pick a question from exactly that category, or that category and subcategories. |
| array | $tagids | An array of tag ids. If an array is provided, then only the questions that are tagged with ALL the provided tagids will be loaded. |
| int | $limit | Maximum number of results to return. |
| int | $offset | Number of items to skip from the begging of the result set. |
| string[] | $fields | The fields to return for each question. |
| stdClass[] | The list of question records |
| core_question\local\bank\random_question_loader::is_filtered_question_available | ( | array | $filters, |
| int | $questionid ) |
Check whether a given question is available in a given category.
If so, mark it used. If an optional list of tag ids are provided, then the question must be tagged with ALL of the provided tags to be considered as available.
| array | $filters | filter array |
| int | $questionid | the question that is being used. |
| bool | whether the question is available in the requested category. |
| core_question\local\bank\random_question_loader::is_question_available | ( | $categoryid, | |
| $includesubcategories, | |||
| $questionid, | |||
| $tagids = [] ) |
Check whether a given question is available in a given category.
If so, mark it used. If an optional list of tag ids are provided, then the question must be tagged with ALL of the provided tags to be considered as available.
| int | $categoryid | the id of a category in the question bank. |
| bool | $includesubcategories | wether to pick a question from exactly that category, or that category and subcategories. |
| int | $questionid | the question that is being used. |
| array | $tagids | An array of tag ids. Only the questions that are tagged with all the provided tagids can be available. |
| bool | whether the question is available in the requested category. |
|
protected |
Update the internal data structures to indicate that a given question has been used one more time.
| int | $questionid | the question that is being used. |
|
protected |
questionid => num recent uses.
Questions that have been used, but that is not yet recorded in the DB.
1.11.0