File Source for OCSP_FRMVIEW

<?php
/**
* Class file OCSP_FRMVIEW_FORM.phpclass
*
* @project Open CSP-Management
* @package forms
* @category dbms_form
*
* @author Peter Krebs (pk) <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-06-30
* @version $Id: OCSP_FRMVIEW_FORM.phpclass,v 1.28 2008/12/04 16:02:28 peterkrebs Exp $
*
*/
require_once dirname(__FILE__)."/OCSP_FRMVIEW.phpclass";
/**
* class OCSP_FRMVIEW_FORM
*
* @project Open CSP-Management
* @package forms
* @category dbms_form
*
* @author Peter Krebs (pk) <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-06-30
* @version $Id: OCSP_FRMVIEW_FORM.phpclass,v 1.28 2008/12/04 16:02:28 peterkrebs Exp $
*/
class OCSP_FRMVIEW_FORM extends OCSP_FRMVIEW
{
/*** Aggregations: */
/*** Compositions: */
/**
* @var OCSP_FRMCONTR_FORM $myControl
* @access protected
*/
protected $myControl;
/*** Attributes: */
/**
* button images
* @var array $buttonImages
* @access protected
*/
protected $buttonImages = array();
/**
* hide form button pannel
* @var boolean $hideFrmBtnPannel
* @access protected
*/
protected $hideFrmBtnPannel=FALSE;
/**
* @var string $outerDivStyle
* @access protected
*/
protected $outerDivStyle="display:inline;margin:0px;padding:0px;border:0px;";
/*** Association */
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// init methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// getter/setter methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* @return int
*/
function getMode()
{
return intval($this->myForm->getFrmMode());
}
/**
* @param int $aMode
*/
function setMode($aMode)
{
$this->myForm->setFrmMode($aMode);
}
/**
* @param boolean $debug
* @return array
*/
function getFields($debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW_FORM::getFields()");
return $this->getFieldsMode($this->getMyForm()->getFrmMode(),$debug);
}
/**
* sets $this->hideFrmBtnPannel to TRUE
*/
function set_ButtonPannelHidden()
{
$this->hideFrmBtnPannel=TRUE;
}
/**
* sets $this->hideFrmBtnPannel to FALSE
*/
function set_ButtonPannelShown()
{
$this->hideFrmBtnPannel=FALSE;
}
/**
* @return boolean
*/
function buttonPannelIsHidden()
{
return $this->hideFrmBtnPannel;
}
/**
* @param string $btnImgUrl
*/
function setButtonImg($cmd,$btnImgUrl)
{
$this->buttonImages[$cmd]=$btnImgUrl;
}
/**
* returns the first enabled field
*
* @return DBMS_FIELD
*
* @since pk-08-12-04
*/
public function &getFirstEnabledField()
{
if ($arr_fields = $this->getFields())
{
foreach($arr_fields as &$obj_field)
{
if ($obj_field->isToShow($this->getMyForm()->getFrmMode(),$this->getMyForm()->getControl()->getCurrentRow()))
{
if ($obj_field->isEnabled($this->getMyForm()->getFrmMode()))
{
return $obj_field;
}
}
}
}
$obj_ret = Null;
return $obj_ret;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// output
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// ----------- buttons -------------------------
/**
* @param boolean $debug
* @return string
*/
function getButtonPannel($debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW_FORM::getButtonPannel()");
$str_ret="";
if ($this->myControl->hasCmdButtons($debug))
{
$str_ret.="<div class=\"frmButtonPanel\">";
$str_ret.=$this->myControl->getFormCmdButtons($debug);
$str_ret.="</div>";
}
return $str_ret;
}
/**
* returns the image tag for a button
*
* @param string $cmd
* @param boolean $debug
*
* @global array $OCSP_CONF
*
* @return string
* @access public
*/
function getButton($cmd,$debug=FALSE)
{
global $OCSP_CONF;
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW_FORM::getButton()");
if (isset($this->buttonImages[$cmd]))
{
return "<img src=\"".$this->buttonImages[$cmd]."\" border=\"0\" alt=\"$cmd\" class=\"button\" />";
}
// some default settings
switch($cmd)
{
case "BACK":
return "<img src=\"" . OCSP_CONF::getInstance()->getValue('SYSIMGURL') . "icons-22x22/back.png\" border=\"0\" alt=\"back\" title=\"".$this->myForm->getLangTxt('BACK')."\" class=\"button\">";
case "SAVE":
switch($this->myForm->getFrmMode())
{
case FRM_MODE_NEW:
case FRM_MODE_COPY:
return "<img src=\"" . OCSP_OBJ::getConf('SYSIMGURL') . "icons-22x22/filesaveas.png\" border=\"0\" alt=\"save\" title=\"".$this->myForm->getLangTxt('SUBMIT')."\" class=\"button\" />";
case FRM_MODE_DELETE:
return "<img src=\"" . OCSP_OBJ::getConf('SYSIMGURL') . "icons-22x22/remove.png\" border=\"0\" alt=\"remove\" title=\"".$this->myForm->getLangTxt('DELETE')."\" class=\"button\" />";
default:
return "<img src=\"" . OCSP_OBJ::getConf('SYSIMGURL') . "icons-22x22/filesave.png\" border=\"0\" alt=\"save\" title=\"".$this->myForm->getLangTxt('SUBMIT')."\" class=\"button\" />";
}
case "EDIT":
return "<img src=\"" . OCSP_OBJ::getConf('SYSIMGURL') . "icons-22x22/edit.png\" border=\"0\" alt=\"edit\" title=\"".$this->myForm->getLangTxt('EDIT')."\" class=\"button\" />";
case "DELETE":
return "<img src=\"" . OCSP_OBJ::getConf('SYSIMGURL') . "icons-22x22/emptytrash.png\" border=\"0\" alt=\"save\" title=\"".$this->myForm->getLangTxt('DELETE')."\" class=\"button\" />";
case "RESET":
return "<img src=\"" . OCSP_OBJ::getConf('SYSIMGURL') . "icons-22x22/undo.png\" border=\"0\" alt=\"reset\" title=\"".$this->myForm->getLangTxt('RESET')."\" class=\"button\" />";
case "RELOAD":
return "<img src=\"" . OCSP_OBJ::getConf('SYSIMGURL') . "icons-16x16/reload.gif\" border=\"0\" alt=\"reload\" title=\"".$this->myForm->getLangTxt('RELOAD')."\" class=\"button\" />";
default:
return $cmd;
}
}
/**
* returns the outer-div tag vor buttons
* @param boolean $debug
*/
function getButtonOuterDiv($debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW_FORM::getButtonOuterDiv()");
return "<div style=\"display: inline;\" class=\"frmPanelButton\">";
}
/**
* @param OCSP_FORM_BLOCK $aBlock
* @param int $aMode
* @param boolean $debug
*
* @global array $OCSP_CONF
*
* @return string (html)
*
*/
function getTableBlock_Fields(&$aBlock,$debug=FALSE)
{
global $OCSP_CONF;
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW_FORM::getTableBlock_Fields(\$aBlock[id:".$aBlock->getId()."])");
$str_ret="";
$arr_fields=$aBlock->getFields($this->getMyForm()->getFrmMode(),$debug);
if (!pcf_is_instance_of($this->myControl,'OCSP_FRMCONTR'))
{
$this->myControl = $this->getMyForm()->getControl();
}
if (is_array($arr_fields) && sizeof($arr_fields))
{
foreach($arr_fields as $int_ordNr => &$obj_field)
{
$obj_field->setMyForm($this->myForm);
$obj_field->setControll($this->myControl);
if ($obj_field->isToShow($this->myForm->getFrmMode(),$this->myControl->getCurrentRow()))
{
if (pcf_is_instance_of($obj_field,'DBMS_FIELD_LAYOUT') && $obj_field->isLayoutFld()) // <pk-08-03-07 /> isLayoutFld() added
{
$str_ret.="\n<tr >";
$str_ret.=$obj_field->getFieldRowCols($this->myForm->getFrmMode(),$this->myControl->getCurrentRow(),$debug);
$str_ret.="</tr>";
} else {
$str_ret.="\n<tr id=\"tr_".$obj_field->getDOMId()."\" >";
if (!$obj_field->labelIsHidden())
{
$str_ret.="<td id=\"fldName_".$obj_field->getDOMId()."\" class=\"fldName\" ".$this->myControl->getFieldEvents('fldName').">";
if ($this->myForm->getFrmMode() != FRM_MODE_READONLY)
{
$str_tip=$obj_field->getToolTip();
if (!empty($str_tip))
{
$str_ret.="<div style=\"float:right\" title=\"".$str_tip."\"><img src=\"".$OCSP_CONF['SYSIMGURL']."icons-16x16/tip.gif\" border=\"0\"></div>";
}
}
//$str_ret.=$this->myControl->getFieldLabelDiv($obj_field);
$str_ret.=$obj_field->getLabel();
if ($debug) $str_ret.=" ".$obj_field->getTable();
$str_ret.="</td>";
$int_colspan=1;
} else {
$int_colspan=2;
}
switch($this->myForm->getFrmMode())
{
case FRM_MODE_READONLY:
$str_class="fldValueRO";
break;
default:
$str_class="fldValue";
}
$str_ret.="<td id=\"fldValue_".$obj_field->getDOMId()."\" class=\"$str_class\" colspan=\"$int_colspan\" ".$this->myControl->getFieldEvents('fldValue').">";
$str_ret.=$this->myControl->getFieldTag($obj_field,$debug);
$str_ret.="<div id=\"error_".$obj_field->getDOMId()."\" class=\"fldErrorMsg\" ".($obj_field->hasErrors() ? "" : "style=\"display:none\"").">".$obj_field->getErrorMsg()."</div>";
$str_ret.="</td>";
$str_ret.="</tr>";
}
} else {
if ($debug) $str_ret.="<tr><td colspan=\"2\">Hidden Field: ".$obj_field->getKey()." (".basename(__FILE__)." Line: ".__LINE__.")</td></tr>";
}
}
}
return $str_ret;
}
/**
* @param OCSP_FORM_BLOCK $aBlock
* @param int $aMode
* @param boolean $debug
*
* @global array $OCSP_CONF
*
* @return string (html)
*
* @todo OCSP_FRMVIEW_FORM::getFieldSetBlock_Fields() still uses table format
*/
function getFieldSetBlock_Fields(&$aBlock,$debug=FALSE)
{
global $OCSP_CONF;
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW_FORM::getTableBlock_Fields(\$aBlock[id:".$aBlock->getId()."])");
return $this->getTableBlock_Fields($aBlock,$debug);
}
/**
* returns the html code for the form
*
* @param int $aMode
* @param boolean $debug
* @param boolean $withOuterDiv
* @param boolean $withjOCSPInit
*
* @return string (html)
*
* @todo OCSP_FRMVIEW_FORM::getForm -> block view tab
*
* @version pk-08-01-29 id added
* @version pk-08-01-31 jOCSP_getFormInitCmd() added
* @version pk-08-11-02 $withjOCSPInit
*/
function getForm($aMode=-1,$debug=False,$withOuterDiv=True,$withjOCSPInit=True)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW_FORM::getForm()");
// ----------------------------
// check settings
// ----------------------------
if ($aMode > -1)
$this->myForm->setFrmMode($aMode);
if (!pcf_is_instance_of($this->myControl,'OCSP_FRMCONTR'))
$this->myControl=$this->myForm->getControllObj('OCSP_FRMCONTR_FORM',$debug);
// ----------------------------
// form start
// ----------------------------
$str_ret = "";
if ($withjOCSPInit && $str_js = $this->myControl->jOCSP_getFormInitCmd())
{
if ($obj_ajax = $this->myForm->ajax_getObj(FALSE))
{
$obj_ajax->addJsCode($str_js);
} else {
$str_ret .= "<script type=\"text/javascript\" language=\"javascript\">\n" . $str_js . "\n</script>";
}
}
if ($withOuterDiv) $str_ret.="<div id=\"frmOuter_". $this->myControl->getFormHTMLId() . "\" style=\"".$this->outerDivStyle."\">\n";
if ($debug) $str_ret .= "<p>Form: " . $this->myControl->getFormHTMLId() . " (" . basename(__FILE__) . " L: " . __LINE__ .")</p>";
$str_ret .= "<form name=\"" . $this->myControl->getFormHTMLId() . "\"";
$str_ret .= " id=\"" . $this->myControl->getFormHTMLId() . "\"" ; // <pk-08-01-29 />
$str_ret .= " " . $this->myForm->getLayoutField('FRMFRM_FORMADD');
$str_ret .= " " . $this->myControl->getFormEvents($aMode,$debug);
$str_ret .= ">\n";
$str_ret .= $this->myControl->getFormCmdFields($debug);
// ----------------------------
// form blocks
// ----------------------------
$str_tabHeader = "";
$str_tabTabs = "";
$bol_tabOpen = False;
$bol_tableOpen = False;
$bol_fieldSetOpen = False;
if ($arr_blocks = $this->myForm->getBlocks($debug))
{
foreach($arr_blocks as &$obj_block)
{
if ($obj_block->isToShow($this->myForm->getFrmMode(),$debug))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,$obj_block->getTitle() . " is to show in " . $this->myForm->getFrmMode());
switch($obj_block->getViewType())
{
case __OCSP_FRMBLK_VIEWFIELDSET__:
if ($bol_tableOpen) $str_ret .= "</table>";
if ($bol_fieldSetOpen) $str_ret .= "</fieldset>";
$str_ret .= "<fieldset " . $this->myForm->getLayoutField('FRMFRM_FIELDSETADD') . "><legend>".$obj_block->getTitle()."</legend>";
$str_ret .= "<table " . $this->myForm->getLayoutField('FRMFRM_TABLEADD') . ">";
$bol_tableOpen = True;
$bol_fieldSetOpen = True;
$str_ret .= $this->getTableBlock_Fields($obj_block,$debug);
break;
case __OCSP_FRMBLK_VIEWTABLE__:
if ($bol_tableOpen) $str_ret .= "</table>";
if ($bol_fieldSetOpen) $str_ret .= "</fieldset>";
$str_ret .= "<table " . $this->myForm->getLayoutField('FRMFRM_TABLEADD') . ">";
$bol_tableOpen = True;
$str_ret .= $this->getTableBlock_Fields($obj_block,$debug);
break;
case __OCSP_FRMBLK_VIEWINLINE__:
default:
if (!$bol_tableOpen) {
$str_ret .= "<table " . $this->myForm->getLayoutField('FRMFRM_TABLEADD') . ">";
$bol_tableOpen = True;
}
if ($bol_tabOpen)
{
$str_tabTabs .= $this->getTableBlock_Fields($obj_block,$debug);
} else {
$str_ret .= $this->getTableBlock_Fields($obj_block,$debug);
}
}
}
} // foreach($arr_blocks as &$obj_block)
}
if ($bol_tableOpen) $str_ret .= "</table>";
if ($bol_fieldSetOpen) $str_ret .= "</fieldset>";
if (!empty($str_tabHeader))
{
$str_ret .= $str_tabHeader;
$str_ret .= $str_tabTabs;
}
// ----------------------------
// form end
// ----------------------------
if (!$this->hideFrmBtnPannel)
{
$str_btnPannnel=$this->getButtonPannel();
if (!empty($str_btnPannnel))
{
$str_ret.=$this->getButtonPannel($debug);
}
}
if (!empty($str_tabHeader))
{
$str_ret .= $str_tabHeader;
$str_ret .= $str_tabTabs;
}
$str_ret .= "</form>";
if ($withOuterDiv) $str_ret.="</div>";
return $str_ret;
}
} // end of OCSP_FRMVIEW_FORM
?>

Source for file OCSP_FRMVIEW_FORM.phpclass