core_course\reportbuilder\local\entities\completion Class Reference

Inheritance diagram for core_course\reportbuilder\local\entities\completion:

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.
	has_table_join_alias (string $tablename)
	Determine whether defined table join alias was specified.
	initialise ()
	Initialise the entity.
	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, to avoid table alias clashes that may occur if multiple entities of a report each define the same default alias for one of their tables.
	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_all_columns ()
	Returns list of all available columns.
	get_all_filters ()
	Return list of all available filters.
	get_default_entity_title ()
	The default title for this entity in the list of columns/conditions/filters in the report builder.
	get_default_table_aliases ()
	Database tables that this entity uses and their default aliases.
	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 )

finalprotectedinherited

Add a column to the entity.

Parameters

column

$column

Return values

self

add_condition()

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

finalprotectedinherited

Add a condition to the entity.

Parameters

filter

$condition

Return values

$this

add_filter()

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

finalprotectedinherited

Add a filter to the entity.

Parameters

filter

$filter

Return values

self

add_join()

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

finalinherited

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 )

finalinherited

Add multiple join clauses required for this entity {.

See also

add_join}

Parameters

string[]

$joins

Return values

self

get_all_columns()

core_course\reportbuilder\local\entities\completion::get_all_columns ( )

protected

Returns list of all available columns.

Return values

column[]

get_all_filters()

core_course\reportbuilder\local\entities\completion::get_all_filters ( )

protected

Return list of all available filters.

Return values

filter[]

get_column()

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

finalinherited

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 ( )

finalinherited

Returns entity columns.

Return values

column[]

get_condition()

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

finalinherited

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 ( )

finalinherited

Returns entity conditions.

Return values

filter[]

get_default_entity_title()

core_course\reportbuilder\local\entities\completion::get_default_entity_title ( )

protected

The default title for this entity in the list of columns/conditions/filters in the report builder.

Return values

lang_string

Reimplemented from core_reportbuilder\local\entities\base.

get_default_table_aliases()

core_course\reportbuilder\local\entities\completion::get_default_table_aliases ( )

protected

Database tables that this entity uses and their default aliases.

Return values

array

Reimplemented from core_reportbuilder\local\entities\base.

get_entity_name()

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

finalinherited

Return entity name.

Return values

string

get_entity_title()

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

finalinherited

Get entity title.

Return values

lang_string

get_filter()

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

finalinherited

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 ( )

finalinherited

Returns entity filters.

Return values

filter[]

get_joins()

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

finalinherited

Return entity joins.

Return values

string[]

get_table_alias()

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

finalinherited

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

Parameters

string

$tablename

Return values

string

Exceptions

coding_exception

get_tag_joins_for_entity()

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

finalprotectedinherited

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_table_aliases} 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 )

finalinherited

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_course\reportbuilder\local\entities\completion::initialise

(

)

Initialise the entity.

Return values

base

Reimplemented from core_reportbuilder\local\entities\base.

set_entity_name()

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

finalinherited

Set entity name.

Parameters

string

$entityname

Return values

self

set_entity_title()

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

finalinherited

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 )

finalinherited

Override the default alias for given database table used in entity queries, to avoid table alias clashes that may occur if multiple entities of a report each define the same default alias for one of their tables.

Parameters

string	$tablename
string	$alias

Return values

self

Exceptions

coding_exception

set_table_aliases()

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

finalinherited

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

See also

set_table_alias}, typically when you're adding an entity multiple times to a report you'd want to override the table aliases in the second instance to avoid clashes with the first

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 )

finalinherited

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:

• course/classes/reportbuilder/local/entities/completion.php