Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
<?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/>.

/**
 * Manage user profile fields.
 * @package core_user
 * @copyright  2007 onwards Shane Elliot {@link http://pukunui.com}
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

require('../../config.php');
require_once($CFG->libdir.'/adminlib.php');
require_once($CFG->dirroot.'/user/profile/lib.php');
require_once($CFG->dirroot.'/user/profile/definelib.php');

admin_externalpage_setup('profilefields');

$action   = optional_param('action', '', PARAM_ALPHA);

$redirect = $CFG->wwwroot.'/user/profile/index.php';

< $strchangessaved = get_string('changessaved'); < $strcancelled = get_string('cancelled');
$strdefaultcategory = get_string('profiledefaultcategory', 'admin');
< $strnofields = get_string('profilenofieldsdefined', 'admin');
$strcreatefield = get_string('profilecreatefield', 'admin'); // Do we have any actions to perform before printing the header. switch ($action) { case 'movecategory': $id = required_param('id', PARAM_INT); $dir = required_param('dir', PARAM_ALPHA); if (confirm_sesskey()) { profile_move_category($id, $dir); } redirect($redirect); break; case 'movefield': $id = required_param('id', PARAM_INT); $dir = required_param('dir', PARAM_ALPHA); if (confirm_sesskey()) { profile_move_field($id, $dir); } redirect($redirect); break; case 'deletecategory': $id = required_param('id', PARAM_INT); if (confirm_sesskey()) { profile_delete_category($id); } redirect($redirect, get_string('deleted')); break; case 'deletefield': $id = required_param('id', PARAM_INT); $confirm = optional_param('confirm', 0, PARAM_BOOL); // If no userdata for profile than don't show confirmation. $datacount = $DB->count_records('user_info_data', array('fieldid' => $id)); if (((data_submitted() and $confirm) or ($datacount === 0)) and confirm_sesskey()) { profile_delete_field($id); redirect($redirect, get_string('deleted')); } // Ask for confirmation, as there is user data available for field. $fieldname = $DB->get_field('user_info_field', 'name', array('id' => $id)); $optionsyes = array ('id' => $id, 'confirm' => 1, 'action' => 'deletefield', 'sesskey' => sesskey()); $strheading = get_string('profiledeletefield', 'admin', format_string($fieldname)); $PAGE->navbar->add($strheading); echo $OUTPUT->header(); echo $OUTPUT->heading($strheading); $formcontinue = new single_button(new moodle_url($redirect, $optionsyes), get_string('yes'), 'post'); $formcancel = new single_button(new moodle_url($redirect), get_string('no'), 'get'); echo $OUTPUT->confirm(get_string('profileconfirmfielddeletion', 'admin', $datacount), $formcontinue, $formcancel); echo $OUTPUT->footer(); die; break;
< case 'editfield': < $id = optional_param('id', 0, PARAM_INT); < $datatype = optional_param('datatype', '', PARAM_ALPHA); < < profile_edit_field($id, $datatype, $redirect); < die; < break; < case 'editcategory': < $id = optional_param('id', 0, PARAM_INT); < < profile_edit_category($id, $redirect); < die; < break;
default: // Normal form. } // Show all categories. $categories = $DB->get_records('user_info_category', null, 'sortorder ASC'); // Check that we have at least one category defined. if (empty($categories)) { $defaultcategory = new stdClass(); $defaultcategory->name = $strdefaultcategory; $defaultcategory->sortorder = 1; $DB->insert_record('user_info_category', $defaultcategory); redirect($redirect); } // Print the header. echo $OUTPUT->header(); echo $OUTPUT->heading(get_string('profilefields', 'admin'));
< foreach ($categories as $category) { < $table = new html_table(); < $table->head = array(get_string('profilefield', 'admin'), get_string('edit')); < $table->align = array('left', 'right'); < $table->width = '95%'; < $table->attributes['class'] = 'generaltable profilefield'; < $table->data = array();
> $outputcategories = []; > $options = profile_list_datatypes();
> foreach ($categories as $category) { if ($fields = $DB->get_records('user_info_field', array('categoryid' => $category->id), 'sortorder ASC')) { > // Category fields. foreach ($fields as $field) { > $outputfields = [];
< $table->data[] = array(format_string($field->name), profile_field_icons($field)); < }
> $fieldname = format_string($field->name); > $component = 'profilefield_' . $field->datatype; > $classname = "\\$component\\helper"; > if (class_exists($classname) && method_exists($classname, 'get_fieldname')) { > $fieldname = $classname::get_fieldname($field->name); > } > $outputfields[] = [ > 'id' => $field->id, > 'shortname' => $field->shortname, > 'datatype' => $field->datatype, > 'name' => $fieldname, > 'isfirst' => !count($outputfields), > 'islast' => count($outputfields) == count($fields) - 1, > ];
}
< < echo $OUTPUT->heading(format_string($category->name) .' '.profile_category_icons($category)); < if (count($table->data)) { < echo html_writer::table($table); < } else { < echo $OUTPUT->notification($strnofields);
}
< } // End of $categories foreach. < < echo '<hr />'; < echo '<div class="profileeditor">'; < < // Create a new field link. < $options = profile_list_datatypes(); < $popupurl = new moodle_url('/user/profile/index.php?id=0&action=editfield'); < echo $OUTPUT->single_select($popupurl, 'datatype', $options, '', array('' => get_string('choosedots')), 'newfieldform', array('label' => $strcreatefield)); < < // Add a div with a class so themers can hide, style or reposition the text. < html_writer::start_tag('div', array('class' => 'adminuseractionhint')); < echo get_string('or', 'lesson'); < html_writer::end_tag('div'); < < // Create a new category link. < $options = array('action' => 'editcategory'); < echo $OUTPUT->single_button(new moodle_url('index.php', $options), get_string('profilecreatecategory', 'admin')); < < echo '</div>';
> // Add new field menu. > $menu = new \action_menu(); > $menu->set_menu_trigger($strcreatefield); > foreach ($options as $type => $fieldname) { > $action = new \action_menu_link_secondary(new \moodle_url('#'), null, $fieldname, > ['data-action' => 'createfield', 'data-categoryid' => $category->id, 'data-datatype' => $type, > 'data-datatypename' => $fieldname]); > $menu->add($action); > } > $menu->attributes['class'] .= ' float-left mr-1'; > > // Add category information to the template. > $outputcategories[] = [ > 'id' => $category->id, > 'name' => format_string($category->name), > 'fields' => $outputfields, > 'hasfields' => count($outputfields), > 'isfirst' => !count($outputcategories), > 'islast' => count($outputcategories) == count($categories) - 1, > 'candelete' => count($categories) > 1, > 'addfieldmenu' => $menu->export_for_template($OUTPUT), > ]; > } > > echo $OUTPUT->render_from_template('core_user/edit_profile_fields', [ > 'categories' => $outputcategories, > 'sesskey' => sesskey(), > 'baseurl' => (new moodle_url('/user/profile/index.php'))->out(false) > ]);
echo $OUTPUT->footer();
< die; < < < /***** Some functions relevant to this script *****/ < < /** < * Create a string containing the editing icons for the user profile categories < * @param stdClass $category the category object < * @return string the icon string < */ < function profile_category_icons($category) { < global $CFG, $USER, $DB, $OUTPUT; < < $strdelete = get_string('delete'); < $strmoveup = get_string('moveup'); < $strmovedown = get_string('movedown'); < $stredit = get_string('edit'); < < $categorycount = $DB->count_records('user_info_category'); < $fieldcount = $DB->count_records('user_info_field', array('categoryid' => $category->id)); < < // Edit. < $editstr = '<a title="'.$stredit.'" href="index.php?id='.$category->id.'&amp;action=editcategory">' . < $OUTPUT->pix_icon('t/edit', $stredit) .'</a> '; < < // Delete. < // Can only delete the last category if there are no fields in it. < if (($categorycount > 1) or ($fieldcount == 0)) { < $editstr .= '<a title="'.$strdelete.'"'; < $editstr .= ' href="index.php?id='.$category->id.'&amp;action=deletecategory&amp;sesskey='.sesskey() . '">'; < $editstr .= $OUTPUT->pix_icon('t/delete', $strdelete).'</a> '; < } else { < $editstr .= $OUTPUT->spacer() . ' '; < } < < // Move up. < if ($category->sortorder > 1) { < $editstr .= '<a title="'.$strmoveup.'" '; < $editstr .= ' href="index.php?id='.$category->id.'&amp;action=movecategory&amp;dir=up&amp;sesskey='.sesskey().'">'; < $editstr .= $OUTPUT->pix_icon('t/up', $strmoveup) . '</a> '; < } else { < $editstr .= $OUTPUT->spacer() . ' '; < } < < // Move down. < if ($category->sortorder < $categorycount) { < $editstr .= '<a title="'.$strmovedown.'" '; < $editstr .= ' href="index.php?id='.$category->id.'&amp;action=movecategory&amp;dir=down&amp;sesskey='.sesskey().'">'; < $editstr .= $OUTPUT->pix_icon('t/down', $strmovedown) . '</a> '; < } else { < $editstr .= $OUTPUT->spacer() . ' '; < } < < return $editstr; < } < < /** < * Create a string containing the editing icons for the user profile fields < * @param stdClass $field the field object < * @return string the icon string < */ < function profile_field_icons($field) { < global $CFG, $USER, $DB, $OUTPUT; < < $strdelete = get_string('delete'); < $strmoveup = get_string('moveup'); < $strmovedown = get_string('movedown'); < $stredit = get_string('edit'); < < $fieldcount = $DB->count_records('user_info_field', array('categoryid' => $field->categoryid)); < $datacount = $DB->count_records('user_info_data', array('fieldid' => $field->id)); < < // Edit. < $editstr = '<a title="'.$stredit.'" href="index.php?id='.$field->id.'&amp;action=editfield">'; < $editstr .= $OUTPUT->pix_icon('t/edit', $stredit) . '</a> '; < < // Delete. < $editstr .= '<a title="'.$strdelete.'" href="index.php?id='.$field->id.'&amp;action=deletefield&amp;sesskey='.sesskey().'">'; < $editstr .= $OUTPUT->pix_icon('t/delete', $strdelete) . '</a> '; < < // Move up. < if ($field->sortorder > 1) { < $editstr .= '<a title="'.$strmoveup.'" '; < $editstr .= ' href="index.php?id='.$field->id.'&amp;action=movefield&amp;dir=up&amp;sesskey='.sesskey().'">'; < $editstr .= $OUTPUT->pix_icon('t/up', $strmoveup) . '</a> '; < } else { < $editstr .= $OUTPUT->spacer() . ' '; < } < < // Move down. < if ($field->sortorder < $fieldcount) { < $editstr .= '<a title="'.$strmovedown.'" '; < $editstr .= ' href="index.php?id='.$field->id.'&amp;action=movefield&amp;dir=down&amp;sesskey='.sesskey().'">'; < $editstr .= $OUTPUT->pix_icon('t/down', $strmovedown) . '</a> '; < } else { < $editstr .= $OUTPUT->spacer() . ' '; < } < < return $editstr; < } < < <