File Source for HTML.php

<?php
/**
* Formagic
*
* LICENCE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at
* http://formagic.weasle.de/licence.txt
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to licence@weasle.de so we can send you a copy immediately.
*
* @category Formagic
* @package Renderer
* @author Florian Sonnenburg
* @copyright Copyright (c) 2007 Florian Sonnenburg
* @license http://formagic.weasle.de/licence.txt New BSD License
* @revision $Revision: 14 $
*/
/**
* Formagic Renderer HTML
*
* @category Formagic
* @package Renderer
* @author Florian Sonnenburg
* @copyright Copyright (c) 2007
* @version $Id: HTML.php 14 2007-08-13 20:33:26Z meweasle $
***/
class Formagic_Renderer_HTML extends Formagic_Renderer {
/**
* Form action, value of <form action=""> tag
* @var string
***/
private $_action;
/**
* Overwrites default templates for item types or individual items
* @var array
***/
private $_templates = array();
/**
* Hidden inputs string
* @var string
***/
private $_hiddenString = "";
/**
* Error/notice/debug colors
* @var array
***/
public $messageColors = array(
Formagic::ERROR => '#F41414',
Formagic::NOTICE => '#DCB913',
Formagic::DEBUG => '#E2D726');
/**
* HTML string for mandatory fields
* @var
***/
public $mandatoryMarker = "<span class=\"mandatory\">*</span>";
/**
* Constructor
*
*/
public function __construct()
{
// $this->_action = $_SERVER['PHP_SELF'];
// set root template
$this->setRootTemplate('
<!-- formagic HTML renderer start
============================= -->
%MESSAGE%
<form name="%NAME%" action="%ACTION%" id="%NAME%" method="%METHOD%">
%HIDDENS%
%CONTENT%
</form>
<!-- formagic HTML renderer end
=========================== -->
',
'main');
// set container main template
$this->setTemplate('<table border="0" cellpadding="4" cellspacing="0"%ATTRIBUTES%>
%ROWS%
</table>',
'main', null, 'container');
// normal items template
$this->setTemplate('
<tr>
<td>%LABEL%</td>
<td>%ERROR%
%INPUT%</td>
</tr>
',
'item', null, 'container');
// wide template
$this->setTemplate('
<tr>
<td colspan="2">%ERROR%
%INPUT%</td>
</tr>
',
'itemWide', null, 'container');
// label template
$this->setTemplate('<b><label for="%ID%"%ERRORCLASS%>%LABEL%%ERRORMARKER%</label></b>',
'label', null, 'container');
// error template
$this->setTemplate('<span style="color:#ff0000">%ERRORMSG%</span><br />',
'error', null, 'container');
}
/**
* Formagic_Renderer_HTML::setCustomTemplate()
*
* @param string $template
* @param string $item
* @param string $itemType
* @return void
*/
public function setTemplate($template, $part='main', $item=null, $itemType=null)
{
if ($item) {
$this->_templates['__fm'][$item][$part] = $template;
return ;
}
if ($itemType) {
$this->_templates[$itemType][$part] = $template;
}
}
public function setRootTemplate($template)
{
$this->_templates['root'] = $template;
}
/**
* Returns surrounding template
*
* @return string
*/
public function _getRootTemplate()
{
return $this->_templates['root'];
}
/**
* Returns template string
*
* @param string $item
* @param string $itemType
* @return string
*/
private function _getTemplate($part='main', $item=null, $itemType=null)
{
if ($item && isset($this->_templates['__fm'][$item][$part])) {
return $this->_templates['__fm'][$item][$part];
}
if ($itemType) {
// don't check class hierarchy if not necessary
if (isset($this->_templates[$itemType][$part])) {
return $this->_templates[$itemType][$part];
}
$parents = @class_parents('Formagic_Item_' . ucfirst($itemType));
if (!$parents) {
throw new Formagic_Exception('Invalid item type: ' . $itemType);
}
foreach($parents as $parent) {
$itemTypeParent = strToLower(str_replace('Formagic_Item_', '', $parent));
if (isset($this->_templates[$itemTypeParent][$part])) {
$this->_templates[$itemType] =& $this->_templates[$itemTypeParent];
return $this->_templates[$itemType][$part];
}
}
}
return '';
}
/**
* Returns form HTML string
*
* @param Formagic $fObj
* @return string
*/
public function fetch(&$fObj)
{
$content = $this->_renderSubItemsRecursive($fObj->getItemHolder());
$rootTpl = $this->_getRootTemplate();
$messages = $fObj->getMessages();
$msgStr = '';
if (count($messages)) {
$msgStr = '<ul>';
foreach($messages as $level => $texts) {
foreach($texts as $msg) {
$msgStr .= '<li style="color:' . $this->messageColors[$level] . '">';
$msgStr .= $msg . '</li>';
}
}
$msgStr .= '</ul>';
}
$str = str_replace(array('%MESSAGE%', '%NAME%', '%ACTION%', '%METHOD%', '%HIDDENS%', '%CONTENT%'),
array($msgStr, $fObj->name, $fObj->getFormAction(), $fObj->method, $this->_hiddenString, $content),
$rootTpl);
return $str;
}
/**
* Adds hidden fields to form HTML string
*
* @param string $name
* @param string $value
* @return boolean
*/
private function _saveHiddenItem($name, $value)
{
$this->_hiddenString .= "<input type=\"hidden\" name=\"$name\" value=\"$value\" />\n";
return true;
}
/**
* Recursively iterate through item objects
*
* @param object $item
* @return string
*/
private function _renderSubItemsRecursive($container, $start = false)
{
$rows = "";
$items = $container->getItems();
$containerTpl = $this->_getTemplate('main', $container->name, $container->type);
$errorTpl = $this->_getTemplate('error', $container->name, $container->type);
$labelTpl = $this->_getTemplate('label', $container->name, $container->type);
$itemTpl = $this->_getTemplate('item', $container->name, $container->type);
$itemWideTpl = $this->_getTemplate('itemWide', $container->name, $container->type);
foreach($items as &$item) {
/**
* skip disabled inputs
**/
if ($item->isDisabled()) {
continue;
}
/**
* Run through containers recursively
**/
if ($item instanceOf Formagic_Item_Container) {
// render fake input string from container items
$rows .= $this->_renderSubItemsRecursive($item);
continue;
}
/**
* Catch hiddens and continue to next input
**/
if ($item->isHidden()) {
$this->_saveHiddenItem($item->name, $item->getValue());
continue;
}
/**
* Render "real" items
**/
$part = $item->isWide
// template spans both label and input column
? 'itemWide'
// separate label and input columns
: 'item';
$varName = $part.'Tpl';
$rowTpl =& $$varName;
/**
* Error message
**/
$msg = $item->getErrorMessage();
$error = $msg
// render error message
? preg_replace('/%ERRORMSG%/', $msg, $errorTpl)
// or discard it if no error message present
: '';
/**
* Label
**/
$itemLabel = $item->getLabel();
// render label
if ($itemLabel) {
$errorMarker = '';
$errorClass = '';
if ($item->hasRule('mandatory')) {
$errorMarker = $this->mandatoryMarker;
}
if ($msg) {
$errorClass = ' class="inputError"';
}
$label = str_replace(
array('%LABEL%', '%ERRORCLASS%', '%ID%', '%ERRORMARKER%'),
array($itemLabel, $errorClass, $item->id, $errorMarker),
$labelTpl);
// display nothing if no label present
} else {
$label = ' ';
}
/**
* render input HTML string
**/
$rows .= str_replace(
array('%LABEL%', '%ERROR%', '%INPUT%'),
array($label, $error, $item->getHtml()),
$rowTpl);
}
$res = $container->hasHtml
? str_replace(
array('%ROWS%', '%ATTRIBUTES%'),
array($rows, $container->getAttributeStr()), $containerTpl)
: $rows;
return $res;
}
/**
* Reformats $string so that it can be used as HTML ID
*
* @param string $string
* @return string
*/
private function _htmlId($string)
{
return str_replace(array('[',']'), array('_',''), $string);
}
}

Source for file HTML.php