moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 02:16:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-30974 form: Checked and updated docblock for form library

Browse source
This commit is contained in:
Rajesh Taneja 2012-01-06 16:38:06 +08:00 • committed by Rajesh Taneja
parent 5fc420e2ed
commit 6c1fd30484
39 changed files with 2567 additions and 1156 deletions
Download patch file Download diff file Expand all files Collapse all files

60
lib/form/submit.php
View file

@ -1,28 +1,60 @@
<?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/>.
/**
* submit type form element
*
* Contains HTML class for a submit type element
*
* @package core_form
* @copyright 2006 Jamie Pratt <me@jamiep.org>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("HTML/QuickForm/submit.php");
/**
* submit type form element
*
* HTML class for a submit type element
*
* @author Adam Daniel <adaniel1@eesus.jnj.com>
* @author Bertrand Mansion <bmansion@mamasam.com>
* @version 1.0
* @since PHP4.04pl1
* @access public
* @package core_form
* @category form
* @copyright 2006 Jamie Pratt <me@jamiep.org>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class MoodleQuickForm_submit extends HTML_QuickForm_submit {
/**
* constructor
*
* @param string $elementName (optional) name of the field
* @param string $value (optional) field label
* @param string $attributes (optional) Either a typical HTML attribute string or an associative array
*/
function MoodleQuickForm_submit($elementName=null, $value=null, $attributes=null) {
parent::HTML_QuickForm_submit($elementName, $value, $attributes);
}
/**
* Called by HTML_QuickForm whenever form event is made on this element
*
* @param string $event Name of event
* @param mixed $arg event arguments
* @param object $caller calling object
* @since 1.0
* @access public
* @return void
* @param string $event Name of event
* @param mixed $arg event arguments
* @param object $caller calling object
*/
function onQuickFormEvent($event, $arg, &$caller)
{
@ -43,7 +75,8 @@ class MoodleQuickForm_submit extends HTML_QuickForm_submit {
}
return parent::onQuickFormEvent($event, $arg, $caller);
} // end func onQuickFormEvent
}
/**
* Slightly different container template when frozen. Don't want to display a submit
* button if the form is frozen.
@ -58,6 +91,9 @@ class MoodleQuickForm_submit extends HTML_QuickForm_submit {
}
}
/**
* Freeze the element so that only its value is returned
*/
function freeze(){
$this->_flagFrozen = true;
}