Олег Давидович: 1 версия импортирована

2024-10-21T08:59:27Z

1 версия импортирована

← Предыдущая версия	Версия от 08:59, 21 октября 2024
(нет различий)

1>Nakohdo: /* moodleform::validation() */ coloring the code

2009-06-15T14:22:26Z

moodleform::validation(): coloring the code

Новая страница

{{Formslib}}

There are two ways to add validation in the forms lib.

== MoodleQuickForm::addRule() ==

You use this typically inside your moodleform::definition method. For example to set a field as required.

<code php>
$mform->addElement('text','shortname', get_string('shortname'),'maxlength="15" size="10"');
$mform->setHelpButton('shortname', array('courseshortname', get_string('shortname')), true);
$mform->setDefault('shortname', get_string('defaultcourseshortname'));
$mform->addRule('shortname', null, 'required', null, 'client');
$mform->setType('shortname', PARAM_MULTILANG);
</code>

There is good documentation for this on the [http://pear.php.net/manual/en/package.html.html-quickform.intro-validation.php PEAR web site]

In Moodle formslib you can set certain rules' error message to null and a default error message will automatically be used. The default messages are defined in lang/{language}/form.php. Here are the English definitions :

<code php>
$string['err_alphanumeric']='You must enter only letters or numbers here.';
$string['err_email']='You must enter a valid email address here.';
$string['err_lettersonly']='You must enter only letters here.';
$string['err_maxlength']='You must enter not more than $a->format characters here.';
$string['err_minlength']='You must enter at least $a->format characters here.';
$string['err_nopunctuation']='You must enter no punctuation characters here.';
$string['err_nonzero']='You must enter a number not starting with a 0 here.';
$string['err_numeric']='You must enter a number here.';
$string['err_rangelength']='You must enter between {$a->format[0]} and {$a->format[1]} characters here.';
$string['err_required']='You must supply a value here.';
</code>

== moodleform::validation() ==

Define a method validation on your moodleform child to make your own custom validation for the form. This is done on the server side. And data_submitted will return null until the function returns no errors. You return an array of errors if there is any error or an empty array if there are no errors.

<code php>
class course_edit_form extends moodleform {

function definition() {
blah blah;
}

/// perform some extra moodle validation
function validation($data) {
$errors= array();
if ($foundcourses = get_records('course', 'shortname', $data['shortname'])) {
if (!empty($data['id'])) {
unset($foundcourses[$data['id']]);
}
if (!empty($foundcourses)) {
foreach ($foundcourses as $foundcourse) {
$foundcoursenames[] = $foundcourse->fullname;
}
$foundcoursenamestring = implode(',', $foundcoursenames);
$errors['shortname']= get_string('shortnametaken', '', $foundcoursenamestring);
}
}

if (empty($data['enrolenddisabled'])){
if ($data['enrolenddate'] <= $data['enrolstartdate']){
$errors['enroldateendgrp'] = get_string('enrolenddaterror');
}
}
return $errors;
}
}
?>
</code>

{{Moodle 1.9}}There is a new parameter $files in Moodle 1.9, it allows validation of uploaded files too.

<code php>
function validation($data, $files) {
$errors = parent::validation($data, $files);
if (empty($files['userfile'])) {
if (array_key_exists('url', $data)) {
$errors['url'] = get_string('required');
}
}
return $errors;
}
</code>

{{Moodle 1.9}}To validate a recaptcha element use the following code inside the function validation($data) {
:
<code php>
if (!empty($CFG->recaptchapublickey) && !empty($CFG->recaptchaprivatekey)) {
$recaptcha_element = $this->_form->getElement('recaptcha_field_name');
if (!empty($this->_form->_submitValues['recaptcha_challenge_field'])) {
$challenge_field = $this->_form->_submitValues['recaptcha_challenge_field'];
$response_field = $this->_form->_submitValues['recaptcha_response_field'];
if (true !== ($result = $recaptcha_element->verify($challenge_field, $response_field))) {
$errors['recaptcha_field_name'] = $result;
}
} else {
$errors['recaptcha_field_name'] = get_string('missingrecaptchachallengefield');
}
}
</code>

Development:lib/formslib.php Validation - История изменений

Олег Давидович: 1 версия импортирована

1>Nakohdo: /* moodleform::validation() */ coloring the code