File Source for CLI_PROFILE

<?php
/**
* Class file CLI_PROFILE_ENTRY.phpclass
*
* @project Open CSP-Management
* @package client
*
* @author Peter Krebs <pitlinz@sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-06-10-08
* @version $Id:$
*/
// ---------------------------------------------------------
// requirements
// ---------------------------------------------------------
pcf_require_class('DBMS_TABLEOBJ',"db/");
pcf_require_class('CLI_PROFILE',"client/");
/**
* Class file CLI_PROFILE_ENTRY.phpclass
*
* @project Open CSP-Management
* @package client
*
* @author Peter Krebs <pitlinz@sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @version pk-03-12-23
* @version pk-07-10-06
* @version $Id:$
*/
class CLI_PROFILE_ENTRY extends DBMS_TABLEOBJ {
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
/**
* @constant string CLASS_SRC_FILE
*/
const CLASS_SRC_FILE = __FILE__;
// ---------------------------------------------------------------------------
// class (static)
// ---------------------------------------------------------------------------
/*** class vars ------------------------------------------------------ */
/*** class methods --------------------------------------------------- */
// ---------------------------------------------------------------------------
// object vars
// ---------------------------------------------------------------------------
/*** compostion --------------------------------------------------- */
/**
* @var CLI_PROFILE $myProfile
***/
protected $myProfile=NULL;
/*** attributes -------------------------------------------------- */
// ---------------------------------------------------------------------------
// factory / construct
// ---------------------------------------------------------------------------
/**
* init the object and populate if an id is submitted
*
* @param int $clpId Profile ID
* @param int $id the row id
* @param string $gDBIDX
* @param bool $debug
*
*/
function CLI_PROFILE_ENTRY($clpId=0,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::CLI_PROFILE_ENTRY($clpId)");
if (intval($clpId))
{
$this->myProfile=CLI_PROFILE::getInstance(intval($clpId));
$this->setMyTable($this->myProfile->getEntryTbl());
}
}
/**
* sets the profile object
*
* @param CLI_PROFILE $profile
* @param boolean $debug
*
***/
function setProfileObj(&$profile,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::setProfileObj()");
if (pcf_class_implements($profile,'INFA_CLI_PROFILE'))
{
$this->myProfile=$profile;
if ($this->myTable != $this->myProfile->getEntryTbl()) {
if ($debug) echoDebug(__FILE__,"<blockqoute>CHANGING TABLE</blockqoute>");
$this->myTable=$this->myProfile->getEntryTbl();
$this->init($debug,TRUE);
}
$this->setDBField('CLP_ID',$profile->getId());
}
}
/**
* returns the profle object
* if a new object is created this->myTable is set and $this->init is called
*
* @param boolean $debug
*
* @return CLI_PROFILE
*
***/
function &getProfileObj($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::getProfileObj()");
if (pcf_class_implements($this->myProfile,'INFA_CLI_PROFILE') || ($this->myProfile->getId() != $this->getProfileId()))
{
if ($this->myProfile = CLI_PROFILE::getInstance(intval($this->getProfileId())))
{
if ($this->myProfile->getEntryTbl() != $this->myTable)
{
$this->setMyTable($this->myProfile->getEntryTable,$debug);
}
}
}
return $this->myProfile;
}
/**
* returns the id of the profile
*
* @return int
*
* @since pk-06-10-22
***/
function getProfileId() {
return intval($this->getDBField('CLP_ID'));
}
/**
* @return int
*/
function getId()
{
return intval($this->getDBField('CLP_IDX'));
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// form methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* sets post array with form checks
*
* @param DBMS_FORM $frmObj a formObj as ref
* @param array $dbVal array with data
* @param boolean $debug
* @param boolean $asPopulate
* @param boolean $strict only set columns of $this->myTable and "OBJVALS_".$this->myTable
*
* @returns bool
*
***/
function setFORMPOST(&$frmObj,$dbval,$debug=FALSE,$asPopulate=TRUE,$strict=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::setFORMPOST()");
if (!intval($this->getProfileId())) {
if (isset($dbval['CLP_ID']) && (intval($dbval['CLP_ID']))) {
$this->setDBField('CLP_ID',intval($dbval['CLP_ID']));
} else if (isset($_POST['PFFORM_CLP_ID']) && intval($_POST['PFFORM_CLP_ID'])) {
$this->setDBField('CLP_ID',intval($_POST['PFFORM_CLP_ID']));
}
}
$this->getProfileObj(); // ensure it is set propper and the object is initialized
if ((!pcf_is_instance_of($frmObj,'CLI_PROFILE_FORM')) || (!intval($frmObj->getId()))) {
$o_frmObj=new CLI_PROFILE_FORM($col,$this->getProfileId(),$this->getDBField('CLP_TABLE'));
$o_frmObj->setDBMSValues($frmObj);
$GLOBALS['DBMS_FORMS'][$o_frmObj->getId()]=$o_frmObj;
$frmObj=&$GLOBALS['DBMS_FORMS'][$o_frmObj->getId()];
$frmObj->setProfileObj($this->myProfile);
}
if (!intval($this->myProfile->getId())) {
$frmObj->setError(array('LABEL'=>"Profil",'MSG'=>"Profil konnte nicht ermittelt werden"),'CLP_ID');
return FALSE;
}
// check if the foreign key is set
if (!isset($dbval[$this->myProfile->getKeyColName()]) || !intval($dbval[$this->myProfile->getKeyColName()])) {
if (isset($_POST['PFFORM_FK_VAL']) && intval($_POST['PFFORM_FK_VAL'])) {
$this->setDBField($this->myProfile->getKeyColName(),intval($_POST['PFFORM_FK_VAL']));
$dbval[$this->myProfile->getKeyColName()]=intval($_POST['PFFORM_FK_VAL']);
}
}
return parent::setFORMPOST($frmObj,$dbval,$debug,$asPopulate,$strict);
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// db methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* returns the key array
* an array of all key fields
*
* @param bolean $debug
*
* @returns array
*
* @since pk-05-06-23
*
***/
function getKeyArr($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::getKeyArr()");
$arr_ret=parent::getKeyArr($debug);
if (!isset($arr_ret['CLP_ID']) && isset($this->myFields['CLP_ID']))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"adding key CLP_ID");
$arr_ret['CLP_ID']=array(
'NAME' =>$this->myFields['CLP_ID']['COLNAME'],
'TYPE' =>$this->myFields['CLP_ID']['TYPE'],
'AUTO_INCREMENT' => FALSE
);
}
if (!isset($arr_ret[$this->myProfile->getKeyColName()]) && isset($this->myFields[$this->myProfile->getKeyColName()]))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"adding key ".$this->myProfile->getKeyColName());
$arr_ret[$this->myProfile->getKeyColName()]=array(
'NAME' =>$this->myFields[$this->myProfile->getKeyColName()]['COLNAME'],
'TYPE' =>$this->myFields[$this->myProfile->getKeyColName()]['TYPE'],
'AUTO_INCREMENT' => FALSE
);
}
return $arr_ret;
}
/**
* @param boolean $debug
*
* @return boolean
*
* @since pk-07-10-07
*/
function checkProfileForeignKey($debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::checkProfileForeignKey()");
if (!intval($this->getDBField($this->myProfile->getKeyColName()))) {
if (!intval($this->myProfile->getForeignKey())) {
// the key is not set
if ($debug) ocsp_logError(__FILE__,__LINE__,"KEY: ".$this->myProfile->getKeyColName()." NOT SET",E_ERROR);
return FALSE;
} else {
$this->setDBField($this->myProfile->getKeyColName(),$this->myProfile->getForeignKey());
}
}
return TRUE;
}
/**
* save the Object
*
* @param string $gDBIDX GLOBAL ARRAY INDEX OF DB OBJECT
* @param boolean $debug SHOW DEBUG INFO
*
* @returns mixed
*
***/
function dbSave($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::dbSave()");
if (intval($this->getDBField('CLP_IDX'))) {
// we have an update
return $this->dbReplace($debug);
}
// does we have an insert or update or overwrite of a row
$this->getProfileObj(); // ensure $this->myProfile is set propper
if (!intval($this->myProfile->getId())) {
// no profile set
if ($debug) echo "ERROR: no profile set";
return FALSE;
}
if (!$this->myProfile->isMultiple()) {
$s_query ="SELECT * FROM ".$this->myTable;
$s_query.=" WHERE ".$this->myProfile->getKeyColName()."=".intval($this->getDBField($this->myProfile->getKeyColName()));
if ($this->myProfile->checkProfileIdInEntryQuery()) {
$s_query.=" AND CLP_ID=".$this->myProfile->getId();
}
if ($a_row=$this->myDBObj->quickQuery($s_query)) {
$dbRow=array_merge($a_row,$this->getDBVal());
$this->setDBRow($dbRow,TRUE);
return $this->dbReplace($debug);
}
return $this->dbInsert($debug);
} else {
return $this->dbInsert($debug);
}
}
/**
* inserts a new row to the table
*
* @param string $gDBIDX Index of $GLOBALS to the db object
* @param bool $debug show debug info
*
* @global array $OCSP_OBJ
*
* @returns int returns the autoIncFld ID if exists or 1 on success
*
* @since pk-05-11-30
*
***/
function dbInsert($debug=FALSE) {
global $OCSP_OBJ;
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::dbInsert()");
if (!$this->checkProfileForeignKey($debug)) return FALSE;
$this->setDBField('CLP_CTIME',"CURRENT_TIMESTAMP");
$this->setDBField('CLP_CUSER',$OCSP_OBJ['USER']->getId());
$this->setDBField('CLP_UTIME',"CURRENT_TIMESTAMP");
$this->setDBField('CLP_UUSER',$OCSP_OBJ['USER']->getId());
$this->setDBField('CLP_RADDR',$_SERVER['REMOTE_ADDR']);
$this->setDBField('CLP_HVIA',$_SERVER['HTTP_VIA']);
$this->setDBField('CLP_HX_FORWD',$_SERVER['HTTP_X_FORWARDED_FOR']);
if (!intval($this->getProfileId()) && pcf_is_instance_of($this->myProfile,'CLI_PROFILE')) {
$this->setDBField('CLP_ID',$this->myProfile->getId());
} else if (!intval($this->getProfileId())) {
$this->setError("KEIN PROFIL GESETZT");
return FALSE;
}
return parent::dbInsert($debug);
}
/**
* replaces a row in the table
*
* @param boolean $debug show debug info
* @param boolean $ignorPopulated (if false the table MUST have been populated)
*
* @returns boolean
*
* @since pk-05-11-30
*
***/
function dbReplace($debug=FALSE,$ignorPopulated=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::dbReplace($gDBIDX,$debug)");
if (!$this->checkProfileForeignKey($debug)) return FALSE;
$this->setDBField('CLP_UTIME',"CURRENT_TIMESTAMP");
$this->setDBField('CLP_UUSER',$GLOBALS['USER']->getId());
$this->setDBField('CLP_RADDR',$_SERVER['REMOTE_ADDR']);
$this->setDBField('CLP_HVIA',$_SERVER['HTTP_VIA']);
$this->setDBField('CLP_HX_FORWD',$_SERVER['HTTP_X_FORWARDED_FOR']);
$this->setDBField('CLP_ID',$this->myProfile->getId());
return parent::dbReplace($debug,$ignorPopulated);
}
/**
* deletes the row from the database
*
* @param string $gDBIDX
* @param boolean $backupData
*
* @returns boolean
*
* @since pk-06-10-24
*
***/
function dbDelete($backupData=FALSE,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_PROFILE_ENTRY::dbDelete($gDBIDX,$debug)");
if (!intval($this->getProfileId())) {
if (isset($dbval['CLP_ID']) && (intval($dbval['CLP_ID']))) {
$this->setDBField('CLP_ID',intval($dbval['CLP_ID']));
} else if (isset($_POST['PFFORM_CLP_ID']) && intval($_POST['PFFORM_CLP_ID'])) {
$this->setDBField('CLP_ID',intval($_POST['PFFORM_CLP_ID']));
}
}
$this->getProfileObj(); // ensure it is set propper and the object is initialized
return parent::dbDelete($backupData,$debug);
}
/**
* returns the form
*
* @param int $mode
* @param mixed $form (string) form name (int) form id
* @param boolean $debug
*
* @return CLI_PROFILE_FORM
*
* @requires CLI_PROFILE_FORM.phpclass
*
* @since pk-07-08-16
*
*/
function &getForm($mode=FRM_MODE_READONLY,$form='',$frmClass='CLI_PROFILE_FORM',$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_TABLEOBJ::getForm($mode,$form,$frmClass)");
pcf_require_class('CLI_PROFILE_FORM', dirname(__FILE__) . "/");
if (!$obj_profile=$this->getProfileObj())
{
ocsp_logError(__FILE__,__LINE__,"could not get profile",E_ERROR);
$obj_ret=NULL;
return $obj_ret;
}
if (empty($form))
{
$form=$this->myProfile->getEntryTblFormIdName($mode);
}
$obj_form=parent::getForm($mode,$form,$frmClass,$debug);
if (method_exists($obj_form,'setProfileObj'))
{
$obj_form->setProfileObj($this->myProfile);
}
return $obj_form;
}
}

Source for file CLI_PROFILE_ENTRY.phpclass