File Source for DBMS_FIELD_DBSELECTLIST.phpclass

<?php
/**
* Class file DBMS_FIELD_DBSELECTLIST.phpclass
*
* @project Open CSP-Management
* @package dbms_field
* @category mixed
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @version $Id: DBMS_FIELD_DBSELECTLIST.phpclass,v 1.11 2008/08/08 02:00:42 pitlinz Exp $
*/
// ---------------------------------------------------------
// requirements
// ---------------------------------------------------------
pcf_require_class('DBMS_FIELD_SELECTLIST',dirname(__FILE__) . "/DBMS_FIELD_SELECTLIST.phpclass");
pcf_require_class('OCSP_TEMPLATE',"common/");
/**
* Class DBMS_FIELD_DBSELECTLIST
*
* handels select fields (<SELECT>) with DB Values
* extends DBMS_FIELD_SELECTLIST to get the values from the database
*
* @project Open CSP-Management
* @package dbms_field
* @category mixed
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @version pk-06-07-24 getPopupLinkJs() added
* @version $Id: DBMS_FIELD_DBSELECTLIST.phpclass,v 1.11 2008/08/08 02:00:42 pitlinz Exp $
*
***/
class DBMS_FIELD_DBSELECTLIST extends DBMS_FIELD_SELECTLIST {
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
/**
* @constant string CLASS_SRC_FILE
*/
const CLASS_SRC_FILE = __FILE__;
// ---------------------------------------------------------------------------
// class (static)
// ---------------------------------------------------------------------------
/*** class vars ------------------------------------------------------ */
/**
* multidimensonal array of already loaded values
*
* array[$this->getClassCacheKey()][$value] = {query result}
*
* if self::$classValPopulateTs[$this->getClassCacheKey()] > (time() - ini_get('max_execution_time'))
* the array should be up to date and there is no need to query the db
*
* for list modes simply check if the value is set
*
* @var array $classCache
*/
protected static $classCache = array();
/**
* array of class value populate time stemps
*
* @var array $classValPopulateTs
*/
protected static $classValPopulateTs = array();
/*** class methods --------------------------------------------------- */
// ---------------------------------------------------------------------------
// object vars
// ---------------------------------------------------------------------------
/*** compostion --------------------------------------------------- */
/*** attributes -------------------------------------------------- */
/**
* @deprecated
*/
protected $classSrcFile=__FILE__;
/**
* a sql query to get data array
* @var string $query
*/
protected $query = "";
// ---------------------------------------------------------------------------
// factory / construct
// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------
// getter / setter
// ---------------------------------------------------------------------------
protected function getClassCacheKey()
{
return md5($this->query);
}
// ---------------------------------------------------------------------------
// OBJECT SETTINGS 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-04-26
*
*/
function editTbl_getFieldEditArr($debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_DBSELECTLIST::editTbl_getFieldEditArr","",0);
$a_ret=parent::editTbl_getFieldEditArr($debug);
$a_ret['SELECT']['FLD_LSTVALS']=NULL; // unset parent field
$a_ret['SELECT']['FLD_VALQUERY']=array(
'FLDLAB'=>"Query (SELECT KEY,VALUE ..)",
'FLDVAL'=>"<textarea name=\"SELECTQUERY\" cols=\"40\" rows=\"5\" wrap=\"off\">".htmlspecialchars($this->query)."</textarea>"
);
return $a_ret;
}
/**
* save the filed definition form
*
* @return bool
*
* @version pk-04-10-11
* @version pk-07-05-17
* @version pk-08-06-13 use OCSP_OBJ::defaultReadDBObj()
*
*/
function save()
{
$b_ret=parent::save();
if (isset($_POST['SELECTQUERY'])) // <pk-07-05-17> E_ALL
{
$this->query = OCSP_OBJ::defaultReadDBObj()->checkQuery($_POST['SELECTQUERY'],PQT_SELECT);
}
return $b_ret;
}
// -----------------------------------------------------------
// DB value methods
// -----------------------------------------------------------
/**
* sets populates $this->myValues array from the database
*
* @param string $arrName
* @param bool $debug
*
* @global string ${$arrName}
*
* @version pk-04-10-11
* @version pk-05-02-24
* @version pk-07-10-10
* @version pk-08-06-13 use OCSP_OBJ::defaultReadDBObj()
* @version pk-08-08-01 use self::$classCache
*/
function setMyValues($arrName="DBVAL",$debug=False) {
global ${$arrName};
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_DBSELECTLIST::setMyValues($arrName,...)","ClassCacheKey: ". $this->getClassCacheKey());
if (
isset(DBMS_FIELD_DBSELECTLIST::$classValPopulateTs[$this->getClassCacheKey()]) &&
(DBMS_FIELD_DBSELECTLIST::$classValPopulateTs[$this->getClassCacheKey()] > (time() - ini_get('max_execution_time')))
)
{
$this->myValues = DBMS_FIELD_DBSELECTLIST::$classCache[$this->getClassCacheKey()];
return True;
}
$str_query = OCSP_TEMPLATE::parse($this->query,${$arrName});
$dbVals=OCSP_OBJ::defaultReadDBObj()->queryArray($str_query,0,1);
if (!is_array($dbVals))
{
$dbVals=array("NULL"=>"keine Datensätzegefunden");
return False;
}
$this->myValues=$dbVals;
DBMS_FIELD_DBSELECTLIST::$classCache[$this->getClassCacheKey()] = &$this->myValues;
if (!is_array(DBMS_FIELD_DBSELECTLIST::$classValPopulateTs))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"<pre>" . print_r(DBMS_FIELD_DBSELECTLIST::$classValPopulateTs,True) . " - " . time() . "\n {$this->getKey()} - {$this->getClassCacheKey()}</pre>");
} else {
DBMS_FIELD_DBSELECTLIST::$classValPopulateTs[$this->getClassCacheKey()] = time();
if ($debug) echoDebugLine(__FILE__,__LINE__,"<pre>" . print_r(DBMS_FIELD_DBSELECTLIST::$classValPopulateTs,True) . " - " . time() . "\n {$this->getKey()} </pre>");
}
return True;
}
// ###########################################################
// OBJECT HTML FORM METHODS
// ###########################################################
/**
* return the link to the new or edit form
* the link is a template which is parsed with global ${$this->myDataArrName}
* also ##VALUE## is replaced with the current value
*
* @param string $url
* @param int $mode
* @param boolean $debug
*
* @returns string
*
* @since pk-06-07-24
*
*/
function getPopupLinkJs($url,$mode=FRM_MODE_NEW,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_SELECTLIST::getPopupLinkJs()");
require_once __OCSP_PHPINCPATH__."common"._OCSP_DIRSEP_."pcf_templates.phpinc";
$jCmd="\n";
global ${$this->myDataArrName};
$valArr=${$this->myDataArrName};
if ($debug) echo "<pre>\$valArr:\n".print_r($valArr,TRUE)."</pre>";
$url=str_replace("##VALUE##",$valArr[$this->myName],$url);
$url=pcf_tmpl_parse($url,$valArr); // parse the field setting
if (empty($url)) return ""; // empty url stop
switch($mode) {
case FRM_MODE_NEW:
unset($valArr[$this->myName]); // do not add own values to new link
break;
case FRM_MODE_EDIT:
if ($this->enableEdit) { // user can change value -> get the current value from the select
$jCmd.="var fldVal_".$this->myName."=getSelectedOptionByName(document.forms['".$this->getMyFormName()."'],'".$this->myDataArrName."[".$this->myName."]');\n";
$valArr[$this->myName]="'+fldVal_".$this->myName."+'";
break;
}
}
if (!strstr($url,"?")) $url.="?"; // ensure we are adding get values from now
if (!empty($this->myURIQueryArrgs)) { // add aditional args
if ($debug) echo "<blockquote><p>Args: ".$this->myURIQueryArrgs."</p>";
if ($addArgs=explode(";",$this->myURIQueryArrgs)) {
unset($addArgs[$this->myName]); // do not add field value as it is added later
foreach($addArgs as $key) {
if ($debug) echo "<p>$key:".htmlspecialchars($valArr[$key])."</p>";
if (!empty($valArr[$key])) { // only not empty values
$url.="&$key=".$valArr[$key];
}
}
} else if (!empty($valArr[$this->myURIQueryArrgs])) {
$url.="&".$this->myURIQueryArrgs."=".$valArr[$this->myURIQueryArrgs];
}
if ($debug) echo "</blockquote>";
}
if ($mode != FRM_MODE_NEW) { // ensure the field value is in the param list
if (!strstr($url,$this->myName."=")) {
$url.="&".$this->myName."=".$valArr[$this->myName];
}
}
// generate the fields to set update the field from the popup
$myForm=&$this->getMyForm();
$oArgs['FORMID'] =$myForm->getId(); // id of the form
$oArgs['FORMNAME'] =$this->getMyFormName(); // html name of the form (document.forms[...])
$oArgs['ARRNAME'] =$this->myDataArrName; // name of the data array
$oArgs['FIELD'] =$this->myName; // name of the field
$url.="&OPENERURL=".base64_encode(serialize($oArgs));
if ($this->reloadFormOnChange) $url.="&OPENERRELOAD=1";
if (!intval($this->popupWndWidth)) {
switch ($mode) {
case FRM_MODE_NEW:
$this->popupWndWidth=$this->newWndWidth;
break;
case FRM_MODE_EDIT:
$this->popupWndWidth=$this->editWndWidth;
break;
default:
$this->popupWndWidth=400;
}
}
if (!intval($this->popupWndpopupWndHeight)) {
switch ($mode) {
case FRM_MODE_NEW:
$this->popupWndpopupWndHeight=$this->editWndHeight;
break;
case FRM_MODE_EDIT:
$this->popupWndpopupWndHeight=$this->editWndpopupWndHeight;
break;
default:
$this->popupWndpopupWndHeight=300;
}
}
$jCmd.="var url_".$this->myName."='".$url."';\n";
$jCmd.="var opt_".$this->myName."='width=".$this->popupWndWidth.",height=".$this->popupWndHeight.",toolbar=no,location=no,status=yes,menubar=no,scrollbars=yes,resizable=yes';\n";
$jCmd.="hWnd_".$this->myName."=window.open(url_".$this->myName.",'".$this->myName."', opt_".$this->myName.");\n";
$jCmd.="hWnd_".$this->myName.".focus();\n";
if ($debug) echo "<blockquote><pre>".htmlspecialchars($jCmd)."</pre></blockquote>";
return $jCmd;
}
// -------------------------------------------------
// jOCSP rpc commands
// -------------------------------------------------
function jOCSP_reloadOptionLst($options,$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_DBSELECTLIST::jOCSP_reloadOptionLst()");
if (isset($options['FRMARRAYNAME']) && (!empty($options['FRMARRAYNAME'])))
{
$this->myDataArrName = $options['FRMARRAYNAME'];
}
global ${$this->myDataArrName};
if (is_array($options[$this->myDataArrName]))
{
${$this->myDataArrName} = $options[$this->myDataArrName];
} else {
${$this->myDataArrName} = array();
if (isset($options['fldValue']))
{
${$this->myDataArrName}[$this->getName()] = $options['fldValue'];
}
}
if (isset($options['fldValue']) && !empty($options['fldValue']))
{
$arr_values = array();
$arr_values[] = $options['fldValue'];
} else if (is_array(${$this->myDataArrName}[$this->getName()]))
{
$arr_values = ${$this->myDataArrName}[$this->getName()];
} else {
$arr_values = array();
if (!empty(${$this->myDataArrName}[$this->getName()]))
{
$arr_values[] = ${$this->myDataArrName}[$this->getName()];
}
}
$this->setMyValues($this->myDataArrName,$debug);
$str_ret = "
if (obj_fld = document.getElementById('" . $options['domId'] . "'))
{
var i=0;
var defaultValues = {};
";
if ($this->showNullOption)
{
$str_ret .= "
if (obj_fld.options[i].value != '')
{
if (obj_fld.options[i].defaultSelected)
{
defaultValues[obj_fld.options[i].value] = obj_fld.options[i].value;
}
obj_fld.options[i] = new Option('" . $this->nullLabel . "','',false," . (sizeof($arr_values) ? "false" : "true") . ");
}
i++;
";
}
if (sizeof($this->myValues))
{
foreach($this->myValues as $str_val => $str_text)
{
$str_ret .= "
if (obj_fld.options[i].value != '" . pcf_js_escape($str_val) . "')
{
if (obj_fld.options[i].defaultSelected)
{
defaultValues[obj_fld.options[i].value] = obj_fld.options[i].value;
}
obj_fld.options[i] = new Option('" . pcf_js_escape($str_text) . "','" . pcf_js_escape($str_val) . "',false," . (in_array($str_val,$arr_values) ? "true" : "false") . ");
} else {
obj_fld.options[i].text = '" . pcf_js_escape($str_text) . "';
}
i++;
";
}
}
$str_ret .= "
int_len = obj_fld.options.length;
while(i < int_len)
{
obj_fld.options[i] = null;
i++;
}
// restore default values
if (defaultValues.length)
{
int_len = obj_fld.options.length;
for (i = 0;i < int_len;i++)
{
if (defaultValues[obj_fld.options[i].value] == obj_fld.options[i].value)
{
obj_fld.options[i].defaultSelected = true;
}
}
}
}
";
return $str_ret;
}
} // end class DBMS_FIELD_DBSELECTLIST
?>

Source for file DBMS_FIELD_DBSELECTLIST.phpclass