File Source for ABSTHTMLFormItem.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();
}
/**
* Including the basic class for html-tags.
*/
require_once( CLASSPATH."html/ABSTHTMLTag.class.php" );
/**
* An abstract class as base for classes to create form items.
*
* @package forms
* @subpackage items
* @abstract
* @version 0.1.71
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (c) 2004 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 ABSTHTMLFormItem extends ABSTHTMLTag
{
/**
* The value of the "value"-attribute of this form item object.
*
* @var string $value
* @access public
*/
var $value = "";
/**
* @var boolean $enabled
* @access public
*/
var $enabled = true;
/**
* @var boolean $manipulateable
* @access public
*/
var $manipulateable = true;
/**
* A reference to a label object, which carries information for this input
* object.
*
* @var HTMLLabel $label_obj
* @access public
*/
var $label_obj = null;
/**
* A reference to the form that contains this input object.
*
* @var object $parentform
* @access private
*/
var $parentform = null;
/**
* Constructor
*
* @version 1.0
* @since 0.1.1
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function HTMLFormItem()
{
die(
"ABSTHTMLFormItem is an abstract class. "
."You cannot get an instance of it."
);
}
/**
* Stores the value of this item's "value"-attribute.
*
* @version 1.0
* @since 0.1.5
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param void
*/
function setValue( $string )
{ $this->value = $string; }
/**
* Concats the given string to the value of this item's "value"-attribute.
*
* @version 1.0
* @since 0.1.5
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param void
*/
function addValue( $string )
{ $this->value .= $string; }
/**
* Returns the value of this item's "value"-attribute.
*
* @version 1.0
* @since 0.1.5
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function getValue()
{ return $this->value; }
/**
* Disables this item.
*
* @version 1.0
* @since 0.1.2
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function setDisabled()
{ $this->enabled = false; }
/**
* Disables this item. This method is an alias for the method setDisabled().
*
* @version 1.0
* @since 0.1.4
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function disable()
{ $this->setDisabled(); }
/**
* Enables this item.
*
* @version 1.0
* @since 0.1.2
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function setEnabled()
{ $this->enabled = true; }
/**
* Enables this item. This method is an alias for the method setDisabled().
*
* @version 1.0
* @since 0.1.4
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function enable()
{ $this->setEnabled(); }
/**
* Makes sure that this item is not manipulateable by the user, but carrys
* the value trough the form.
*
* @version 1.0
* @since 0.1.41
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function setNotManipulateable()
{
$this->manipulateable = false;
$this->enabled = true;
}
/**
* Makes sure that this item is manipulateable by the user.
*
* @version 1.0
* @since 0.1.41
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return void
*/
function setManipulateable()
{
$this->manipulateable = true;
$this->enabled = true;
}
/**
* Stores a reference to the form-object that contains this item-object.
*
* @version 1.0
* @since 0.1.1
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param object
* @return void
*/
function setParentForm( &$formobj )
{ $this->parentform = $formobj; }
/**
* Stores the given label object to the extended underlying form component.
*
* @version 1.0
* @since 0.1.7
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param object
* @return void
*/
function setLabel( &$lab_obj )
{ $this->label_obj = $lab_obj; }
/**
* Blind method cause other objects will invoke it.
*
* @version 1.0
* @since 0.1.3
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function getCheckOrder()
{ return false; }
/**
* Blind method cause other objects will invoke it.
*
* @version 1.0
* @since 0.1.2
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function getValidationOrder()
{ return false; }
/**
* Returns the label to the extended extended underlying form component as
* string.
*
* @version 1.0
* @since 0.1.6
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function getLabel()
{
$out = "";
if (
!function_exists( "is_a" )
&& (
get_class( $this->label_obj ) == "htmllabel"
|| get_parent_class( $this->label_obj ) == "htmllabel"
)
)
$out = $this->label_obj->get();
else
if (
function_exists( "is_a" )
&& (
is_a( $this->label_obj, "HTMLLabel" )
|| is_subclass_of( $this->label_obj, "htmllabel" )
)
)
$out = $this->label_obj->get();
return $out;
}
} // End of class HTMLFormItem
?>

Source for file ABSTHTMLFormItem.class.php