core_reportbuilder\local\filters\date Class Reference

Inheritance diagram for core_reportbuilder\local\filters\date:

Public Member Functions
	applies_to_values (array $values)
	Given an array of current filter values for the report, determine whether the filter would apply to the report (i.e.
	get_entity_name ()
	Returns the filter's entity name.
	get_filter_persistent ()
	Returns the filter persistent.
	get_header ()
	Returns the filter header.
	get_sample_values ()
	Return sample filter values.
	get_sql_filter (array $values)
	Return filter SQL.
	setup_form (MoodleQuickForm $mform)
	Setup form.

Static Public Member Functions
static	create (filter $filter)
	Creates an instance of a filter type, based on supplied report filter instance.

Public Attributes
int const	DATE_AFTER = 10
	Date after [X relative date unit(s)].
int const	DATE_ANY = 0
	Any value.
int const	DATE_BEFORE = 9
	Date before [X relative date unit(s)].
int const	DATE_CURRENT = 5
	Date in current [relative date unit].
int const	DATE_EMPTY = 2
	Empty (zero) value.
int const	DATE_FUTURE = 8
	Date in the future.
int const	DATE_LAST = 4
	Date in the last [X relative date unit(s)].
int const	DATE_NEXT = 6
	Date in the next [X relative date unit(s)].
int const	DATE_NOT_EMPTY = 1
	Non-empty (positive) value.
int const	DATE_PAST = 7
	Date in the past.
int const	DATE_PREVIOUS = self::DATE_LAST
	Date in the previous [X relative date unit(s)] Kept for backwards compatibility.
int const	DATE_RANGE = 3
	Date within defined range.
int const	DATE_UNIT_DAY = 1
	Relative date unit for a day.
int const	DATE_UNIT_HOUR = 0
	Relative date unit for an hour.
int const	DATE_UNIT_MONTH = 3
	Relative date unit for a month.
int const	DATE_UNIT_WEEK = 2
	Relative date unit for a week.
int const	DATE_UNIT_YEAR = 4
	Relative date unit for a month.

Protected Attributes
filter	$filter
	$filter
string	$name
	$name

Member Function Documentation

applies_to_values()

core_reportbuilder\local\filters\base::applies_to_values ( array $values )

inherited

Given an array of current filter values for the report, determine whether the filter would apply to the report (i.e.

user has configured it from it's initial "Any value" state). A filter would typically be considered applied if it returns SQL filter clauses, but child classes may override this method if they use different logic

Parameters

array

$values

Return values

bool

create()

static core_reportbuilder\local\filters\base::create ( filter $filter )

staticfinalinherited

Creates an instance of a filter type, based on supplied report filter instance.

The report filter instance is used by reports/entities to define what should be filtered against, e.g. a SQL fragment

Parameters

filter

$filter

The report filter instance

Return values

static

get_entity_name()

core_reportbuilder\local\filters\base::get_entity_name ( )

finalinherited

Returns the filter's entity name.

Return values

string

get_filter_persistent()

core_reportbuilder\local\filters\base::get_filter_persistent ( )

finalinherited

Returns the filter persistent.

Note that filters for system reports don't store a persistent and will return null.

Return values

filter_model|null

get_header()

core_reportbuilder\local\filters\base::get_header ( )

finalinherited

Returns the filter header.

Return values

string

get_sample_values()

core_reportbuilder\local\filters\date::get_sample_values

(

)

Return sample filter values.

Return values

array

Reimplemented from core_reportbuilder\local\filters\base.

get_sql_filter()

core_reportbuilder\local\filters\date::get_sql_filter

(

array

$values

)

Return filter SQL.

Parameters

array

$values

Return values

array

Reimplemented from core_reportbuilder\local\filters\base.

setup_form()

core_reportbuilder\local\filters\date::setup_form

(

MoodleQuickForm

$mform

)

Setup form.

Parameters

MoodleQuickForm

$mform

Reimplemented from core_reportbuilder\local\filters\base.

---

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

• reportbuilder/classes/local/filters/date.php