Source for file advcheckbox.php
Documentation is available at advcheckbox.php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// +----------------------------------------------------------------------+
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.net/license/2_02.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.net so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Authors: Adam Daniel <adaniel1@eesus.jnj.com> |
// | Bertrand Mansion <bmansion@mamasam.com> |
// +----------------------------------------------------------------------+
// $Id: advcheckbox.php,v 1.16 2006/06/20 16:33:06 avb Exp $
require_once('HTML/QuickForm/checkbox.php');
* HTML class for an advanced checkbox type field
* Basically this fixes a problem that HTML has had
* where checkboxes can only pass a single value (the
* value of the checkbox when checked). A value for when
* the checkbox is not checked cannot be passed, and
* furthermore the checkbox variable doesn't even exist if
* the checkbox was submitted unchecked.
* It works by prepending a hidden field with the same name and
* another "unchecked" value to the checbox. If the checkbox is
* checked, PHP overwrites the value of the hidden field with
* @author Jason Rust <jrust@php.net>
* The values passed by the hidden elment
var $_currentValue = null;
* @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
$this->HTML_QuickForm_checkbox ($elementName, $elementLabel, $text, $attributes);
* Gets the private name for the element
* @param string $elementName The element name to make private
* @deprecated Deprecated since 3.2.6, both generated elements have the same name
return '__'. $elementName;
* Create the javascript for the onclick event which will
* set the value of the hidden field
* @param string $elementName The element name
* @deprecated Deprecated since 3.2.6, this element no longer uses any javascript
$onclickJs = 'if (this.checked) { this.form[\''. $elementName. '\'].value=\''. addcslashes($this->_values[1 ], '\''). '\'; }';
$onclickJs .= 'else { this.form[\''. $elementName. '\'].value=\''. addcslashes($this->_values[0 ], '\''). '\'; }';
* Sets the values used by the hidden element
* @param mixed $values The values, either a string or an array
// give it default checkbox behavior
$this->_values = array ('', 1 );
// if it's string, then assume the value to
// be passed is for when the element is checked
$this->_values = array ('', $values);
$this->_values = $values;
$this->updateAttributes (array ('value' => $this->_values[1 ]));
$this->setChecked ($this->_currentValue == $this->_values[1 ]);
* Sets the element's value
* @param mixed Element's value
$this->setChecked (isset ($this->_values[1 ]) && $value == $this->_values[1 ]);
$this->_currentValue = $value;
* Returns the element's value
return $this->_values[$this->getChecked ()? 1: 0 ];
* Returns the checkbox element in HTML
* and the additional hidden element in HTML
if ($this->_flagFrozen) {
return '<input' . $this->_getAttrString (array (
'name' => $this->getName (),
'value' => $this->_values[0 ]
)) . ' />' . parent ::toHtml ();
* Unlike checkbox, this has to append a hidden input in both
* checked and non-checked states
return ($this->getChecked ()? '<tt>[x]</tt>': '<tt>[ ]</tt>') .
$this->_getPersistantData ();
// {{{ onQuickFormEvent()
* Called by HTML_QuickForm whenever form event is made on this element
* @param string $event Name of event
* @param mixed $arg event arguments
* @param object $caller calling object
// constant values override both default and submitted ones
// default values are overriden by submitted
$value = $this->_findValue ($caller->_constantValues );
$value = $this->_findValue ($caller->_submitValues );
$value = $this->_findValue ($caller->_defaultValues );
parent ::onQuickFormEvent ($event, $arg, $caller);
} // end func onQuickFormLoad
* This element has a value even if it is not checked, thus we override
* checkbox's behaviour here
$value = $this->_findValue ($submitValues);
} elseif (is_array($this->_values) && ($value != $this->_values[0 ]) && ($value != $this->_values[1 ])) {
return $this->_prepareValue ($value, $assoc);
} //end class HTML_QuickForm_advcheckbox
Documentation generated on Mon, 11 Mar 2019 14:41:19 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|