| Current File : //opt/RZphp74/includes/DB/DataObject/FormBuilder/QuickForm/SubForm.php |
<?php
/**
* This is an HTML_QuickForm element for internal FormBuilder use only. It
* creates a select element for a foreign key / link which also has a hidden
* div with a form for a new linked record in it. All processing is done in
* the FormBuilder main class.
*
* PHP Versions 4 and 5
*
* @category DB
* @package DB_DataObject_FormBuilder
* @copyright 1997-2006 The PHP Group
* @license http://www.gnu.org/licenses/lgpl.txt LGPL 2.1
* @author Justin Patrin <papercrane@reversefold.com>
* @version $Id$
*/
require_once('HTML/QuickForm/static.php');
if ( substr(phpversion(),0,1) != 5) {
if (!function_exists('clone')) {
// emulate clone - as per php_compact, slow but really the correct behaviour..
eval('function clone($t) { $r = $t; if (method_exists($r,"__clone")) { $r->__clone(); } return $r; }');
}
}
/**
* A few caveats: this element *must* be either created by a call to addElement on your main form (with the
* construction parameters, not an element object) or you must call setParentForm on the element. If you
* don't, the rules on the subform won't work. Here's the two usages (assuming $form is the main form
* and $subForm is the sub-form):
*
* require_once('HTML/QuickForm/SubForm.php');
* $form->addElement('subForm', 'subFormElementName', 'Sub Form Label', $subForm);
* //NOTE: with this version $subForm is now a copy in the element so changing
* // $subForm now will not change the form within the element
*
* OR
*
* require_once('HTML/QuickForm/SubForm.php');
* $el =& HTML_QuickForm::createElement('subFormElementName', 'Sub Form Label', $subForm);
* $el->setParentForm($form);
* $form->addElement($el);
*
* This also uses a few hacks which access HTML_QuickForm internals which is a no-no, but it's the only
* way I could get unfreeze and setPersistentFreeze to work as HTML_QuickForm doesn't implement these
* functions (perhaps these should be added?). This also only works with the default QF renderer, but
* it shouldn't be too hard to fix it.
*
* This *should* also work for subforms within subforms. ;-)
*
* The following are quick instructions on how to get a dynamic subform
* working (i.e. a subform which is displayed / hidden by JS and
* conditionally validated).
*
* Add a hidden field which holds when the sub form is displayed.
* $form->addElement('hidden', 'subFormDisplayed');
*
* Use this CSS class:
* .hidden {
* overflow: hidden;
* visibility: hidden;
* display: none;
* }
*
* Apply that class to a div surrounding the SubForm (I use an altered
* elementTemplate for QF). You also need a link which calls the
* javascript below (I've added it to the template for simplicity).
* Also, only hide it if the sub form was not displayed (if the
* validation fails you need to redisplay the form).
*
* $renderer =& HTML_QuickForm::defaultRenderer();
* $renderer->setElementTemplate(str_replace('{element}',
* '<a href="javascript:void();" onclick="showSubFormElement()">Show Sub Form</a>
* <div class="'.($_REQUEST['subFormDisplayed'] ? '' : 'hidden')." id="idForElementDiv">{element}</div>',
* $renderer->_elementTemplate),
* 'subFormElement');
*
*
* Add the JavaScript with the function somewhere in your code.
*
* <script language="javascript" type="text/javascript">
* function newCorrectiveAction() {
* if(document.getElementById("idForElementDiv").className == "hidden") {
* document.getElementById("idForElementDiv").className = "";
* document.getElementById("subFormDisplayed").value = "1";
* } else {
* document.getElementById("idForElementDiv").className = "hidden";
* document.getElementById("subFormDisplayed").value = "0";
* }
* }
* </script>
*
* Now add the sub form element and also make sure to set up the
* conditional validation. (assuming $subForm is your completed sub
* form. Note that there may be reference problems here, it's best to
* have the sub form finished before creating the element).
*
* require_once('HTML/QuickForm/SubForm.php');
* function subFormDisplayed($values) {
* return $values['subFormDisplayed'] == 1;
* }
* $el =& HTML_QuickForm::createElement('subForm', 'subFormElement', '', $subForm);
* $el->setPreValidationCallback('subFormDisplayed');
*/
class HTML_QuickForm_SubForm extends HTML_QuickForm_static {
var $_subForm;
var $_parentForm;
var $_name;
var $_preValidationCallback;
function HTML_QuickForm_SubForm($name=null, $label=null, $form=null)
{
if ($form !== null) {
$this->setForm($form);
}
HTML_QuickForm_static::HTML_QuickForm_static($name, $label);
}
function setForm(&$form)
{
$this->_subForm =& $form;
$this->_checkForEnctype();
}
function accept(&$renderer, $required = null, $error = null)
{
$this->_renderer = clone($renderer);
$renderer->renderElement($this, $required, $error);
}
/**
* renders the element
*
* @return string the HTML for the element
*/
function toHtml()
{
if (!isset($this->_renderer) || !is_a($this->_renderer, 'HTML_QuickForm_Renderer_Default')) {
$this->_renderer = clone(HTML_QuickForm::defaultRenderer());
}
$this->_renderer->_html =
$this->_renderer->_hiddenHtml =
$this->_renderer->_groupTemplate =
$this->_renderer->_groupWrap = '';
$this->_renderer->_groupElements = array();
$this->_renderer->_inGroup = false;
$this->_renderer->setFormTemplate(preg_replace('!</?form[^>]*>!', '', $this->_renderer->_formTemplate));
$this->_subForm->accept($this->_renderer);
return $this->_renderer->toHtml();
}
function freeze()
{
parent::freeze();
$this->_subForm->freeze();
}
function unfreeze()
{
parent::unfreeze();
foreach (array_keys($this->_subForm->_elements) as $key) {
$this->_subForm->_elements[$key]->unfreeze();
}
}
function setPersistantFreeze($persistant = false)
{
parent::setPersistantFreeze($persistant);
foreach (array_keys($this->subForm->_elements) as $key) {
$this->_subForm->_elements[$key]->setPersistantFreeze($persistant);
}
}
function exportValue(&$submitValues, $assoc = false)
{
return $this->_subForm->exportValues();
}
function setParentForm(&$form)
{
$this->_parentForm =& $form;
$this->_parentForm->addFormRule(array(&$this, 'checkSubFormRules'));
$this->_ruleRegistered = true;
$this->_checkForEnctype();
}
/**
* If set, the pre validation callback will be called before the sub-form's validation is checked.
* This is meant to allow the developer to turn off sub-form validation for optional forms.
*/
function setPreValidationCallback($callback = null) {
$this->_preValidationCallback = $callback;
}
function checkSubFormRules($values)
{
if ((!isset($this->_preValidationCallback)
|| !is_callable($this->_preValidationCallback)
|| call_user_func($this->_preValidationCallback, $values))
&& !$this->_subForm->validate()) {
return array($this->getName() => 'Please fix the errors below');
} else {
return true;
}
}
/**
* Sets this element's name
*
* @param string name
*/
function setName($name)
{
$this->_name = $name;
}
/**
* Gets this element's name
*
* @return string name
*/
function getName()
{
return $this->_name;
}
/**
* Called by HTML_QuickForm whenever form event is made on this element
*
* @param string Name of event
* @param mixed event arguments
* @param object calling object
* @access public
* @return bool true
*/
function onQuickFormEvent($event, $arg, &$caller)
{
if (is_a($caller, 'html_quickform')) {
$this->setParentForm($caller);
}
switch ($event) {
case 'updateValue':
$this->_subForm->_submitValues = $caller->_submitValues;
$this->_subForm->setDefaults($caller->_defaultValues);
$this->_subForm->setConstants($caller->_constantValues);
break;
default:
parent::onQuickFormEvent($event, $arg, $caller);
break;
}
return true;
}
function _checkForEnctype() {
if ($this->_subForm && $this->_parentForm) {
if ($this->_subForm->getAttribute('enctype') == 'multipart/form-data') {
$this->_parentForm->updateAttributes(array('enctype' => 'multipart/form-data'));
$this->_parentForm->setMaxFileSize();
}
/*foreach (array_keys($this->_subForm->_elements) as $key) {
if (is_a($this->_subForm->_elements[$key], 'HTML_QuickForm_file')) {
$this->_parentForm->updateAttributes(array('enctype' => 'multipart/form-data'));
$this->_parentForm->setMaxFileSize();
}
}*/
}
}
}
if (class_exists('HTML_QuickForm')) {
HTML_QuickForm::registerElementType('subForm', __FILE__, 'HTML_QuickForm_SubForm');
}
?>