Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Course completion target. More...
Public Member Functions | |
add_bulk_actions_js () | |
Adds the JS required to run the bulk actions. | |
add_sample_data ($data) | |
add_sample_data | |
always_update_analysis_time () | |
Update the last analysis time on analysable processed or always. | |
bulk_actions (array $predictions) | |
Suggested bulk actions for a user. | |
calculate ($sampleids, core_analytics\analysable $analysable, $starttime=false, $endtime=false) | |
Calculates the target. | |
can_use_timesplitting (\core_analytics\local\time_splitting\base $timesplitting) | |
Can the provided time-splitting method be used on this target?. | |
can_use_timesplitting (\core_analytics\local\time_splitting\base $timesplitting) | |
Only past stuff. | |
clear_sample_data () | |
clear_sample_data | |
filter_out_invalid_samples (&$sampleids, core_analytics\analysable $analysable, $fortraining=true) | |
Filters out invalid samples for training. | |
generate_insight_notifications ($modelid, $samplecontexts, array $predictions=[]) | |
Generates insights notifications. | |
get_analyser_class () | |
Returns the analyser class that should be used along with this target. | |
get_calculation_outcome ($value, $ignoredsubtype=false) | |
Is the calculated value a positive outcome of this target? | |
get_display_value ($value, $ignoredsubtype=false) | |
get_display_value | |
get_id () | |
The class id is the calculable class full qualified class name. | |
get_insight_body (\context $context, string $contextname, stdClass $user, moodle_url $insighturl) | |
Returns the body message for the insight. | |
get_insight_body_for_prediction (\context $context, stdClass $user, core_analytics\prediction $prediction, array &$actions) | |
Returns the body message for an insight for a single prediction. | |
get_insight_context_url ($modelid, $context) | |
URL to the insight. | |
get_insight_subject (int $modelid, context $context) | |
Overwritten to show a simpler language string. | |
get_insights_users (\context $context) | |
Returns the list of users that will receive insights notifications. | |
ignored_predicted_classes () | |
Returns the predicted classes that will be ignored. | |
is_linear () | |
is_linear | |
is_valid_analysable (\core_analytics\analysable $analysable, $fortraining=true) | |
Allows the target to verify that the analysable is a good candidate. | |
is_valid_analysable (\core_analytics\analysable $course, $fortraining=true) | |
Discards courses that are not yet ready to be used for training or prediction. | |
is_valid_sample ($sampleid, core_analytics\analysable $analysable, $fortraining=true) | |
Is this sample from the $analysable valid? | |
is_valid_sample ($sampleid, core_analytics\analysable $course, $fortraining=true) | |
Discard student enrolments that are invalid. | |
link_insights_report () | |
Should the insights of this model be linked from reports? | |
prediction_actions (\core_analytics\prediction $prediction, $includedetailsaction=false, $isinsightuser=false) | |
Suggested actions for a user. | |
prediction_actions (\core_analytics\prediction $prediction, $includedetailsaction=false, $isinsightuser=false) | |
prediction_actions | |
prediction_callback ($modelid, $sampleid, $rangeindex, context $samplecontext, $prediction, $predictionscore) | |
Callback to execute once a prediction has been returned from the predictions processor. | |
save_calculation_info (\core_analytics\local\time_splitting\base $timesplitting, int $rangeindex) | |
Stores in MUC the previously added data and it associates it to the provided $calculable. | |
triggers_callback ($predictedvalue, $predictionscore) | |
This method determines if a prediction is interesing for the model or not. | |
Static Public Member Functions | |
static | based_on_assumptions () |
Based on facts (processed by machine learning backends) by default. | |
static | get_classes () |
Returns the target discrete values. | |
static | get_name () |
Returns the name. | |
static | instance () |
Returns an instance of the child class. | |
static | uses_insights () |
Is this target generating insights? | |
Protected Member Functions | |
add_shared_calculation_info (int $sampleid, array $info) | |
Adds info related to the current calculation for later use when generating insights. | |
calculate_sample ($sampleid, core_analytics\analysable $analysable, $starttime=false, $endtime=false) | |
Calculates this target for the provided samples. | |
calculate_sample ($sampleid, core_analytics\analysable $course, $starttime=false, $endtime=false) | |
Course completion sets the target value. | |
classify_value ($value, $ranges) | |
Classifies the provided value into the provided range according to the ranges predicates. | |
enrolment_active_during_analysis_time (int $sampleid, int $starttime, int $endtime) | |
Is/was this user enrolment active during most of the analysis interval? | |
get_time_range_weeks_number ($starttime, $endtime) | |
Returns the number of weeks a time range contains. | |
limit_value ($calculatedvalue) | |
Limits the calculated value to the minimum and maximum values. | |
min_prediction_score () | |
Defines a boundary to ignore predictions below the specified prediction score. | |
retrieve ($elementname, $sampleid) | |
Retrieve the specified element associated to $sampleid. | |
Static Protected Member Functions | |
static | classes_description () |
Returns descriptions for each of the values the target calculation can return. | |
static | is_a_class ($class) |
Is the provided class one of this target valid classes? | |
Protected Attributes | |
core_analytics calculation_info null | $calculationinfo = null |
array[] | $sampledata = array() |
int[] | $students |
Students in the course. | |
Course completion target.
|
inherited |
Adds the JS required to run the bulk actions.
Reimplemented from core_analytics\local\target\base.
|
inherited |
add_sample_data
array | $data |
void |
|
finalprotectedinherited |
Adds info related to the current calculation for later use when generating insights.
Note that the data in $info array is reused across multiple samples, if you want to add data just for this sample you can use the sample id as key.
Please, note that you should be careful with how much data you add here as it can kill the server memory.
int | $sampleid | The sample id this data is associated with |
array | $info | The data. Indexed by an id unique across the site. E.g. an activity id. |
null |
|
inherited |
Update the last analysis time on analysable processed or always.
If you overwrite this method to return false the last analysis time will only be recorded in DB when the element successfully analysed. You can safely return false for lightweight targets.
bool |
Reimplemented in core_user\analytics\target\upcoming_activities_due.
|
staticinherited |
Based on facts (processed by machine learning backends) by default.
bool |
Reimplemented in core_course\analytics\target\no_recent_accesses, core_course\analytics\target\no_teaching, and core_user\analytics\target\upcoming_activities_due.
|
inherited |
Suggested bulk actions for a user.
core_analytics\prediction[] | $predictions | List of predictions suitable for the bulk actions to use. |
core_analytics\bulk_action[] | The list of bulk actions. |
Reimplemented from core_analytics\local\target\base.
|
inherited |
Calculates the target.
Returns an array of values which size matches $sampleids size.
Rows with null values will be skipped as invalid by time splitting methods.
array | $sampleids | |
core_analytics\analysable | $analysable | |
int | $starttime | |
int | $endtime |
array | The format to follow is [userid] = scalar|null |
|
abstractprotectedinherited |
Calculates this target for the provided samples.
In case there are no values to return or the provided sample is not applicable just return null.
int | $sampleid | |
core_analytics\analysable | $analysable | |
int | false | $starttime | Limit calculations to start time |
int | false | $endtime | Limit calculations to end time |
float|null |
|
protected |
Course completion sets the target value.
int | $sampleid | |
core_analytics\analysable | $course | |
int | $starttime | |
int | $endtime |
float|null | 0 -> course not completed, 1 -> course completed |
|
abstractinherited |
Can the provided time-splitting method be used on this target?.
Time-splitting methods not matching the target requirements will not be selectable by models based on this target.
core_analytics\local\time_splitting\base | $timesplitting |
bool |
|
inherited |
Only past stuff.
core_analytics\local\time_splitting\base | $timesplitting |
bool |
Reimplemented in core_course\analytics\target\no_access_since_course_start, and core_course\analytics\target\no_recent_accesses.
|
staticprotected |
Returns descriptions for each of the values the target calculation can return.
string[] |
Reimplemented from core_analytics\local\target\binary.
|
protectedinherited |
Classifies the provided value into the provided range according to the ranges predicates.
Use:
coding_exception |
int | float | $value | |
array | $ranges | e.g. [ ['lt', 20], ['ge', 20] ] |
float |
|
inherited |
clear_sample_data
void |
|
protectedinherited |
Is/was this user enrolment active during most of the analysis interval?
This method discards enrolments that were not active during most of the analysis interval. It is important to discard these enrolments because the indicator calculations can lead to misleading results.
Note that this method assumes that the target is interested in enrolments that are/were active during the analysis interval. Targets interested in predicting students at risk before their enrolment start should not call this method. Similarly, targets interested in getting predictions for students whose enrolment already finished should not call this method either.
int | $sampleid | The id of the sample that is being calculated |
int | $starttime | The analysis interval start time |
int | $endtime | The analysis interval end time |
bool |
|
inherited |
Filters out invalid samples for training.
int[] | $sampleids | |
core_analytics\analysable | $analysable | |
bool | $fortraining |
void |
|
inherited |
Generates insights notifications.
int | $modelid | |
context[] | $samplecontexts | |
core_analytics\prediction[] | $predictions |
void |
|
inherited |
Returns the analyser class that should be used along with this target.
string | The full class name as a string |
Reimplemented from core_analytics\local\target\base.
|
inherited |
Is the calculated value a positive outcome of this target?
string | $value | |
string | $ignoredsubtype |
int |
Reimplemented from core_analytics\local\target\discrete.
|
staticfinalinherited |
Returns the target discrete values.
Only useful for targets using discrete values, must be overwriten if it is the case.
array |
Reimplemented from core_analytics\local\target\discrete.
|
inherited |
get_display_value
float | $value | |
string | $ignoredsubtype |
string |
Reimplemented from core_analytics\calculable.
|
inherited |
The class id is the calculable class full qualified class name.
string |
|
inherited |
Returns the body message for the insight.
context | $context | |
string | $contextname | |
stdClass | $user | |
moodle_url | $insighturl |
string[] | The plain text message and the HTML message |
Reimplemented from core_analytics\local\target\base.
Reimplemented in core_course\analytics\target\no_access_since_course_start, and core_course\analytics\target\no_recent_accesses.
|
inherited |
Returns the body message for an insight for a single prediction.
This default method is executed when the analysable used by the model generates one insight for each analysable (one_sample_per_analysable === true)
context | $context | |
stdClass | $user | |
core_analytics\prediction | $prediction | |
core_analytics\action[] | $actions | Passed by reference to remove duplicate links to actions. |
array | Plain text msg, HTML message and the main URL for this insight (you can return null if you are happy with the default insight URL calculated in prediction_info()) |
|
inherited |
|
inherited |
Overwritten to show a simpler language string.
int | $modelid | |
context | $context |
string |
Reimplemented from core_analytics\local\target\base.
|
inherited |
Returns the list of users that will receive insights notifications.
Feel free to overwrite if you need to but keep in mind that moodle/analytics:listinsights or moodle/analytics:listowninsights capability is required to access the list of insights.
context | $context |
array |
|
static |
Returns the name.
If there is a corresponding '_help' string this will be shown as well.
lang_string |
Reimplemented from core_analytics\calculable.
|
protectedinherited |
Returns the number of weeks a time range contains.
Useful for calculations that depend on the time range duration. Note that it returns a float, rounding the float may lead to inaccurate results.
int | $starttime | |
int | $endtime |
float |
|
inherited |
Returns the predicted classes that will be ignored.
array |
Reimplemented from core_analytics\local\target\discrete.
Reimplemented in core_user\analytics\target\upcoming_activities_due.
|
staticinherited |
Returns an instance of the child class.
Useful to reset cached data.
core_analytics\base\target |
|
staticprotectedinherited |
Is the provided class one of this target valid classes?
mixed | $class |
bool |
|
inherited |
|
abstractinherited |
Allows the target to verify that the analysable is a good candidate.
This method can be used as a quick way to discard invalid analysables. e.g. Imagine that your analysable don't have students and you need them.
core_analytics\analysable | $analysable | |
bool | $fortraining |
true|string |
core_course\analytics\target\course_completion::is_valid_analysable | ( | \core_analytics\analysable | $course, |
$fortraining = true ) |
Discards courses that are not yet ready to be used for training or prediction.
core_analytics\analysable | $course | |
bool | $fortraining |
true|string |
Reimplemented from core_course\analytics\target\course_enrolments.
|
abstractinherited |
Is this sample from the $analysable valid?
int | $sampleid | |
core_analytics\analysable | $analysable | |
bool | $fortraining |
bool |
|
inherited |
Discard student enrolments that are invalid.
Note that this method assumes that the target is only interested in enrolments that are/were active between the current course start and end times. Targets interested in predicting students at risk before their enrolment start and targets interested in getting predictions for students whose enrolment already finished should overwrite this method as these students are discarded by this method.
int | $sampleid | |
core_analytics\analysable | $course | |
bool | $fortraining |
bool |
|
protectedinherited |
Limits the calculated value to the minimum and maximum values.
float | $calculatedvalue |
float|null |
|
inherited |
Should the insights of this model be linked from reports?
bool |
Reimplemented in core_user\analytics\target\upcoming_activities_due.
|
protectedinherited |
Defines a boundary to ignore predictions below the specified prediction score.
Value should go from 0 to 1.
float |
|
inherited |
Suggested actions for a user.
core_analytics\prediction | $prediction | |
bool | $includedetailsaction | |
bool | $isinsightuser | Force all the available actions to be returned as it the user who receives the insight is the one logged in. |
core_analytics\prediction_action[] |
|
inherited |
prediction_actions
core_analytics\prediction | $prediction | |
bool | $includedetailsaction | |
bool | $isinsightuser |
core_analytics\prediction_action[] |
|
inherited |
Callback to execute once a prediction has been returned from the predictions processor.
Note that the analytics_predictions db record is not yet inserted.
int | $modelid | |
int | $sampleid | |
int | $rangeindex | |
context | $samplecontext | |
float | int | $prediction | |
float | $predictionscore |
void |
|
protectedinherited |
Retrieve the specified element associated to $sampleid.
string | $elementname | |
int | $sampleid |
stdClass|false | An stdClass object or false if it can not be found. |
|
finalinherited |
Stores in MUC the previously added data and it associates it to the provided $calculable.
Flagged as final as we don't want people to extend this, it is likely to be moved to core_analytics\calculable
core_analytics\local\time_splitting\base | $timesplitting | |
int | $rangeindex |
null |
|
inherited |
This method determines if a prediction is interesing for the model or not.
This method internally calls ignored_predicted_classes to skip classes flagged by the target as not important for users.
mixed | $predictedvalue | |
float | $predictionscore |
bool |
Reimplemented from core_analytics\local\target\base.
|
staticinherited |
Is this target generating insights?
Defaults to true.
bool |