mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
859b00d0cc
AMOS START MOV [profilefieldtypecheckbox,core_admin],[pluginname,profilefield_checkbox] MOV [profilefieldtypemenu,core_admin],[pluginname,profilefield_menu] MOV [profilefieldtypetext,core_admin],[pluginname,profilefield_text] MOV [profilefieldtypetextarea,core_admin],[pluginname,profilefield_textarea] AMOS END
545 lines
18 KiB
PHP
545 lines
18 KiB
PHP
<?php
|
|
|
|
class profile_define_base {
|
|
|
|
/**
|
|
* Prints out the form snippet for creating or editing a profile field
|
|
* @param object instance of the moodleform class
|
|
*/
|
|
function define_form(&$form) {
|
|
$form->addElement('header', '_commonsettings', get_string('profilecommonsettings', 'admin'));
|
|
$this->define_form_common($form);
|
|
|
|
$form->addElement('header', '_specificsettings', get_string('profilespecificsettings', 'admin'));
|
|
$this->define_form_specific($form);
|
|
}
|
|
|
|
/**
|
|
* Prints out the form snippet for the part of creating or
|
|
* editing a profile field common to all data types
|
|
* @param object instance of the moodleform class
|
|
*/
|
|
function define_form_common(&$form) {
|
|
|
|
$strrequired = get_string('required');
|
|
|
|
$form->addElement('text', 'shortname', get_string('profileshortname', 'admin'), 'maxlength="100" size="25"');
|
|
$form->addRule('shortname', $strrequired, 'required', null, 'client');
|
|
$form->setType('shortname', PARAM_ALPHANUM);
|
|
|
|
$form->addElement('text', 'name', get_string('profilename', 'admin'), 'size="50"');
|
|
$form->addRule('name', $strrequired, 'required', null, 'client');
|
|
$form->setType('name', PARAM_MULTILANG);
|
|
|
|
$form->addElement('editor', 'description', get_string('profiledescription', 'admin'), null, null);
|
|
$form->setHelpButton('description', array('text2', get_string('helptext')));
|
|
|
|
$form->addElement('selectyesno', 'required', get_string('profilerequired', 'admin'));
|
|
|
|
$form->addElement('selectyesno', 'locked', get_string('profilelocked', 'admin'));
|
|
|
|
$form->addElement('selectyesno', 'forceunique', get_string('profileforceunique', 'admin'));
|
|
|
|
$form->addElement('selectyesno', 'signup', get_string('profilesignup', 'admin'));
|
|
|
|
$choices = array();
|
|
$choices[PROFILE_VISIBLE_NONE] = get_string('profilevisiblenone', 'admin');
|
|
$choices[PROFILE_VISIBLE_PRIVATE] = get_string('profilevisibleprivate', 'admin');
|
|
$choices[PROFILE_VISIBLE_ALL] = get_string('profilevisibleall', 'admin');
|
|
$form->addElement('select', 'visible', get_string('profilevisible', 'admin'), $choices);
|
|
$form->setHelpButton('visible', array('profilevisible', get_string('profilevisible','admin')));
|
|
$form->setDefault('visible', PROFILE_VISIBLE_ALL);
|
|
|
|
$choices = profile_list_categories();
|
|
$form->addElement('select', 'categoryid', get_string('profilecategory', 'admin'), $choices);
|
|
}
|
|
|
|
/**
|
|
* Prints out the form snippet for the part of creating or
|
|
* editing a profile field specific to the current data type
|
|
* @param object instance of the moodleform class
|
|
*/
|
|
function define_form_specific(&$form) {
|
|
/// do nothing - overwrite if necessary
|
|
}
|
|
|
|
/**
|
|
* Validate the data from the add/edit profile field form.
|
|
* Generally this method should not be overwritten by child
|
|
* classes.
|
|
* @param object data from the add/edit profile field form
|
|
* @return array associative array of error messages
|
|
*/
|
|
function define_validate($data, $files) {
|
|
|
|
$data = (object)$data;
|
|
$err = array();
|
|
|
|
$err += $this->define_validate_common($data, $files);
|
|
$err += $this->define_validate_specific($data, $files);
|
|
|
|
return $err;
|
|
}
|
|
|
|
/**
|
|
* Validate the data from the add/edit profile field form
|
|
* that is common to all data types. Generally this method
|
|
* should not be overwritten by child classes.
|
|
* @param object data from the add/edit profile field form
|
|
* @return array associative array of error messages
|
|
*/
|
|
function define_validate_common($data, $files) {
|
|
global $USER, $DB;
|
|
|
|
$err = array();
|
|
|
|
/// Check the shortname was not truncated by cleaning
|
|
if (empty($data->shortname)) {
|
|
$err['shortname'] = get_string('required');
|
|
|
|
} else {
|
|
/// Fetch field-record from DB
|
|
$field = $DB->get_record('user_info_field', array('shortname'=>$data->shortname));
|
|
/// Check the shortname is unique
|
|
if ($field and $field->id <> $data->id) {
|
|
$err['shortname'] = get_string('profileshortnamenotunique', 'admin');
|
|
|
|
/// Shortname must also be unique compared to the standard user fields
|
|
} else if (!$field and isset($USER->{$data->shortname})) {
|
|
$err['shortname'] = get_string('profileshortnamenotunique', 'admin');
|
|
}
|
|
}
|
|
|
|
/// No further checks necessary as the form class will take care of it
|
|
return $err;
|
|
}
|
|
|
|
/**
|
|
* Validate the data from the add/edit profile field form
|
|
* that is specific to the current data type
|
|
* @param object data from the add/edit profile field form
|
|
* @return array associative array of error messages
|
|
*/
|
|
function define_validate_specific($data, $files) {
|
|
/// do nothing - overwrite if necessary
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Alter form based on submitted or existing data
|
|
* @param object form
|
|
*/
|
|
function define_after_data(&$mform) {
|
|
/// do nothing - overwrite if necessary
|
|
}
|
|
|
|
/**
|
|
* Add a new profile field or save changes to current field
|
|
* @param object data from the add/edit profile field form
|
|
* @return boolean status of the insert/update record
|
|
*/
|
|
function define_save($data) {
|
|
global $DB;
|
|
|
|
$data = $this->define_save_preprocess($data); /// hook for child classes
|
|
|
|
$old = false;
|
|
if (!empty($data->id)) {
|
|
$old = $DB->get_record('user_info_field', array('id'=>(int)$data->id));
|
|
}
|
|
|
|
/// check to see if the category has changed
|
|
if (!$old or $old->categoryid != $data->categoryid) {
|
|
$data->sortorder = $DB->count_records('user_info_field', array('categoryid'=>$data->categoryid)) + 1;
|
|
}
|
|
|
|
|
|
if (empty($data->id)) {
|
|
unset($data->id);
|
|
$data->id = $DB->insert_record('user_info_field', $data);
|
|
} else {
|
|
$DB->update_record('user_info_field', $data);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Preprocess data from the add/edit profile field form
|
|
* before it is saved. This method is a hook for the child
|
|
* classes to overwrite.
|
|
* @param object data from the add/edit profile field form
|
|
* @return object processed data object
|
|
*/
|
|
function define_save_preprocess($data) {
|
|
/// do nothing - overwrite if necessary
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Provides a method by which we can allow the default data in profile_define_*
|
|
* to use an editor
|
|
*
|
|
* This should return an array of editor names (which will need to be formatted/cleaned)
|
|
*
|
|
* @return array
|
|
*/
|
|
function define_editors() {
|
|
return array();
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Reorder the profile fields within a given category starting
|
|
* at the field at the given startorder
|
|
*/
|
|
function profile_reorder_fields() {
|
|
global $DB;
|
|
|
|
if ($categories = $DB->get_records('user_info_category')) {
|
|
foreach ($categories as $category) {
|
|
$i = 1;
|
|
if ($fields = $DB->get_records('user_info_field', array('categoryid'=>$category->id), 'sortorder ASC')) {
|
|
foreach ($fields as $field) {
|
|
$f = new object();
|
|
$f->id = $field->id;
|
|
$f->sortorder = $i++;
|
|
$DB->update_record('user_info_field', $f);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Reorder the profile categoriess starting at the category
|
|
* at the given startorder
|
|
*/
|
|
function profile_reorder_categories() {
|
|
global $DB;
|
|
|
|
$i = 1;
|
|
if ($categories = $DB->get_records('user_info_category', null, 'sortorder ASC')) {
|
|
foreach ($categories as $cat) {
|
|
$c = new object();
|
|
$c->id = $cat->id;
|
|
$c->sortorder = $i++;
|
|
$DB->update_record('user_info_category', $c);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete a profile category
|
|
* @param integer id of the category to be deleted
|
|
* @return boolean success of operation
|
|
*/
|
|
function profile_delete_category($id) {
|
|
global $DB;
|
|
|
|
/// Retrieve the category
|
|
if (!$category = $DB->get_record('user_info_category', array('id'=>$id))) {
|
|
print_error('invalidcategoryid');
|
|
}
|
|
|
|
if (!$categories = $DB->get_records('user_info_category', null, 'sortorder ASC')) {
|
|
print_error('nocate', 'debug');
|
|
}
|
|
|
|
unset($categories[$category->id]);
|
|
|
|
if (!count($categories)) {
|
|
return; //we can not delete the last category
|
|
}
|
|
|
|
/// Does the category contain any fields
|
|
if ($DB->count_records('user_info_field', array('categoryid'=>$category->id))) {
|
|
if (array_key_exists($category->sortorder-1, $categories)) {
|
|
$newcategory = $categories[$category->sortorder-1];
|
|
} else if (array_key_exists($category->sortorder+1, $categories)) {
|
|
$newcategory = $categories[$category->sortorder+1];
|
|
} else {
|
|
$newcategory = reset($categories); // get first category if sortorder broken
|
|
}
|
|
|
|
$sortorder = $DB->count_records('user_info_field', array('categoryid'=>$newcategory->id)) + 1;
|
|
|
|
if ($fields = $DB->get_records('user_info_field', array('categoryid'=>$category->id), 'sortorder ASC')) {
|
|
foreach ($fields as $field) {
|
|
$f = new object();
|
|
$f->id = $field->id;
|
|
$f->sortorder = $sortorder++;
|
|
$f->categoryid = $newcategory->id;
|
|
$DB->update_record('user_info_field', $f);
|
|
//echo "<pre>";var_dump($f);echo"</pre>";
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Finally we get to delete the category
|
|
$DB->delete_records('user_info_category', array('id'=>$category->id));
|
|
profile_reorder_categories();
|
|
return true;
|
|
}
|
|
|
|
|
|
function profile_delete_field($id) {
|
|
global $DB;
|
|
|
|
/// Remove any user data associated with this field
|
|
if (!$DB->delete_records('user_info_data', array('fieldid'=>$id))) {
|
|
print_error('cannotdeletecustomfield');
|
|
}
|
|
|
|
/// Try to remove the record from the database
|
|
$DB->delete_records('user_info_field', array('id'=>$id));
|
|
|
|
/// Reorder the remaining fields in the same category
|
|
profile_reorder_fields();
|
|
}
|
|
|
|
/**
|
|
* Change the sortorder of a field
|
|
* @param integer id of the field
|
|
* @param string direction of move
|
|
* @return boolean success of operation
|
|
*/
|
|
function profile_move_field($id, $move) {
|
|
global $DB;
|
|
|
|
/// Get the field object
|
|
if (!$field = $DB->get_record('user_info_field', array('id'=>$id), 'id, sortorder, categoryid')) {
|
|
return false;
|
|
}
|
|
/// Count the number of fields in this category
|
|
$fieldcount = $DB->count_records('user_info_field', array('categoryid'=>$field->categoryid));
|
|
|
|
/// Calculate the new sortorder
|
|
if ( ($move == 'up') and ($field->sortorder > 1)) {
|
|
$neworder = $field->sortorder - 1;
|
|
} elseif ( ($move == 'down') and ($field->sortorder < $fieldcount)) {
|
|
$neworder = $field->sortorder + 1;
|
|
} else {
|
|
return false;
|
|
}
|
|
|
|
/// Retrieve the field object that is currently residing in the new position
|
|
if ($swapfield = $DB->get_record('user_info_field', array('categoryid'=>$field->categoryid, 'sortorder'=>$neworder), 'id, sortorder')) {
|
|
|
|
/// Swap the sortorders
|
|
$swapfield->sortorder = $field->sortorder;
|
|
$field->sortorder = $neworder;
|
|
|
|
/// Update the field records
|
|
$DB->update_record('user_info_field', $field);
|
|
$DB->update_record('user_info_field', $swapfield);
|
|
}
|
|
|
|
profile_reorder_fields();
|
|
}
|
|
|
|
/**
|
|
* Change the sortorder of a category
|
|
* @param integer id of the category
|
|
* @param string direction of move
|
|
* @return boolean success of operation
|
|
*/
|
|
function profile_move_category($id, $move) {
|
|
global $DB;
|
|
/// Get the category object
|
|
if (!($category = $DB->get_record('user_info_category', array('id'=>$id), 'id, sortorder'))) {
|
|
return false;
|
|
}
|
|
|
|
/// Count the number of categories
|
|
$categorycount = $DB->count_records('user_info_category');
|
|
|
|
/// Calculate the new sortorder
|
|
if ( ($move == 'up') and ($category->sortorder > 1)) {
|
|
$neworder = $category->sortorder - 1;
|
|
} elseif ( ($move == 'down') and ($category->sortorder < $categorycount)) {
|
|
$neworder = $category->sortorder + 1;
|
|
} else {
|
|
return false;
|
|
}
|
|
|
|
/// Retrieve the category object that is currently residing in the new position
|
|
if ($swapcategory = $DB->get_record('user_info_category', array('sortorder'=>$neworder),'id, sortorder')) {
|
|
|
|
/// Swap the sortorders
|
|
$swapcategory->sortorder = $category->sortorder;
|
|
$category->sortorder = $neworder;
|
|
|
|
/// Update the category records
|
|
if ($DB->update_record('user_info_category', $category) and $DB->update_record('user_info_category', $swapcategory)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Retrieve a list of all the available data types
|
|
* @return array a list of the datatypes suitable to use in a select statement
|
|
*/
|
|
function profile_list_datatypes() {
|
|
global $CFG;
|
|
|
|
$datatypes = array();
|
|
|
|
$plugins = get_plugin_list('profilefield');
|
|
foreach ($plugins as $type=>$unused) {
|
|
$datatypes[$type] = get_string('pluginname', 'profilefield_'.$type);
|
|
}
|
|
asort($datatypes);
|
|
|
|
return $datatypes;
|
|
}
|
|
|
|
/**
|
|
* Retrieve a list of categories and ids suitable for use in a form
|
|
* @return array
|
|
*/
|
|
function profile_list_categories() {
|
|
global $DB;
|
|
if (!$categories = $DB->get_records_menu('user_info_category', NULL, 'sortorder ASC', 'id, name')) {
|
|
$categories = array();
|
|
}
|
|
return $categories;
|
|
}
|
|
|
|
|
|
/// Are we adding or editing a cateogory?
|
|
function profile_edit_category($id, $redirect) {
|
|
global $CFG, $DB, $OUTPUT;
|
|
|
|
require_once('index_category_form.php');
|
|
$categoryform = new category_form();
|
|
|
|
if ($category = $DB->get_record('user_info_category', array('id'=>$id))) {
|
|
$categoryform->set_data($category);
|
|
}
|
|
|
|
if ($categoryform->is_cancelled()) {
|
|
redirect($redirect);
|
|
} else {
|
|
if ($data = $categoryform->get_data()) {
|
|
if (empty($data->id)) {
|
|
unset($data->id);
|
|
$data->sortorder = $DB->count_records('user_info_category') + 1;
|
|
$DB->insert_record('user_info_category', $data, false);
|
|
} else {
|
|
$DB->update_record('user_info_category', $data);
|
|
}
|
|
profile_reorder_categories();
|
|
redirect($redirect);
|
|
|
|
}
|
|
|
|
if (empty($id)) {
|
|
$strheading = get_string('profilecreatenewcategory', 'admin');
|
|
} else {
|
|
$strheading = get_string('profileeditcategory', 'admin', format_string($category->name));
|
|
}
|
|
|
|
/// Print the page
|
|
echo $OUTPUT->header();
|
|
echo $OUTPUT->heading($strheading);
|
|
$categoryform->display();
|
|
echo $OUTPUT->footer();
|
|
die;
|
|
}
|
|
|
|
}
|
|
|
|
function profile_edit_field($id, $datatype, $redirect) {
|
|
global $CFG, $DB, $OUTPUT, $PAGE;
|
|
|
|
if (!$field = $DB->get_record('user_info_field', array('id'=>$id))) {
|
|
$field = new object();
|
|
$field->datatype = $datatype;
|
|
$field->description = '';
|
|
$field->descriptionformat = FORMAT_HTML;
|
|
$field->defaultdata = '';
|
|
$field->defaultdataformat = FORMAT_HTML;
|
|
}
|
|
|
|
|
|
// Clean and prepare description for the editor
|
|
$field->description = clean_text($field->description, $field->descriptionformat);
|
|
$field->description = array('text'=>$field->description, 'format'=>$field->descriptionformat, 'itemid'=>0);
|
|
|
|
require_once('index_field_form.php');
|
|
$fieldform = new field_form(null, $field->datatype);
|
|
|
|
// Convert the data format for
|
|
if (is_array($fieldform->editors())) {
|
|
foreach ($fieldform->editors() as $editor) {
|
|
if (isset($field->$editor)) {
|
|
$field->$editor = clean_text($field->$editor, $field->{$editor.'format'});
|
|
$field->$editor = array('text'=>$field->$editor, 'format'=>$field->{$editor.'format'}, 'itemid'=>0);
|
|
}
|
|
}
|
|
}
|
|
|
|
$fieldform->set_data($field);
|
|
|
|
if ($fieldform->is_cancelled()) {
|
|
redirect($redirect);
|
|
|
|
} else {
|
|
if ($data = $fieldform->get_data()) {
|
|
require_once($CFG->dirroot.'/user/profile/field/'.$datatype.'/define.class.php');
|
|
$newfield = 'profile_define_'.$datatype;
|
|
$formfield = new $newfield();
|
|
|
|
// Collect the description and format back into the proper data structure from the editor
|
|
// Note: This field will ALWAYS be an editor
|
|
$data->descriptionformat = $data->description['format'];
|
|
$data->description = $data->description['text'];
|
|
|
|
// Check whether the default data is an editor, this is (currently) only the
|
|
// textarea field type
|
|
if (is_array($data->defaultdata) && array_key_exists('text', $data->defaultdata)) {
|
|
// Collect the default data and format back into the proper data structure from the editor
|
|
$data->defaultdataformat = $data->defaultdata['format'];
|
|
$data->defaultdata = $data->defaultdata['text'];
|
|
}
|
|
|
|
// Convert the data format for
|
|
if (is_array($fieldform->editors())) {
|
|
foreach ($fieldform->editors() as $editor) {
|
|
if (isset($field->$editor)) {
|
|
$field->{$editor.'format'} = $field->{$editor}['format'];
|
|
$field->$editor = $field->{$editor}['text'];
|
|
}
|
|
}
|
|
}
|
|
|
|
$formfield->define_save($data);
|
|
profile_reorder_fields();
|
|
profile_reorder_categories();
|
|
redirect($redirect);
|
|
}
|
|
|
|
$datatypes = profile_list_datatypes();
|
|
|
|
if (empty($id)) {
|
|
$strheading = get_string('profilecreatenewfield', 'admin', $datatypes[$datatype]);
|
|
} else {
|
|
$strheading = get_string('profileeditfield', 'admin', $field->name);
|
|
}
|
|
|
|
/// Print the page
|
|
$PAGE->navbar->add($strheading);
|
|
echo $OUTPUT->header();
|
|
echo $OUTPUT->heading($strheading);
|
|
$fieldform->display();
|
|
echo $OUTPUT->footer();
|
|
die;
|
|
}
|
|
}
|
|
|
|
|