core_question\output\question_bank_filter_ui Class Reference

Inheritance diagram for core_question\output\question_bank_filter_ui:

Public Member Functions
array array string string string int null array	__construct (context $context, protected array $searchconditions, protected array $additionalparams, protected string $component, protected string $callback, protected string $view, ?string $tableregionid=null, protected ?int $cmid=null, array $pagevars=[], protected array $extraparams=[])
	$searchconditions Searchconditions for the filter.
	export_for_template (renderer_base $output)
	Export the renderer data in a mustache template friendly format.

Public Attributes
int const	JOINTYPE_ALL = 2
	All of the following match.
int const	JOINTYPE_ANY = 1
	Any of the following match.
int const	JOINTYPE_NONE = 0
	None of the following match.

Protected Member Functions
	get_filter_object (string $name, string $title, bool $custom, bool $multiple, ?string $filterclass, array $values, bool $allowempty=false, ?stdClass $filteroptions=null, bool $required=false, array $joinlist=[self::JOINTYPE_NONE, self::JOINTYPE_ANY, self::JOINTYPE_ALL])
	Get a standardised filter object.
	get_filtertypes ()
	Get data for all filter types.

Protected Attributes
context	$context
	$context The context where the filters are being rendered.
stdClass	$course
	$course The course shown
array	$pagevars
	Parameters for the page URL.
int	$perpage = 0
	$perpage number of records per page.
string	$tableregionid
	$tableregionid Container of the table to be updated by this filter, is used to retrieve the table

Constructor & Destructor Documentation

__construct()

array array string string string int null array core_question\output\question_bank_filter_ui::__construct	(	context	$context,
		protected array	$searchconditions,
		protected array	$additionalparams,
		protected string	$component,
		protected string	$callback,
		protected string	$view,
		?string	$tableregionid = null,
		protected ?int	$cmid = null,
		array	$pagevars = [],
		protected array	$extraparams = [] )

$searchconditions Searchconditions for the filter.

$additionalparams Conditino objects for the current filter. $component Component for calling the fragment callback. $callback Fragment callback. $view View class name. $cmid if in an activity, the cmid. $extraparams Additional parameters used by view classes. Create a new datafilter

Parameters

context	$context	The context of the course being displayed
array	$searchconditions	Array of condition objects for the current filters
array	$additionalparams	Additional display parameters
string	$component	the component for the fragment
string	$callback	the callback for the fragment
string	$view	the view class
?string	$tableregionid	The ID of the region to update with the fragment
?int	$cmid	if in an activity, the cmid.
array	$pagevars	current filter parameters
array	$extraparams	additional parameters required for a particular view class.

Member Function Documentation

export_for_template()

core_question\output\question_bank_filter_ui::export_for_template

(

renderer_base

$output

)

Export the renderer data in a mustache template friendly format.

Parameters

renderer_base

$output

Unused.

Return values

stdClass

Data in a format compatible with a mustache template.

Implements templatable.

get_filter_object()

core\output\datafilter::get_filter_object ( string $name, string $title, bool $custom, bool $multiple, ?string $filterclass, array $values, bool $allowempty = false, ?stdClass $filteroptions = null, bool $required = false, array $joinlist = [self::JOINTYPE_NONE, self::JOINTYPE_ANY, self::JOINTYPE_ALL] )

protectedinherited

Get a standardised filter object.

Parameters

string	$name
string	$title
bool	$custom
bool	$multiple
string | null	$filterclass
array	$values
bool	$allowempty

Return values

stdClass|null

get_filtertypes()

core_question\output\question_bank_filter_ui::get_filtertypes ( )

protected

Get data for all filter types.

Return values

array

Reimplemented from core\output\datafilter.

---

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

• question/classes/output/question_bank_filter_ui.php