Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250711) (9addea9f0ac)
qbank_editquestion\status_condition Class Reference
Inheritance diagram for qbank_editquestion\status_condition:
core_question\local\bank\condition

Public Member Functions

 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 ()
 Return a single join type, we don't want a join type selector for this condition.
 
 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 Public Member Functions

static build_query_from_filter (array $filter)
 Return an SQL condition to filter qv.status on the selected status.
 
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.
 

Public Attributes

array array $filter
 Filter properties for this condition.
 
int const JOINTYPE_DEFAULT = datafilter::JOINTYPE_ANY
 The default filter type.
 

Static Protected Member Functions

static get_status_list ()
 Return an array mapping the values returned from the filter to the values required for the query.
 

Protected Attributes

array array $params = []
 query param used in where.
 
string string $where = ''
 SQL fragment to add to the where clause.
 

Member Function Documentation

◆ allow_custom()

core_question\local\bank\condition::allow_custom ( )
inherited

Whether customisation is allowed.

Return values
bool

Reimplemented in qbank_managecategories\category_condition, qbank_tagquestion\tag_condition, and qbank_viewquestiontype\type_condition.

◆ allow_empty()

core_question\local\bank\condition::allow_empty ( )
inherited

Whether empty value is allowed.

Return values
bool

Reimplemented in qbank_managecategories\category_condition.

◆ allow_multiple()

core_question\local\bank\condition::allow_multiple ( )
inherited

Whether multiple values are allowed .

Return values
bool

Reimplemented in qbank_managecategories\category_condition.

◆ build_query_from_filter()

static qbank_editquestion\status_condition::build_query_from_filter ( array $filter)
static

Return an SQL condition to filter qv.status on the selected status.

Parameters
array$filter
Return values
array

Reimplemented from core_question\local\bank\condition.

◆ display_options()

core_question\local\bank\condition::display_options ( )
inherited

Display GUI for selecting criteria for this condition.

Displayed always, whether Show More is open or not.

Compare display_options_adv(), which displays when Show More is open.

Return values
bool|stringHTML form fragment
Deprecated
since Moodle 4.0 MDL-72321 - please do not use this function any more.
Todo
Final deprecation on Moodle 4.1 MDL-72572

Reimplemented in qbank_managecategories\category_condition, and qbank_tagquestion\tag_condition.

◆ display_options_adv()

core_question\local\bank\condition::display_options_adv ( )
inherited

Display GUI for selecting criteria for this condition.

Displayed when Show More is open.

Compare display_options(), which displays always, whether Show More is open or not.

Return values
bool|stringHTML form fragment
Deprecated
since Moodle 4.0 MDL-72321 - please do not use this function any more.
Todo
Final deprecation on Moodle 4.1 MDL-72572

Reimplemented in qbank_managecategories\category_condition.

◆ filter_invalid_values()

core_question\local\bank\condition::filter_invalid_values ( array $filterconditions)
inherited

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
array$filterconditions
Return values
array

Reimplemented in qbank_managecategories\category_condition.

◆ get_condition_class()

core_question\local\bank\condition::get_condition_class ( )
inherited

Return this condition class.

Return values
string

◆ get_condition_key()

static qbank_editquestion\status_condition::get_condition_key ( )
static

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
string

Reimplemented from core_question\local\bank\condition.

◆ get_filter_class()

qbank_editquestion\status_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
?stringfilter class

Reimplemented from core_question\local\bank\condition.

◆ get_filter_from_list()

static core_question\local\bank\condition::get_filter_from_list ( array $filters)
staticinherited

Given an array of filters, pick the entry that matches the condition key and return it.

Parameters
array$filtersArray of filters, keyed by condition.
Return values
?arrayThe filter that matches this condition

◆ get_filteroptions()

core_question\local\bank\condition::get_filteroptions ( )
inherited

Extra data specific to this condition.

Return values
stdClass

Reimplemented in qbank_managecategories\category_condition.

◆ get_initial_values()

core_question\local\bank\condition::get_initial_values ( )
inherited

◆ get_join_list()

qbank_editquestion\status_condition::get_join_list ( )

Return a single join type, we don't want a join type selector for this condition.

Return values
array

Reimplemented from core_question\local\bank\condition.

◆ get_status_list()

static qbank_editquestion\status_condition::get_status_list ( )
staticprotected

Return an array mapping the values returned from the filter to the values required for the query.

Return values
array

◆ get_title()

qbank_editquestion\status_condition::get_title ( )

Return title of the condition.

Return values
stringtitle of the condition

Reimplemented from core_question\local\bank\condition.

◆ is_required()

core_question\local\bank\condition::is_required ( )
inherited

Whether this filter is required - if so it cannot be removed from the list of filters.

Return values
bool

Reimplemented in qbank_deletequestion\hidden_condition, and qbank_managecategories\category_condition.

◆ params()

core_question\local\bank\condition::params ( )
inherited

Return parameters to be bound to the above WHERE clause fragment.

Return values
arrayparameter name => value.

◆ where()

core_question\local\bank\condition::where ( )
inherited

Return an SQL fragment to be ANDed into the WHERE clause to filter which questions are shown.

Return values
stringSQL fragment. Must use named parameters.

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