* @author Adam Daniel
* @author Bertrand Mansion
* @author Mark Wiesemann
* @copyright 2005-2006 The PHP Group
* @license http://www.php.net/license/3_01.txt PHP License 3.01
* @version CVS: $Id$
* @link http://pear.php.net/package/HTML_QuickForm_Renderer_Tableless
*/
require_once 'HTML/QuickForm/Renderer/Default.php';
/**
* A renderer for HTML_QuickForm that only uses XHTML and CSS but no
* table tags
*
* You need to specify a stylesheet like the one that you find in
* data/stylesheet.css to make this work.
*
* @category HTML
* @package HTML_QuickForm_Renderer_Tableless
* @author Alexey Borzov
* @author Adam Daniel
* @author Bertrand Mansion
* @author Mark Wiesemann
* @license http://www.php.net/license/3_01.txt PHP License 3.01
* @version Release: 0.3.4
* @link http://pear.php.net/package/HTML_QuickForm_Renderer_Tableless
*/
class HTML_QuickForm_Renderer_Tableless extends HTML_QuickForm_Renderer_Default
{
/**
* Header Template string
* @var string
* @access private
*/
var $_headerTemplate =
"\n\t\t";
/**
* Element template string
* @var string
* @access private
*/
var $_elementTemplate =
"\n\t\t
error\">{error} {element}
";
/**
* Form template string
* @var string
* @access private
*/
var $_formTemplate =
"\n\n\t
{hidden}
\n{content}\n";
/**
* Template used when opening a fieldset
* @var string
* @access private
*/
var $_openFieldsetTemplate = "\n\t";
/**
* Template used when opening a hidden fieldset
* (i.e. a fieldset that is opened when there is no header element)
* @var string
* @access private
*/
var $_openHiddenFieldsetTemplate = "\n\t";
/**
* Required Note template string
* @var string
* @access private
*/
var $_requiredNoteTemplate =
"\n\t\t
{requiredNote}
";
/**
* How many fieldsets are open
* @var integer
* @access private
*/
var $_fieldsetsOpen = 0;
/**
* Array of element names that indicate the end of a fieldset
* (a new one will be opened when a the next header element occurs)
* @var array
* @access private
*/
var $_stopFieldsetElements = array();
/**
* Constructor
*
* @access public
*/
public function __construct() {
parent::__construct();
} // end constructor
/**
* Old syntax of class constructor for backward compatibility.
*/
public function HTML_QuickForm_Renderer_Tableless() {
self::__construct();
}
/**
* Called when visiting a header element
*
* @param object An HTML_QuickForm_header element being visited
* @access public
* @return void
*/
function renderHeader(&$header)
{
$name = $header->getName();
$id = empty($name) ? '' : ' id="' . $name . '"';
if (is_null($header->_text)) {
$header_html = '';
}
elseif (!empty($name) && isset($this->_templates[$name])) {
$header_html = str_replace('{header}', $header->toHtml(), $this->_templates[$name]);
} else {
$header_html = str_replace('{header}', $header->toHtml(), $this->_headerTemplate);
}
if ($this->_fieldsetsOpen > 0) {
$this->_html .= $this->_closeFieldsetTemplate;
$this->_fieldsetsOpen--;
}
$openFieldsetTemplate = str_replace('{id}', $id, $this->_openFieldsetTemplate);
$this->_html .= $openFieldsetTemplate . $header_html;
$this->_fieldsetsOpen++;
} // end func renderHeader
/**
* Renders an element Html
* Called when visiting an element
*
* @param object An HTML_QuickForm_element object being visited
* @param bool Whether an element is required
* @param string An error message associated with an element
* @access public
* @return void
*/
function renderElement(&$element, $required, $error)
{
// if the element name indicates the end of a fieldset, close the fieldset
if ( in_array($element->getName(), $this->_stopFieldsetElements)
&& $this->_fieldsetsOpen > 0
) {
$this->_html .= $this->_closeFieldsetTemplate;
$this->_fieldsetsOpen--;
}
// if no fieldset was opened, we need to open a hidden one here to get
// XHTML validity
if ($this->_fieldsetsOpen === 0) {
$this->_html .= $this->_openHiddenFieldsetTemplate;
$this->_fieldsetsOpen++;
}
if (!$this->_inGroup) {
$html = $this->_prepareTemplate($element->getName(), $element->getLabel(), $required, $error);
// the following lines (until the "elseif") were changed / added
// compared to the default renderer
$element_html = $element->toHtml();
if (!is_null($element->getAttribute('id'))) {
$id = $element->getAttribute('id');
} else {
$id = $element->getName();
}
if (!empty($id) and !is_a($element, 'MoodleQuickForm_group') and !is_a($element, 'HTML_QuickForm_static')) { // moodle hack
$html = str_replace('(\s|\S)*([ \t\n\r]*)?/i", '', $html);
}
$this->_groupElements[] = str_replace('{element}', $element->toHtml(), $html);
} else {
$this->_groupElements[] = $element->toHtml();
}
} // end func renderElement
/**
* Called when visiting a form, before processing any form elements
*
* @param object An HTML_QuickForm object being visited
* @access public
* @return void
*/
function startForm(&$form)
{
$this->_fieldsetsOpen = 0;
parent::startForm($form);
} // end func startForm
/**
* Called when visiting a form, after processing all form elements
* Adds required note, form attributes, validation javascript and form content.
*
* @param object An HTML_QuickForm object being visited
* @access public
* @return void
*/
function finishForm(&$form)
{
// add a required note, if one is needed
if (!empty($form->_required) && !$form->_freezeAll) {
$requiredNote = $form->getRequiredNote();
// replace default required note by DOM/XHTML optimized note
if ($requiredNote == '* denotes required field') {
$requiredNote = '* denotes required field';
}
$this->_html .= str_replace('{requiredNote}', $requiredNote, $this->_requiredNoteTemplate);
}
// close the open fieldset
if ($this->_fieldsetsOpen > 0) {
$this->_html .= $this->_closeFieldsetTemplate;
$this->_fieldsetsOpen--;
}
// add form attributes and content
$html = str_replace('{attributes}', $form->getAttributes(true), $this->_formTemplate);
if (strpos($this->_formTemplate, '{hidden}')) {
$html = str_replace('{hidden}', $this->_hiddenHtml, $html);
} else {
$this->_html .= $this->_hiddenHtml;
}
$this->_hiddenHtml = '';
$this->_html = str_replace('{content}', $this->_html, $html);
$this->_html = str_replace('>', '> ', $this->_html);
// add a validation script
if ('' != ($script = $form->getValidationScript())) {
$this->_html = $script . "\n" . $this->_html;
}
} // end func finishForm
/**
* Sets the template used when opening a fieldset
*
* @param string The HTML used when opening a fieldset
* @access public
* @return void
*/
function setOpenFieldsetTemplate($html)
{
$this->_openFieldsetTemplate = $html;
} // end func setOpenFieldsetTemplate
/**
* Sets the template used when opening a hidden fieldset
* (i.e. a fieldset that is opened when there is no header element)
*
* @param string The HTML used when opening a hidden fieldset
* @access public
* @return void
*/
function setOpenHiddenFieldsetTemplate($html)
{
$this->_openHiddenFieldsetTemplate = $html;
} // end func setOpenHiddenFieldsetTemplate
/**
* Sets the template used when closing a fieldset
*
* @param string The HTML used when closing a fieldset
* @access public
* @return void
*/
function setCloseFieldsetTemplate($html)
{
$this->_closeFieldsetTemplate = $html;
} // end func setCloseFieldsetTemplate
/**
* Adds one or more element names that indicate the end of a fieldset
* (a new one will be opened when a the next header element occurs)
*
* @param mixed Element name(s) (as array or string)
* @access public
* @return void
*/
function addStopFieldsetElements($element)
{
if (is_array($element)) {
$this->_stopFieldsetElements = array_merge($this->_stopFieldsetElements,
$element);
} else {
$this->_stopFieldsetElements[] = $element;
}
} // end func addStopFieldsetElements
} // end class HTML_QuickForm_Renderer_Default
?>