AutorÃa | Ultima modificación | Ver Log |
<?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/>.
namespace mod_questionnaire\question;
/**
* This file contains the parent class for date question types.
*
* @author Mike Churchward
* @copyright 2016 onward Mike Churchward (mike.churchward@poetopensource.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
* @package mod_questionnaire
*/
class date extends question {
/**
* Return the responseclass used.
* @return string
*/
protected function responseclass() {
return '\\mod_questionnaire\\responsetype\\date';
}
/**
* Return the help name.
* @return string
*/
public function helpname() {
return 'date';
}
/**
* Override and return a form template if provided. Output of question_survey_display is iterpreted based on this.
* @return boolean | string
*/
public function question_template() {
return 'mod_questionnaire/question_date';
}
/**
* Override and return a form template if provided. Output of response_survey_display is iterpreted based on this.
* @return boolean | string
*/
public function response_template() {
return 'mod_questionnaire/response_date';
}
/**
* Return the context tags for the check question template.
* @param \mod_questionnaire\responsetype\response\response $response
* @param array $descendantsdata
* @param boolean $blankquestionnaire
* @return object The check question context tags.
*/
protected function question_survey_display($response, $descendantsdata, $blankquestionnaire=false) {
// Date.
$questiontags = new \stdClass();
if (!empty($response->answers[$this->id])) {
$dateentered = $response->answers[$this->id][0]->value;
$setdate = $this->check_date_format($dateentered);
if (!$setdate) {
$msg = get_string('wrongdateformat', 'questionnaire', $dateentered);
$this->add_notification($msg);
} else {
$response->answers[$this->id][0]->value = $dateentered;
}
}
$choice = new \stdClass();
$choice->type = 'date'; // Using HTML5 date input.
$choice->onkeypress = 'return event.keyCode != 13;';
$choice->name = 'q'.$this->id;
$choice->value = (isset($response->answers[$this->id][0]->value) ? $response->answers[$this->id][0]->value : '');
$questiontags->qelements = new \stdClass();
$questiontags->qelements->choice = $choice;
return $questiontags;
}
/**
* Return the context tags for the check response template.
* @param \mod_questionnaire\responsetype\response\response $response
* @return object The check question response context tags.
*/
protected function response_survey_display($response) {
$resptags = new \stdClass();
if (isset($response->answers[$this->id])) {
$answer = reset($response->answers[$this->id]);
$resptags->content = $answer->value;
}
return $resptags;
}
/**
* Check question's form data for valid response. Override this is type has specific format requirements.
*
* @param \stdClass $responsedata The data entered into the response.
* @return boolean
*/
public function response_valid($responsedata) {
$responseval = false;
if (is_a($responsedata, 'mod_questionnaire\responsetype\response\response')) {
// If $responsedata is a response object, look through the answers.
if (isset($responsedata->answers[$this->id]) && !empty($responsedata->answers[$this->id])) {
$answer = $responsedata->answers[$this->id][0];
$responseval = $answer->value;
}
} else if (isset($responsedata->{'q'.$this->id})) {
$responseval = $responsedata->{'q' . $this->id};
}
if ($responseval !== false) {
$checkdateresult = true;
if ($responseval != '') {
$checkdateresult = $this->check_date_format($responseval);
}
return $checkdateresult;
} else {
return parent::response_valid($responsedata);
}
}
/**
* Return the form length.
* @param \MoodleQuickForm $mform
* @param string $helpname
* @return \MoodleQuickForm|void
*/
protected function form_length(\MoodleQuickForm $mform, $helpname = '') {
return question::form_length_hidden($mform);
}
/**
* Return the form precision.
* @param \MoodleQuickForm $mform
* @param string $helpname
* @return \MoodleQuickForm|void
*/
protected function form_precise(\MoodleQuickForm $mform, $helpname = '') {
return question::form_precise_hidden($mform);
}
/**
* Verify that the date provided is in the proper YYYY-MM-DD format.
* @param string $date
* @return bool
*/
public function check_date_format($date) {
$datepieces = explode('-', $date);
$return = true;
if (count($datepieces) != 3) {
$return = false;
} else {
foreach ($datepieces as $piece => $datepiece) {
if (!is_numeric($datepiece)) {
$return = false;
break;
}
switch ($piece) {
// Year check.
case 0:
if ((strlen($datepiece) != 4) || ($datepiece <= 0)) {
$return = false;
break 2;
}
break;
// Month check.
case 1:
if ((strlen($datepiece) != 2) || ((int)$datepiece < 1) || ((int)$datepiece > 12)) {
$return = false;
break 2;
}
break;
// Day check.
case 2:
if ((strlen($datepiece) != 2) || ((int)$datepiece < 1) || ((int)$datepiece > 31)) {
$return = false;
break 2;
}
break;
}
}
}
return $return;
}
/**
* True if question provides mobile support.
*
* @return bool
*/
public function supports_mobile() {
return true;
}
/**
* Does the question support mobile display.
* @param int $qnum
* @param bool $autonum
* @return \stdClass
*/
public function mobile_question_display($qnum, $autonum = false) {
$mobiledata = parent::mobile_question_display($qnum, $autonum);
$mobiledata->isdate = true;
return $mobiledata;
}
/**
* Does the question have mobile choices.
* @return mixed
*/
public function mobile_question_choices_display() {
$choices = [];
$choices[0] = new \stdClass();
$choices[0]->id = 0;
$choices[0]->choice_id = 0;
$choices[0]->question_id = $this->id;
$choices[0]->content = '';
$choices[0]->value = null;
return $choices;
}
}