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

68
lib/form/htmleditor.php
View file

@ -1,17 +1,62 @@
<?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/>.
/**
* htmleditor type form element
*
* Contains HTML class for htmleditor 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
*/
global $CFG;
require_once("$CFG->libdir/form/textarea.php");
/**
* htmleditor type form element
*
* HTML class for htmleditor type element
*
* @author Jamie Pratt
* @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_htmleditor extends MoodleQuickForm_textarea{
/** @var string defines the type of editor */
var $_type;
/** @var bool Does the user want and can edit using rich text html editor */
var $_canUseHtmlEditor;
/** @var array default options for html editor, which can be overridden */
var $_options=array('canUseHtmlEditor'=>'detect','rows'=>10, 'cols'=>45, 'width'=>0,'height'=>0);
/**
* Constructor
*
* @param string $elementName (optional) name of the html editor
* @param string $elementLabel (optional) editor label
* @param array $options set of options to create html editor
* @param array $attributes (optional) Either a typical HTML attribute string
* or an associative array
*/
function MoodleQuickForm_htmleditor($elementName=null, $elementLabel=null, $options=array(), $attributes=null){
parent::MoodleQuickForm_textarea($elementName, $elementLabel, $attributes);
// set the options, do not bother setting bogus ones
@ -39,17 +84,25 @@ class MoodleQuickForm_htmleditor extends MoodleQuickForm_textarea{
editors_head_setup();
}
/**
* set html for help button
*
* @access public
* @param array $help array of arguments to make a help button
* @param array $helpbuttonargs array of arguments to make a help button
* @param string $function function name to call to get 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');
}
/**
* Returns the input field in HTML
*
* @return string
*/
function toHtml(){
//if ($this->_canUseHtmlEditor && !$this->_flagFrozen){
// $script = '';
@ -71,17 +124,16 @@ class MoodleQuickForm_htmleditor extends MoodleQuickForm_textarea{
true,
$this->getAttribute('id'));
}
} //end func toHtml
}
/**
* What to display when element is frozen.
*
* @access public
* @return string
* @return string
*/
function getFrozenHtml()
{
$html = format_text($this->getValue());
return $html . $this->_getPersistantData();
} //end func getFrozenHtml
}
}