core_reportbuilder\reportbuilder\audience\manual Class Reference

Inheritance diagram for core_reportbuilder\reportbuilder\audience\manual:

Public Member Functions
	get_config_form (MoodleQuickForm $mform)
	Adds audience's elements to the given mform.
	get_description ()
	Return the description for the audience.
	get_name ()
	Return user friendly name of this audience type.
	get_sql (string $usertablealias)
	Helps to build SQL to retrieve users that matches the current report audience.
	user_can_add ()
	If the current user is able to add this audience.
	user_can_edit ()
	If the current user is able to edit this audience.

Member Function Documentation

get_config_form()

core_reportbuilder\reportbuilder\audience\manual::get_config_form

(

MoodleQuickForm

$mform

)

Adds audience's elements to the given mform.

Parameters

MoodleQuickForm

$mform

The form to add elements to

get_description()

core_reportbuilder\reportbuilder\audience\manual::get_description

(

)

Return the description for the audience.

Return values

string

get_name()

core_reportbuilder\reportbuilder\audience\manual::get_name

(

)

Return user friendly name of this audience type.

Return values

string

get_sql()

core_reportbuilder\reportbuilder\audience\manual::get_sql

(

string

$usertablealias

)

Helps to build SQL to retrieve users that matches the current report audience.

Parameters

string

$usertablealias

Return values

array

array of three elements [$join, $where, $params]

user_can_add()

core_reportbuilder\reportbuilder\audience\manual::user_can_add

(

)

If the current user is able to add this audience.

Return values

bool

user_can_edit()

core_reportbuilder\reportbuilder\audience\manual::user_can_edit

(

)

If the current user is able to edit this audience.

Return values

bool

---

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

• reportbuilder/classes/reportbuilder/audience/manual.php