FormValidator.class.php from pointcarre at Krugle
Show FormValidator.class.php syntax highlighted
<?php
// $Id: FormValidator.class.php 361 2006-08-18 10:22:16Z evie_em $
/*
==============================================================================
Dokeos - elearning and course management software
Copyright (c) 2004-2005 Dokeos S.A.
Copyright (c) Bart Mollet, Hogeschool Gent
For a full list of contributors, see "credits.txt".
The full license can be read in "license.txt".
This program 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 2
of the License, or (at your option) any later version.
See the GNU General Public License for more details.
Contact address: Dokeos, 44 rue des palais, B-1030 Brussels, Belgium
Mail: info@dokeos.com
==============================================================================
*/
require_once ('HTML/QuickForm.php');
require_once ('HTML/QuickForm/advmultiselect.php');
/**
* Filter
*/
define('NO_HTML', 1);
define('STUDENT_HTML', 2);
define('TEACHER_HTML', 3);
define('STUDENT_HTML_FULLPAGE',4);
define('TEACHER_HTML_FULLPAGE',5);
/**
* Objects of this class can be used to create/manipulate/validate user input.
*/
class FormValidator extends HTML_QuickForm
{
/**
* Constructor
* @param string $form_name Name of the form
* @param string $method Method ('post' (default) or 'get')
* @param string $action Action (default is $PHP_SELF)
* @param string $target Form's target defaults to '_self'
* @param mixed $attributes (optional)Extra attributes for <form> tag
* @param bool $trackSubmit (optional)Whether to track if the form was
* submitted by adding a special hidden field (default = true)
*/
function FormValidator($form_name, $method = 'post', $action = '', $target = '', $attributes = null, $trackSubmit = true)
{
$this->HTML_QuickForm($form_name, $method,$action, $target, $attributes, $trackSubmit);
// Load some custom elements and rules
$dir = dirname(__FILE__).'/';
$this->registerElementType('html_editor', $dir.'Element/html_editor.php', 'HTML_QuickForm_html_editor');
$this->registerElementType('datepicker', $dir.'Element/datepicker.php', 'HTML_QuickForm_datepicker');
$this->registerElementType('receivers', $dir.'Element/receivers.php', 'HTML_QuickForm_receivers');
$this->registerElementType('select_language', $dir.'Element/select_language.php', 'HTML_QuickForm_Select_Language');
$this->registerRule('date', null, 'HTML_QuickForm_Rule_Date', $dir.'Rule/Date.php');
$this->registerRule('date_compare', null, 'HTML_QuickForm_Rule_DateCompare', $dir.'Rule/DateCompare.php');
$this->registerRule('html',null,'HTML_QuickForm_Rule_HTML',$dir.'Rule/HTML.php');
$this->registerRule('username_available',null,'HTML_QuickForm_Rule_UsernameAvailable',$dir.'Rule/UsernameAvailable.php');
$this->registerRule('username',null,'HTML_QuickForm_Rule_Username',$dir.'Rule/Username.php');
$this->registerRule('filetype',null,'HTML_QuickForm_Rule_Filetype',$dir.'Rule/Filetype.php');
// Modify the default templates
$renderer = & $this->defaultRenderer();
$form_template = <<<EOT
<form {attributes}>
{content}
<div class="clear">
</div>
</form>
EOT;
$renderer->setFormTemplate($form_template);
$element_template = <<<EOT
<div class="row">
<div class="label">
<!-- BEGIN required --><span class="form_required">*</span> <!-- END required -->{label}
</div>
<div class="formw">
<!-- BEGIN error --><span class="form_error">{error}</span><br /><!-- END error --> {element}
</div>
</div>
EOT;
$renderer->setElementTemplate($element_template);
$header_template = <<<EOT
<div class="row">
<div class="form_header">{header}</div>
</div>
EOT;
$renderer->setHeaderTemplate($header_template);
HTML_QuickForm :: setRequiredNote('<span class="form_required">*</span> <small>'.get_lang('ThisFieldIsRequired').'</small>');
$required_note_template = <<<EOT
<div class="row">
<div class="label"></div>
<div class="formw">{requiredNote}</div>
</div>
EOT;
$renderer->setRequiredNoteTemplate($required_note_template);
}
/**
* Add a textfield to the form.
* A trim-filter is attached to the field.
* @param string $label The label for the form-element
* @param string $name The element name
* @param boolean $required Is the form-element required (default=true)
* @param array $attributes Optional list of attributes for the form-element
*/
function add_textfield( $name, $label,$required = true, $attributes = array())
{
$this->addElement('text',$name,$label,$attributes);
$this->applyFilter($name,'trim');
if($required)
{
$this->addRule($name, get_lang('ThisFieldIsRequired'), 'required');
}
}
/**
* Add a HTML-editor to the form to fill in a title.
* A trim-filter is attached to the field.
* A HTML-filter is attached to the field (cleans HTML)
* A rule is attached to check for unwanted HTML
* @param string $label The label for the form-element
* @param string $name The element name
* @param boolean $required Is the form-element required (default=true)
*/
function add_html_editor($name, $label, $required = true, $full_page = false)
{
$this->addElement('html_editor',$name,$label,'rows="15" cols="80"');
$this->applyFilter($name,'trim');
$html_type = $_SESSION['status'] == COURSEMANAGER ? TEACHER_HTML : STUDENT_HTML;
if($full_page)
{
$html_type = $_SESSION['status'] == COURSEMANAGER ? TEACHER_HTML_FULLPAGE : STUDENT_HTML_FULLPAGE;
//First *filter* the HTML (markup, indenting, ...)
$this->applyFilter($name,'html_filter_teacher_fullpage');
}
else
{
//First *filter* the HTML (markup, indenting, ...)
$this->applyFilter($name,'html_filter_teacher');
}
if($required)
{
$this->addRule($name, get_lang('ThisFieldIsRequired'), 'required');
}
if($full_page)
{
$el = $this->getElement($name);
$el->fullPage = true;
}
//Add rule to check not-allowed HTML
$this->addRule($name,get_lang('SomeHTMLNotAllowed'),'html',$html_type);
}
/**
* Add a datepicker element to the form
* A rule is added to check if the date is a valid one
* @param string $label The label for the form-element
* @param string $name The element name
*/
function add_datepicker($name,$label)
{
$this->addElement('datepicker', $name, $label, array ('form_name' => $this->getAttribute('name')));
$this->addRule($name, get_lang('InvalidDate'), 'date');
}
/**
* Add a timewindow element to the form.
* 2 datepicker elements are added and a rule to check if the first date is
* before the second one.
* @param string $label The label for the form-element
* @param string $name The element name
*/
function add_timewindow($name_1, $name_2, $label_1,$label_2)
{
$this->add_datepicker($name_1, $label_1);
$this->add_datepicker( $name_2, $label_2);
$this->addRule(array ($name_1, $name_2), get_lang('StartDateShouldBeBeforeEndDate'), 'date_compare', 'lte');
}
/**
* Add a button to the form to add resources.
*/
function add_resource_button()
{
$group[] = $this->createElement('static','add_resource_img',null,'<img src="'.api_get_path(WEB_IMG_PATH).'attachment.gif" alt="'.get_lang('Attachment').'"/>');
$group[] = $this->createElement('submit','add_resource',get_lang('Attachment'),'class="link_alike"');
$this->addGroup($group);
}
/**
* Display the form.
* If an element in the form didn't validate, an error message is showed
* asking the user to complete the form.
*/
function display()
{
$error = false;
foreach($this->_elements as $index => $element)
{
if( !is_null(parent::getElementError($element->getName())) )
{
$error = true;
break;
}
}
if($error)
{
Display::display_error_message(get_lang('FormHasErrorsPleaseComplete'));
}
parent::display();
}
}
/**
* Clean HTML
* @param string HTML to clean
* @param int $mode
* @return string The cleaned HTML
*/
function html_filter($html, $mode = NO_HTML)
{
require_once(dirname(__FILE__).'/Rule/HTML.php');
$allowed_tags = HTML_QuickForm_Rule_HTML::get_allowed_tags($mode);
$cleaned_html = kses($html,$allowed_tags);
return $cleaned_html;
}
function html_filter_teacher($html)
{
return html_filter($html,TEACHER_HTML);
}
function html_filter_student($html)
{
return html_filter($html,STUDENT_HTML);
}
function html_filter_teacher_fullpage($html)
{
return html_filter($html,TEACHER_HTML_FULLPAGE);
}
function html_filter_student_fullpage($html)
{
return html_filter($html,STUDENT_HTML_FULLPAGE);
}
?>
See more files for this project here