/**
* This function processes the submitted form for all of the sections. Most of the work
* is completed via using the section_icon class and its associated routines. The data
* is pulled from the form, a check is made to see if any boxes are ticked, then the
* desired result is processed. Any draft files that need to be saved are saved in this
* function.
*
* TODO: some logic should be added to outright delete a settings record if it has neither
* a disable flag or custom label associated with it.
*
*/
function process_form($courseid, $blockid, &$submittedform, &$sectionheaders, $numberofsections)
{
global $DB;
for ($i = 0; $i < $numberofsections; $i++) {
$filepickername = 'fileinfo_' . "{$i}";
$hiddenidname = 'hiddenid_' . "{$i}";
$masterupdatename = 'masterid_' . "{$i}";
$deleteiconname = 'deleteid_' . "{$i}";
$noiconname = 'noicon_' . "{$i}";
$newcourseid = $courseid;
$customlabelfield = 'customlabelfield_' . "{$i}";
$customlabelcheckbox = 'customlbelcheckbox_' . "{$i}";
$si = new section_icon($courseid, $sectionheaders[$i]);
// Update master via using courseid 0.
if (!isset($submittedform->{$masterupdatename})) {
// Use courseid of 1 so we get the correct context.
$newcourseid = 1;
$context = context_course::instance($newcourseid);
} else {
// Save block context instead of the course context for course-specific records.
$context = context_block::instance($blockid);
}
// Check for delete first.
if (isset($submittedform->{$deleteiconname})) {
$si->delete_record();
continue;
}
$draftitemid = file_get_submitted_draft_itemid($filepickername);
$itemid = get_unused_file_id();
file_save_draft_area_files($draftitemid, $context->id, BNN_BLOCK_SAVE_COMPONENT, BNN_BLOCK_SAVE_AREA, $itemid, array('subdirs' => 0, 'maxbytes' => BNN_MAX_BYTES, 'maxfiles' => BNN_MAX_FILES));
// Only update if the user uploaded a file.
if (check_draft_id($draftitemid)) {
$si->update_icon_record($newcourseid, $itemid);
}
// The other IFs are separate cases because the user can do multiple things at once.
if ($submittedform->{$noiconname} != $si->get_icon_disable()) {
$si->update_disableicon($submittedform->{$noiconname});
}
if ($submittedform->{$customlabelcheckbox} == true) {
// Only write label if different from existing label.
if ($si->get_custom_label() != $submittedform->{$customlabelfield}) {
$si->update_label($submittedform->{$customlabelfield});
}
} else {
// Only write a null if the record exists and is not already null.
if ($si->settings_exists() && $si->get_custom_label() != null) {
$si->update_label(null);
}
}
}
}
/**
* This method tests the update_label() routine. Two possible outcomes can exist:
* a new record can be created, or an existing record can be udpated. I've included
* both below.
*
*/
public function test_update_label()
{
$courseid = $this->testcourseid;
// Create a new settings record.
$sectionname = "This is a new section";
$customlabel = "This is a new label";
$si = new section_icon($courseid, $sectionname);
$si->update_label($customlabel);
// Comment: disable = 0 -> this is what a new record should default to.
$this->check_section_settings_record($courseid, $sectionname, 0, $customlabel);
// Update an existing record.
$sectionname = self::SECTION5_NAME;
$customlabel = "This is an updated label";
$si = new section_icon($courseid, $sectionname);
$si->update_label($customlabel);
// Comment: disable = 1, since the disable flag is set in the test DB for Topic 5.
$this->check_section_settings_record($courseid, $sectionname, 1, $customlabel);
}
