moodle/lib/form/warning.php

93 lines
2.7 KiB
PHP

<?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/>.
/**
* static warning element
*
* Contains class for static warning type element
*
* @package core_form
* @copyright 2008 Jamie Pratt <me@jamiep.org>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("HTML/QuickForm/static.php");
/**
* static warning
*
* overrides {@link HTML_QuickForm_static} to display staic warning.
*
* @package core_form
* @category form
* @copyright 2008 Jamie Pratt <me@jamiep.org>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class MoodleQuickForm_warning extends HTML_QuickForm_static{
/** @var string Form element type */
var $_elementTemplateType='warning';
/** @var string html for help button, if empty then no help */
var $_helpbutton='';
/** @var string class assigned to field, default is notifyproblem */
var $_class='';
/**
* constructor
*
* @param string $elementName (optional) name of the field
* @param string $elementClass (optional) show as warning or notification => 'notifyproblem'
* @param string $text (optional) Text to put in warning field
*/
function MoodleQuickForm_warning($elementName=null, $elementClass='notifyproblem', $text=null) {
parent::HTML_QuickForm_static($elementName, null, $text);
$this->_type = 'warning';
if (is_null($elementClass)) {
$elementClass = 'notifyproblem';
}
$this->_class = $elementClass;
}
/**
* Returns HTML for this form element.
*
* @return string
*/
function toHtml() {
global $OUTPUT;
return $OUTPUT->notification($this->_text, $this->_class);
}
/**
* get html for help button
*
* @return string html for help button
*/
function getHelpButton(){
return $this->_helpbutton;
}
/**
* Gets the type of form element
*
* @return string
*/
function getElementTemplateType(){
return $this->_elementTemplateType;
}
}