Skip to content

Commit

Permalink
MDL-18375 calendar: fixed issue when resaving the year in the datetim…
Browse files Browse the repository at this point in the history 
…e field causing the year to decrease

For example, a user may create a date/time profile field and set the 'Start year'
field to '2012'. Another user, using the Hijri calendar, may edit the name of
this field. They visit the settings page and in this case the date '1/1/2012'
is converted to '7/2/1433' in Hijri. So, the year '1433' is then displayed.
The user then changes the name of this field and saves the form. This is where
the issue occurs, as the date '1/1/1433' is converted into Gregorian, which
converts to the year '26/09/2011', so the year '2011' is saved in the DB, not
'2012'.
  • Loading branch information
@mdjnelson
mdjnelson committed Sep 5, 2013
1 parent deed22e commit 5ca04d0
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 17 deletions.
1 change: 1 addition & 0 deletions calendar/tests/calendartype_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,7 @@ private function datetime_field_submission_test($type, $date) {

// Get the data we are submitting for the form.
$formdata = array();
$formdata['id'] = 0;
$formdata['shortname'] = 'Shortname';
$formdata['name'] = 'Name';
$formdata['param1'] = $date['inputminyear'];
Expand Down
76 changes: 60 additions & 16 deletions user/profile/field/datetime/define.class.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,18 @@ public function define_form_specific($form) {
$form->addElement('checkbox', 'param3', get_string('wanttime', 'profilefield_datetime'));
$form->setType('param3', PARAM_INT);

$form->addElement('hidden', 'startday', '1');
$form->setType('startday', PARAM_INT);
$form->addElement('hidden', 'startmonth', '1');
$form->setType('startmonth', PARAM_INT);
$form->addElement('hidden', 'startyear', '1');
$form->setType('startyear', PARAM_INT);
$form->addElement('hidden', 'endday', '1');
$form->setType('endday', PARAM_INT);
$form->addElement('hidden', 'endmonth', '1');
$form->setType('endmonth', PARAM_INT);
$form->addElement('hidden', 'endyear', '1');
$form->setType('endyear', PARAM_INT);
$form->addElement('hidden', 'defaultdata', '0');
$form->setType('defaultdata', PARAM_INT);
}
Expand Down Expand Up @@ -85,23 +97,45 @@ public function define_validate_specific($data, $files) {
* @param moodleform $mform
*/
public function define_after_data(&$mform) {
global $DB;

// If we are adding a new profile field then the dates have already been set
// by setDefault to the correct dates in the used calendar system. We only want
// to execute the rest of the code when we have the years in the DB saved in
// Gregorian that need converting to the date for this user.
$id = required_param('id', PARAM_INT);
if ($id === 0) {
return;
}

// Get the field data from the DB.
$field = $DB->get_record('user_info_field', array('id' => $id), 'param1, param2', MUST_EXIST);

// Get the current calendar in use - see MDL-18375.
$calendartype = \core_calendar\type_factory::get_calendar_instance();

// An array to store form values.
$values = array();

// The start and end year will be set as a Gregorian year in the DB. We want
// to convert these to the equivalent year in the current calendar system.
$param1 = $mform->getElement('param1');
$year = $param1->getValue(); // The getValue() for select elements returns an array.
$year = $year[0];
$date1 = $calendartype->convert_from_gregorian($year, 1, 1);

$param2 = $mform->getElement('param2');
$year = $param2->getValue(); // The getValue() for select elements returns an array.
$year = $year[0];
$date2 = $calendartype->convert_from_gregorian($year, 1, 1);

$param1->setValue($date1['year']);
$param2->setValue($date2['year']);
// convert these to the equivalent year in the current calendar type being used.
$startdate = $calendartype->convert_from_gregorian($field->param1, 1, 1);
$values['startday'] = $startdate['day'];
$values['startmonth'] = $startdate['month'];
$values['startyear'] = $startdate['year'];
$values['param1'] = $startdate['year'];

$stopdate = $calendartype->convert_from_gregorian($field->param2, 1, 1);
$values['endday'] = $stopdate['day'];
$values['endmonth'] = $stopdate['month'];
$values['endyear'] = $stopdate['year'];
$values['param2'] = $stopdate['year'];

// Set the values.
foreach ($values as $key => $value) {
$param = $mform->getElement($key);
$param->setValue($value);
}
}

/**
Expand All @@ -115,9 +149,19 @@ public function define_save_preprocess($data) {
// Get the current calendar in use - see MDL-18375.
$calendartype = \core_calendar\type_factory::get_calendar_instance();

// Ensure the years are saved as Gregorian in the database.
$startdate = $calendartype->convert_to_gregorian($data->param1, 1, 1);
$stopdate = $calendartype->convert_to_gregorian($data->param2, 1, 1);
// Check if the start year was changed, if it was then convert from the start of that year.
if ($data->param1 != $data->startyear) {
$startdate = $calendartype->convert_to_gregorian($data->param1, 1, 1);
} else {
$startdate = $calendartype->convert_to_gregorian($data->param1, $data->startmonth, $data->startday);
}

// Check if the end year was changed, if it was then convert from the start of that year.
if ($data->param2 != $data->endyear) {
$stopdate = $calendartype->convert_to_gregorian($data->param2, 1, 1);
} else {
$stopdate = $calendartype->convert_to_gregorian($data->param2, $data->endmonth, $data->endday);
}

$data->param1 = $startdate['year'];
$data->param2 = $stopdate['year'];
Expand Down
2 changes: 1 addition & 1 deletion user/profile/field/datetime/version.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@

defined('MOODLE_INTERNAL') || die();

$plugin->version = 2013070200; // The current plugin version (Date: YYYYMMDDXX)
$plugin->version = 2013090200; // The current plugin version (Date: YYYYMMDDXX)
$plugin->requires = 2013050100; // Requires this Moodle version
$plugin->component = 'profilefield_datetime'; // Full name of the plugin (used for diagnostics)

0 comments on commit 5ca04d0

Please sign in to comment.