/**
* Performs program update
* @throws moodle_exception If there was an error in passed parameters.
* @throws data_object_exception If there was an error creating the entity.
* @param array $data The incoming data parameter.
* @return array An array of parameters, if successful.
*/
public static function program_update(array $data)
{
global $USER, $DB;
if (static::require_elis_dependencies() !== true) {
throw new moodle_exception('ws_function_requires_elis', 'local_datahub');
}
// Parameter validation.
$params = self::validate_parameters(self::program_update_parameters(), array('data' => $data));
// Context validation.
$context = context_user::instance($USER->id);
self::validate_context($context);
$data = (object) $data;
// Validate program exists
if (!($curid = $DB->get_field(curriculum::TABLE, 'id', array('idnumber' => $data->idnumber)))) {
throw new data_object_exception('ws_program_update_fail_invalid_idnumber', 'local_datahub', '', $data);
}
// Capability checking.
require_capability('local/elisprogram:program_edit', \local_elisprogram\context\program::instance($curid));
// More validation
if (isset($data->reqcredits)) {
$reqcredits = (string) $data->reqcredits;
$digits = strlen($reqcredits);
$decies = 0;
if (($decpos = strpos($reqcredits, '.')) !== false) {
$decies = $digits - $decpos - 1;
$digits = $decpos;
}
if (!is_numeric($reqcredits) || $digits > 8 || $decies > 2) {
throw new data_object_exception('ws_program_update_fail_invalid_reqcredits', 'local_datahub', '', $data);
}
}
if (isset($data->timetocomplete)) {
$datedelta = new datedelta($data->timetocomplete);
if (!$datedelta->getDateString()) {
throw new data_object_exception('ws_program_update_fail_invalid_timetocomplete', 'local_datahub', '', $data);
}
}
if (isset($data->frequency)) {
$datedelta = new datedelta($data->frequency);
if (!$datedelta->getDateString()) {
throw new data_object_exception('ws_program_update_fail_invalid_frequency', 'local_datahub', '', $data);
}
}
if (isset($data->priority)) {
if ($data->priority < 0 || $data->priority > 10) {
throw new data_object_exception('ws_program_update_fail_invalid_priority', 'local_datahub', '', $data);
}
}
$prg = new curriculum($curid);
$prg->load();
$prg->set_from_data($data);
$prg->save();
// Respond.
if (!empty($prg->id)) {
$prgrec = (array) $DB->get_record(curriculum::TABLE, array('id' => $prg->id));
$prgobj = $prg->to_array();
// convert multi-valued custom field arrays to comma-separated listing
$fields = self::get_program_custom_fields();
foreach ($fields as $field) {
// Generate name using custom field prefix.
$fullfieldname = data_object_with_custom_fields::CUSTOM_FIELD_PREFIX . $field->shortname;
if ($field->multivalued && isset($prgobj[$fullfieldname]) && is_array($prgobj[$fullfieldname])) {
$prgobj[$fullfieldname] = implode(',', $prgobj[$fullfieldname]);
}
}
return array('messagecode' => get_string('ws_program_update_success_code', 'local_datahub'), 'message' => get_string('ws_program_update_success_msg', 'local_datahub'), 'record' => array_merge($prgrec, $prgobj));
} else {
throw new data_object_exception('ws_program_update_fail', 'local_datahub');
}
}
/**
* Validate that an appropriate error is logged when max field lengths are
* exceeded during a track update action
*
* @param string $field The identifier for the field we are testing
* @param int $length The length we are testing at
* @param string $customvalue A custom value to use rather than simply repeating a character,
* or null if not applicable
* @dataProvider trackupdatefieldprovider
*/
public function test_trackupdatelogserrorwhenfieldstoolong($field, $length, $customvalue)
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/data/curriculum.class.php';
require_once $CFG->dirroot . '/local/elisprogram/lib/data/track.class.php';
$program = new curriculum(array('idnumber' => 'testprogramidnumber'));
$program->save();
$track = new track(array('curid' => $program->id, 'idnumber' => 'testtrackidnumber'));
$track->save();
$data = array('action' => 'update', 'context' => 'track', 'idnumber' => 'testtrackidnumber');
if ($customvalue !== null) {
$value = $customvalue;
} else {
$value = str_repeat('a', $length);
}
$data[$field] = $value;
$maxlength = $length - 1;
$expectederror = "{$field} value of \"{$value}\" exceeds the maximum field length of {$maxlength}.\n";
$this->assert_data_produces_error($data, $expectederror, 'course');
}
/**
* Test failure conditions.
* @dataProvider dataprovider_failure
* @expectedException moodle_exception
* @param array $prg The incoming program data.
*/
public function test_failure(array $prg)
{
global $DB;
$this->give_permissions(array('local/elisprogram:program_delete'));
// Create test program to update.
$cur = new curriculum(array('idnumber' => 'testprogram', 'name' => 'testprogram'));
$cur->save();
$response = local_datahub_elis_program_delete::program_delete($prg);
}
/**
* Create a test curriculum.
* @return curriculum The test curriculum.
*/
public function create_curriculum(field &$field = null)
{
$data = new stdClass();
$data->courseid = '';
$data->idnumber = 'testprg';
$data->name = 'Test Program';
$data->description = '';
$data->reqcredits = '';
$data->priority = '0';
$data->timetocomplete = '';
$data->frequency = '';
if (!empty($field)) {
$fieldvar = 'field_' . $field->shortname;
$data->{$fieldvar} = 'test field data';
}
$cur = new curriculum();
$cur->set_from_data($data);
$cur->save();
return $cur;
}
/**
* Validate that track-class associations can be created during a class instance
* update action
*
* @param mixed $autoenrol The appropriate autoenrol value specified
* @param int $dbautoenrol The value expected to be set in the db for autoenrol
* @dataProvider autoenrol_provider
*/
public function test_associate_track_during_class_update($autoenrol, $dbautoenrol)
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/setup.php';
require_once elispm::lib('data/course.class.php');
require_once elispm::lib('data/curriculum.class.php');
require_once elispm::lib('data/curriculumcourse.class.php');
require_once elispm::lib('data/pmclass.class.php');
require_once elispm::lib('data/track.class.php');
// Create the course description.
$course = new course(array('name' => 'testcoursename', 'idnumber' => 'testcourseidnumber', 'syllabus' => ''));
$course->save();
// Create the class instance.
$pmclass = new pmclass(array('courseid' => $course->id, 'idnumber' => 'testclassidnumber'));
$pmclass->save();
// Create the curriculum / program.
$curriculum = new curriculum(array('idnumber' => 'testcurriculumidnumber'));
$curriculum->save();
// Associate the course description to the program.
$curriculumcourse = new curriculumcourse(array('curriculumid' => $curriculum->id, 'courseid' => $course->id));
$curriculumcourse->save();
// Create the track.
$track = new track(array('curid' => $curriculum->id, 'idnumber' => 'testtrackidnumber'));
$track->save();
// Run the class instance update action.
$record = new stdClass();
$record->assignment = 'testcourseidnumber';
$record->idnumber = 'testclassidnumber';
$record->track = 'testtrackidnumber';
if ($autoenrol !== null) {
$record->autoenrol = $autoenrol;
}
$importplugin = rlip_dataplugin_factory::factory('dhimport_version1elis');
$importplugin->fslogger = new silent_fslogger(null);
$importplugin->class_update($record, 'bogus');
// Validation.
$classid = $DB->get_field(pmclass::TABLE, 'id', array('idnumber' => 'testclassidnumber'));
$this->assertTrue($DB->record_exists(trackassignment::TABLE, array('trackid' => $track->id, 'classid' => $classid, 'autoenrol' => $dbautoenrol)));
}
/**
* Validate that enrolments still work when the entity's identifier contains
* an underscore
*/
public function test_enrolmentinstancesupportsunderscores()
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/setup.php';
require_once elispm::lib('data/curriculum.class.php');
require_once elispm::lib('data/curriculumstudent.class.php');
require_once elispm::lib('data/user.class.php');
// Set up required data.
$program = new curriculum(array('idnumber' => 'testprogram_idnumber'));
$program->save();
$user = new user(array('idnumber' => 'testuseridnumber', 'username' => 'testuserusername', 'firstname' => 'testuserfirstname', 'lastname' => 'testuserlastname', 'email' => '*****@*****.**', 'country' => 'CA'));
$user->save();
$importplugin = rlip_dataplugin_factory::factory('dhimport_version1elis');
$importplugin->fslogger = new silent_fslogger(null);
// Create action.
$record = new stdClass();
$record->action = 'create';
$record->context = 'curriculum_testprogram_idnumber';
$record->user_idnumber = 'testuseridnumber';
$importplugin->process_record('enrolment', $record, 'bogus');
// Validation for create action.
$params = array('userid' => $user->id, 'curriculumid' => $program->id);
$exists = $DB->record_exists(curriculumstudent::TABLE, $params);
$this->assertTrue($exists);
// Delete action.
$record->action = 'delete';
$importplugin->process_record('enrolment', $record, 'bogus');
// Validation for delete action.
$this->assertEquals(0, $DB->count_records(curriculumstudent::TABLE));
}
/**
* Validate that a success message is logged on pmentity delete
*/
public function testpmentitydeletelogssuccessmessage()
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/data/user.class.php';
$program = new curriculum(array('idnumber' => 'testprogramidnumber', 'name' => 'testprogramname'));
$program->save();
$record = new stdClass();
$record->context = 'curriculum';
$record->idnumber = 'testprogramidnumber';
$importplugin = rlip_dataplugin_factory::factory('dhimport_version1elis');
$importplugin->dblogger = new rlip_dblogger_import(false);
$importplugin->fslogger = new silent_fslogger(null);
$importplugin->curriculum_delete($record, 'bogus');
$importplugin->dblogger->flush('bogus');
$expectedmessage = 'All lines from import file bogus were successfully processed.';
$where = 'statusmessage = ?';
$exists = $DB->record_exists_select(RLIP_LOG_TABLE, $where, array($expectedmessage));
$this->assertTrue($exists);
}
/**
* Initialize a new program object
*/
protected function initprogram()
{
$data = array('idnumber' => '__fcH__TESTID001__', 'name' => 'Test Program 1');
$newprogram = new curriculum($data);
$newprogram->save();
$this->tprogramid = $newprogram->id;
}
function curriculum_update($record, $filename)
{
global $CFG, $DB;
//field length checking
$lengthcheck = $this->check_program_field_lengths($record, $filename);
if (!$lengthcheck) {
return false;
}
if (isset($record->idnumber)) {
if (!$DB->record_exists(curriculum::TABLE, array('idnumber' => $record->idnumber))) {
$identifier = $this->get_field_mapping('idnumber');
$this->fslogger->log_failure("{$identifier} value of \"{$record->idnumber}\" does not refer to a valid program.", 0, $filename, $this->linenumber, $record, "curriculum");
return false;
}
}
if (!$this->validate_program_data('update', $record, $filename)) {
return false;
}
$record = $this->add_custom_field_prefixes($record);
//custom field validation
if (!$this->validate_custom_field_data('update', $record, $filename, 'curriculum')) {
return false;
}
$id = $DB->get_field(curriculum::TABLE, 'id', array('idnumber' => $record->idnumber));
$record->id = $id;
if (!$this->validate_program_data('update', $record, $filename)) {
return false;
}
$cur = new curriculum();
$cur->set_from_data($record);
$cur->save();
//log success
$success_message = "Program with idnumber \"{$record->idnumber}\" successfully updated.";
$this->fslogger->log_success($success_message, 0, $filename, $this->linenumber);
return true;
}
/**
* Validate that users can be unenrolled from tracks
*
* @param string $username A sample user's username, or null if not used in the import
* @param string $email A sample user's email, or null if not used in the import
* @param string $idnumber A sample user's idnumber, or null if not used in the import
* @dataProvider user_identifier_provider
*/
public function test_elis_user_track_unenrolment_import($actioncreate, $actiondelete, $username, $email, $idnumber)
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/setup.php';
require_once elispm::lib('data/curriculum.class.php');
require_once elispm::lib('data/track.class.php');
require_once elispm::lib('data/user.class.php');
require_once elispm::lib('data/usertrack.class.php');
$user = new user(array('idnumber' => 'testuseridnumber', 'username' => 'testuserusername', 'firstname' => 'testuserfirstname', 'lastname' => 'testuserlastname', 'email' => '*****@*****.**', 'country' => 'CA'));
$user->save();
$program = new curriculum(array('idnumber' => 'testprogramidnumber'));
$program->save();
$track = new track(array('curid' => $program->id, 'idnumber' => 'testtrackidnumber'));
$track->save();
$usertrack = new usertrack(array('userid' => $user->id, 'trackid' => $track->id));
$usertrack->save();
// Validate setup.
$this->assertTrue($DB->record_exists(usertrack::TABLE, array('userid' => $user->id, 'trackid' => $track->id)));
// Run the track enrolment delete action.
$record = new stdClass();
$record->action = $actiondelete;
$record->context = 'track_testtrackidnumber';
if ($username != null) {
$record->user_username = $user->username;
}
if ($email != null) {
$record->user_email = $user->email;
}
if ($idnumber != null) {
$record->user_idnumber = $user->idnumber;
}
$importplugin = rlip_dataplugin_factory::factory('dhimport_version1elis');
$importplugin->fslogger = new silent_fslogger(null);
$importplugin->process_record('enrolment', (object) $record, 'bogus');
// Validation.
$this->assertEquals(0, $DB->count_records(usertrack::TABLE));
}
/**
* Validate that create actions are converted to updates for tracks when the
* "createorupdate" flag is enabled
*/
public function test_elis_createorupdate_updates_track()
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/data/curriculum.class.php';
require_once $CFG->dirroot . '/local/elisprogram/lib/data/track.class.php';
// Set up initial conditions.
set_config('createorupdate', 1, 'dhimport_version1elis');
$program = new curriculum(array('name' => 'testprogramname', 'idnumber' => 'testprogramidnumber'));
$program->save();
// Create the test track.
$track = new track(array('curid' => $program->id, 'name' => 'testtrackname', 'idnumber' => 'testtrackidnumber', 'startdate' => rlip_timestamp(0, 0, 0, 1, 1, 2012)));
$track->save();
// Run the track create action.
$record = new stdClass();
$record->action = 'create';
$record->context = 'track';
$record->idnumber = 'testtrackidnumber';
$record->startdate = 'Jan/02/2012';
$importplugin = rlip_dataplugin_factory::factory('dhimport_version1elis');
$importplugin->fslogger = new silent_fslogger(null);
$importplugin->process_record('course', $record, 'bogus');
// Validation.
$this->assertTrue($DB->record_exists(track::TABLE, array('name' => 'testtrackname', 'idnumber' => 'testtrackidnumber', 'startdate' => rlip_timestamp(0, 0, 0, 1, 2, 2012))));
}
/**
* Validate that enrolling a user into a user set via IP auto-enrolls them in
* an associated track, and any associated programs or class instances
*/
public function test_userset_enrolment_creates_track_enrolment()
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/setup.php';
require_once elispm::lib('data/clustertrack.class.php');
require_once elispm::lib('data/course.class.php');
require_once elispm::lib('data/curriculum.class.php');
require_once elispm::lib('data/curriculumcourse.class.php');
require_once elispm::lib('data/curriculumstudent.class.php');
require_once elispm::lib('data/pmclass.class.php');
require_once elispm::lib('data/student.class.php');
require_once elispm::lib('data/track.class.php');
require_once elispm::lib('data/user.class.php');
require_once elispm::lib('data/userset.class.php');
require_once elispm::lib('data/usertrack.class.php');
// Make sure no emails are sent.
set_config('noemailever', true);
// Set up data.
// Test user.
$user = new user(array('idnumber' => 'testuseridnumber', 'username' => 'testuserusername', 'firstname' => 'testuserfirstname', 'firstname' => 'testuserfirstname', 'lastname' => 'testuserlastname', 'email' => '*****@*****.**', 'country' => 'CA'));
$user->save();
// Test user set.
$userset = new userset(array('name' => 'testusersetname'));
$userset->save();
// Test program and track.
$program = new curriculum(array('idnumber' => 'testprogramidnumber'));
$program->save();
$track = new track(array('curid' => $program->id, 'idnumber' => 'testtrackidnumber'));
$track->save();
// Associate the userset to the track.
$clustertrack = new clustertrack(array('clusterid' => $userset->id, 'trackid' => $track->id, 'autoenrol' => 1));
$clustertrack->save();
// Test course and class.
$course = new course(array('name' => 'testcoursename', 'idnumber' => 'testcourseidnumber', 'syllabus' => ''));
$course->save();
$class = new pmclass(array('courseid' => $course->id, 'idnumber' => 'testclass1idnumber'));
$class->save();
// Associate course to the program.
$curriculumcourse = new curriculumcourse(array('curriculumid' => $program->id, 'courseid' => $course->id));
$curriculumcourse->save();
// Associate track to the test class.
$trackassignment = new trackassignment(array('trackid' => $track->id, 'classid' => $class->id, 'autoenrol' => 1));
$trackassignment->save();
// Run the assignment create action.
$record = new stdClass();
$record->context = 'userset_testusersetname';
$record->user_username = '******';
$importplugin = rlip_dataplugin_factory::factory('dhimport_version1elis');
$importplugin->fslogger = new silent_fslogger(null);
$importplugin->cluster_enrolment_create($record, 'bogus', 'testusersetname');
// Validation.
// Userset assignment should trigger track assignment.
$this->assertTrue($DB->record_exists(usertrack::TABLE, array('userid' => $user->id, 'trackid' => $track->id)));
// Track assignment should trigger program assignment.
$this->assertTrue($DB->record_exists(curriculumstudent::TABLE, array('userid' => $user->id, 'curriculumid' => $program->id)));
// Track assignment should create a class enrolment.
$this->assertTrue($DB->record_exists(student::TABLE, array('userid' => $user->id, 'classid' => $class->id)));
}
/**
* Clone a curriculum.
* @param array $options options for cloning. Valid options are:
* - 'tracks': whether or not to clone tracks (default: false)
* - 'courses': whether or not to clone courses (default: false)
* - 'classes': whether or not to clone classes (default: false)
* - 'moodlecourses': whether or not to clone Moodle courses (if they were
* autocreated). Values can be (default: "copyalways"):
* - "copyalways": always copy course
* - "copyautocreated": only copy autocreated courses
* - "autocreatenew": autocreate new courses from course template
* - "link": link to existing course
* - 'targetcluster': the cluster id or cluster object (if any) to
* associate the clones with (default: none)
* @return array array of array of object IDs created. Key in outer array
* is type of object (plural). Key in inner array is original object ID,
* value is new object ID. Outer array also has an entry called 'errors',
* which is an array of any errors encountered when duplicating the
* object.
*/
function duplicate(array $options = array())
{
require_once elispm::lib('data/track.class.php');
$objs = array('errors' => array());
if (isset($options['targetcluster'])) {
$userset = $options['targetcluster'];
if (!is_object($userset) || !is_a($userset, 'userset')) {
$options['targetcluster'] = $userset = new userset($userset);
}
}
// Due to lazy loading, we need to pre-load this object
$this->load();
// clone main curriculum object
$clone = new curriculum($this);
unset($clone->id);
$idnumber = $clone->idnumber;
$name = $clone->name;
if (isset($userset)) {
$to_append = ' - ' . $userset->name;
// if cluster specified, append cluster's name to curriculum
$idnumber = append_once($idnumber, $to_append, array('maxlength' => 95));
$name = append_once($name, $to_append, array('maxlength' => 59));
}
//get a unique idnumber
$clone->idnumber = generate_unique_identifier(curriculum::TABLE, 'idnumber', $idnumber, array('idnumber' => $idnumber));
if ($clone->idnumber != $idnumber) {
//get the suffix appended and add it to the name
$parts = explode('.', $clone->idnumber);
$suffix = end($parts);
$clone->name = $name . '.' . $suffix;
} else {
$clone->name = $name;
}
$clone = new curriculum($clone);
$clone->save();
$objs['curricula'] = array($this->id => $clone->id);
$options['targetcurriculum'] = $clone->id;
// associate with target cluster (if any)
if (isset($userset)) {
clustercurriculum::associate($userset->id, $clone->id);
}
if (!empty($options['courses'])) {
// copy courses
$currcrs = curriculumcourse_get_list_by_curr($this->id);
if ($currcrs->valid()) {
$objs['courses'] = array();
$objs['classes'] = array();
foreach ($currcrs as $currcrsdata) {
$course = new course($currcrsdata->courseid);
$rv = $course->duplicate($options);
if (isset($rv['errors']) && !empty($rv['errors'])) {
$objs['errors'] = array_merge($objs['errors'], $rv['errors']);
}
if (isset($rv['courses'])) {
$objs['courses'] = $objs['courses'] + $rv['courses'];
}
if (isset($rv['classes'])) {
$objs['classes'] = $objs['classes'] + $rv['classes'];
}
// associate with curriculum
if (isset($rv['courses'][$course->id])) {
$curcrs = new curriculumcourse($currcrsdata);
unset($curcrs->id);
$curcrs->courseid = $rv['courses'][$course->id];
$curcrs->curriculumid = $clone->id;
$curcrs->save();
}
}
}
unset($currcrs);
}
if (!empty($objs['errors'])) {
return $objs;
}
if (!empty($options['tracks'])) {
// copy tracks
$tracks = track_get_listing('name', 'ASC', 0, 0, '', '', $this->id);
if (isset($objs['courses'])) {
$options['coursemap'] = $objs['courses'];
}
if (!empty($tracks)) {
$objs['tracks'] = array();
if (isset($objs['courses'])) {
$options['coursemap'] = $objs['courses'];
}
if (!isset($objs['classes'])) {
$objs['classes'] = array();
}
foreach ($tracks as $track) {
$track = new track($track);
$options['classmap'] = $objs['classes'];
$rv = $track->duplicate($options);
if (isset($rv['errors']) && !empty($rv['errors'])) {
$objs['errors'] = array_merge($objs['errors'], $rv['errors']);
}
if (isset($rv['tracks'])) {
$objs['tracks'] = $objs['tracks'] + $rv['tracks'];
}
if (isset($rv['classes'])) {
$objs['classes'] = $objs['classes'] + $rv['classes'];
}
}
}
}
return $objs;
}
/**
* Validate that the provided custom field type and value produce the
* specified error message on program update
*
* @param string $uitype The input control / UI type
* @param string $value The value to use for the custom field
* @param string $message The expected error message
* @param array $otherparams Other parameters to give to the field owner
* @dataProvider type_error_provider
*/
public function test_program_update_customfield_message($uitype, $value, $message, $otherparams)
{
global $CFG;
require_once $CFG->dirroot . '/local/elisprogram/accesslib.php';
require_once $CFG->dirroot . '/local/elisprogram/lib/data/curriculum.class.php';
$this->create_custom_field(CONTEXT_ELIS_PROGRAM, $uitype, $otherparams);
// Create mapping record.
$this->create_mapping_record('course', 'testfieldshortname', 'customtestfieldshortname');
$program = new curriculum(array('name' => 'testprogramname', 'idnumber' => 'testprogramidnumber'));
$program->save();
$temp = new curriculum();
$temp->reset_custom_field_list();
$data = array('action' => 'update', 'context' => 'curriculum', 'idnumber' => 'testprogramidnumber', 'customtestfieldshortname' => $value);
$message = '[course.csv line 2] Program with idnumber "testprogramidnumber" could not be updated. ' . $message . "\n";
$this->assert_data_produces_error($data, $message, 'course');
}
/**
* Test failure conditions.
* @dataProvider dataprovider_failure
* @expectedException moodle_exception
* @param array $programtocreate The incoming program data.
*/
public function test_failure(array $programtocreate)
{
global $DB;
$this->give_permissions(array('local/elisprogram:program_create'));
// Setup duplicate program.
$dupcur = new curriculum(array('idnumber' => 'DupProgramIdnumber', 'name' => 'DupProgramName'));
$dupcur->save();
$response = local_datahub_elis_program_create::program_create($programtocreate);
}
/**
* Validating that enrolling a user in a track instance triggers the enrolment
* notification
*/
public function test_track_enrolment_sends_class_enrolment_notification()
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/setup.php';
require_once elispm::lib('data/curriculum.class.php');
require_once elispm::lib('data/track.class.php');
require_once elispm::lib('data/user.class.php');
// Configuration.
set_config('popup_provider_elis_program_notify_pm_permitted', 1, 'message');
set_config('email_provider_elis_program_notify_pm_permitted', 1, 'message');
set_config('notify_trackenrol_user', 1, 'local_elisprogram');
$message = '%%userenrolname%% has been enrolled in the track %%trackname%%.';
set_config('notify_trackenrol_message', $message, 'local_elisprogram');
// Force refreshing of configuration.
elis::$config = new elis_config();
$this->setAdminUser();
unset_config('noemailever');
// Setup.
$user = new user(array('idnumber' => 'testuseridnumber', 'username' => 'testuserusername', 'firstname' => 'testuserfirstname', 'lastname' => 'testuserlastname', 'email' => '*****@*****.**', 'country' => 'CA'));
$user->save();
$program = new curriculum(array('idnumber' => 'testprogramidnumber'));
$program->save();
$track = new track(array('curid' => $program->id, 'idnumber' => 'testtrackidnumber', 'name' => 'testtrackname'));
$track->save();
// Run the enrolment create action.
$record = new stdClass();
$record->context = 'track_testtrackidnumber';
$record->user_username = '******';
$importplugin = rlip_dataplugin_factory::factory('dhimport_version1elis');
$importplugin->fslogger = new silent_fslogger(null);
$sink = $this->redirectEmails();
$importplugin->track_enrolment_create($record, 'bogus', 'testtrackidnumber');
$this->assertEquals(1, count($sink->get_messages()));
$sink->close();
// Validation.
$mdluserid = $DB->get_field('user', 'id', array('username' => 'testuserusername'));
$expectedmessage = "{$user->firstname} {$user->lastname} has been enrolled in the track {$track->name}.";
$like = $DB->sql_like('fullmessagehtml', ':message');
$select = "useridto = :userid\n AND {$like}";
$this->assertTrue($DB->record_exists_select('message', $select, array('userid' => $mdluserid, 'message' => "{$expectedmessage}%")));
}
/**
* Validate that mappings are applied during the class instance update action
*/
public function test_mapping_applied_during_class_update()
{
global $CFG, $DB;
require_once $CFG->dirroot . '/course/lib.php';
require_once $CFG->dirroot . '/local/eliscore/lib/data/customfield.class.php';
require_once $CFG->dirroot . '/local/elisprogram/accesslib.php';
require_once $CFG->dirroot . '/local/elisprogram/lib/data/classmoodlecourse.class.php';
require_once $CFG->dirroot . '/local/elisprogram/lib/data/course.class.php';
require_once $CFG->dirroot . '/local/elisprogram/lib/data/curriculum.class.php';
require_once $CFG->dirroot . '/local/elisprogram/lib/data/pmclass.class.php';
require_once $CFG->dirroot . '/local/elisprogram/lib/data/track.class.php';
$this->init_mapping();
$customfieldid = $this->create_custom_field(CONTEXT_ELIS_CLASS);
$pmcourse = new course(array('name' => 'testcoursename', 'idnumber' => 'testcourseidnumber', 'syllabus' => ''));
$pmcourse->save();
$program = new curriculum(array('idnumber' => 'testprogramidnumber'));
$program->save();
$track = new track(array('curid' => $program->id, 'idnumber' => 'testtrackidnumber'));
$track->save();
$category = new stdClass();
$category->name = 'testcategoryname';
$category->id = $DB->insert_record('course_categories', $category);
$course = new stdClass();
$course->category = $category->id;
$course->shortname = 'testcourseshortname';
$course->fullname = 'testcoursefullname';
$course = create_course($course);
$pmclass = new pmclass(array('courseid' => $pmcourse->id, 'idnumber' => 'testclassidnumber'));
$pmclass->save();
// Run the class create update.
$record = new stdClass();
$record->customaction = 'update';
$record->customcontext = 'class';
$record->customidnumber = 'testclassidnumber';
$record->customstartdate = 'Jan/02/2012';
$record->customenddate = 'Jan/02/2012';
$record->customstarttimehour = '2';
$record->customstarttimeminute = '10';
$record->customendtimehour = '2';
$record->customendtimeminute = '10';
$record->custommaxstudents = '2';
$record->customenrol_from_waitlist = '1';
$record->customassignment = 'testcourseidnumber';
$record->customtrack = 'testtrackidnumber';
$record->customautoenrol = '1';
$record->customlink = 'testcourseshortname';
$record->customtestfieldshortname = '1';
$this->run_pmentity_import((array) $record);
// Validation.
$data = array('courseid' => $pmcourse->id, 'idnumber' => 'testclassidnumber', 'startdate' => rlip_timestamp(0, 0, 0, 1, 2, 2012), 'enddate' => rlip_timestamp(0, 0, 0, 1, 2, 2012), 'starttimehour' => 2, 'starttimeminute' => 10, 'endtimehour' => 2, 'endtimeminute' => 10, 'maxstudents' => 2, 'enrol_from_waitlist' => 1);
$this->assertTrue($DB->record_exists(pmclass::TABLE, $data));
$this->assertTrue($DB->record_exists(trackassignment::TABLE, array('classid' => $pmclass->id, 'trackid' => $track->id, 'autoenrol' => 1)));
$this->assertTrue($DB->record_exists(classmoodlecourse::TABLE, array('classid' => $pmclass->id, 'moodlecourseid' => $course->id)));
$instance = \local_elisprogram\context\pmclass::instance(1);
$this->assertTrue($DB->record_exists(field_data_int::TABLE, array('fieldid' => $customfieldid, 'contextid' => $instance->id, 'data' => 1)));
}
/**
* Validate that mappings are applied during the track enrolment delete action
*/
public function test_mapping_applied_during_track_enrolment_delete()
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/data/curriculum.class.php';
require_once $CFG->dirroot . '/local/elisprogram/lib/data/track.class.php';
$this->init_mapping();
$userid = $this->create_test_user();
$program = new curriculum(array('idnumber' => 'testprogramidnumber'));
$program->save();
$track = new track(array('curid' => $program->id, 'idnumber' => 'testtrackidnumber'));
$track->save();
$usertrack = new usertrack(array('trackid' => $track->id, 'userid' => $userid));
$usertrack->save();
// Run the track enrolment delete action.
$record = new stdClass();
$record->customaction = 'delete';
$record->customcontext = 'track_testtrackidnumber';
$record->customuser_username = '******';
$record->customuser_email = '*****@*****.**';
$record->customuser_idnumber = 'testuseridnumber';
$this->run_enrolment_import((array) $record);
// Validation.
$this->assertEquals(0, $DB->count_records(usertrack::TABLE));
}
/**
* Test creating a new program entity with a default role assignment defined.
*/
public function test_createprogramwithdefaultroleassignment()
{
global $DB, $USER;
list($rcid, $reid) = $this->create_roles('program');
// Setup the editor role to be the default role for the program context.
elis::$config->local_elisprogram->default_curriculum_role_id = $reid;
$sysctx = context_system::instance();
// Assign the test user the creator role.
role_assign($rcid, 100, $sysctx->id);
// Create a new program entity.
$data = array('idnumber' => 'program100', 'name' => 'program100', 'description' => 'program100');
$obj = new curriculum($data);
$obj->save();
// Initialize a new program management page and invoke the code that handles default role assignments.
$page = new curriculumpage();
$page->after_cm_entity_add($obj);
$programctx = \local_elisprogram\context\program::instance($obj->id);
$params = array('roleid' => $reid, 'userid' => $USER->id, 'contextid' => $programctx->id);
$this->assertTrue($DB->record_exists('role_assignments', $params));
}
/**
* Validate that deleting a userset deletes all appropriate associations
*/
public function test_delete_elis_userset_deletes_associations()
{
global $CFG, $DB;
// Entities.
require_once $CFG->dirroot . '/local/elisprogram/lib/setup.php';
require_once elispm::lib('data/userset.class.php');
require_once elispm::lib('data/user.class.php');
require_once elispm::lib('data/curriculum.class.php');
require_once elispm::lib('data/track.class.php');
require_once elis::lib('data/customfield.class.php');
// Associations.
require_once elispm::lib('data/clusterassignment.class.php');
require_once elispm::lib('data/clustercurriculum.class.php');
require_once elispm::lib('data/clustertrack.class.php');
require_once elispm::file('enrol/userset/moodleprofile/userset_profile.class.php');
// For context level access.
require_once elispm::file('accesslib.php');
$origfieldcount = $DB->count_records(field::TABLE);
// Set up user set.
$userset = new userset(array('name' => 'testusersetname'));
$userset->save();
// Set up other entities and associations.
// Cluster enrolment.
$user = new user(array('idnumber' => 'testuseridnumber', 'username' => 'testuserusername', 'firstname' => 'testuserfirstname', 'lastname' => 'testuserlastname', 'email' => '*****@*****.**', 'country' => 'CA'));
$user->save();
$clusterassignment = new clusterassignment(array('clusterid' => $userset->id, 'userid' => $user->id));
$clusterassignment->save();
// Cluster-curriculum assignment.
$curriculum = new curriculum(array('idnumber' => 'testcurriculumidnumber'));
$curriculum->save();
$clustercurriculum = new clustercurriculum(array('clusterid' => $userset->id, 'curriculumid' => $curriculum->id));
$clustercurriculum->save();
// Cluster-track assignment.
$track = new track(array('curid' => $curriculum->id, 'idnumber' => 'testtrackidnumber'));
$track->save();
$clustertrack = new clustertrack(array('clusterid' => $userset->id, 'trackid' => $track->id));
$clustertrack->save();
// Custom field.
$field = new field(array('name' => 'testfieldname', 'categoryid' => 9999));
$field->save();
$context = \local_elisprogram\context\userset::instance($userset->id);
$data = new field_data_int(array('contextid' => $context->id, 'fieldid' => $field->id, 'data' => 1));
$data->save();
// Cluster profile criteria.
$clusterprofile = new userset_profile(array('clusterid' => $userset->id, 'fieldid' => $field->id, 'value' => 0));
$clusterprofile->save();
// Validate setup.
$this->assertEquals(1, $DB->count_records(userset::TABLE));
$this->assertEquals(1, $DB->count_records(user::TABLE));
$this->assertEquals(1, $DB->count_records(clusterassignment::TABLE));
$this->assertEquals(1, $DB->count_records(curriculum::TABLE));
$this->assertEquals(1, $DB->count_records(clustercurriculum::TABLE));
$this->assertEquals(1, $DB->count_records(track::TABLE));
$this->assertEquals(1, $DB->count_records(clustertrack::TABLE));
$this->assertEquals(1 + $origfieldcount, $DB->count_records(field::TABLE));
$this->assertEquals(1, $DB->count_records(field_data_int::TABLE));
$this->assertEquals(1, $DB->count_records(userset_profile::TABLE));
// Run the import.
$data = array('action' => 'delete');
$this->run_core_userset_import($data, true);
// Validation.
$this->assertEquals(0, $DB->count_records(userset::TABLE));
$this->assertEquals(1, $DB->count_records(user::TABLE));
$this->assertEquals(0, $DB->count_records(clusterassignment::TABLE));
$this->assertEquals(1, $DB->count_records(curriculum::TABLE));
$this->assertEquals(0, $DB->count_records(clustercurriculum::TABLE));
$this->assertEquals(1, $DB->count_records(track::TABLE));
$this->assertEquals(0, $DB->count_records(clustertrack::TABLE));
$this->assertEquals(1 + $origfieldcount, $DB->count_records(field::TABLE));
$this->assertEquals(0, $DB->count_records(field_data_int::TABLE));
$this->assertEquals(0, $DB->count_records(userset_profile::TABLE));
}
/**
* Set up data that is needed for testing
*/
private function set_up_required_data($assignusertouserset = true, $assigncoursetoclass = true, $assigntracktoclass = true, $initclusterprofile = false, $initusersetfielddata = true)
{
global $CFG, $DB;
require_once $CFG->dirroot . '/local/elisprogram/lib/setup.php';
require_once $CFG->dirroot . '/course/lib.php';
require_once $CFG->dirroot . '/lib/enrollib.php';
require_once elis::lib('data/customfield.class.php');
require_once elispm::file('accesslib.php');
require_once elispm::lib('data/classmoodlecourse.class.php');
require_once elispm::lib('data/clusterassignment.class.php');
require_once elispm::lib('data/clustertrack.class.php');
require_once elispm::lib('data/course.class.php');
require_once elispm::lib('data/curriculum.class.php');
require_once elispm::lib('data/pmclass.class.php');
require_once elispm::lib('data/track.class.php');
require_once elispm::lib('data/user.class.php');
require_once elispm::lib('data/userset.class.php');
require_once elispm::lib('data/usertrack.class.php');
$fieldcategoryid = $DB->get_field(field_category::TABLE, 'id', array('name' => 'Associated Group'));
$this->assertNotEquals(false, $fieldcategoryid);
$fieldcategory = new field_category($fieldcategoryid);
$fieldcategory->load();
// Set up the test user.
$user = new user(array('idnumber' => 'testuseridnumber', 'username' => 'testuserusername', 'firstname' => 'testuserfirstname', 'lastname' => 'testuserlastname', 'email' => '*****@*****.**', 'country' => 'CA'));
$user->save();
// Set up the test course description and class instance.
$course = new course(array('name' => 'testcoursename', 'idnumber' => 'testcourseidnumber', 'syllabus' => ''));
$course->save();
$pmclass = new pmclass(array('courseid' => $course->id, 'idnumber' => 'testclassidnumber'));
$pmclass->save();
$category = new stdClass();
$category->name = 'testcategoryname';
$category->id = $DB->insert_record('course_categories', $category);
// Set up the test Moodle course.
set_config('enrol_plugins_enabled', 'manual');
set_config('defaultenrol', 1, 'enrol_manual');
set_config('status', ENROL_INSTANCE_ENABLED, 'enrol_manual');
$course = new stdClass();
$course->category = $category->id;
$course->shortname = 'testcourseshortname';
$course->fullname = 'testcoursefullname';
$course = create_course($course);
if ($assigncoursetoclass) {
// Assign the Moodle course to a class instance.
$classmoodlecourse = new classmoodlecourse(array('classid' => $pmclass->id, 'moodlecourseid' => $course->id));
$classmoodlecourse->save();
}
// Set up the test program and track.
$curriculum = new curriculum(array('idnumber' => 'testcurriculumidnumber'));
$curriculum->save();
$track = new track(array('curid' => $curriculum->id, 'idnumber' => 'testtrackidnumber'));
$track->save();
if ($assigntracktoclass) {
// Assign the test track to the test class instance.
$trackassignment = new trackassignment(array('trackid' => $track->id, 'classid' => $pmclass->id, 'autoenrol' => 1));
$trackassignment->save();
}
// Set up the test userset.
$userset = new userset();
$usersetdata = array('name' => 'testusersetname');
if ($initusersetfielddata) {
$usersetdata['field_userset_group'] = 1;
$usersetdata['field_userset_groupings'] = 1;
}
$userset->set_from_data((object) $usersetdata);
$userset->save();
// Assign the test user to the test track.
$usertrack = new usertrack(array('userid' => $user->id, 'trackid' => $track->id));
$usertrack->save();
$clustertrack = new clustertrack(array('clusterid' => $userset->id, 'trackid' => $track->id));
$clustertrack->save();
if ($assignusertouserset) {
// Assign the test user to the test userset.
$clusterassignment = new clusterassignment(array('userid' => $user->id, 'clusterid' => $userset->id, 'plugin' => 'manual'));
$clusterassignment->save();
}
if ($initclusterprofile) {
// Set up a file we can use to auto-associate users to a userset.
$field = new field(array('categoryid' => $fieldcategory->id, 'shortname' => 'autoassociate', 'name' => 'autoassociate', 'datatype' => 'bool'));
$field->save();
// Ensure manual field owner exists for syncing.
field_owner::ensure_field_owner_exists($field, 'manual');
$ownerid = $DB->get_field(field_owner::TABLE, 'id', array('fieldid' => $field->id, 'plugin' => 'manual'));
$owner = new field_owner($ownerid);
$owner->param_control = 'checkbox';
$owner->save();
field_owner::ensure_field_owner_exists($field, 'moodle_profile');
$DB->execute("UPDATE {" . field_owner::TABLE . "} SET exclude = ?", array(pm_moodle_profile::sync_to_moodle));
$fieldcontextlevel = new field_contextlevel(array('fieldid' => $field->id, 'contextlevel' => CONTEXT_ELIS_USER));
$fieldcontextlevel->save();
// The associated Moodle user profile field.
require_once $CFG->dirroot . '/user/profile/definelib.php';
require_once $CFG->dirroot . '/user/profile/field/checkbox/define.class.php';
$profiledefinecheckbox = new profile_define_checkbox();
$data = new stdClass();
$data->datatype = 'checkbox';
$data->categoryid = 99999;
$data->shortname = 'autoassociate';
$data->name = 'autoassociate';
$profiledefinecheckbox->define_save($data);
$mfield = $DB->get_record('user_info_field', array('shortname' => 'autoassociate'));
// The "cluster-profile" association.
$usersetprofile = new userset_profile(array('clusterid' => $userset->id, 'fieldid' => $mfield->id, 'value' => true));
$usersetprofile->save();
}
// Enrol the user in the Moodle course.
$mdluserid = $DB->get_field('user', 'id', array('username' => 'testuserusername'));
$roleid = create_role('testrole', 'testrole', 'testrole');
enrol_try_internal_enrol($course->id, $mdluserid, $roleid);
// Set up the necessary config data.
set_config('userset_groups', 1, 'elisprogram_usetgroups');
set_config('siteguest', '');
// Validate setup.
$this->assertEquals(0, $DB->count_records('groups'));
}
