Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/mod/data/ -> field.php (source)
<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * This file is part of the Database module for Moodle
 *
 * @copyright 2005 Martin Dougiamas  http://dougiamas.com
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @package mod_data
 */

require_once('../../config.php');
require_once('lib.php');
> require_once($CFG->dirroot.'/mod/data/preset_form.php');
$id = optional_param('id', 0, PARAM_INT); // course module id $d = optional_param('d', 0, PARAM_INT); // database id $fid = optional_param('fid', 0 , PARAM_INT); // update field id $newtype = optional_param('newtype','',PARAM_ALPHA); // type of the new field $mode = optional_param('mode','',PARAM_ALPHA);
> $action = optional_param('action', '', PARAM_ALPHA); $defaultsort = optional_param('defaultsort', 0, PARAM_INT); > $fullname = optional_param('fullname', '', PARAM_PATH); // Directory the preset is in.
$defaultsortdir = optional_param('defaultsortdir', 0, PARAM_INT); $cancel = optional_param('cancel', 0, PARAM_BOOL); if ($cancel) { $mode = 'list'; } $url = new moodle_url('/mod/data/field.php'); if ($fid !== 0) { $url->param('fid', $fid); } if ($newtype !== '') { $url->param('newtype', $newtype); } if ($mode !== '') { $url->param('mode', $mode); } if ($defaultsort !== 0) { $url->param('defaultsort', $defaultsort); } if ($defaultsortdir !== 0) { $url->param('defaultsortdir', $defaultsortdir); } if ($cancel !== 0) { $url->param('cancel', $cancel); }
> if ($action !== '') { > $url->param('action', $action); if ($id) { > }
$url->param('id', $id); $PAGE->set_url($url); if (! $cm = get_coursemodule_from_id('data', $id)) { print_error('invalidcoursemodule'); } if (! $course = $DB->get_record('course', array('id'=>$cm->course))) { print_error('coursemisconf'); } if (! $data = $DB->get_record('data', array('id'=>$cm->instance))) { print_error('invalidcoursemodule'); } } else { $url->param('d', $d); $PAGE->set_url($url); if (! $data = $DB->get_record('data', array('id'=>$d))) { print_error('invalidid', 'data'); } if (! $course = $DB->get_record('course', array('id'=>$data->course))) { print_error('invalidcoursemodule'); } if (! $cm = get_coursemodule_from_instance('data', $data->id, $course->id)) { print_error('invalidcoursemodule'); } } require_login($course, true, $cm); $context = context_module::instance($cm->id); require_capability('mod/data:managetemplates', $context);
> $formimportzip = new data_import_preset_zip_form(); /************************************ > $formimportzip->set_data(array('d' => $data->id)); * Data Processing * > ***********************************/ > $actionbar = new \mod_data\output\action_bar($data->id, $PAGE->url); switch ($mode) { > > $PAGE->set_title(get_string('course') . ': ' . $course->fullname); case 'add': ///add a new field > $PAGE->set_heading($course->fullname); if (confirm_sesskey() and $fieldinput = data_submitted()){ > $PAGE->activityheader->disable(); > //$fieldinput->name = data_clean_field_name($fieldinput->name); > // Fill in missing properties needed for updating of instance. > $data->course = $cm->course; /// Only store this new field if it doesn't already exist. > $data->cmidnumber = $cm->idnumber; if (($fieldinput->name == '') or data_fieldname_exists($fieldinput->name, $data->id)) { > $data->instance = $cm->instance; >
$displaynoticebad = get_string('invalidfieldname','data');
> $renderer = $PAGE->get_renderer('mod_data'); > } else { > if ($formimportzip->is_cancelled()) { > redirect(new moodle_url('/mod/data/field.php', ['d' => $data->id])); /// Check for arrays and convert to a comma-delimited string > } else if ($formdata = $formimportzip->get_data()) { data_convert_arrays_to_strings($fieldinput); > $fieldactionbar = $actionbar->get_fields_action_bar(); > data_print_header($course, $cm, $data, false, $fieldactionbar); /// Create a field object to collect and store the data safely > echo $OUTPUT->heading(get_string('importpreset', 'data'), 2, 'mb-4'); $type = required_param('type', PARAM_FILE); > $file = new stdClass; $field = data_get_field_new($type, $data); > $file->name = $formimportzip->get_new_filename('importfile'); > $file->path = $formimportzip->save_temp_file('importfile'); $field->define_field($fieldinput); > $importer = new data_preset_upload_importer($course, $cm, $data, $file->path); $field->insert_field(); > echo $renderer->import_setting_mappings($data, $importer); > echo $OUTPUT->footer(); /// Update some templates > exit(0); data_append_new_field_to_templates($data, $fieldinput->name); > } > $displaynoticegood = get_string('fieldadded','data'); > if ($action == 'finishimport' && confirm_sesskey()) { } > data_print_header($course, $cm, $data, false); } > $overwritesettings = optional_param('overwritesettings', false, PARAM_BOOL); break; > > if (!$fullname) { > $presetdir = $CFG->tempdir . '/forms/' . required_param('directory', PARAM_FILE); case 'update': ///update a field > if (!file_exists($presetdir) || !is_dir($presetdir)) { if (confirm_sesskey() and $fieldinput = data_submitted()){ > throw new moodle_exception('cannotimport', 'error'); > } //$fieldinput->name = data_clean_field_name($fieldinput->name); > $importer = new data_preset_upload_importer($course, $cm, $data, $presetdir); > } else { if (($fieldinput->name == '') or data_fieldname_exists($fieldinput->name, $data->id, $fieldinput->fid)) { > $importer = new data_preset_existing_importer($course, $cm, $data, $fullname); > } $displaynoticebad = get_string('invalidfieldname','data'); > > $importer->import($overwritesettings); } else { > $strimportsuccess = get_string('importsuccess', 'data'); /// Check for arrays and convert to a comma-delimited string > $straddentries = get_string('addentries', 'data'); data_convert_arrays_to_strings($fieldinput); > $strtodatabase = get_string('todatabase', 'data'); > /// Create a field object to collect and store the data safely > if (!$DB->get_records('data_records', array('dataid' => $data->id))) { $field = data_get_field_from_id($fid, $data); > echo $OUTPUT->notification("$strimportsuccess <a href='edit.php?d=$data->id'>$straddentries</a> $strtodatabase", $oldfieldname = $field->field->name; > 'notifysuccess'); > } else { $field->field->name = $fieldinput->name; > echo $OUTPUT->notification("$strimportsuccess", 'notifysuccess'); $field->field->description = $fieldinput->description; > } $field->field->required = !empty($fieldinput->required) ? 1 : 0; > > echo $OUTPUT->continue_button(new moodle_url('/mod/data/field.php', ['d' => $data->id])); for ($i=1; $i<=10; $i++) { > echo $OUTPUT->footer(); if (isset($fieldinput->{'param'.$i})) { > exit; $field->field->{'param'.$i} = $fieldinput->{'param'.$i}; > } } else { >
$field->field->{'param'.$i} = '';
> if (!empty($validationerrors = $field->validate($fieldinput))) { } > $displaynoticebad = html_writer::alist($validationerrors); } > $mode = 'new'; > $newtype = $type; $field->update_field(); > break; > } /// Update the templates. >
data_replace_field_in_templates($data, $oldfieldname, $field->field->name);
> if (!empty($validationerrors = $field->validate($fieldinput))) { > $displaynoticebad = html_writer::alist($validationerrors); $displaynoticegood = get_string('fieldupdated','data'); > $mode = 'display'; } > break; } > }
break; case 'delete': // Delete a field if (confirm_sesskey()){ if ($confirm = optional_param('confirm', 0, PARAM_INT)) { // Delete the field completely if ($field = data_get_field_from_id($fid, $data)) { $field->delete_field(); // Update the templates. data_replace_field_in_templates($data, $field->field->name, ''); // Update the default sort field if ($fid == $data->defaultsort) { $rec = new stdClass(); $rec->id = $data->id; $rec->defaultsort = 0; $rec->defaultsortdir = 0; $DB->update_record('data', $rec); } $displaynoticegood = get_string('fielddeleted', 'data'); } } else { data_print_header($course,$cm,$data, false);
> echo $OUTPUT->heading(get_string('deletefield', 'data'), 2, 'mb-4');
// Print confirmation message. $field = data_get_field_from_id($fid, $data);
< echo $OUTPUT->confirm('<strong>'.$field->name().': '.$field->field->name.'</strong><br /><br />'. get_string('confirmdeletefield','data'),
> if ($field->type === 'unknown') { > $fieldtypename = get_string('unknown', 'data'); > } else { > $fieldtypename = $field->name(); > } > echo $OUTPUT->confirm('<strong>'.$fieldtypename.': '.$field->field->name.'</strong><br /><br />'. > get_string('confirmdeletefield', 'data'),
'field.php?d='.$data->id.'&mode=delete&fid='.$fid.'&confirm=1', 'field.php?d='.$data->id); echo $OUTPUT->footer(); exit; } } break; case 'sort': // Set the default sort parameters if (confirm_sesskey()) { $rec = new stdClass(); $rec->id = $data->id; $rec->defaultsort = $defaultsort; $rec->defaultsortdir = $defaultsortdir; $DB->update_record('data', $rec); redirect($CFG->wwwroot.'/mod/data/field.php?d='.$data->id, get_string('changessaved'), 2); exit; } break;
> case 'import': default: > $PAGE->navbar->add(get_string('importpreset', 'data')); break; > $fieldactionbar = $actionbar->get_fields_action_bar(); } > data_print_header($course, $cm, $data, false, $fieldactionbar); > > echo $OUTPUT->heading(get_string('importpreset', 'data'), 2, 'mb-4'); > echo $formimportzip->display(); /// Print the browsing interface > echo $OUTPUT->footer(); > exit; ///get the list of possible fields (plugins) > $plugins = core_component::get_plugin_list('datafield'); > case 'usepreset': $menufield = array(); > $PAGE->navbar->add(get_string('usestandard', 'data')); > $fieldactionbar = $actionbar->get_fields_action_bar(); foreach ($plugins as $plugin=>$fulldir){ > data_print_header($course, $cm, $data, false, $fieldactionbar); $menufield[$plugin] = get_string('pluginname', 'datafield_'.$plugin); //get from language files > } > if ($action === 'select') { asort($menufield); //sort in alphabetical order > if (!empty($fullname)) { $PAGE->set_title(get_string('course') . ': ' . $course->fullname); > echo $OUTPUT->heading(get_string('usestandard', 'data'), 2, 'mb-4'); $PAGE->set_heading($course->fullname); > $importer = new data_preset_existing_importer($course, $cm, $data, $fullname); $PAGE->force_settings_menu(true); > echo $renderer->import_setting_mappings($data, $importer); > } $PAGE->set_pagetype('mod-data-field-' . $newtype); > } else { if (($mode == 'new') && (!empty($newtype)) && confirm_sesskey()) { /// Adding a new field > echo $OUTPUT->heading(get_string('presets', 'data'), 2, 'mb-4'); data_print_header($course, $cm, $data,'fields'); > $presets = data_get_available_presets($context); > $presetstable = new \mod_data\output\presets($data->id, $presets, $field = data_get_field_new($newtype, $data); > new \moodle_url('/mod/data/field.php')); $field->display_edit_field(); > echo $renderer->render_presets($presetstable, false); > } } else if ($mode == 'display' && confirm_sesskey()) { /// Display/edit existing field > echo $OUTPUT->footer(); data_print_header($course, $cm, $data,'fields'); > exit; >
$field = data_get_field_from_id($fid, $data);
> if (!is_dir($fulldir)) { $field->display_edit_field(); > continue; > }
< $PAGE->set_title(get_string('course') . ': ' . $course->fullname); < $PAGE->set_heading($course->fullname);
< if (($mode == 'new') && (!empty($newtype)) && confirm_sesskey()) { /// Adding a new field
> if (($mode == 'new') && (!empty($newtype))) { // Adding a new field.
if (!$DB->record_exists('data_fields', array('dataid'=>$data->id))) {
> echo $OUTPUT->heading(get_string('newfield', 'data'));
echo $OUTPUT->notification(get_string('nofieldindatabase','data')); // nothing in database
> echo $OUTPUT->heading(get_string('editfield', 'data'));
< data_print_header($course, $cm, $data,'fields');
> $fieldactionbar = $actionbar->get_fields_action_bar(true, true, true); > data_print_header($course, $cm, $data, 'fields', $fieldactionbar); > echo $OUTPUT->heading(get_string('managefields', 'data'), 2, 'mb-4');
} else { //else print quiz style list of fields $table = new html_table(); $table->head = array( get_string('fieldname', 'data'), get_string('type', 'data'), get_string('required', 'data'), get_string('fielddescription', 'data'), get_string('action', 'data'), ); $table->align = array('left', 'left', 'left', 'left'); $table->wrap = array(false,false,false,false); if ($fff = $DB->get_records('data_fields', array('dataid'=>$data->id),'id')){
> $missingfieldtypes = [];
foreach ($fff as $ff) { $field = data_get_field($ff, $data); $baseurl = new moodle_url('/mod/data/field.php', array( 'd' => $data->id, 'fid' => $field->field->id, 'sesskey' => sesskey(), )); $displayurl = new moodle_url($baseurl, array( 'mode' => 'display', )); $deleteurl = new moodle_url($baseurl, array( 'mode' => 'delete', ));
< $table->data[] = array( < html_writer::link($displayurl, $field->field->name), < $field->image() . '&nbsp;' . $field->name(),
> // It display a notification when the field type does not exist. > $deletelink = html_writer::link($deleteurl, $OUTPUT->pix_icon('t/delete', get_string('delete'))); > $editlink = html_writer::link($displayurl, $OUTPUT->pix_icon('t/edit', get_string('edit'))); > if ($field->type === 'unknown') { > $missingfieldtypes[] = $field->field->name; > $fieldnamedata = $field->field->name; > $fieltypedata = $field->field->type; > $fieldlinkdata = $deletelink; > } else { > $fieldnamedata = html_writer::link($displayurl, $field->field->name); > $fieltypedata = $field->image() . '&nbsp;' . $field->name(); > $fieldlinkdata = $editlink . '&nbsp;' . $deletelink; > } > > $table->data[] = [ > $fieldnamedata, > $fieltypedata,
$field->field->required ? get_string('yes') : get_string('no'), shorten_text($field->field->description, 30),
< html_writer::link($displayurl, $OUTPUT->pix_icon('t/edit', get_string('edit'))) . < '&nbsp;' . < html_writer::link($deleteurl, $OUTPUT->pix_icon('t/delete', get_string('delete'))), < );
> $fieldlinkdata > ]; > } > if (!empty($missingfieldtypes)) { > echo $OUTPUT->notification(get_string('missingfieldtypes', 'data') . html_writer::alist($missingfieldtypes));
} } echo html_writer::table($table); }
< < < echo '<div class="fieldadd">'; < $popupurl = $CFG->wwwroot.'/mod/data/field.php?d='.$data->id.'&mode=new&sesskey='. sesskey(); < echo $OUTPUT->single_select(new moodle_url($popupurl), 'newtype', $menufield, null, array('' => 'choosedots'), < 'fieldform', array('label' => get_string('newfield', 'data'))); < echo $OUTPUT->help_icon('newfield', 'data'); < echo '</div>';
echo '<div class="sortdefault">'; echo '<form id="sortdefault" action="'.$CFG->wwwroot.'/mod/data/field.php" method="get">'; echo '<div>'; echo '<input type="hidden" name="d" value="'.$data->id.'" />'; echo '<input type="hidden" name="mode" value="sort" />'; echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />'; echo '<label for="defaultsort">'.get_string('defaultsortfield','data').'</label>'; echo '<select id="defaultsort" name="defaultsort" class="custom-select">'; if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id))) { echo '<optgroup label="'.get_string('fields', 'data').'">'; foreach ($fields as $field) { if ($data->defaultsort == $field->id) { echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>'; } else { echo '<option value="'.$field->id.'">'.$field->name.'</option>'; } } echo '</optgroup>'; } $options = array(); $options[DATA_TIMEADDED] = get_string('timeadded', 'data'); // TODO: we will need to change defaultsort db to unsinged to make these work in 2.0 /* $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data'); $options[DATA_FIRSTNAME] = get_string('authorfirstname', 'data'); $options[DATA_LASTNAME] = get_string('authorlastname', 'data'); if ($data->approval and has_capability('mod/data:approve', $context)) { $options[DATA_APPROVED] = get_string('approved', 'data'); }*/ echo '<optgroup label="'.get_string('other', 'data').'">'; foreach ($options as $key => $name) { if ($data->defaultsort == $key) { echo '<option value="'.$key.'" selected="selected">'.$name.'</option>'; } else { echo '<option value="'.$key.'">'.$name.'</option>'; } } echo '</optgroup>'; echo '</select>'; $options = array(0 => get_string('ascending', 'data'), 1 => get_string('descending', 'data')); echo html_writer::label(get_string('sortby'), 'menudefaultsortdir', false, array('class' => 'accesshide')); echo html_writer::select($options, 'defaultsortdir', $data->defaultsortdir, false, array('class' => 'custom-select')); echo '<input type="submit" class="btn btn-secondary ml-1" value="'.get_string('save', 'data').'" />'; echo '</div>'; echo '</form>'; echo '</div>'; } /// Finish the page echo $OUTPUT->footer();