moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-06 09:26:35 +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

92
lib/form/advcheckbox.php
View file

@ -1,42 +1,59 @@
<?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/>.
/**
* Advanced checkbox type form element
*
* Contains HTML class for an advcheckbox type form element
*
* @package core_form
* @copyright 2007 Jamie Pratt <me@jamiep.org>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once('HTML/QuickForm/advcheckbox.php');
/**
* HTML class for a advcheckbox type element
* HTML class for an advcheckbox type element
*
* default behavior special for Moodle is to return '0' if not checked
* '1' for checked.
* Overloaded {@see HTML_QuickForm_advcheckbox} with default behavior modified for Moodle.
* This will return '0' if not checked and '1' if checked.
*
* * @author Jamie Pratt
* @access public
* @package core_form
* @category form
* @copyright 2007 Jamie Pratt <me@jamiep.org>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class MoodleQuickForm_advcheckbox extends HTML_QuickForm_advcheckbox{
/**
* html for help button, if empty then no help
*
* @var string
*/
/** @var string html for help button, if empty then no help will icon will be dispalyed. */
var $_helpbutton='';
/**
* Group to which this checkbox belongs (for select all/select none button)
* @var string $_group
*/
/** @var string Group to which this checkbox belongs (for select all/select none button) */
var $_group;
/**
* Class constructor
* constructor
*
* @param string $elementName (optional)Input field name attribute
* @param string $elementLabel (optional)Input field label
* @param string $text (optional)Text to put after the checkbox
* @param mixed $attributes (optional)Either a typical HTML attribute string
* or an associative array
* @param mixed $values (optional)Values to pass if checked or not checked
*
* @since 1.0
* @access public
* @return void
* @param string $elementName (optional) name of the checkbox
* @param string $elementLabel (optional) checkbox label
* @param string $text (optional) Text to put after the checkbox
* @param mixed $attributes (optional) Either a typical HTML attribute string
* or an associative array
* @param mixed $values (optional) Values to pass if checked or not checked
*/
function MoodleQuickForm_advcheckbox($elementName=null, $elementLabel=null, $text=null, $attributes=null, $values=null)
{
@ -65,29 +82,35 @@ class MoodleQuickForm_advcheckbox extends HTML_QuickForm_advcheckbox{
}
parent::HTML_QuickForm_advcheckbox($elementName, $elementLabel, $text, $attributes, $values);
} //end constructor
}
/**
* set html for help button
*
* @access public
* @param array $help array of arguments to make a help button
* @param string $function function name to call to get html
* @param array $helpbuttonargs array of arguments to make a help button
* @param string $function (optional)function name get help html
* @deprecated since Moodle 2.0. Please do not call this function any more.
* @todo MDL-31047 this api will be removed.
* @see MoodleQuickForm::setHelpButton()
*/
function setHelpButton($helpbuttonargs, $function='helpbutton'){
debugging('component setHelpButton() is not used any more, please use $mform->setHelpButton() instead');
}
/**
* get html for help button
*
* @access public
* @return string html for help button
* @return string html for help button
*/
function getHelpButton(){
return $this->_helpbutton;
}
/**
* Returns HTML for advchecbox form element.
*
* @return string
*/
function toHtml()
{
return '<span>' . parent::toHtml() . '</span>';
@ -96,7 +119,8 @@ class MoodleQuickForm_advcheckbox extends HTML_QuickForm_advcheckbox{
/**
* Returns the disabled field. Accessibility: the return "[ ]" from parent
* class is not acceptable for screenreader users, and we DO want a label.
* @return string
*
* @return string
*/
function getFrozenHtml()
{
@ -108,6 +132,6 @@ class MoodleQuickForm_advcheckbox extends HTML_QuickForm_advcheckbox{
$output .= '/>';
}
return $output;
} //end func getFrozenHtml
}
}