tag * @param bool $track_submit (optional) Whether to track if the form was * submitted by adding a special hidden field (default = true) */ function __construct($form_name, $method = 'post', $action = '', $target = '', $attributes = null, $track_submit = true) { //Default form class if (is_array($attributes) && !isset($attributes['class']) || empty($attributes)) { $attributes['class'] = 'form-horizontal'; } parent::__construct($form_name, $method, $action, $target, $attributes, $track_submit); // Load some custom elements and rules $dir = api_get_path(LIBRARY_PATH).'formvalidator/'; $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('datepickerdate', $dir.'Element/datepickerdate.php', 'HTML_QuickForm_datepickerdate'); $this->registerElementType('receivers', $dir.'Element/receivers.php', 'HTML_QuickForm_receivers'); $this->registerElementType('select_language', $dir.'Element/select_language.php', 'HTML_QuickForm_Select_Language'); $this->registerElementType('select_theme', $dir.'Element/select_theme.php', 'HTML_QuickForm_Select_Theme'); $this->registerElementType('style_button', $dir.'Element/style_button.php', 'HTML_QuickForm_stylebutton'); $this->registerElementType('style_submit_button', $dir.'Element/style_submit_button.php', 'HTML_QuickForm_stylesubmitbutton'); $this->registerElementType('style_reset_button', $dir.'Element/style_reset_button.php', 'HTML_QuickForm_styleresetbutton'); $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'); $this->registerRule('multiple_required', 'required', 'HTML_QuickForm_Rule_MultipleRequired', $dir.'Rule/MultipleRequired.php'); // Modify the default templates $renderer = & $this->defaultRenderer(); //Form template $form_template = '

{content}

{hidden} '; $renderer->setFormTemplate($form_template); //Element template $element_template = '

* {label}

{element} {label_3}

{label_2}

{error}

'; $renderer->setElementTemplate($element_template); //Set Header template $renderer->setHeaderTemplate('{header}'); //Set required field template HTML_QuickForm::setRequiredNote('* '.get_lang('ThisFieldIsRequired').''); $required_note_template = <<

{requiredNote}

EOT; $renderer->setRequiredNoteTemplate($required_note_template); } /** * Adds 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 (optional) 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'); } } /** * Adds 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 (optional) Is the form-element required (default=true) * @param boolean $full_page (optional) When it is true, the editor loads completed html code for a full page. * @param array $editor_config (optional) Configuration settings for the online editor. */ function add_html_editor($name, $label, $required = true, $full_page = false, $config = null) { $this->addElement('html_editor', $name, $label, 'rows="15" cols="80"', $config); $this->applyFilter($name, 'trim'); $html_type = STUDENT_HTML; if (!empty($_SESSION['status'])) { $html_type = $_SESSION['status'] == COURSEMANAGER ? TEACHER_HTML : STUDENT_HTML; } if (is_array($config)) { if (isset($config['FullPage'])) { $full_page = is_bool($config['FullPage']) ? $config['FullPage'] : ($config['FullPage'] === 'true'); } else { $config['FullPage'] = $full_page; } } else { $config = array('FullPage' => (bool) $full_page); } 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); } /** * Adds 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->_elements[$this->_elementIndex[$name]]->setLocalOption('minYear', 1900); // TODO: Now - 9 years $this->addRule($name, get_lang('InvalidDate'), 'date'); } /** * Adds a datepickerdate 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_datepickerdate($name, $label) { $this->addElement('datepickerdate', $name, $label, array('form_name' => $this->getAttribute('name'))); $this->_elements[$this->_elementIndex[$name]]->setLocalOption('minYear', 1900); // TODO: Now - 9 years $this->addRule($name, get_lang('InvalidDate'), 'date'); } /** * Adds 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'); } /** * Adds a button to the form to add resources. */ function add_resource_button() { $group[] = $this->createElement('static', 'add_resource_img', null, ' '.get_lang('Attachment').'

'); $group[] = $this->createElement('submit', 'add_resource', get_lang('Attachment'), 'class="link_alike"'); $this->addGroup($group); } /** * Adds a progress bar to the form. * * Once the user submits the form, a progress bar (animated gif) is * displayed. The progress bar will disappear once the page has been * reloaded. * * @param int $delay (optional) The number of seconds between the moment the user * @param string $label (optional) Custom label to be shown * submits the form and the start of the progress bar. */ function add_progress_bar($delay = 2, $label = '') { if (empty($label)) { $label = get_lang('PleaseStandBy'); } $this->with_progress_bar = true; $this->updateAttributes("onsubmit=\"javascript: myUpload.start('dynamic_div','".api_get_path(WEB_IMG_PATH)."progress_bar.gif','".$label."','".$this->getAttribute('id')."')\""); $this->addElement('html', ''); $this->addElement('html', ''); } /** * Uses new functions (php 5.2) for displaying real upload progress. * @param string $upload_id The value of the field UPLOAD_IDENTIFIER, the second parameter (XXX) of the $form->addElement('file', XXX) sentence * @param string $element_after The first element of the form (to place at first UPLOAD_IDENTIFIER) * @param int $delay (optional) The frequency of the xajax call * @param bool $wait_after_upload (optional) */ function add_real_progress_bar($upload_id, $element_after, $delay = 2, $wait_after_upload = false) { if (!function_exists('uploadprogress_get_info')) { $this -> add_progress_bar($delay); return; } if (!class_exists('xajax')) { require_once api_get_path(LIBRARY_PATH).'xajax/xajax.inc.php'; } $xajax_upload = new xajax(api_get_path(WEB_LIBRARY_PATH).'upload.xajax.php'); $xajax_upload -> registerFunction('updateProgress'); // IMPORTANT : must be the first element of the form $el = $this->insertElementBefore(FormValidator::createElement('html', ''), $element_after); $this->addElement('html', '
'); // Add div-element where the progress bar is to be displayed $this->addElement('html',' '); if ($wait_after_upload) { $this->addElement('html',' '); } // Get the xajax code $this->addElement('html', $xajax_upload->getJavascript(api_get_path(WEB_LIBRARY_PATH).'xajax')); // Get the upload code $this->addElement('html', ''); $this->addElement('html', ''); if (!$wait_after_upload) { $wait_after_upload = 0; } // Add the upload event $this->updateAttributes("onsubmit=\"javascript: myUpload.startRealUpload('dynamic_div','".$upload_id."','".$this->getAttribute('id')."',".$wait_after_upload.")\""); } /** * This function has been created for avoiding changes directly within QuickForm class. * When we use it, the element is threated as 'required' to be dealt during validation. * @param array $element The array of elements * @param string $message The message displayed */ function add_multiple_required_rule($elements, $message) { $this->_required[] = $elements[0]; $this -> addRule ($elements , $message , 'multiple_required'); } /** * Displays 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() { echo $this->return_form(); } /** * Returns the HTML code of the form. * If an element in the form didn't validate, an error message is showed * asking the user to complete the form. * * @return string $return_value HTML code of the form * * @author Patrick Cool , Ghent University, august 2006 */ function return_form() { $error = false; foreach ($this->_elements as $element) { if (!is_null(parent::getElementError($element->getName()))) { $error = true; break; } } $return_value = ''; if ($error) { $return_value = Display::return_message(get_lang('FormHasErrorsPleaseComplete'),'warning'); } $return_value .= parent::toHtml(); // Add div-element which is to hold the progress bar if (isset($this->with_progress_bar) && $this->with_progress_bar) { $return_value .= '

'; } return $return_value; } } /** * Cleans HTML text * @param string $html HTML to clean * @param int $mode (optional) * @return string The cleaned HTML */ function html_filter($html, $mode = NO_HTML) { require_once api_get_path(LIBRARY_PATH).'formvalidator/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); }