Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Functions
lib.php File Reference

Returns new improtcode for current user. More...

Functions

 get_new_importcode ()
 
 get_unenrolled_users_in_import ($importcode, $courseid)
 This function returns an array of grades that were included in the import, but where the user does not currently have a graded role on the course. More...
 
 grade_import_commit ($courseid, $importcode, $importfeedback=true, $verbose=true)
 given an import code, commits all entries in buffer tables (grade_import_value and grade_import_newitem) If this function is called, we assume that all data collected up to this point is fine and we can go ahead and commit More...
 
 import_cleanup ($importcode)
 removes entries from grade import buffer tables grade_import_value and grade_import_newitem after a successful import, or during an import abort More...
 

Detailed Description

Returns new improtcode for current user.

Return values
intimportcode

Function Documentation

◆ get_unenrolled_users_in_import()

get_unenrolled_users_in_import (   $importcode,
  $courseid 
)

This function returns an array of grades that were included in the import, but where the user does not currently have a graded role on the course.

These grades are still stored in the database, but will not be visible in the gradebook unless this user subsequently enrols on the course in a graded roles.

The returned objects have fields user firstname, lastname and useridnumber, and gradeidnumber.

Parameters
integer$importcodeimport batch identifier
integer$courseidthe course we are importing to.
Return values
mixedand array of user objects, or false if none.

◆ grade_import_commit()

grade_import_commit (   $courseid,
  $importcode,
  $importfeedback = true,
  $verbose = true 
)

given an import code, commits all entries in buffer tables (grade_import_value and grade_import_newitem) If this function is called, we assume that all data collected up to this point is fine and we can go ahead and commit

Parameters
int$courseid- ID of the course.
int$importcode- Import batch identifier.
bool$importfeedback- Whether to import feedback as well.
bool$verbose- Print feedback and continue button.
Return values
boolsuccess

◆ import_cleanup()

import_cleanup (   $importcode)

removes entries from grade import buffer tables grade_import_value and grade_import_newitem after a successful import, or during an import abort

Parameters
stringimportcode - import batch identifier