Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_analytics\analysable Interface Reference

Any element analysers can analyse. More...

Inheritance diagram for core_analytics\analysable:
core_analytics\course core_analytics\site core_analytics\user

Public Member Functions

 get_context ()
 The analysable context.
 
 get_end ()
 The end of the analysable if there is one.
 
 get_id ()
 The analysable unique identifier in the site.
 
 get_name ()
 The analysable human readable name.
 
 get_start ()
 The start of the analysable if there is one.
 

Public Attributes

const MAX_TIME = PHP_INT_MAX < 9999999999 ? PHP_MAX_INT : 9999999999
 Max timestamp.
 

Detailed Description

Any element analysers can analyse.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ get_context()

core_analytics\analysable::get_context ( )

The analysable context.

Return values
context

Implemented in core_analytics\course, core_analytics\site, and core_analytics\user.

◆ get_end()

core_analytics\analysable::get_end ( )

The end of the analysable if there is one.

Return values
int|false

Implemented in core_analytics\course, core_analytics\site, and core_analytics\user.

◆ get_id()

core_analytics\analysable::get_id ( )

The analysable unique identifier in the site.

Return values
int.

Implemented in core_analytics\course, core_analytics\site, and core_analytics\user.

◆ get_name()

core_analytics\analysable::get_name ( )

The analysable human readable name.

Return values
string

Implemented in core_analytics\course, core_analytics\site, and core_analytics\user.

◆ get_start()

core_analytics\analysable::get_start ( )

The start of the analysable if there is one.

Return values
int|false

Implemented in core_analytics\course, core_analytics\site, and core_analytics\user.

Member Data Documentation

◆ MAX_TIME

const core_analytics\analysable::MAX_TIME = PHP_INT_MAX < 9999999999 ? PHP_MAX_INT : 9999999999

Max timestamp.

We are limited by both PHP's max int value and DB (cross-db) max int allowed. Use the smallest one.


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