<?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 contains the datetime profile field definition class.
*
* @package profilefield_datetime
* @copyright 2010 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*/
/**
* Define datetime fields.
*
* @copyright 2010 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*/
class profile_define_datetime extends profile_define_base {
/**
* Define the setting for a datetime custom field.
*
* @param moodleform $form the user form
*/
public function define_form_specific($form) {
// Get the current calendar in use - see MDL-18375.
$calendartype = \core_calendar\type_factory::get_calendar_instance();
// Create variables to store start and end.
list($year, $month, $day) = explode('_', date('Y_m_d'));
$currentdate = $calendartype->convert_from_gregorian($year, $month, $day);
$currentyear = $currentdate['year'];
$arryears = $calendartype->get_years();
// Add elements.
$form->addElement('select', 'param1', get_string('startyear', 'profilefield_datetime'), $arryears);
$form->setType('param1', PARAM_INT);
$form->setDefault('param1', $currentyear);
$form->addElement('select', 'param2', get_string('endyear', 'profilefield_datetime'), $arryears);
$form->setType('param2', PARAM_INT);
$form->setDefault('param2', $currentyear);
$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);
}
/**
* Validate the data from the profile field form.
*
* @param stdClass $data from the add/edit profile field form
* @param array $files
* @return array associative array of error messages
*/
public function define_validate_specific($data, $files) {
$errors = array();
// Make sure the start year is not greater than the end year.
if ($data->param1 > $data->param2) {
$errors['param1'] = get_string('startyearafterend', 'profilefield_datetime');
}
return $errors;
}
/**
* Alter form based on submitted or existing data.
*
* @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);
> $id = optional_param('id', 0, 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
// 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);
}
}
/**
* Preprocess data from the profile field form before
* it is saved.
*
* @param stdClass $data from the add/edit profile field form
* @return stdClass processed data object
*/
public function define_save_preprocess($data) {
// Get the current calendar in use - see MDL-18375.
$calendartype = \core_calendar\type_factory::get_calendar_instance();
// 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'];
if (empty($data->param3)) {
$data->param3 = null;
}
// No valid value in the default data column needed.
$data->defaultdata = '0';
return $data;
}
}