File Source for CLI_STAFF

<?php
/**
* Class file CLI_STAFF_TYPE.phpclass
*
* @project Open CSP-Management
* @package client
*
* @author Peter Krebs <p.krebs@wpus.at>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-06-10-02
* @version pk-07-09-18
* @version $Id: CLI_STAFF_TYPE.phpclass,v 1.11 2008/12/02 15:08:57 peterkrebs Exp $
*/
// ---------------------------------------------------------
// requirements
// ---------------------------------------------------------
pcf_require_class('DBMS_TABLEOBJ',"db/");
pcf_require_class('CLI_TYPE',dirname(__FILE__) . "/");
require_once __OCSP_DEFAULTCONFPATH__."client.conf.phpinc";
/**
* Class file CLI_STAFF_TYPE.phpclass
*
* @project Open CSP-Management
* @package client
*
* @author Peter Krebs <p.krebs@wpus.at>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-06-10-02
*
***/
class CLI_STAFF_TYPE extends DBMS_TABLEOBJ {
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
/**
* @constant string CLASS_SRC_FILE
* @since pk-08-02-03
*/
const CLASS_SRC_FILE = __FILE__;
// ---------------------------------------------------------------------------
// class (static)
// ---------------------------------------------------------------------------
/*** class vars ------------------------------------------------------ */
/**
* identity map of loaded types
*
* @var array $loadedTypes
*/
static protected $loadedCliStaffTypes = array();
/*** class methods --------------------------------------------------- */
/**
* returns a type out of self::$loadedCliStaffTypes
*
* @param int $aId
* @param boolean $debug
*
* @return CLI_STAFF_TYPE
*/
public static function &getInstance($aId,$debug=False)
{
$aId = intval($aId);
if ($debug) echoDebugMethod(__FILE__,"static","CLI_STAFF_TYPE::getInstance({$aId}");
if (isset(self::$loadedCliStaffTypes[$aId]) && pcf_is_instance_of(self::$loadedCliStaffTypes[$aId],'CLI_STAFF_TYPE'))
{
return self::$loadedCliStaffTypes[$aId];
}
self::$loadedCliStaffTypes[$aId] = self::factoryFromId($aId,$debug);
return self::$loadedCliStaffTypes[$aId];
}
// ---------------------------------------------------------------------------
// object vars
// ---------------------------------------------------------------------------
/*** compostion --------------------------------------------------- */
/*** attributes -------------------------------------------------- */
/**
* source file of the class
*
* @staticvar string $classSrcFile
* @since pk-07-09-17
* @deprecated
***/
protected $classSrcFile=__FILE__;
/**
* @staticvar string $myTable name of the db table
*/
var $myTable="T_CLI_STAFF_TYPE";
/**
* @var CLI_TYPE $myClientType
*
* @deprecated since pk-08-11-20 use $this->getClientTypeObj
*/
var $myClientType=NULL;
// ---------------------------------------------------------------------------
// factory / construct
// ---------------------------------------------------------------------------
/**
* factories a type object from the id
*
* @param int $aId
* @param boolean $debug
*
* @return CLI_STAFF_TYPE
*/
public static function factoryFromId($aId,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"static","CLI_STAFF_TYPE::factoryFromId({$aId}");
$obj_ret = new CLI_STAFF_TYPE();
$obj_ret->setId(intval($aId));
$obj_ret->dbPopulate($debug);
return $obj_ret;
}
/**
* init the object and populate if an id is submitted
*
* @param int $cliId CLI_ID
* @param int $cstId
* @param string $gDBIdx
* @param bool $debug
*
* @deprecated since pk-08-07-30
*/
function CLI_STAFF_TYPE($csttId=0,$ctyId=0,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::CLI_STAFF_TYPE($csttId,$ctyId,$debug)");
$this->init($debug);
if (intval($csttId)) {
$this->setId($csttId);
$this->dbPopulate($debug);
} else {
$this->setDefaults();
$this->setCtyId(intval($ctyId));
}
}
/**
* returns the id
* @return int
***/
function getId() {
return intval($this->getDBField('CSTTYPE_ID'));
}
/**
* sets the id
* @param int $aId
***/
function setId($aId) {
$this->setDBField('CSTTYPE_ID',intval($aId));
}
/**
* returns the name of the staff
* @return string
***/
function getName() {
$s_ret=$this->getDBField('CSTTYPE_NAME');
return (empty($s_ret) ? "Mitarbeiter" : $s_ret);
}
/**
* @return boolean
***/
function hasLogin() {
if (intval($this->getId())) {
return (intval($this->getDBField('CSTTYPE_HASLOGIN')) ? TRUE : FALSE);
}
return TRUE;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// profiles
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* @return boolean
***/
function hasProfiles() {
if (intval($this->getId())) {
return (intval($this->getDBField('CSTTYPE_HASPROFILES')) ? TRUE : FALSE);
}
return TRUE;
}
/**
* returns an Array with profiles available for the staff type
*
* @param boolean $strict
* @param boolean $debug
*
* @return array
*
* @requires CLI_PROFILE.phpclass
*
* @since pk-08-01-24
*/
function getAvailAbleProfiles($strict=FALSE,$debug=TRUE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::getAvailAbleProfiles()");
pcf_require_class('CLI_PROFILE',"client/");
$arr_ret=NULL;
$arr_filter=array();
$arr_filter['CLP_KEYTABLE']="T_CLI_STAFF";
$arr_filter['?CTY_ID']="(CTY_ID=0 OR CTY_ID=".$this->getCtyId().")";
if ($strict)
{
$arr_filter['CSTTYPE_ID']=$this->getId();
} else {
$arr_filter['?CSTTYPE_ID']="(CSTTYPE_ID = 0 OR CSTTYPE_ID=".$this->getId().")";
}
if ($arr_pfRows=OCSP_OBJ::defaultReadDBObj()->getArray("T_CLI_PROFILES",$arr_filter,0,0,"CLP_SORTORDER,CLP_TITLE",$debug))
{
foreach($arr_pfRows as $arr_row)
{
$arr_ret[$arr_row['CLP_ID']]=new CLI_PROFILE();
$arr_ret[$arr_row['CLP_ID']]->setDBRow($arr_row);
}
}
return $arr_ret;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// clienttype methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* @return int
***/
function getCtyId() {
return intval($this->getDBField('CTY_ID'));
}
/**
* @param int $aTypId
***/
function setCtyId($aTypId) {
$this->setDBField('CTY_ID',intval($aTypId));
}
/**
* @return CLI_TYPE
***/
function &getClientTypeObj() {
$this->myClientType=CLI_TYPE::getInstance($this->getCtyId());
$this->setCtyId($this->myClientType->getId());
return $this->myClientType;
}
/**
* @param CLI_TYPE $aTypeObj
***/
function setClientTypeObj(&$aTypeObj) {
if (pcf_is_instance_of($aTypeObj,"CLI_TYPE")) {
$this->setCtyId($aTypeObj->getId());
}
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// staff methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* factory a staff object if (!intval($this->getId()) the default type of $client is used)
*
* @param mixed $client (CLIENT object or client id)
* @param int $cstId
* @param boolean $debug
*
* @return CLI_STAFF
*
*/
public function factoryStaff($client,$cstId=0,$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::factoryStaff();");
if (!$this->getId())
{
if (pcf_is_instance_of($client,'CLIENT'))
{
$this->setCtyId($client->getTypeId());
} else if (intval($client)) {
$client = CLIENT::factoryFromId(intval($client));
$this->setCtyId($client->getTypeId());
} else {
$client = new CLIENT();
}
if (intval($this->getCtyId()))
{
if (!$this->isConnected(TRUE,$debug))
{
return NULL;
}
$str_query = "SELECT * FROM " . $this->myTable;
$str_query .= " WHERE (CTY_ID=" . $this->getCtyId() . " OR CTY_ID=0)";
$str_query .= " ORDER BY CTY_ID DESC,CTY_SORTORDER";
if ($arr_row = $this->myDBObj->quickQuery($str_query))
{
$this->setDBRow($arr_row,TRUE,$debug);
}
}
}
$str_className = $this->getCstClassName($debug);
$str_cmd = "\$obj_staff = new $str_className(\$client," . intval($cstId) . ",\$debug);";
eval ($str_cmd);
$obj_staff->setTypeObj($this);
return $obj_staff;
}
public function factoryStaffFromRow($staffRow,$debug = FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::factoryStaffFromRow();");
$staffRow['CSTTYPE_ID'] = $this->getId();
$str_className = $this->getCstClassName($debug);
$str_cmd = "\$obj_staff = new $str_className();";
eval ($str_cmd);
$obj_staff->setTypeObj($this);
$obj_staff->setDBRow($staffRow,TRUE);
return $obj_staff;
}
/**
* includes the client class source file
*
* @param boolean $debug
* @global array $OCSP_CONF
*
* @return boolean
*
***/
function incCstClassSource($debug=FALSE)
{
global $OCSP_CONF;
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::incCstClassSource()");
if (!class_exists("CLI_STAFF")) require_once dirname(__FILE__)._OCSP_DIRSEP_."CLI_STAFF.phpclass";
$s_Src=$this->getDBField('CSTTYPE_CLASS_SRC');
if (empty($s_Src)) {
$s_Src=__OCSP_PHPINCPATH__."client"._OCSP_DIRSEP_."CLI_STAFF.phpclass";
} else {
$s_Src=$OCSP_CONF['PROJECTPATH'].$s_Src;
}
if ($debug) echoDebug(__FILE__,"Source: ".$s_Src);
if (file_exists($s_Src)) {
require_once $s_Src;
return TRUE;
} else {
return FALSE;
}
}
/**
* returns the class name of the client object defined by the type
* and ensures the class exists
*
* @param boolean $debug
*
* @return string
*
***/
function getCstClassName($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::getCliClassName()");
$s_className=$this->getDBField('CSTTYPE_CLASS');
if (empty($s_className)) {
$s_className="CLI_STAFF";
}
if (!class_exists($s_className)) {
$this->incCstClassSource($debug);
}
$s_className=(class_exists($s_className) ? $s_className : "CLI_STAFF");
if ($debug) echoDebug(__FILE__,"Returning: ".$s_className."");
return $s_className;
}
/**
* generates a new client object with this type
*
* @param array $cstRow
* @param boolean $debug
*
* @return CLI_STAFF or an instance of it
*
***/
function &getCstObjectFromArray($cstRow,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::getCstObjectFromArray()");
$s_className=$this->getCstClassName($debug);
$s_cmd="\$o_staff=new ".$s_className."();";
if ($debug) echoDebug(__FILE__,"<blockquote>".$s_cmd."</blockquote>");
eval($s_cmd);
if (!pcf_is_instance_of($o_staff,"CLI_STAFF")) {
$o_staff=new CLI_STAFF();
}
$o_staff->setDBRow($cstRow,((intval($cstRow['CLI_ID']) && intval($cstRow['CST_ID'])) ? TRUE:FALSE),$debug);
$o_staff->setTypeObj($this);
return $o_staff;
}
// ------------------------------------------------------
// DBMS_FORM methods
// ------------------------------------------------------
/**
* returns the admin form
*
* @param boolean $useTblDefault if true and not set CSTTYPE_FRM_ADMIN the default form for T_CLI_STAFF is returned else NULL
* @param boolean $debug
*
* @return CLI_FORM
*
* @requires CLI_FORM
*
* @version pk-07-10-10
*
***/
function &getAdminForm($useTblDefault=TRUE,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::getAdminForm()");
pcf_require_class('CLI_STAFF_FORM',"client/");
$obj_form=NULL;
if (intval($this->getDBField('CSTTYPE_FRM_ADMIN')))
{
if ($obj_form=OCSP_FORM::factory_from_id(intval($this->getDBField('CSTTYPE_FRM_ADMIN')),'CLI_STAFF_FORM',$debug))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"return form ".$obj_form->getName());
return $obj_form;
}
}
if (!pcf_is_instance_of($obj_form,"OCSP_FORM")) {
if ($useTblDefault) {
return OCSP_FORM::factory_from_name('T_CLI_STAFF','CLI_STAFF_FORM',$debug);
} else {
$o_ret=NULL; // as we return a pointer
return $o_ret;
}
} else {
return $obj_form;
}
}
/**
* returns the form used to handele values in T_CLI_USER AND T_SYS_USER
* if no form id is set the default form for T_SYS_USER is returned
*
*
* @param boolean $debug
*
* @return DBMS_FORM
*
* @since pk-06-10-04
*
***/
function &getCliUserForm($mode=FRM_MODE_EDIT,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::getCliUserForm()");
$o_frmObj=NULL;
if ($i_frmId=intval($this->getDBField('CSTTYPE_FRM_CLI_USER'))) {
$o_frmObj=&DBMS_form_loadId($i_frmId,$debug);
}
if (pcf_is_instance_of($o_frmObj,"DBMS_FORM")) {
return $o_frmObj;
} else {
return DBMS_form_loadName("T_SYS_USER");
}
}
/**
* returns the list form
*
* @param boolean $debug
*
* @return CLI_STAFF_FORM
*
* @since pk-08-12-02
*/
public function &getListForm($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::getListForm()");
return $this->getAdminForm(True,$debug);
}
// ------------------------------------------------------
// rights
// ------------------------------------------------------
/**
* returns if the current user can show staffs of this type
*
* @param boolean $debug
*
* @return boolean
* @since pk-06-10-26
*
***/
function userCanShowStaff($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::userCanShowStaff()");
if (OCSP_OBJ::currentUser()->isGroupMember(_OCSP_GROUP_CLIADMIN_)) return TRUE;
if (OCSP_OBJ::currentUser()->isGroupMember($this->getDBField('CSTTYPE_SHOWGROUP'))) return TRUE;
if (OCSP_OBJ::currentUser()->isGroupMember($this->getDBField('CSTTYPE_EDITGROUP'))) return TRUE;
if (OCSP_OBJ::currentUser()->isGroupMember($this->getDBField('CSTTYPE_ADMINGROUP'))) return TRUE;
return $this->getClientTypeObj()->userCanShowClients($debug);
}
/**
* returns if the current user can edit staffs of this type
*
* @param boolean $debug
*
* @return boolean
* @since pk-06-10-26
*
***/
function userCanEditStaff($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::userCanEditStaff()");
if (OCSP_OBJ::currentUser()->isGroupMember(_OCSP_GROUP_CLIADMIN_)) return TRUE;
if (OCSP_OBJ::currentUser()->isGroupMember($this->getDBField('CSTTYPE_EDITGROUP'))) return TRUE;
if (OCSP_OBJ::currentUser()->isGroupMember($this->getDBField('CSTTYPE_ADMINGROUP'))) return TRUE;
return $this->getClientTypeObj()->userCanEditClients($debug);
}
/**
* returns if the current user can delete clients of this type
*
* @param boolean $debug
*
* @return boolean
* @since pk-06-10-26
*
***/
function userCanDeleteStaff($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CLI_STAFF_TYPE::userCanDeleteStaff()");
if (OCSP_OBJ::currentUser()->isGroupMember(_OCSP_GROUP_CLIADMIN_)) return TRUE;
if (OCSP_OBJ::currentUser()->isGroupMember($this->getDBField('CSTTYPE_ADMINGROUP'))) return TRUE;
return $this->getClientTypeObj()->userCanDeleteClients($debug);
}
/**
* return if a user can edit his own client data
*
* @param boolean $debug
*
* @return boolean
*
* @since pk-06-10-26
*
***/
function userCanSelfEdit($debug=FALSE) {
if (intval($this->getDBField('CSTTYPE_SELFEDIT'))) return TRUE;
return (intval($this->getId()) ? FALSE : TRUE); // for systems not using CLI_STAFF_TYPEs
}
}
?>

Source for file CLI_STAFF_TYPE.phpclass