File Source for OCSP_FORM

<?php
/**
* Class file OCSP_FORM_BLOCK.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
*
***/
/**
* requirements
*/
require_once __OCSP_PHPINCPATH__."common"._OCSP_DIRSEP_."OCSP_OBJ.phpclass";
/**
* constants
*/
define('__OCSP_FRMBLK_VIEWINLINE__',0);
define('__OCSP_FRMBLK_VIEWTAB__',1);
define('__OCSP_FRMBLK_VIEWFIELDSET__',2);
define('__OCSP_FRMBLK_VIEWTABLE__',3);
/**
* class OCSP_FORM_BLOCK
*
* @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
*
*/
class OCSP_FORM_BLOCK extends OCSP_OBJ
{
/*** class constants --------------------------------------------- */
/**
* @constant string CLASS_SRC_FILE
*/
const CLASS_SRC_FILE = __FILE__;
/*** Aggregations: */
/*** Compositions: */
/**
* @var OCSP_FORM $myForm
* @access protected
*/
protected $myForm=NULL;
/**
* @var array $myFields
* @access protected
*/
protected $myFields=array();
/**
* @var int $curFieldMode
* @access protected
*/
protected $curFieldMode=-99; // set to an unsed value
/*** Attributes: ***/
/**
* @var boolean $fieldsLoaded
* @access protected
*/
protected $fieldsLoaded=False;
/**
* db vars
*/
protected $FRB_SHOW_RO=1;
protected $FRB_SHOW_EDIT=1;
protected $FRB_SHOW_NEW=1;
protected $FRB_SHOW_COPY=1;
protected $FRB_SHOW_DELETE=1;
protected $FRB_SHOW_LIST=1;
protected $FRB_GROUP_SHOW=0;
/**
* @var array $myDBColumns
* @access protected
*/
protected $myBlockDBColumns=array('FRB_ID','FRM_ID','FRB_VIEWTYPE','FRB_ORIG_FRB_ID','FRB_ORIG_FRM_ID','FRB_SORTORDER','FRB_PARENT',
'FRB_SHOW_RO','FRB_SHOW_NEW','FRB_SHOW_EDIT','FRB_SHOW_DELETE','FRB_SHOW_LIST','FRB_SHOW_COPY','FRB_GROUP_SHOW','FRB_GROUP_NEW','FRB_GROUP_EDIT',
'FRB_CLASS','FRB_CLASSSRC','FRB_TABLES','FRB_LINKCOLS','FRB_NAME','FRB_OBJVALS',
'FRB_SHOW_FRMBUTTONS','FRB_CSS_CLASS','FRB_CSS_STYLE','FRB_DESC','FRB_EXTCONF');
/**
* @var OCSP_DB $myDBObj
* @access protected
*/
protected $myDBObj = NULL;
// ------------------------------------
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// init methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* @param OCSP_FORM $aForm
* @param boolean $debug
*/
function OCSP_FORM_BLOCK(&$aForm,$debug=False)
{
$this->setMyForm($aForm);
}
/**
* generates a new block form from a database row
*
* @param OCSP_FORM $aForm
* @param array $row
* @param boolean $debug
*
* @return OCSP_FORM_BLOCK
*
* @todo OCSP_FORM_BLOCK::getBlockObjFromRow() load class if not loaded
*/
function getBlockObjFromRow(&$aForm,$row,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::getBlockObjFromRow()",print_r($row,True));
if (isset($row['FRB_CLASS']) && ($row['FRB_CLASS'] != "OCSP_FORM_BLOCK"))
{
if (!class_exists($row['FRB_CLASS']))
{
ocsp_logError(__FILE__,__LINE__,$row['FRB_CLASS']." does not exist");
return NULL;
}
$str_cmd="\$obj_ret=new ".$row['FRB_CLASS']."(\$aForm);";
@eval($str_cmd);
if (!pcf_is_instance_of($obj_ret,'OCSP_FORM_BLOCK'))
{
ocsp_logError(__FILE__,__LINE__,$str_cmd." failed");
return NULL;
}
} else {
$obj_ret=new OCSP_FORM_BLOCK($aForm);
}
foreach($row as $str_col => $mix_val)
{
$obj_ret->setMyDBColValue($str_col,$mix_val);
}
return $obj_ret;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// getter/setter methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* @returns boolean
*/
function isTab()
{
if (isset($this->FRB_VIEWTYPE) && ($this->FRB_VIEWTYPE==__OCSP_FRMBLK_VIEWTAB__)) return True;
return False;
}
/**
* @returns boolean
*/
function isFieldSet()
{
if (isset($this->FRB_VIEWTYPE) && ($this->FRB_VIEWTYPE==__OCSP_FRMBLK_VIEWFIELDSET__)) return True;
return False;
}
/**
* @return boolean
*/
function isTable()
{
if (isset($this->FRB_VIEWTYPE) && ($this->FRB_VIEWTYPE==__OCSP_FRMBLK_VIEWTABLE__)) return True;
return False;
}
/**
* @return boolean
*/
function isInline()
{
if (!isset($this->FRB_VIEWTYPE) || intval($this->FRB_VIEWTYPE) < 1) return True;
return False;
}
/**
* @return int
*/
function getViewType()
{
if (isset($this->FRB_VIEWTYPE)) return intval($this->FRB_VIEWTYPE);
return __OCSP_FRMBLK_VIEWINLINE__;
}
/**
* @return boolean
*/
function showButtons()
{
if (isset($this->FRB_SHOW_FRMBUTTONS) && intval($this->FRB_SHOW_FRMBUTTONS)) return True;
return False;
}
/**
* @return OCSP_FORM
*/
function &getMyForm()
{
return $this->myForm;
}
/**
* @param OCSP_FORM $aForm
*/
function setMyForm(&$aForm)
{
$this->myForm=&$aForm;
$this->FRM_ID=$aForm->getId();
}
/**
* @return int
*/
function getFrmId()
{
if (pcf_is_instance_of($this->myForm,'OCSP_FORM'))
{
return $this->myForm->getId();
} else if (isset($this->FRM_ID)) {
return intval($this->FRM_ID);
} else {
return False;
}
}
// database values ----------------------------------
/**
* @return int
*/
function getId()
{
if (isset($this->FRB_ID))
{
return intval($this->FRB_ID);
} else {
return 0;
}
}
/**
* sets the block id to the object and the fields
*
* @param unknown_type $aId
*/
function setId($aId)
{
$this->FRB_ID=intval($aId);
}
/**
* @return string
*/
function getName()
{
if (isset($this->FRB_NAME) && !empty($this->FRB_NAME))
{
return $this->FRB_NAME;
}
if (!intval($this->getId()))
{
return "DEFAULT";
} else {
return $this->FRB_NAME;
}
}
/**
* returns $this->FRB_NAME if intval($this->getId()
* @return string
*/
function getTitle()
{
if (intval($this->getId())) return $this->FRB_NAME;
return "";
}
/**
* @param string $aName
*/
function setName($aName)
{
$this->FRB_NAME=$aName;
}
/**
* @return int
*/
function getOrderNr()
{
if (isset($this->FRB_SORTORDER))
{
return intval($this->FRB_SORTORDER);
} else {
return 0;
}
}
/**
* @param int $ordNr
*/
function setOrderNr($ordNr)
{
$this->FRB_SORTORDER=$ordNr;
}
/**
* returns an array with the show fields
*
* @return array
*/
function getShowFields()
{
return array(
'FRB_SHOW_RO' =>OCSP_FORM::getLangTxt('MOD_RO'),
'FRB_SHOW_NEW' =>OCSP_FORM::getLangTxt('MOD_NEW'),
'FRB_SHOW_EDIT' =>OCSP_FORM::getLangTxt('MOD_EDIT'),
'FRB_SHOW_DELETE' =>OCSP_FORM::getLangTxt('MOD_DELETE'),
'FRB_SHOW_LIST' =>OCSP_FORM::getLangTxt('MOD_LIST'),
'FRB_SHOW_COPY' =>OCSP_FORM::getLangTxt('MOD_COPY'),
);
}
/**
* @param string $col
* @param mixed $val
*/
function setMyDBColValue($col,$val)
{
if (in_array($col,$this->myBlockDBColumns))
{
$this->{$col}=$val;
}
}
/**
* @param string $col
* @return mixed
*/
function getMyDBColValue($col)
{
if (in_array($col,$this->myBlockDBColumns))
{
if (isset($this->{$col})) return $this->{$col};
else return NULL;
}
}
/**
* @return string
*/
function getCssClass()
{
return $this->FRB_CSS_CLASS;
}
/**
* @return string
*/
function getCssStyle()
{
return $this->FRB_CSS_STYLE;
}
/**
* @return string
*/
function getDesc()
{
return $this->FRB_DESC;
}
/**
* returns the extJS configuration options for the block
*
* @return string
* @since pk-08-09-22
*/
function getExtConf()
{
return $this->FRB_EXTCONF;
}
/**
* returns if the block is linked from another form
* @return boolean
*/
function isLinked()
{
if (isset($this->FRB_ORIG_FRB_ID) && intval($this->FRB_ORIG_FRB_ID) && intval($this->FRB_ORIG_FRM_ID))
{
return True;
} else {
return False;
}
}
/**
* @return int
*/
function getLinkedFromFormId()
{
return intval($this->FRB_ORIG_FRM_ID);
}
/**
* @return int
*/
function getLinkedFromBlockId()
{
return intval($this->FRB_ORIG_FRB_ID);
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// form block db methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* returns the db object from the form
*
* @param boolean $debug
* @return OCSP_DB
* @access public
*/
function &getDBObj($debug=False)
{
if (!pcf_is_instance_of($this->myDBObj,'OCSP_DB'))
{
if (!pcf_is_instance_of($this->myForm,'OCSP_FORM'))
{
$this->myDBObj = NULL;
} else {
$this->myDBObj=$this->myForm->getDBObj($debug);
}
}
return $this->myDBObj;
}
/**
* @param OCSP_DB $dbObj
* @access public
*/
function setDBObj(&$dbObj)
{
$this->myDBObj=&$dbObj;
}
/**
* loads the block form the database
* @param boolean $debug
* @access public
*/
function loadFromDB($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this)."OCSP_FORM_BLOCK::loadFormDB()");
if ($arr_Data=$this->getDBObj()->getArray("T_DBMS_FORMBLOCKS",array('FRM_ID' => intval($this->myForm->getId())),0,1,NULL,$debug))
{
$this->setDBRow($arr_Data);
$this->myFields=array();
}
}
/**
* stores the block to the database
* @param boolean $debug
*/
function storeToDB($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::storeToDB()");
$arr_dbRow=array();
foreach($this->myBlockDBColumns as $str_colName)
{
if (isset($this->{$str_colName}))
{
$arr_dbRow[$str_colName]=$this->{$str_colName};
} else {
$arr_dbRow[$str_colName]=NULL;
}
}
if (empty($arr_dbRow['FRB_TABLES']))
{
$arr_dbRow['FRB_TABLES']="__NO-DBFIELD__";
foreach($this->myFields as &$obj_field)
{
$str_tbl=$obj_field->getTable();
if (!empty($str_tbl) && (empty($arr_dbRow['FRB_TABLES']) || !strstr($arr_dbRow['FRB_TABLES'],$str_tbl)))
{
$arr_dbRow['FRB_TABLES'].=" ".$str_tbl;
}
}
}
if (intval($this->getId()))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"updating existing block");
if (!OCSP_OBJ::defaultWriteDBObj()->replaceArray('T_DBMS_FORMBLOCKS',$arr_dbRow,False))
{
ocsp_logError(__FILE__,__LINE__,OCSP_OBJ::defaultWriteDBObj()->errorMsg("error updateing form block ".$this->getId())."\n".print_r($arr_dbRow,True));
return False;
}
} else {
if ($debug) echoDebugLine(__FILE__,__LINE__,"inserting new block");
if ($this->getName() != "DEFAULT")
{
unset($arr_dbRow['FRB_ID']);
if ($aId=OCSP_OBJ::defaultWriteDBObj()->insertArray('T_DBMS_FORMBLOCKS',$arr_dbRow,False,'FRB_ID'))
{
if ($arr_Data=OCSP_OBJ::defaultWriteDBObj()->getArray("T_DBMS_FORMBLOCKS",array('FRB_ID' => intval($aId)),0,1,NULL,False))
{ // to also have db default values loaded
foreach($arr_Data as $str_col => $mix_val)
{
$this->{$str_col}=$mix_val;
}
} else {
ocsp_logError(__FILE__,__LINE__,"error reloading inserted formblock ID:".$aId);
return False;
}
} else {
ocsp_logError(__FILE__,__LINE__,OCSP_OBJ::defaultWriteDBObj()->errorMsg("error inserting formblock").print_r($arr_dbRow));
return False;
}
} else if ($debug) {
echoDebugLine(__FILE__,__LINE__,"\$this->getName() returned DEFAULT");
}
}
if ($debug) echoDebugLine(__FILE__,__LINE__,"<h1>Field of ".$this->getName()."</h1>");
foreach($this->myFields as &$o_fld)
{
$this->storeFldToDb($o_fld,$debug);
}
}
/**
* writes the field data to T_DBMS_FORMFIELDS
*
* @param DBMS_FIELD $aFld
* @param boolean $debug
* @param foreceLinked (if false linked block fields are not stored. this should only be tree if a block is linked to hide existing fields)
*/
function storeFldToDb($aFld,$debug=False,$forceLinked=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::storeFldToDb(".$aFld->getKey().")");
if ($this->isLinked() && !$forceLinked)
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"Link Block no need to store fields to db");
return True;
}
if ($aFld->isMarkedDeleted())
{
$arr_delKey=array(
'FRM_ID' => $this->getFrmId(),
'FRB_ID' => $this->getId(),
'FLD_KEY' => $aFld->getKey(),
'FLD_TABLE' => $aFld->getTable(),
);
OCSP_OBJ::defaultWriteDBObj()->deleteRows("T_DBMS_FORMFIELDS",$arr_delKey,True,$debug);
} else {
$a_fldRow=array(
'FRM_ID' => $this->getFrmId(),
'FRB_ID' => $this->getId(),
'FRM_CLASS' => strtoupper(get_class($this->myForm)),
'FRB_CLASS' => strtoupper(get_class($this)),
'FLD_KEY' => $aFld->getKey(),
'FLD_TABLE' => $aFld->getTable(),
'FLD_NAME' => $aFld->getName(),
'FRM_MODULE' => $aFld->getModuleKey(),
'FLD_IS_HIDDEN' => intval($aFld->isHidden()),
'FLD_ENABLE_NEW' => intval($aFld->isEnabled(FRM_MODE_NEW)),
'FLD_ENABLE_EDIT' => intval($aFld->isEnabled(FRM_MODE_EDIT)),
'FLD_SHOW_IN_LIST' => intval($aFld->showInList()),
'FLD_SORTORDER' => intval($aFld->getOrderNr()),
'FLD_CLASS' => strtoupper(get_class($aFld)),
'FLD_CLASS_SRC' => $aFld->getSourceFile(),
'FLD_B64OBJECT' => base64_encode(serialize($aFld->getObjectData())),
'FLD_LABEL' => $aFld->getLabel() // <pk-05-10-04 />
);
if ($debug) echoDebugLine(__FILE__,__LINE__,"FRM_ID: ".$a_fldRow['FRM_ID']." FRB_ID: ".$a_fldRow['FRB_ID']." FLD_KEY: ".$a_fldRow['FLD_KEY']."");
OCSP_OBJ::defaultWriteDBObj()->replaceArray("T_DBMS_FORMFIELDS",$a_fldRow,False);
}
}
/**
* sets the database row to the object
*
* @param array $dbRow
* @param boolean $debug
* @access public
*/
function setDBRow($dbRow,$debug=False)
{
foreach($dbRow as $str_col => $str_val)
{
$this->{$str_col}=$str_val;
}
}
/**
* updates a block form $_POST[$arrName] values
*
* @param string $arrName
* @param array $colNames
* @param boolean $debug
*
* @return boolean
*/
function updateBlockFromPost($arrName='DBVAL',$colNames=NULL,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM::updateBlockFromPost()",print_r($colNames,True));
if(!isset($_POST[$arrName]) || (!is_array($_POST[$arrName]))) return False;
$this->getMyForm(); // ensure $this->myForm isset
$this->getDBObj(); // ensure $this->myDBObj isset
$this->getFields(-1); // ensure all fields are loaded
$arr_Data=$_POST[$arrName];
unset($arr_Data['FRB_ID']); // avoid overwriting
$b_reloadForm=False; // if true the whole form is reloaded after the updates have been made
$arr_Data['FRB_NAME']=trim($arr_Data['FRB_NAME']);
if (isset($arr_Data['FRB_NAME']) && !empty($arr_Data['FRB_NAME']) && ($arr_Data['FRB_NAME'] != $this->getName()))
{
$this->getDBObj(); // ensure $this->myDBObj isset
$str_query ="SELECT COUNT(*) FROM T_DBMS_FORMBLOCKS ";
$str_query.=" WHERE FRM_ID=".$this->getId();
$str_query.=" AND UPPER(FRB_NAME)=".$this->myDBObj->qs_getSlashedValue(strtoupper(trim($arr_Data['FRB_NAME'])));
$str_query.=" AND FRB_ID <> ".$this->getId();
if (intval($this->myDBObj->getOne($str_query)))
{
ocsp_logError(__FILE__,__LINE__,"Name: ".$arr_Data['FRB_NAME']." already in use",E_NOTICE);
} else {
$this->setName($arr_Data['FRB_NAME']);
}
}
if (isset($arr_Data['FRB_SORTORDER']) && intval($arr_Data['FRB_SORTORDER']) && ($this->getOrderNr() != intval($arr_Data['FRB_SORTORDER'])))
{
$str_cmd ="UPDATE T_DBMS_FORMBLOCKS SET FRB_SORTORDER=FRB_SORTORDER+1 ";
$str_cmd.=" WHERE FRM_ID=".$this->getFrmId();
$str_cmd.=" AND FRB_SORTORDER >= ".intval($arr_Data['FRB_SORTORDER']);
if ($debug) echoDebugLine(__FILE__,__LINE__,$str_cmd);
$this->myDBObj->executeCmd($str_cmd);
$str_cmd ="UPDATE T_DBMS_FORMBLOCKS SET FRB_SORTORDER=".intval($arr_Data['FRB_SORTORDER']);
$str_cmd.=" WHERE FRM_ID=".$this->getFrmId();
$str_cmd.=" AND FRB_ID=".$this->getId();
if ($debug) echoDebugLine(__FILE__,__LINE__,$str_cmd);
$this->myDBObj->executeCmd($str_cmd);
$b_reloadForm=True;
}
$arr_showCols=$this->getShowFields();
foreach($arr_showCols as $col => $lab)
{
if (isset($arr_Data[$col]))
{
if (!empty($arr_Data[$col]))
{
$this->setMyDBColValue($col,True);
} else {
$this->setMyDBColValue($col,False);
}
unset($arr_Data[$col]);
} else {
$this->setMyDBColValue($col,False);
}
}
foreach($arr_Data as $col => $val)
{
$this->setMyDBColValue($col,$val);
}
if (!$this->isLinked() && is_array($colNames))
{
foreach($colNames as $str_colName)
{
if ($debug) echo "$str_colName --".substr($str_colName,0,2)."--";
if (substr($str_colName,0,2) != "-:")
{
if ($obj_field=$this->myForm->getField($str_colName))
{
$this->addFieldObj($obj_field,$debug);
} else {
ocsp_logError(__FILE__,__LINE__,"Field: ".$str_colName." not found");
}
$b_reloadForm=True;
}
}
}
$this->storeToDb($debug);
$this->myForm->delCacheFiles();
if ($b_reloadForm)
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"Reloading Form");
$this->myForm->loadBlocksFromDb();
}
return True;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// export / import
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* returns the form export string (php array)
*
* @return string
*
* @since pk-08-10-31
*/
public function getExportString()
{
$str_ret = "array(\n";
foreach($this->myBlockDBColumns as $str_colName)
{
$str_ret .= "\t\t\t\t'{$str_colName}' => \"" . base64_encode(serialize($this->{$str_colName})) . "\",\n";
}
if ($arr_fields = $this->getFields(-1))
{
$str_ret .= "\t\t\t\t'_FIELDS' => array(\n";
$str_tabs = "\t\t\t\t\t";
foreach($arr_fields as $obj_field)
{
if ($arr_fldData = $obj_field->getObjectVars())
{
$str_ret .= $str_tabs . "'{$obj_field->getKey()}' => array(\n";
$str_ret .= $str_tabs . "\t'class' => \"" . get_class($obj_field) . "\",\n";
foreach($arr_fldData as $str_valName => $mix_val)
{
switch($str_valName)
{
case "classSrcFile":
$str_ret .= $str_tabs."\t'{$str_valName}' => \"" . str_replace(__OCSP_PHPINCPATH__,'',$mix_val) . "\",\n";
break;
default:
$str_ret .= $str_tabs."\t'{$str_valName}' => \"" . base64_encode(serialize($mix_val)) . "\",\n";
}
}
}
$str_ret .= $str_tabs. "), // field {$obj_field->getKey()}\n";
}
$str_ret .= "\t\t\t\t) // _FIELDS\n";
}
$str_ret .= "\t\t\t),// blockValues {$this->getId()}\n";
return $str_ret;
}
/**
* imports the form from an array
* NOTE: does not save the form
*
* @param array $impArray
* @param boolean $debug
*/
public function importFromArray($impArray,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::importFromArray()");
if (isset($impArray['FRB_ID'])) unset($impArray['FRB_ID']);
if (isset($impArray['FRM_ID'])) unset($impArray['FRM_ID']);
foreach($this->myBlockDBColumns as $str_colName)
{
if (isset($impArray[$str_colName]) && !empty($impArray[$str_colName]))
{
$this->$str_colName = unserialize(base64_decode($impArray[$str_colName]));
}
}
if (isset($impArray['_FIELDS']) && is_array($impArray['_FIELDS']))
{
$arr_tables = $this->myForm->getTables();
if ($debug) echoDebugLine(__FILE__,__LINE__,"importing " . sizeof($impArray['_FIELDS']) . " fields");
foreach($impArray['_FIELDS'] as $arr_fld)
{
pcf_require_class($arr_fld['class'],$arr_fld['classSrcFile']);
$obj_fld = new $arr_fld['class']();
unset($arr_fld['class']);
unset($arr_fld['classSrcFile']);
$arr_fldValues = array();
foreach($arr_fld as $str_colName => $mix_value)
{
if (!empty($mix_value))
{
switch($str_colName)
{
case "myBlockId":
case "myFrmId":
break;
default:
$arr_fldValues[$str_colName] = unserialize(base64_decode($mix_value));
}
}
}
$obj_fld->setObjectVars($arr_fldValues);
$this->addFieldObj($obj_fld,$debug);
if ($str_table = $obj_fld->getTable())
{
if (substr($str_table,-3) != "_OV")
{
if (!in_array($str_table,$arr_tables) && OCSP_OBJ::defaultReadDBObj()->tblExists($str_table))
{
$arr_tables[] = $str_table;
$this->myForm->registerTable($str_table);
}
}
}
}
}
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// form block cache methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* @param resource $hFile
* @param boolean $debug
*/
function writeToFileCache($hFile,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::writeToFileCache()");
$str_eol="\n";
$arr_dbRow=array();
foreach ($this->myBlockDBColumns as $str_col)
{
if (isset($this->{$str_col})) {
$arr_dbRow[$str_col]=$this->{$str_col};
}
}
fwrite($hFile,"'block".$this->getId()."'=>array($str_eol");
fwrite($hFile,"'dbRow'=>unserialize(base64_decode(\"".base64_encode(serialize($arr_dbRow))."\")),$str_eol");
fwrite($hFile,"'fields'=>array($str_eol");
$arr_fields=$this->getFields(-1,$debug);
foreach ($arr_fields as &$obj_fld)
{
fwrite($hFile,"'".$obj_fld->getKey()."'=>unserialize(base64_decode(\"".base64_encode(serialize($obj_fld->getObjectData($debug)))."\")),$str_eol");
}
fwrite($hFile,")),$str_eol");
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// fields methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* add all columns in a table to the block
*
* @param string $aTable
* @param boolean $asHidden if true the columns are added as hidden fields
* @param boolean $debug
*
* @return boolean
*
* requires OCSP_FORM_DBCONTROLL.phpclass
*
*/
function addTable($aTable,$asHidden=True,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::addTable($aTable)");
$this->getDBObj(); // ensure we have a valid db connection
if (!($arr_tblDesc=$this->myDBObj->getDBTblDesc($aTable)))
{
ocsp_logError(__FILE__,__LINE__,'Error no tabledesc found for $aTable');
return False;
}
if (!($o_frmDBControll=$this->myForm->getMyDBControll()))
{
ocsp_logError(__FILE__,__LINE__,"no db controll object");
return False;
}
$this->getFields(-1); // ensure this my fields is loaded
foreach($arr_tblDesc as $str_colName => $arr_colDesc)
{
if (!$this->myForm->getField($str_colName,$aTable))
{
$i_ordNr=sizeof($this->myFields);
$this->myFields[$i_ordNr]=$o_frmDBControll->generateField($arr_colDesc,$debug);
$this->myFields[$i_ordNr]->setOrderNr($i_ordNr);
$this->myFields[$i_ordNr]->setMyForm($this->getMyForm());
}
}
return True;
}
/**
* loads the fields form the database
*
* @param boolean $debug
* @access public
*/
function loadMyFieldsFromDb($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::loadMyFieldsFromDb() [BlockId: ".$this->getId()."]");
$dbObj=$this->myForm->getDBObj(); // ensure we have a database connection
if ($this->isLinked())
{
$arr_filter=array('FRM_ID'=>intval($this->FRB_ORIG_FRM_ID),'FRB_ID' => intval($this->FRB_ORIG_FRB_ID));
} else {
$arr_filter=array('FRM_ID'=>$this->getFrmId(),'FRB_ID' => $this->getId());
}
if ($arr_fields=$dbObj->getArray('T_DBMS_FORMFIELDS',$arr_filter,0,0,'FLD_SORTORDER',False))
{
$i_sort=1;$this->myFields=array();
foreach($arr_fields as $arr_row)
{
$arr_objData=unserialize(base64_decode($arr_row['FLD_B64OBJECT']));
if (!class_exists($arr_row['FLD_CLASS']))
{
$b_loaded=OCSP_FORM::requireFieldClass($arr_row['FLD_CLASS'],$debug);
if (!$b_loaded) {
// try to find the source file in the system
$arr_sources=array(
__OCSP_PROJECTPATH__.$arr_row['FLD_CLASS_SRC'],
__OCSP_PHPINCPATH__.$arr_row['FLD_CLASS_SRC'],
__OCSP_PROJECTPATH__.$arr_objData['OBJDESC']['SRCFILE'],
__OCSP_PHPINCPATH__.$arr_objData['OBJDESC']['SRCFILE'],
$arr_objData['OBJVAL']['classSrcFile']
);
foreach($arr_sources as $str_file)
{
if (file_exists($str_file) && !is_dir($str_file))
{
require_once $str_file;
$b_loaded=True;
break;
}
}
if (!$b_loaded && isset($arr_objData['OBJDESC']['SRCFILE']) && !empty($arr_objData['OBJDESC']['SRCFILE']))
{
require_once __OCSP_PHPINCPATH__."common/pcf_templates.phpinc";
$str_src=pcf_tmpl_parse($arr_objData['OBJDESC']['SRCFILE'],$arr_objData['OBJVAL']);
if (file_exists($str_src))
{
include $str_src;
$b_loaded=True;
}
}
}
if (!$b_loaded)
{
ocsp_logError(__FILE__,__LINE__,"fieldclass ".$arr_row['FLD_CLASS']." not loaded row:".print_r($arr_row,True)."objData:".print_r($arr_objData,True)."");
}
}
if (class_exists($arr_row['FLD_CLASS']))
{
eval("\$this->myFields['".$i_sort."']=new ".$arr_row['FLD_CLASS']."();");
if (is_object($this->myFields[$i_sort]))
{
//echoDebugLine(__FILE__,__LINE__,"Object values:<pre>".print_r(unserialize(base64_decode($arr_row['FLD_B64OBJECT'])),True)."</pre>");
$this->myFields[$i_sort]->setObjectVars($arr_objData['OBJVAL']);
$this->myFields[$i_sort]->setOrderNr($i_sort);
$this->myFields[$i_sort]->setMyForm($this->myForm);
$this->myFields[$i_sort]->setMyBlock($this);
$i_sort++;
}
} else {
ocsp_logError(__FILE__,__LINE__,"fieldclass ".$arr_row['FLD_CLASS']." not loaded <pre>" . print_r($arr_row,True) . "</pre>");
}
}
} else {
if($debug) echoDebugLine(__FILE__,__LINE__,'block '.$this->getName()." has no fields");
$b_loaded=True;
$this->myFields=array();
}
}
/**
* returns the number of fields in the form
*
* @param int $mode
* @param boolean $debug
*
*/
function getNofFields($mode=-1,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM::getNofFields()");
$arr_fields=$this->getFields($mode,$debug);
return sizeof($arr_fields);
}
/**
* @param int $mode (-1 all modes)
* @param boolean $debug
*
* @return array of DBMS_FIELDS
*
* @todo cacheing
*/
function getFields($mode=-1,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::getFields($mode) [BlockId: ".$this->getId()."]");
if (!is_array($this->myFields) || (!sizeof($this->myFields)) || (($this->curFieldMode > -1) && ($mode != $this->curFieldMode)))
{
$this->loadMyFieldsFromDb($debug);
$this->curFieldMode=$mode;
}
switch($mode)
{
case FRM_MODE_LIST:
$arr_ret=array();
foreach($this->myFields as &$objFld)
{
if (!$objFld->isHidden('list'))
{
while (isset($arr_ret[$objFld->getOrderNr()]))
{
$objFld->incOrderNr();
}
$arr_ret[$objFld->getOrderNr()]=&$objFld;
}
}
return $arr_ret;
case FRM_MODE_NEW:
case FRM_MODE_EDIT:
case FRM_MODE_COPY:
$arr_ret=array();
foreach($this->myFields as &$objFld)
{
if (!$objFld->isHidden('form'))
{
while (isset($arr_ret[$objFld->getOrderNr()]))
{
$objFld->incOrderNr();
}
$arr_ret[$objFld->getOrderNr()]=&$objFld;
}
}
return $arr_ret;
case FRM_MODE_SEARCH:
$arr_ret=array();
foreach($this->myFields as &$objFld)
{
if (!$objFld->isHidden('search'))
{
$arr_ret[]=&$objFld;
}
}
return $arr_ret;
default:
return $this->myFields;
}
}
/**
* returns a field object
*
* @param string $aFldName
* @param string $aTable (empty to search in all tables)
* @param string $aFldKey
* @param boolean $debug
*
* @return DBMS_FIELD
*
* @version pk-08-07-31
* @version pk-08-11-06 object values added to table (_OV)
*/
function &getField($aFldName,$aTable="",$aFldKey="",$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::getField($aFldName)");
if (!strstr($aFldKey,'.')) // no table field seperator ignore it
{
$aFldKey = "";
}
if ($this->getFields(-1,$debug))
{
foreach($this->myFields as &$obj_fld)
{
if (!empty($aFldKey) && ($obj_fld->getKey() == $aFldKey)) // <pk-08-07-31>
{
return $obj_fld;
} else if ((!empty($aTable) && ($obj_fld->getTable() == $aTable)) || (empty($aTable))) {
if ($obj_fld->getName()==$aFldName)
{
return $obj_fld;
}
} else if ((!empty($aTable) && ($obj_fld->getTable() == $aTable . "_OV"))) { // <pk-08-11-06>
if ($obj_fld->getName()==$aFldName)
{
return $obj_fld;
}
}
}
}
$obj_ret=NULL;
return $obj_ret;
}
/**
* adds a field to $this->myFields and removes it from the original block
*
* @param DBMS_FIELD $aField
* @param boolean $debug
*/
function addFieldObj(&$aField,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::addFieldObj(".$aField->getKey().") [BlockId: ".$this->getId()."]");
if ($obj_other = $aField->getMyBlock())
{
$obj_other->removeFieldObj($aField,$debug);
}
$this->getFields(-1,$debug);
$aField->setMyBlock($this,$debug);
$this->myFields[]=$aField;
$aField->setOrderNr(sizeof($this->myFields));
if ($debug) {
echoDebugLine(__FILE__,__LINE__,"Field: ".$this->myFields[(sizeof($this->myFields)-1)]->getKey()." added to block ".$this->getId());
$str_debug="";
foreach($this->myFields as &$obj_fld) {
$str_debug.=$obj_fld->getKey().", ";
}
echoDebugLine(__FILE__,__LINE__,"Fields: ".$str_debug."");
}
}
/**
* removes the field from the block not from the database
*
* @param DBMS_FIELD $aField
* @param boolean $debug
*/
function removeFieldObj(&$aField,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::removeFieldObj(".$aField->getKey().") [BlockId: ".$this->getId()."]");
$this->getFields(-1,$debug);$i_sort=1;
foreach($this->myFields as $i_idx => &$obj_fld)
{
if ($obj_fld->getKey() != $aField->getKey())
{
$obj_fld->setOrderNr($i_sort++);
} else {
unset($this->myFields[$i_idx]);
if ($debug) echoDebugLine(__FILE__,__LINE__,$aField->getKey()." removed from block ".$this->getId());
}
}
}
/**
* creates a new field and add it to the block
*
* @param string $colName
* @param string $colType
* @param string $table
* @param int $size
* @param boolean $debug
*
* @return DBMS_FIELD
*/
function &addNewField($colName,$colType,$table="__NO-DBFIELD__",$size=0,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::createField($colName,$colType,$table,$size) Block: ".$this->getId());
$obj_field=NULL;
if (empty($colName))
{
ocsp_logError(__FILE__,__LINE__,"no colum name set",E_WARNING);
return $obj_field;
}
if (empty($colType))
{
ocsp_logError(__FILE__,__LINE__,"no colum type set",E_WARNING);
return $obj_field;
}
require_once dirname(__FILE__)."/OCSP_FORM_DBCONTROLL.phpclass";
$str_dbColName=preg_replace('/[^a-z0-9_]/i',"_", $colName);
$obj_dbControll=OCSP_FORM_DBCONTROLL::newSubClass($this->getDBObj(),$debug);
if ($arr_dbDesc=$obj_dbControll->generateColDesc($str_dbColName,$colType,$table,$size,$debug))
{
if ($obj_field=$obj_dbControll->generateField($arr_dbDesc,$debug))
{
// <pk-08-07-12>
if (substr($table,-3) == "_OV")
{
$obj_field->setTblAlias('OBJVALS_' . substr($table,0,-3));
}
// </pk-08-07-12>
$this->getFields(-1,$debug);
$this->myFields[]=&$obj_field;
$obj_field->setLabel($colName);
$obj_field->setOrderNr(sizeof($this->myFields));
$obj_field->setMyForm($this->getMyForm());
$obj_field->setMyBlock($this);
if (method_exists($obj_field,'setDBObj'))
{
$obj_field->setDBObj($this->getDBObj);
}
return $obj_field;
}
}
}
// field sorting
/**
* moves a field in the block
*
* @param mixed $field (DBMS_FIELD or field name)
* @param int $movedir (-1 = up,0=position,1=down)
* @param int $newPos
* @param boolean $debug
*
* @return boolean
* @access public
*/
function moveField(&$field,$movedir=0,$newPos=0,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::moveField(\$field,$movedir,$newPos)");
if (pcf_is_instance_of($field,'DBMS_FIELD'))
{
$obj_field=&$field;
$obj_block=$obj_field->getMyBlock();
if ($obj_block->getId() != $this->getId())
{
$this->addFieldObj($field);
}
} else if (!empty($field)) {
if (strstr($field,".")) {
$arr_fldName=explode('.',$field);
if (!($obj_field=$this->getField($arr_fldName[1],$arr_fldName[0],$debug)))
{
ocsp_logError(__FILE__,__LINE__,"field {$arr_fldName[1]} table {$arr_fldName[0]} not found",E_WARNING);
return False;
}
} else if (!($obj_field=$this->getField($field))) {
ocsp_logError(__FILE__,__LINE__,"field $field not found",E_WARNING);
return False;
}
} else {
ocsp_logError(__FILE__,__LINE__,"param \$field is empty",E_WARNING);
return False;
}
switch(intval($movedir))
{
case -1:
case 1:
$i_newPos=$obj_field->getOrderNr()+$movedir;
break;
default:
$i_newPos=intval($newPos);
}
if ($debug) echoDebugLine(__FILE__,__LINE__,"new position: $i_newPos");
$obj_field->setOrderNr($i_newPos);
$arr_fields=$this->getFields(-1,$debug);
$arr_tmp=array();
$i_idx=-1;
foreach($arr_fields as &$obj_blockFld)
{
if ($i_idx < 0 ) // first loop
{
$i_idx=$obj_blockFld->getOrderNr();
if ($i_newPos < $i_idx) $i_newPos=$i_idx;
if ($debug) echoDebugLine(__FILE__,__LINE__,"first orderNr in block: $i_idx");
}
if ($i_newPos==$i_idx)
{
$arr_tmp[$i_idx]=&$obj_field;
$obj_field->setOrderNr($i_idx);
if ($debug) echoDebugLine(__FILE__,__LINE__,"setting moveField (".$obj_field->getKey().") sortOrder to $i_idx");
$i_idx++;
}
if ($obj_blockFld->getKey() != $obj_field->getKey())
{
if ($debug && ($obj_blockFld->getOrderNr() != $i_idx)) echoDebugLine(__FILE__,__LINE__,"setting field (".$obj_field->getKey().") sortOrder to $i_idx");
$obj_blockFld->setOrderNr($i_idx);
$arr_tmp[$i_idx]=&$obj_blockFld;
$i_idx++;
}
}
if ($obj_field->getOrderNr() > $i_idx)
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"index $i_idx not found in block");
$arr_tmp[$i_idx]=&$obj_field;
$obj_field->setOrderNr($i_idx);
}
$this->myFields=$arr_tmp;
return True;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// show / rights
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* checks if we have a field in $scope
*
* @param string $scope
* @param boolean $debug
*
* @return boolean
*/
function hasFieldInScope($scope,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::hasFieldInScope($scope)");
foreach($this->myFields as &$obj_fld)
{
if (!$obj_fld->isHidden($scope)) return True;
}
return False;
}
/**
* returns if the block is to show in $mode
* checks $this->show.... and FRB_GROUP_...
*
* @param int $mode
* @param boolean $debug
*
* @return boolean
* @access public
*
*/
function isToShow($mode,$debug=False)
{
global $OCSP_OBJ;
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FORM_BLOCK::isToShow($mode) [".$this->getName()."|".$this->getId()."]");
if (!$this->fieldsLoaded)
{
$this->getFields(-1,False); // to load $this->myFields
}
switch($mode)
{
case FRM_MODE_LIST:
if (!intval($this->getId()) && sizeof($this->myFields))
{
return $this->hasFieldInScope('list',$debug);
} else if (isset($this->FRB_SHOW_LIST) && intval($this->FRB_SHOW_LIST)) {
if (intval($this->FRB_GROUP_SHOW))
{
return OCSP_OBJ::currentUser()->isGroupMember(intval($this->FRB_GROUP_SHOW));
} else {
return True;
}
} else {
return False;
}
case FRM_MODE_NEW:
if ($debug) echoDebugLine(__FILE__,__LINE__,"MODE NEW: FRB_SHOW_NEW = " . $this->FRB_SHOW_NEW);
if (!intval($this->getId()) && sizeof($this->myFields))
{
return $this->hasFieldInScope('form',$debug);
} else if (isset($this->FRB_SHOW_NEW) && intval($this->FRB_SHOW_NEW)) {
if (isset($this->FRB_GROUP_NEW) && intval($this->FRB_GROUP_NEW))
{
return OCSP_OBJ::currentUser()->isGroupMember(intval($this->FRB_GROUP_NEW));
} else {
return $this->hasFieldInScope('form',$debug);
}
} else {
return False;
}
case FRM_MODE_COPY:
if (!intval($this->getId()) && sizeof($this->myFields))
{
return $this->hasFieldInScope('form',$debug);
} else if (intval($this->FRB_SHOW_COPY)) {
if (isset($this->FRB_GROUP_NEW) && intval($this->FRB_GROUP_NEW))
{
return OCSP_OBJ::currentUser()->isGroupMember(intval($this->FRB_GROUP_NEW));
} else {
return True;
}
} else {
return False;
}
case FRM_MODE_EDIT:
if ($debug) echoDebugLine(__FILE__,__LINE__,"FRM_MODE_EDIT:");
if (!intval($this->getId()))
{
return $this->hasFieldInScope('form',$debug);
} else if (intval($this->FRB_SHOW_EDIT)) {
if ((intval($this->FRB_GROUP_EDIT)) && (!OCSP_OBJ::currentUser()->isGroupMember(intval($this->FRB_GROUP_EDIT))))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"GROUP_EDIT: ".$this->FRB_GROUP_EDIT." return False");
}
$b_ret=$this->hasFieldInScope('form',$debug);
if ($debug) echoDebugLine(__FILE__,__LINE__,"hasFieldInScope: return ".($b_ret ? "True" : "False")."");
return $b_ret;
} else {
if ($debug) echoDebugLine(__FILE__,__LINE__,"SHOW_EDIT: ".$this->FRB_SHOW_EDIT." return False");
return False;
}
break;
case FRM_MODE_DELETE:
if ($debug) echoDebugLine(__FILE__,__LINE__,"FRM_MODE_EDIT:");
if (!intval($this->getId()))
{
return $this->hasFieldInScope('form',$debug);
} else if (intval($this->FRB_SHOW_DELETE)) {
$b_ret=$this->hasFieldInScope('form',$debug);
if ($debug) echoDebugLine(__FILE__,__LINE__,"hasFieldInScope: return ".($b_ret ? "True" : "False")."");
return $b_ret;
} else {
if ($debug) echoDebugLine(__FILE__,__LINE__,"SHOW_DELETE: ".$this->FRB_SHOW_DELETE." return False");
return False;
}
break;
case FRM_MODE_READONLY:
if ($this->FRB_SHOW_RO)
{
return $this->hasFieldInScope('form',$debug);
} else {
False;
}
break;
default:
ocsp_logError(__FILE__,__LINE__,"mode $mode not implemented in isToShow()");
return True;
}
}
} // end of OCSP_FORM_BLOCK
?>

Source for file OCSP_FORM_BLOCK.phpclass