|
| | __construct (?view $qbank=null) |
| | Extract the required filter from the provided question bank view and set the initial values.
|
| |
| | allow_custom () |
| | Whether customisation is allowed.
|
| |
| | allow_empty () |
| | Whether empty value is allowed.
|
| |
| | allow_multiple () |
| | Whether multiple values are allowed .
|
| |
| | display_options () |
| | Display GUI for selecting criteria for this condition.
|
| |
| | display_options_adv () |
| | Display GUI for selecting criteria for this condition.
|
| |
| | filter_invalid_values (array $filterconditions) |
| | Method to be overridden in condition classes to filter out anything invalid from the filterconditions array.
|
| |
| | get_condition_class () |
| | Return this condition class.
|
| |
| | get_filter_class () |
| | Return the Javascript filter class to provide the UI for this condition.
|
| |
| | get_filteroptions () |
| | Extra data specific to this condition.
|
| |
| | get_initial_values () |
| | Initial values of the condition.
|
| |
| | get_join_list () |
| | Get the list of available joins for the filter.
|
| |
| | get_title () |
| | Return title of the condition.
|
| |
| | is_required () |
| | Whether this filter is required - if so it cannot be removed from the list of filters.
|
| |
| | params () |
| | Return parameters to be bound to the above WHERE clause fragment.
|
| |
| | where () |
| | Return an SQL fragment to be ANDed into the WHERE clause to filter which questions are shown.
|
| |
|
| static | build_query_from_filter (array $filter) |
| | Return the SQL WHERE condition and parameters to be ANDed with other filter conditions.
|
| |
| static | get_condition_key () |
| | Each condition will need a unique key to be identified and sequenced by the api.
|
| |
| static | get_filter_from_list (array $filters) |
| | Given an array of filters, pick the entry that matches the condition key and return it.
|
| |
|
|
array array | $filter |
| | Filter properties for this condition.
|
| |
|
int const | JOINTYPE_DEFAULT = datafilter::JOINTYPE_ANY |
| | The default filter type.
|
| |
|
|
array array | $params = [] |
| | query param used in where.
|
| |
|
string string | $where = '' |
| | SQL fragment to add to the where clause.
|
| |
◆ __construct()
| core_question\local\bank\condition::__construct |
( |
?view | $qbank = null | ) |
|
Extract the required filter from the provided question bank view and set the initial values.
This will look for the filter matching {
- See also
- get_condition_key()} in the view's current filter parameter. If the filter is not being initialised to display the question bank UI (for example, to resolve a list of questions matching a set of filters), then the
$qbank argument may be null, and any usage of it to set the initial filter state is skipped.
- Parameters
-
| ?view | $qbank | The question bank view the filter is being rendered for. This may only be used for setting the initial state of the filter. |
Reimplemented in qbank_managecategories\category_condition.
◆ allow_custom()
| core_question\local\bank\condition::allow_custom |
( |
| ) |
|
◆ allow_empty()
| core_question\local\bank\condition::allow_empty |
( |
| ) |
|
◆ allow_multiple()
| core_question\local\bank\condition::allow_multiple |
( |
| ) |
|
◆ build_query_from_filter()
| static core_question\local\bank\condition::build_query_from_filter |
( |
array | $filter | ) |
|
|
staticabstract |
Return the SQL WHERE condition and parameters to be ANDed with other filter conditions.
The $filter parameter recieves an array with a 'values' key, containing an array of the filter values selected, and a 'jointype' key containing the selected join type.
- Parameters
-
| array | $filter | filter properties |
- Return values
-
| array | ['SQL where condition', ['param1' => 'value1', 'param2' => 'value2', ...]] |
Reimplemented in qbank_deletequestion\hidden_condition, qbank_editquestion\status_condition, qbank_managecategories\category_condition, qbank_tagquestion\tag_condition, qbank_viewcreator\timemodified_condition, qbank_viewcreator\user_condition, qbank_viewquestionname\question_idnumber_condition, qbank_viewquestionname\question_name_condition, qbank_viewquestiontext\questiontext_condition, and qbank_viewquestiontype\type_condition.
◆ display_options()
| core_question\local\bank\condition::display_options |
( |
| ) |
|
◆ display_options_adv()
| core_question\local\bank\condition::display_options_adv |
( |
| ) |
|
◆ filter_invalid_values()
| core_question\local\bank\condition::filter_invalid_values |
( |
array | $filterconditions | ) |
|
Method to be overridden in condition classes to filter out anything invalid from the filterconditions array.
This can be applied anywhere where the $filterconditions array exists, to let condition plugins remove elements from the array, based on their own internal logic/validation. For example, this is used on the /mod/quiz/editrandom.php page to filter out question categories which no longer exist, which previously broke the editrandom page.
- Parameters
-
- Return values
-
Reimplemented in qbank_managecategories\category_condition.
◆ get_condition_class()
| core_question\local\bank\condition::get_condition_class |
( |
| ) |
|
Return this condition class.
- Return values
-
◆ get_condition_key()
| static core_question\local\bank\condition::get_condition_key |
( |
| ) |
|
|
staticabstract |
Each condition will need a unique key to be identified and sequenced by the api.
Use a unique string for the condition identifier, use string directly, dont need to use language pack. Using language pack might break the filter object for multilingual support.
- Return values
-
Reimplemented in qbank_deletequestion\hidden_condition, qbank_editquestion\status_condition, qbank_managecategories\category_condition, qbank_tagquestion\tag_condition, qbank_viewcreator\createdby_condition, qbank_viewcreator\modifiedby_condition, qbank_viewcreator\timemodified_condition, qbank_viewquestionname\question_idnumber_condition, qbank_viewquestionname\question_name_condition, qbank_viewquestiontext\questiontext_condition, and qbank_viewquestiontype\type_condition.
◆ get_filter_class()
| core_question\local\bank\condition::get_filter_class |
( |
| ) |
|
Return the Javascript filter class to provide the UI for this condition.
If left as null, this will use the default core/datafilter/filtertype class. Otherwise, override it to return the full path to the Javascript module path for the class.
- Return values
-
Reimplemented in qbank_deletequestion\hidden_condition, qbank_editquestion\status_condition, qbank_managecategories\category_condition, qbank_tagquestion\tag_condition, qbank_viewcreator\timemodified_condition, qbank_viewcreator\user_condition, qbank_viewquestionname\question_idnumber_condition, qbank_viewquestionname\question_name_condition, qbank_viewquestiontext\questiontext_condition, and qbank_viewquestiontype\type_condition.
◆ get_filter_from_list()
| static core_question\local\bank\condition::get_filter_from_list |
( |
array | $filters | ) |
|
|
static |
Given an array of filters, pick the entry that matches the condition key and return it.
- Parameters
-
| array | $filters | Array of filters, keyed by condition. |
- Return values
-
| ?array | The filter that matches this condition |
◆ get_filteroptions()
| core_question\local\bank\condition::get_filteroptions |
( |
| ) |
|
◆ get_initial_values()
| core_question\local\bank\condition::get_initial_values |
( |
| ) |
|
◆ get_join_list()
| core_question\local\bank\condition::get_join_list |
( |
| ) |
|
◆ get_title()
| core_question\local\bank\condition::get_title |
( |
| ) |
|
|
abstract |
Return title of the condition.
- Return values
-
| string | title of the condition |
Reimplemented in qbank_deletequestion\hidden_condition, qbank_editquestion\status_condition, qbank_managecategories\category_condition, qbank_tagquestion\tag_condition, qbank_viewcreator\createdby_condition, qbank_viewcreator\modifiedby_condition, qbank_viewcreator\timemodified_condition, qbank_viewquestionname\question_idnumber_condition, qbank_viewquestionname\question_name_condition, qbank_viewquestiontext\questiontext_condition, and qbank_viewquestiontype\type_condition.
◆ is_required()
| core_question\local\bank\condition::is_required |
( |
| ) |
|
◆ params()
| core_question\local\bank\condition::params |
( |
| ) |
|
Return parameters to be bound to the above WHERE clause fragment.
- Return values
-
| array | parameter name => value. |
◆ where()
| core_question\local\bank\condition::where |
( |
| ) |
|
Return an SQL fragment to be ANDed into the WHERE clause to filter which questions are shown.
- Return values
-
| string | SQL fragment. Must use named parameters. |
The documentation for this class was generated from the following file:
- question/classes/local/bank/condition.php
1.13.2