Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Potential social breadth indicator.

Copyright: 2017 David Monllao {@link http://www.davidmonllao.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 148 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

potential_social_breadth:: (5 methods):
  get_name()
  required_sample_data()
  calculate_sample()
  get_social_indicator()
  level_not_accepted()


Class: potential_social_breadth  - X-Ref

Potential social breadth indicator.

It extends linear instead of discrete as there is a linear relation between
the different social levels activities can reach.

get_name()   X-Ref
get_name

return: \lang_string

required_sample_data()   X-Ref
Specify the required data to process this indicator.

return: string[]

calculate_sample($sampleid, $sampleorigin, $notusedstarttime = false, $notusedendtime = false)   X-Ref
calculate_sample

param: int $sampleid
param: string $sampleorigin
param: int|false $notusedstarttime
param: int|false $notusedendtime
return: float

get_social_indicator($modname)   X-Ref
Returns the social breadth class of this indicator.

param: string $modname
return: \core_analytics\local\indicator\base|false

level_not_accepted($level)   X-Ref
Throw a \coding_exception.

param: int $level