core_reportbuilder\local\entities\base Class Reference

Inheritance diagram for core_reportbuilder\local\entities\base:

Public Member Functions
	add_join (string $join)
	Add join clause required for this entity to join to existing tables/entities.
	add_joins (array $joins)
	Add multiple join clauses required for this entity {.
	get_column (string $name)
	Returns an entity column.
	get_columns ()
	Returns entity columns.
	get_condition (string $name)
	Returns an entity condition.
	get_conditions ()
	Returns entity conditions.
	get_entity_name ()
	Return entity name.
	get_entity_title ()
	Get entity title.
	get_filter (string $name)
	Returns an entity filter.
	get_filters ()
	Returns entity filters.
	get_joins ()
	Return entity joins.
	get_table_alias (string $tablename)
	Returns an alias used in the queries for a given table.
	get_table_aliases ()
	Returns aliases used in the queries for all tables.
	has_table_join_alias (string $tablename)
	Determine whether defined table join alias was specified.
	initialise ()
	Initialise the entity, called automatically when it is added to a report.
	set_entity_name (string $entityname)
	Set entity name.
	set_entity_title (lang_string $title)
	Set entity title.
	set_table_alias (string $tablename, string $alias)
	Override the default alias for given database table used in entity queries, for instance when the same table is used by multiple entities and you want them each to refer to it by the same alias.
	set_table_aliases (array $aliases)
	Override multiple default database table aliases used in entity queries as per {.
	set_table_join_alias (string $tablename, string $alias)
	Set the alias for given database table that has already been added to the report.

Protected Member Functions
	add_column (column $column)
	Add a column to the entity.
	add_condition (filter $condition)
	Add a condition to the entity.
	add_filter (filter $filter)
	Add a filter to the entity.
	get_default_entity_title ()
	The default title for this entity.
	get_default_table_aliases ()
	Database tables that this entity uses and their default aliases (note that these aliases are now ignored)
	get_default_tables ()
	Database tables that this entity uses.
	get_tag_joins_for_entity (string $component, string $itemtype, string $itemidfield)
	Helper method for returning joins necessary for retrieving tags related to the current entity.

Member Function Documentation

add_column()

core_reportbuilder\local\entities\base::add_column ( column $column )

finalprotected

Add a column to the entity.

Parameters

column

$column

Return values

self

add_condition()

core_reportbuilder\local\entities\base::add_condition ( filter $condition )

finalprotected

Add a condition to the entity.

Parameters

filter

$condition

Return values

$this

add_filter()

core_reportbuilder\local\entities\base::add_filter ( filter $filter )

finalprotected

Add a filter to the entity.

Parameters

filter

$filter

Return values

self

add_join()

core_reportbuilder\local\entities\base::add_join ( string $join )

final

Add join clause required for this entity to join to existing tables/entities.

Parameters

string

$join

Return values

self

add_joins()

core_reportbuilder\local\entities\base::add_joins ( array $joins )

final

Add multiple join clauses required for this entity {.

See also

add_join}

Parameters

string[]

$joins

Return values

self

get_column()

core_reportbuilder\local\entities\base::get_column ( string $name )

final

Returns an entity column.

Parameters

string

$name

Return values

column

Exceptions

coding_exception

For invalid column name

get_columns()

core_reportbuilder\local\entities\base::get_columns ( )

final

Returns entity columns.

Return values

column[]

get_condition()

core_reportbuilder\local\entities\base::get_condition ( string $name )

final

Returns an entity condition.

Parameters

string

$name

Return values

filter

Exceptions

coding_exception

For invalid condition name

get_conditions()

core_reportbuilder\local\entities\base::get_conditions ( )

final

Returns entity conditions.

Return values

filter[]

get_default_entity_title()

core_reportbuilder\local\entities\base::get_default_entity_title ( )

abstractprotected

The default title for this entity.

Return values

lang_string

Reimplemented in core_admin\reportbuilder\local\entities\task_log, core_cohort\reportbuilder\local\entities\cohort, core_cohort\reportbuilder\local\entities\cohort_member, core_course\reportbuilder\local\entities\access, core_course\reportbuilder\local\entities\completion, core_course\reportbuilder\local\entities\course_category, core_reportbuilder\local\entities\course, core_reportbuilder\local\entities\user, gradereport_summary\local\entities\grade_items, mod_lti\reportbuilder\local\entities\tool_types, report_configlog\reportbuilder\local\entities\config_change, and report_themeusage\reportbuilder\local\entities\theme.

get_default_table_aliases()

core_reportbuilder\local\entities\base::get_default_table_aliases ( )

protected

Database tables that this entity uses and their default aliases (note that these aliases are now ignored)

Return values

string[]

Array of $tablename => $alias

Deprecated

since Moodle 4.4 - aliases are now autogenerated, please implement {

See also

get_default_tables} instead

get_default_tables()

core_reportbuilder\local\entities\base::get_default_tables ( )

protected

Database tables that this entity uses.

Must be overridden by the entity to list all database tables that it expects to be present in the main SQL or in JOINs added to this entity

Todo

in Moodle 4.8 - make abstract when support for {

See also

get_default_table_aliases} is finally removed

Return values

string[]

Reimplemented in core_admin\reportbuilder\local\entities\task_log, core_cohort\reportbuilder\local\entities\cohort, core_cohort\reportbuilder\local\entities\cohort_member, core_course\reportbuilder\local\entities\access, core_course\reportbuilder\local\entities\completion, core_course\reportbuilder\local\entities\course_category, core_reportbuilder\local\entities\course, core_reportbuilder\local\entities\user, gradereport_summary\local\entities\grade_items, mod_lti\reportbuilder\local\entities\tool_types, report_configlog\reportbuilder\local\entities\config_change, and report_themeusage\reportbuilder\local\entities\theme.

get_entity_name()

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

final

Return entity name.

Return values

string

get_entity_title()

core_reportbuilder\local\entities\base::get_entity_title ( )

final

Get entity title.

Return values

lang_string

get_filter()

core_reportbuilder\local\entities\base::get_filter ( string $name )

final

Returns an entity filter.

Parameters

string

$name

Return values

filter

Exceptions

coding_exception

For invalid filter name

get_filters()

core_reportbuilder\local\entities\base::get_filters ( )

final

Returns entity filters.

Return values

filter[]

get_joins()

core_reportbuilder\local\entities\base::get_joins ( )

final

Return entity joins.

Return values

string[]

get_table_alias()

core_reportbuilder\local\entities\base::get_table_alias ( string $tablename )

final

Returns an alias used in the queries for a given table.

Parameters

string

$tablename

One of the tables set by {

See also

get_default_tables}

Return values

string

Exceptions

coding_exception

For invalid table name

get_table_aliases()

core_reportbuilder\local\entities\base::get_table_aliases ( )

final

Returns aliases used in the queries for all tables.

Return values

string[]

get_tag_joins_for_entity()

core_reportbuilder\local\entities\base::get_tag_joins_for_entity ( string $component, string $itemtype, string $itemidfield )

finalprotected

Helper method for returning joins necessary for retrieving tags related to the current entity.

Both 'tag' and 'tag_instance' aliases must be returned by the entity {

See also

get_default_tables} method

Parameters

string	$component
string	$itemtype
string	$itemidfield

Return values

string[]

has_table_join_alias()

core_reportbuilder\local\entities\base::has_table_join_alias ( string $tablename )

final

Determine whether defined table join alias was specified.

Call {

See also

get_table_alias} to retrieve said value

Parameters

string

$tablename

Return values

bool

initialise()

core_reportbuilder\local\entities\base::initialise ( )

abstract

Initialise the entity, called automatically when it is added to a report.

This is where entity defines all its columns and filters by calling:

• {

  See also

  add_column}

• {

  See also

  add_filter}

• etc

Return values

self

Reimplemented in core_admin\reportbuilder\local\entities\task_log, core_cohort\reportbuilder\local\entities\cohort, core_cohort\reportbuilder\local\entities\cohort_member, core_course\reportbuilder\local\entities\access, core_course\reportbuilder\local\entities\completion, core_course\reportbuilder\local\entities\course_category, core_reportbuilder\local\entities\course, core_reportbuilder\local\entities\user, gradereport_summary\local\entities\grade_items, mod_lti\reportbuilder\local\entities\tool_types, report_configlog\reportbuilder\local\entities\config_change, and report_themeusage\reportbuilder\local\entities\theme.

set_entity_name()

core_reportbuilder\local\entities\base::set_entity_name ( string $entityname )

final

Set entity name.

Parameters

string

$entityname

Return values

self

set_entity_title()

core_reportbuilder\local\entities\base::set_entity_title ( lang_string $title )

final

Set entity title.

Parameters

lang_string

$title

Return values

self

set_table_alias()

core_reportbuilder\local\entities\base::set_table_alias ( string $tablename, string $alias )

final

Override the default alias for given database table used in entity queries, for instance when the same table is used by multiple entities and you want them each to refer to it by the same alias.

Parameters

string

$tablename

One of the tables set by {

See also

get_default_tables}

Parameters

string

$alias

Return values

self

Exceptions

coding_exception

For invalid table name

set_table_aliases()

core_reportbuilder\local\entities\base::set_table_aliases ( array $aliases )

final

Override multiple default database table aliases used in entity queries as per {.

See also

set_table_alias}

Parameters

array

$aliases

Array of tablename => alias values

Return values

self

set_table_join_alias()

core_reportbuilder\local\entities\base::set_table_join_alias ( string $tablename, string $alias )

final

Set the alias for given database table that has already been added to the report.

Enables entities to avoid additional joins on the same table by allowing re-use of existing table aliases in their own queries, {

See also

has_table_join_alias}

Parameters

string	$tablename
string	$alias

Return values

self

---

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

• reportbuilder/classes/local/entities/base.php