File Source for DBMS_FIELD_CHECKBOX.phpclass

<?php
/**
* Class file DBMS_FIELD_CHECKBOX.phpclass
*
* @project Open CSP-Management
* @package dbms_field
* @category any
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @version pk-05-02-16
* @version $Id: DBMS_FIELD_CHECKBOX.phpclass,v 1.4 2008/08/08 02:00:42 pitlinz Exp $
*/
pcf_require_class('DBMS_FIELD',dirname(__FILE__) . "/");
/**
* Class DBMS_FIELD_CHECKBOX
*
* @project Open CSP-Management
* @package dbms_field
* @category any
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @version pk-04-05-27
* @version pk-05-11-13
*
* pk-04-05-27:
* ---------------------------------
* changed parent class from DBMS_FIELD_INT to DBMS_FIELD
*
***/
class DBMS_FIELD_CHECKBOX extends DBMS_FIELD
{
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
/**
* @constant string CLASS_SRC_FILE
*/
const CLASS_SRC_FILE = __FILE__;
// ---------------------------------------------------------------------------
// class (static)
// ---------------------------------------------------------------------------
/*** class vars ------------------------------------------------------ */
/*** class methods --------------------------------------------------- */
// ---------------------------------------------------------------------------
// object vars
// ---------------------------------------------------------------------------
/*** compostion --------------------------------------------------- */
/*** attributes -------------------------------------------------- */
/**
* source file of the class
* (without $GLOBALS['PROJECT']['PATH']
*
* @var string $classSrcFile
* @since pk-05-01-11
***/
protected $classSrcFile=__FILE__;
/**
* @var mixed $checkedValue
*/
protected $checkedValue = 1;
/**
* @var mixed $$uncheckedValue
*/
protected $uncheckedValue = 0;
/**
* @var string $checkText
*/
protected $checkText = "";
/**
* @var string $uncheckText
*/
protected $uncheckText = "";
/**
* list layout
*
* styles:
* 0 -> check/uncheckText
* 1 -> disabled checkbox
* 2 -> ok.gif / nothing
* 3 -> ok.gif / cancel.gif
* 4 -> cancel.gif / ok.gif
*
* @since pk-06-01-30
*
*/
protected $lstStyle = 0;
/**
* @var boolean $reloadFormOnChange
* @since pk-05-11-13
***/
protected $reloadFormOnChange = False;
// ###########################################################
// OBJECT SETTINGS METHODS
// ###########################################################
// ###########################################################
// FIELD DEFINITION DATA METHODS
// ###########################################################
/**
* returns an array of field to bie shown in the edit form
* by using editTbl_echoForm
*
* the array is in the form:
*
* <code>
* [_sectionName_]
* [TITLE] -> string
* [_rowName_]
* [FLDLAB] (complete html code with <td></td>)
* [FLDVAL] (complete html code with <td></td>)
* </code>
*
* @param boolean $debug
*
* @returns array
*
* @since pk-06-06-29
*
***/
function editTbl_getFieldEditArr($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_INT::editTbl_getFieldEditArr","",0);
$a_ret=parent::editTbl_getFieldEditArr($debug);
$a_ret['CHKBOX']=array(
'FLD_CHECKED_VAL' => array(
'FLDLAB' => 'Checked Value:',
'FLDVAL' => "<input name=\"CHECKEDVALUE\" type=\"input\" value=\"".$this->checkedValue."\" size=\"3\">"
),
'FLD_CHECKED_TXT' => array(
'FLDLAB' =>'checked Label:',
'FLDVAL' =>"<input name=\"CHECKTEXT\" type=\"input\" value=\"".$this->checkText."\" size=\"30\">"
),
'FLD_UNCHECKED_VAL' => array(
'FLDLAB' => 'Unchecked Value:',
'FLDVAL' => "<input name=\"uncheckedValue\" type=\"input\" value=\"".$this->uncheckedValue."\" size=\"3\">"
),
'FLD_UNCHECKED_TXT' => array(
'FLDLAB' =>'unchecked Label:',
'FLDVAL' =>"<input name=\"UNCHECKTEXT\" type=\"input\" value=\"".$this->uncheckText."\" size=\"30\">"
)
);
$a_ret['VALCHECKS']['RELOADONCHANGE']=array(
'FLDLAB' => "Formular neu Laden:",
'FLDVAL' => '<input name="RELOADONCHANGE" type="checkbox" value="1" '.($this->reloadFormOnChange ? 'checked' : '').'> ja FORMULAR an aktuelle URL schicken'
);
$a_ret['LIST']['CHKBOXLSTSTYLE']=array(
'FLDLAB' => "Listenstyle:",
'FLDVAL' =>"
<select name=\"lstStyle\" size=\"1\">
<option value=\"0\" ".($this->lstStyle == "0" ? "selected" : "").">Checked/Uncheckd Label</option>
<option value=\"1\" ".($this->lstStyle == "1" ? "selected" : "").">Checkbox (disabled)</option>
<option value=\"2\" ".($this->lstStyle == "2" ? "selected" : "").">OK Icon</option>
<option value=\"3\" ".($this->lstStyle == "3" ? "selected" : "").">OK/Cancel Icon</option>
<option value=\"4\" ".($this->lstStyle == "4" ? "selected" : "").">Cancel/OK Icon (Cancel=checked)</option>
</select>
"
);
return $a_ret;
}
/**
* show the filed definition form
*
* @param bool $showSize obsulet show size input
* @param boolean $showUnit obsulet
* @param bool $showNull obsulet show input field to handle null values
*
* @deprecated since pk-06-06-29
*
***/
function editTblForm($showSize=FALSE,$showUnit=FALSE,$showNull=FALSE) {
$a_FieldEditArr=$this->editTbl_getFieldEditArr($debug);
$this->editTbl_echoForm($a_FieldEditArr,$debug);
}
###############################
/**
* save the filed definition form
*
* @returns boolean
*
***/
function save() {
parent::save();
$this->checkedValue =$_POST['CHECKEDVALUE'];
$this->uncheckedValue =$_POST['uncheckedValue'];
$this->checkText =$_POST['CHECKTEXT'];
$this->uncheckText =$_POST['UNCHECKTEXT'];
$this->lstStyle =$_POST['lstStyle']; // <pk-06-01-30 />
$this->reloadFormOnChange=(intval($_POST['RELOADONCHANGE']) ? TRUE : FALSE );
return TRUE;
}
/**
* returns if the list cell can be linked with the ['EDIT'] link
*
* @returns boolean
*
* @since pk-06-01-30
***/
function lstLinksDisabled() {
return TRUE;
}
###############################
/**
* gets the htmlcode for the reload button (if $this->reloadFormOnChange)
* a html link which submits document.forms['".$this->getMyFormName()."'] to global $frmReloadURL if set
* otherwise the form is submitted to $_SERVER['REQUEST_URI']
*
* @param string $arrName
*
* @returns string
*
* @since pk-04-08-31
*
***/
function getReloadButton($arrName="DBVAL") {
global $frmReloadURL;
if (empty($frmReloadURL)) {
$frmReloadURL=$_SERVER['REQUEST_URI'];
}
if ($this->reloadFormOnChange) {
$ret ="<a href=\"javascript:{document.forms['".$this->getMyFormName()."'].action='".$frmReloadURL."';document.forms['".$this->getMyFormName()."'].submit();}\">";
$ret.="<img src=\"".$GLOBALS['PROJECT']['SYSIMGURL']."icons-22x22/reload.png\" border=\"0\" alt=\"refresh form\" width=\"18\" height=\"18\" class=\"button\">";
$ret.="</a>";
}
return $ret;
}
/**
* returns the html code for the checkbox
*
* @param mixed $aValue
* @param string $arrName
* @param string $nameAdd
* @param boolean $addChkTxt
*
* @returns string
*
* @version pk-05-12-28
*
***/
function getInputTag($aValue,$arrName="DBVAL",$nameAdd="",$addChkTxt=TRUE) {
global $frmReloadURL;
if (empty($frmReloadURL)) {
$frmReloadURL=$_SERVER['REQUEST_URI'];
}
$tag = "<input ";
$tag .= "name=\"".$arrName."[".$this->myName."]".$nameAdd."\" ";
$tag .= "type=\"checkbox\" value=\"".$this->checkedValue."\" ";
if ($aValue == $this->checkedValue) $tag.= "checked ";
if ($this->reloadFormOnChange) {
$tag.=" onChange=\"document.forms['".$this->getMyFormName()."'].action='".$frmReloadURL."';";
$tag.="document.forms['".$this->getMyFormName()."'].submit();\"";
}
$tag .= ">";
if ($addChkTxt) { // <pk-05-12-28>
$tag .= " ".$this->checkText;
} // </pk-05-12-28>
return $tag;
}
/**
* returns the html code for the field value input / show
* adds $this->myName to ${$this->myDataArrName}['_DBMS_FIELDS']
*
* @param int $mode
* @param mixed $aValue
* @param boolean $debug
* @param boolean $addChkTxt
*
* @returns string
*
* @since pk-05-12-28
* @version pk-06-01-30 FRM_MODE_LIST added
*
***/
function getFieldTag($mode,$aValue=NULL,$debug=FALSE,$addChkTxt=TRUE) {
if (empty($this->myDataArrName)) $this->myDataArrName="DBVAL";
global ${$this->myDataArrName};
$debug=($debug || $this->fldDebug);
if ($debug) echoDebug(__FILE__,"<p><b>DBMS_FIELD::getFieldTag($mode,".htmlspecialchars(substr($aValue,0,10)).",...)</b> (".get_class($this)."/".$this->myName.")",0);
$this->myCurrentMode=$mode;
$ret="";
switch($mode) {
case FRM_MODE_NEW:
if (empty($aValue) && (strval($aValue) !== "0")) $aValue=$this->getDefaultValue();
if ($this->enableNew) {
$ret .= $this->getInputTag($aValue,$this->myDataArrName,"",$addChkTxt);
$ret .= $this->getAddTag($this->myDataArrName);
if (isset(${$this->myDataArrName}['_DBMS_FIELDS'])) ${$this->myDataArrName}['_DBMS_FIELDS'].=$this->myName.",";
return $ret;
} else {
$ret.=$this->getFieldTag(FRM_MODE_READONLY,$aValue,$debug);
$ret.=$this->getFieldTag(FRM_MODE_HIDDEN,$aValue,$debug);
return $ret;
}
case FRM_MODE_COPY:
if (empty($aValue) && (strval($aValue) !== "0")) $aValue=$this->getDefaultValue();
if ($this->enableCopy) {
$ret .= $this->getInputTag($aValue,$this->myDataArrName,"",$addChkTxt);
$ret .= $this->getAddTag($this->myDataArrName);
if (isset(${$this->myDataArrName}['_DBMS_FIELDS'])) ${$this->myDataArrName}['_DBMS_FIELDS'].=$this->myName.",";
return $ret;
} else {
$ret.=$this->getFieldTag(FRM_MODE_READONLY,$aValue,$debug);
$ret.=$this->getFieldTag(FRM_MODE_HIDDEN,$aValue,$debug);
return $ret;
}
case FRM_MODE_EDIT:
if ($this->enableEdit) {
$ret .= $this->getInputTag($aValue,$this->myDataArrName,"",$addChkTxt);
$ret .= $this->getAddTag($this->myDataArrName);
if (isset(${$this->myDataArrName}['_DBMS_FIELDS'])) ${$this->myDataArrName}['_DBMS_FIELDS'].=$this->myName.",";
return $ret;
} else {
$ret.=$this->getFieldTag(FRM_MODE_READONLY,$aValue,$debug);
$ret.=$this->getFieldTag(FRM_MODE_HIDDEN,$aValue,$debug);
return $ret;
}
case FRM_MODE_LIST:
return $this->getListValue($aValue,$this->myDataArrName,$debug);
default:
return parent::getFieldTag($mode,$aValue,$debug);
}
}
// ################################################
// SEARCH FORM METHODS
// ################################################
/**
* only no options for this fieldtype
*
* @param string $arrName name of the post array
*
* @return string
*
* @since pk-05-02-16
*
**/
function getSearchCompTypes($arrName) {
return "";
}
/**
* returns the html code for a searchformular element
* 3 radiobox are shown checked, unchecked and ignore
* to avoid trubbles with 0 NULL and so an the
*
* radioboxes uses the values:
* - !CHECKED!
* - !UNCHECKED!
* - !IGNORE!
*
* @param mixed $aValue the value to set
* @param string $arrName
*
* @returns string
*
* @since pk-06-01-25
* @version pk-06-02-13
*
**/
function getSearchInputTag($aValue,$arrName="DBVAL") {
$s_name="name=\"".$arrName."[".$this->myName."][VALUE]\"";
$b_radio_checked=FALSE; // either checked or unchecked box is checked
//echo "<pre>".print_r($aValue,TRUE)."</pre>";
$s_ret="<input type=\"radio\" value=\"!CHECKED!\" $s_name";
if (($aValue==$this->checkedValue) || ($aValue=="!CHECKED!")) {
$s_ret.=" checked ";
$b_radio_checked=TRUE;
}
$s_ret.= "> ".(empty($this->checkText) ? "gesetzt" : $this->checkText)." ";
$s_ret.="<input type=\"radio\" value=\"!UNCHECKED!\" $s_name";
if (($aValue==$this->uncheckedValue) || ($aValue=="!UNCHECKED!")) {
$s_ret.=" checked ";
$b_radio_checked=TRUE;
}
$s_ret.= "> ".(empty($this->uncheckText) ? "nicht gesetzt" : $this->uncheckText)." ";
$s_ret.="<input type=\"radio\" value=\"!IGNORE!\" $s_name";
if (!$b_radio_checked) {
$s_ret.=" checked ";
}
$s_ret.= "> ignorieren";
return $s_ret;
}
/**
* checks the searchform post field array if [VALUE] != "!IGNORE!"
* if the field is not to ignore parent::searchWhere() is called
*
* @param array $aArr the posted array of the filed form the search form
* @param bool $debug
*
* @returns string
*
**/
function searchWhere($aArr,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_CHECKBOX::searchWhere()","",0);
$s_ret=($aArr['ANDOR'] == "OR" ? " OR " : " AND ");
switch($aArr['VALUE']) {
case "!IGNORE!":
return "";
case "!CHECKED!":
$ret.=$this->myTable.".".$this->myName;
$ret.=" = ".$this->slashedValue($this->checkedValue,$err,$arrName,$debug);
return $s_ret;
case "!CHECKED!":
$ret.=$this->myTable.".".$this->myName;
$ret.=" <> ".$this->slashedValue($this->checkedValue,$err,$arrName,$debug);
return $s_ret;
default:
return parent::searchWhere($aArr,$debug);
}
}
// ###########################################################
// OBJECT VALUE CHECK/RETURN METHODS
// ###########################################################
function getScreenValue($aValue,$arrName,$debug) {
return (($aValue == $this->checkedValue) ? ((!empty($this->checkText)) ? $this->checkText : "Ja") : ((!empty($this->uncheckText)) ? $this->uncheckText : "Nein"));
}
/**
* returns the field value if the referenzed row exists
*
* @param string $aValue the value
* @param array $err error array
* @param string $arrName name of the array to access fieldsarray gloabl ${$arrName}
* @param bool $debug
*
* @return string
*
* @since pk-03-12-13
* @version pk-04-06-02
*
**/
function getValue($aValue,&$err,$arrName="DBVAL",$debug=FALSE) {
if ($this->fldDebug) $debug=TRUE; /* <pk-04-06-02> */
if ($debug) echo "<hr><p><b>DBMS_FIELD_CHECKBOX::getValue($aValue,$err,$arrName,$debug)</b> (".get_class($this)." | ".$this->myName.")</p>";
return ($aValue == $this->checkedValue ? $this->checkedValue : $this->uncheckedValue);
//return parent::getValue($val,$err,$arrName,$debug);
}
/**
* add slashes to the value to add it to a sql command
*
* @param string $aValue the value
* @param array $err error array
* @param string $arrName name of the global array to access field gloabl ${$arrName}
* @param bool $debug
*
* @return string
*
* @version pk-03-12-13
* @version pk-06-07-28
*
**/
function slashedValue($aValue,&$err,$arrName="DBVAL",$debug=FALSE) {
if ($this->fldDebug) $debug=TRUE; /* <pk-04-06-02> */
if ($debug) echo "<hr><p><b>DBMS_FIELD_CHECKBOX::slashedValue($aValue,$err,$arrName,$debug)</b> (".get_class($this)."/".$this->myName.")</p>";
// $val=($aValue == $this->checkedValue ? $this->checkedValue : $this->uncheckedValue);
// <pk-06-07-28>
//return parent::slashedValue($aValue,$err,$arrName,$debug);
if ($aValue==$this->checkedValue) {
return parent::slashedValue($this->checkedValue,$err,$arrName,$debug);
} else {
return parent::slashedValue($this->uncheckedValue,$err,$arrName,$debug);
}
}
/**
* returns the html representation of the field in a list (table col)
*
* @param mixed $aValue (the value)
* @param string $arrName (name of the global array holding data values)
* @param boolean $debug
*
* @global array $OCSP_CONF
*
* @return mixed the html representation of the field
*
* @since pk-07-11-08
*
**/
function getListValue($aValue=NULL,$arrName="DBVAL",$debug=FALSE)
{
global $OCSP_CONF;
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_CHECKBOX::getListValue()");
switch(intval($this->lstStyle))
{
case 0: // labels
if ($aValue==$this->checkedValue) {
return $this->checkText;
} else {
return $this->uncheckText;
}
case 1: // input
return "<span style=\"text-align:center\"><input type=\"checkbox\" ".(($aValue == $this->checkedValue) ? "checked" : "")." disabled=\"disabled\"/></span>";
case 2: // checked
if ($aValue==$this->checkedValue) {
return "<img src=\"".$OCSP_CONF['SYSIMGURL']."icons-16x16/ok.gif\" title=\"".$this->checkedValue."\" border=\"0\" align=\"center\" alt=\"ok\" />";
} else {
return " ";
}
case 3: // ok | cancel
if ($aValue==$this->checkedValue) {
return "<img src=\"".$OCSP_CONF['SYSIMGURL']."icons-16x16/ok.gif\" title=\"".$this->checkedValue."\" border=\"0\" align=\"center\" alt=\"ok\" />";
} else {
return "<img src=\"".$OCSP_CONF['SYSIMGURL']."icons-16x16/cancel.gif\" title=\"".$this->uncheckedValue."\" border=\"0\" align=\"center\" alt=\"not ok\" />";
}
case 4: // cancel | ok
if ($aValue==$this->checkedValue) {
return "<img src=\"".$OCSP_CONF['SYSIMGURL']."icons-16x16/cancel.gif\" title=\"".$this->uncheckedValue."\" border=\"0\" align=\"center\" alt=\"not ok\" />";
} else {
return "<img src=\"".$OCSP_CONF['SYSIMGURL']."icons-16x16/ok.gif\" title=\"".$this->checkedValue."\" border=\"0\" align=\"center\" alt=\"ok\" />";
}
default:
return $aValue;
}
}
}
?>

Source for file DBMS_FIELD_CHECKBOX.phpclass