File Source for HTMLCheckBox.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package forms
* @subpackage items
*/
if ( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
exit();
}
/**
*
*/
require_once( CLASSPATH."forms/items/ABSTHTMLFormItem.class.php" );
/**
* Loading the javascript class for form features.
*/
include_once CLASSPATH."html/JavaScript.class.php";
/**
* Loading the javascript class for form features.
*/
include_once CLASSPATH."forms/HTMLLabel.class.php";
/**
* A class to generate checkboxes.
*
* @package forms
* @subpackage items
* @version 0.2.61
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (C) 2003 Daniel Plücken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class HTMLCheckBox extends ABSTHTMLFormItem
{
/**
* @var integer $value
* @access public
*/
var $value = 1;
/**
* @var boolean $checked
* @access public
*/
var $checked = false;
/**
* @var boolean $label_position_right
* @access public
*/
var $label_position_right = true;
/**
* Constructor
*
* @version 1.41
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $name
* @param string $checked
* @param string $label
* @return HTMLCheckBox
*/
function HTMLCheckBox(
$name,
$checked = false,
$label = ""
)
{
$this->name = $name;
$this->id = $name;
$this->checked = is_bool( $checked )
? $checked
: !empty( $checked )
? true
: false;
if ( !empty( $label ) )
{
$tmp_obj =& new HTMLLabel( $label );
$tmp_obj->addToFormItem( $this );
}
}
/**
* Returns if the checkbox is declared is checked.
*
* @version 1.1
* @since 0.1.2
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return boolean
*/
function getChecked()
{ return $this->checked; }
/**
* Returns an if-order of a javascript to check whether this item is NOT
* filled
*
* @version 1.1
* @since 0.1.5
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function getChangeOrder()
{ return $this->mouseup; }
/**
* Returns an if-order of a javascript to check whether this item is NOT
* filled
*
* @version 1.1
* @since 0.1.5
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function getCheckOrder()
{
$out = "document.".$this->parentform->name
.".".$this->name.".checked != true";
return $out;
}
/**
* Returns a javascript to check all checkboxes in a given form. You have to
* give the name of the form and the element which should not checked in the
* javascript function.
*
* @static
* @version 1.0
* @since 0.2.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function getJSCheckAllWithAncestor()
{
$out = Javascript::getIsAncestorOf();
$out .= " function checkAllWithAncestor( id_of_ancestor, exception )\r\n"
." {\r\n"
." el_arr = document.getElementsByTagName( 'input' );\r\n\r\n"
." for( i = 0; i < el_arr.length; i++ )\r\n"
." if( "
."el_arr[i].type == 'checkbox' "
."&& isAncestorOf( id_of_ancestor, el_arr[i] ) "
."&& el_arr[i] != exception "
.")\r\n"
." el_arr[i].checked = true;\r\n"
." }\r\n\r\n";
return $out;
}
/**
* Returns a javascript to uncheck all checkboxes in a given form. You have
* to give the name of the form and the element which should not checked in
* the javascript function.
*
* @static
* @version 1.0
* @since 0.2.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function getJSUncheckAllWithAncestor()
{
$out = Javascript::getIsAncestorOf();
$out .= " function uncheckAllWithAncestor( id_of_ancestor, exception )\r\n"
." {\r\n"
." el_arr = document.getElementsByTagName( 'input' );\r\n\r\n"
." for( i = 0; i < el_arr.length; i++ )\r\n"
." if( "
."el_arr[i].type == 'checkbox' "
."&& isAncestorOf( id_of_ancestor, el_arr[i] ) "
."&& el_arr[i] != exception "
.")\r\n"
." el_arr[i].checked = false;\r\n"
." }\r\n\r\n";
return $out;
}
/**
* Returns a javascript to check and uncheck all checkboxes in a given form
* by one checkbox.
*
* @static
* @version 1.1
* @since 0.1.9
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function getJSManageAllCheckboxesWithAnchestorByOne()
{
$out = HTMLCheckBox::getJSCheckAllWithAncestor();
$out .= HTMLCheckBox::getJSUncheckAllWithAncestor();
$out .= " function manageAllCheckboxesWithAnchestorByOne( "
."id_of_anchestor, which "
.")\r\n"
." {\r\n"
." if( !which.checked )\r\n"
." checkAllWithAncestor( id_of_anchestor, which );\r\n"
." else\r\n"
." uncheckAllWithAncestor( id_of_anchestor, which );\r\n"
." }\r\n\r\n";
return $out;
}
/**
* Returns a javascript to check all checkboxes in a given form. You have to
* give the name of the form and the element which should not checked in the
* javascript function.
*
* @static
* @version 1.0
* @since 0.1.9
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function getJSCheckAllInForm()
{
$out = " function checkAllInForm( formname, exception )\r\n"
." {\r\n"
." for( i = 0; i < eval( 'document.' + formname ).length; i++ )\r\n"
." if(\r\n"
." eval( 'document.' + formname ).elements[i].type == 'checkbox'\r\n"
." && eval( 'document.' + formname ).elements[i] != exception\r\n"
." )\r\n"
." eval( 'document.' + formname ).elements[i]"
.".checked = true;\r\n"
." }\r\n\r\n";
return $out;
}
/**
* Returns a javascript to check all checkboxes in a given form. You have to
* give the name of the form and the element which should not unchecked in
* the javascript function.
*
* @static
* @version 1.0
* @since 0.1.9
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function getJSUncheckAllInForm()
{
$out = " function uncheckAllInForm( formname, exception )\r\n"
." {\r\n"
." for( i = 0; i < eval( 'document.' + formname ).length; i++ )\r\n"
." if(\r\n"
." eval( 'document.' + formname ).elements[i].type == 'checkbox'\r\n"
." && eval( 'document.' + formname ).elements[i] != exception\r\n"
." )\r\n"
." eval( 'document.' + formname ).elements[i]"
.".checked = false;\r\n"
." }\r\n\r\n";
return $out;
}
/**
* Returns a javascript to check and uncheck all checkboxes in a given form
* by one checkbox.
*
* @static
* @version 1.1
* @since 0.1.9
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function getJSManageAllCheckboxesByOne()
{
$out = HTMLCheckBox::getJSCheckAllInForm();
$out .= HTMLCheckBox::getJSUncheckAllInForm();
$out .= " function manageAllCheckboxesByOne( which )\r\n"
." {\r\n"
." if( !which.checked )\r\n"
." checkAllInForm( which.form.name, which );\r\n"
." else\r\n"
." uncheckAllInForm( which.form.name, which );\r\n"
." }\r\n\r\n";
return $out;
}
/**
* Sets this checkbox checked.
*
* @version 1.22
* @since 0.1.5
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param boolean $boolean
* @return string
*/
function setChecked( $boolean = true )
{ $this->checked = !empty( $boolean ) ? true : false; }
/**
* Sets the label of this checkbox.
*
* @version 1.21
* @since 0.1.5
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param mixed $mixed
* @return string
*/
function setLabel( &$mixed )
{
if ( is_object( $mixed ) )
$mixed->addToFormItem( $this );
else
{
if ( is_object( $this->label_obj ) )
$this->label_obj->setBody( $mixed );
else
{
$tmp_obj =& new HTMLLabel( $mixed );
$tmp_obj->addToFormItem( $this );
}
}
}
/**
* Sets the position of the label to the right side.
*
* @version 1.0
* @since 0.2.6
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return void
*/
function setLabelPositionRight()
{ $this->label_position_right = true; }
/**
* Sets the position of the label to the left side.
*
* @version 1.0
* @since 0.2.6
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return void
*/
function setLabelPositionLeft()
{ $this->label_position_right = false; }
/**
* Sets the onChange-Attribute of the checkbox.
*
* @version 1.1
* @since 0.1.5
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $formname
* @return string
*/
function setChangeOrder( $string )
{ $this->mouseup = $string; }
/**
* Generates the sourcecode to build this object and returns it.
*
* @version 1.1
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function getPHPSource()
{
$outputstr = "unset( \x24checked );\n";
$outputstr .= "\x24checked = \x24_POST[\"".$this->getName()."\"]\n"
." .\x24_GET[\"".$this->getName()."\"];\n";
$outputstr .= "\x24input[] = new HTMLCheckBox(\n"
." \"".$this->getName()."\",\n"
." \x24checked,\n"
." \"".$this->getLabel()."\"\n"
." );\n\n";
if( $this->checked )
$outputstr .= "if(\n"
." !isset( \x24_POST[\"formsent\"] )\n"
." && !isset( \x24_GET[\"formsent\"] )\n"
." )\n"
." \x24input[count(\x24input)-1]->setChecked( true );\n\n";
return $outputstr;
}
/**
* Returns a generated string based on the attributes of this object.
*
* @version 1.52
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function get( $forminput = "" )
{
$this->idExists( $this->id, true );
$out = "";
if (
!$this->label_position_right
&& is_object( $this->label_obj )
)
$out = $this->label_obj->get();
$out .= "<!--\r\n"
."--><input type=\"checkbox\"\r\n"
." name=\"".$this->name."\"\r\n"
." id=\"".$this->id."\"\r\n"
." value=\"".$this->value."\"\r\n";
$out .= !empty( $this->style_class )
? " class=\"".$this->style_class."\"\r\n"
: "";
$out .= !empty( $this->freestyle )
? " style=\"".$this->freestyle."\"\r\n"
: "";
$out .= !empty( $this->blur )
? " onBlur=\"".$this->blur."\"\r\n"
: "";
$out .= !empty( $this->focus )
? " onFocus=\"".$this->focus."\"\r\n"
: "";
$out .= !empty( $this->click )
? " onClick=\"".$this->click."\"\r\n"
: "";
$out .= !empty( $this->mouseup )
? " onMouseup=\"".$this->mouseup."\"\r\n"
: "";
$out .= !empty( $this->mouseover )
? " onMouseover=\"".$this->mouseover."\"\r\n"
: "";
$out .= !empty( $this->mouseout )
? " onMouseout=\"".$this->mouseout."\"\r\n"
: "";
$out .= !empty( $this->mousemove )
? " onMousemove=\"".$this->mousemove."\"\r\n"
: "";
if (
$forminput == "POST"
|| $forminput == "GET"
|| $forminput == "REQUEST"
)
$out .= "<?php if ( \x24_".$forminput."['".$this->name."'] ) "
."echo ' checked'; ?>";
else
$out .= $this->checked
? " checked=\"checked\"\r\n"
: "";
$out .= (
$this->enabled
&& $this->manipulateable
)
? ""
: " disabled=\"disabled\"\r\n";
$out .= " />".(
$this->label_position_right
&& is_object( $this->label_obj )
? $this->label_obj->get()
: ""
);
return $out;
}
} // END of class HTMLCheckBox
?>

Source for file HTMLCheckBox.class.php