Class CLI_STAFF_TYPE

Description

Class file CLI_STAFF_TYPE.phpclass

  • author: Peter Krebs <p.krebs@wpus.at>
  • version: $Id: DBMS_TABLEOBJ.phpclass,v 1.60 2008/12/17 16:28:52 peterkrebs Exp $
  • version: pk-05-11-17
  • version: pk-04-01-02
  • version: pk-08-01-31
  • since: pk-06-10-02
  • project: Open CSP-Management
  • license: GNU Public License

Located in /client/CLI_STAFF_TYPE.phpclass (line 37)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --CLI_STAFF_TYPE
Class Constant Summary
 CLASS_SRC_FILE = __FILE__
Variable Summary
Method Summary
 static CLI_STAFF_TYPE factoryFromId (int $aId, [boolean $debug = False])
 static CLI_STAFF_TYPE &getInstance (int $aId, [boolean $debug = False])
 CLI_STAFF_TYPE CLI_STAFF_TYPE ([ $csttId = 0], [ $ctyId = 0], [bool $debug = FALSE], int $cliId, int $cstId, string $gDBIdx)
 CLI_STAFF factoryStaff (mixed $client, [int $cstId = 0], [boolean $debug = FALSE])
 void factoryStaffFromRow ( $staffRow, [ $debug = FALSE])
 CLI_FORM &getAdminForm ([boolean $useTblDefault = TRUE], [boolean $debug = FALSE])
 array getAvailAbleProfiles ([boolean $strict = FALSE], [boolean $debug = TRUE])
 DBMS_FORM &getCliUserForm ([ $mode = FRM_MODE_EDIT], [boolean $debug = FALSE])
 string getCstClassName ([boolean $debug = FALSE])
 CLI_STAFF &getCstObjectFromArray (array $cstRow, [boolean $debug = FALSE])
 int getCtyId ()
 int getId ()
 CLI_STAFF_FORM &getListForm ([boolean $debug = False])
 string getName ()
 boolean hasLogin ()
 boolean hasProfiles ()
 void incCstClassSource ([ $debug = FALSE])
 void setClientTypeObj ( &$aTypeObj, CLI_TYPE $aTypeObj)
 void setCtyId (int $aTypId)
 void setId (int $aId)
 boolean userCanDeleteStaff ([boolean $debug = FALSE])
 boolean userCanEditStaff ([boolean $debug = FALSE])
 boolean userCanSelfEdit ([boolean $debug = FALSE])
 boolean userCanShowStaff ([boolean $debug = FALSE])
Variables
static array $loadedCliStaffTypes = array() (line 60)

identity map of loaded types

  • access: protected
mixed $classSrcFile = __FILE__ (line 103)

source file of the class

  • staticvar: string $classSrcFile:
  • deprecated:
  • since: pk-07-09-17
  • access: protected
CLI_TYPE $myClientType = NULL (line 115)
  • deprecated: since pk-08-11-20 use $this->getClientTypeObj
mixed $myTable = "T_CLI_STAFF_TYPE" (line 108)
  • staticvar: string $myTable: name of the db table

Redefinition of:
DBMS_TABLEOBJ::$myTable
NOT FINAL !!!!!

Inherited Variables

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::$autoIncFld
DBMS_TABLEOBJ::$dbTableDefinitions
DBMS_TABLEOBJ::$frmPostSubOjects
DBMS_TABLEOBJ::$hasObjVals
DBMS_TABLEOBJ::$initTS
DBMS_TABLEOBJ::$myCacheTS
DBMS_TABLEOBJ::$myFields
DBMS_TABLEOBJ::$myKeys
DBMS_TABLEOBJ::$myLinkedTableRows
DBMS_TABLEOBJ::$myMode
DBMS_TABLEOBJ::$myObjVals
DBMS_TABLEOBJ::$myObjValsPopulateTS
DBMS_TABLEOBJ::$objError
DBMS_TABLEOBJ::$objErrorMsg
DBMS_TABLEOBJ::$populateTS
DBMS_TABLEOBJ::$staticClassVars
DBMS_TABLEOBJ::$valChangeTS

Inherited from OCSP_OBJ

OCSP_OBJ::$global_currentUser
OCSP_OBJ::$global_defaultDBObj_read
OCSP_OBJ::$global_defaultDBObj_write
OCSP_OBJ::$myDBObj
Methods
static factoryFromId (line 132)

factories a type object from the id

  • access: public
CLI_STAFF_TYPE factoryFromId (int $aId, [boolean $debug = False])
  • int $aId
  • boolean $debug
static getInstance (line 72)

returns a type out of self::$loadedCliStaffTypes

  • access: public
CLI_STAFF_TYPE &getInstance (int $aId, [boolean $debug = False])
  • int $aId
  • boolean $debug
Constructor CLI_STAFF_TYPE (line 153)

init the object and populate if an id is submitted

  • deprecated: since pk-08-07-30
CLI_STAFF_TYPE CLI_STAFF_TYPE ([ $csttId = 0], [ $ctyId = 0], [bool $debug = FALSE], int $cliId, int $cstId, string $gDBIdx)
  • int $cliId: CLI_ID
  • int $cstId
  • string $gDBIdx
  • bool $debug
  • $csttId
  • $ctyId
factoryStaff (line 309)

factory a staff object if (!intval($this->getId()) the default type of $client is used)

  • access: public
CLI_STAFF factoryStaff (mixed $client, [int $cstId = 0], [boolean $debug = FALSE])
  • mixed $client: (CLIENT object or client id)
  • int $cstId
  • boolean $debug
factoryStaffFromRow (line 351)
  • access: public
void factoryStaffFromRow ( $staffRow, [ $debug = FALSE])
  • $staffRow
  • $debug
getAdminForm (line 465)

returns the admin form

  • version: pk-07-10-10
  • requires: CLI_FORM
CLI_FORM &getAdminForm ([boolean $useTblDefault = TRUE], [boolean $debug = FALSE])
  • boolean $useTblDefault: if true and not set CSTTYPE_FRM_ADMIN the default form for T_CLI_STAFF is returned else NULL
  • boolean $debug
getAvailAbleProfiles (line 226)

returns an Array with profiles available for the staff type

  • since: pk-08-01-24
  • requires: CLI_PROFILE.phpclass
array getAvailAbleProfiles ([boolean $strict = FALSE], [boolean $debug = TRUE])
  • boolean $strict
  • boolean $debug
getClientTypeObj (line 280)
CLI_TYPE &getClientTypeObj ()
getCliUserForm (line 505)

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

  • since: pk-06-10-04
DBMS_FORM &getCliUserForm ([ $mode = FRM_MODE_EDIT], [boolean $debug = FALSE])
  • boolean $debug
  • $mode
getCstClassName (line 406)

returns the class name of the client object defined by the type and ensures the class exists

string getCstClassName ([boolean $debug = FALSE])
  • boolean $debug
getCstObjectFromArray (line 432)

generates a new client object with this type

  • return: or an instance of it
CLI_STAFF &getCstObjectFromArray (array $cstRow, [boolean $debug = FALSE])
  • array $cstRow
  • boolean $debug
getCtyId (line 266)
int getCtyId ()
getId (line 169)

returns the id

int getId ()
getListForm (line 528)

returns the list form

  • since: pk-08-12-02
  • access: public
CLI_STAFF_FORM &getListForm ([boolean $debug = False])
  • boolean $debug
getName (line 185)

returns the name of the staff

string getName ()
hasLogin (line 193)
boolean hasLogin ()
hasProfiles (line 207)
boolean hasProfiles ()
incCstClassSource (line 374)
void incCstClassSource ([ $debug = FALSE])
  • $debug
setClientTypeObj (line 289)
void setClientTypeObj ( &$aTypeObj, CLI_TYPE $aTypeObj)
setCtyId (line 273)
void setCtyId (int $aTypId)
  • int $aTypId
setId (line 177)

sets the id

void setId (int $aId)
  • int $aId
userCanDeleteStaff (line 586)

returns if the current user can delete clients of this type

  • since: pk-06-10-26
boolean userCanDeleteStaff ([boolean $debug = FALSE])
  • boolean $debug
userCanEditStaff (line 567)

returns if the current user can edit staffs of this type

  • since: pk-06-10-26
boolean userCanEditStaff ([boolean $debug = FALSE])
  • boolean $debug
userCanSelfEdit (line 605)

return if a user can edit his own client data

  • since: pk-06-10-26
boolean userCanSelfEdit ([boolean $debug = FALSE])
  • boolean $debug
userCanShowStaff (line 547)

returns if the current user can show staffs of this type

  • since: pk-06-10-26
boolean userCanShowStaff ([boolean $debug = FALSE])
  • boolean $debug

Inherited Methods

Inherited From DBMS_TABLEOBJ

 DBMS_TABLEOBJ::DBMS_TABLEOBJ()
 DBMS_TABLEOBJ::cacheRestore()
 DBMS_TABLEOBJ::cacheWriteTo()
 DBMS_TABLEOBJ::clearErrors()
 DBMS_TABLEOBJ::dbDelete()
 DBMS_TABLEOBJ::dbGetDataArray()
 DBMS_TABLEOBJ::dbGetForm()
 DBMS_TABLEOBJ::dbInsert()
 DBMS_TABLEOBJ::dbPopulate()
 DBMS_TABLEOBJ::dbReplace()
 DBMS_TABLEOBJ::dbSave()
 DBMS_TABLEOBJ::db_SetKey()
 DBMS_TABLEOBJ::db_SetKeyArray()
 DBMS_TABLEOBJ::getClassInclude()
 DBMS_TABLEOBJ::getDbDesc()
 DBMS_TABLEOBJ::getDBField()
 DBMS_TABLEOBJ::getDBRow()
 DBMS_TABLEOBJ::getDBVal()
 DBMS_TABLEOBJ::getDefaults()
 DBMS_TABLEOBJ::getErrorMsg()
 DBMS_TABLEOBJ::getFieldDBDefault()
 DBMS_TABLEOBJ::getForm()
 DBMS_TABLEOBJ::getFormClassName()
 DBMS_TABLEOBJ::getFormName()
 DBMS_TABLEOBJ::getJSON()
 DBMS_TABLEOBJ::getKeyArr()
 DBMS_TABLEOBJ::getMyTable()
 DBMS_TABLEOBJ::getObjValArray()
 DBMS_TABLEOBJ::getObjValValue()
 DBMS_TABLEOBJ::getPopulateTs()
 DBMS_TABLEOBJ::getWhere()
 DBMS_TABLEOBJ::hasChanged()
 DBMS_TABLEOBJ::hasColumn()
 DBMS_TABLEOBJ::hasErrors()
 DBMS_TABLEOBJ::hasObjVals()
 DBMS_TABLEOBJ::init()
 DBMS_TABLEOBJ::isInit()
 DBMS_TABLEOBJ::isPopulated()
 DBMS_TABLEOBJ::keysAreSet()
 DBMS_TABLEOBJ::populateFromKeys()
 DBMS_TABLEOBJ::populateFromValues()
 DBMS_TABLEOBJ::populateObjVals()
 DBMS_TABLEOBJ::p_cacheIsExpired()
 DBMS_TABLEOBJ::saveLinkedRow()
 DBMS_TABLEOBJ::saveLinkedTableRows()
 DBMS_TABLEOBJ::saveObjVals()
 DBMS_TABLEOBJ::setChanged()
 DBMS_TABLEOBJ::setDBField()
 DBMS_TABLEOBJ::setDBFieldIfDiff()
 DBMS_TABLEOBJ::setDBFieldIfEmpty()
 DBMS_TABLEOBJ::setDBRow()
 DBMS_TABLEOBJ::setDBVal()
 DBMS_TABLEOBJ::setDefaults()
 DBMS_TABLEOBJ::setError()
 DBMS_TABLEOBJ::setLinkedTableRow()
 DBMS_TABLEOBJ::setMyTable()
 DBMS_TABLEOBJ::setObjValArray()
 DBMS_TABLEOBJ::setObjValValue()
 DBMS_TABLEOBJ::setObjVarIfEmpty()
 DBMS_TABLEOBJ::setUnChanged()
 DBMS_TABLEOBJ::userIsAllowed()
 DBMS_TABLEOBJ::writeDebugInfo()
 DBMS_TABLEOBJ::xmladdDOMElement()
 DBMS_TABLEOBJ::xmlExport()
 DBMS_TABLEOBJ::_getCacheFileName()
 DBMS_TABLEOBJ::_getDBFields()

Inherited From OCSP_OBJ

 OCSP_OBJ::castObj()
 OCSP_OBJ::cloneMe()
 OCSP_OBJ::currentUser()
 OCSP_OBJ::dbConnect()
 OCSP_OBJ::defaultDBObj()
 OCSP_OBJ::defaultReadDBObj()
 OCSP_OBJ::defaultWriteDBObj()
 OCSP_OBJ::getConf()
 OCSP_OBJ::getDBObj()
 OCSP_OBJ::get_myClassConstant()
 OCSP_OBJ::get_myObject_vars()
 OCSP_OBJ::get_mySourceFile()
 OCSP_OBJ::isConnected()
 OCSP_OBJ::isMultiByteStr()
 OCSP_OBJ::isUTF8()
 OCSP_OBJ::setConf()
 OCSP_OBJ::setDBObj()
 OCSP_OBJ::set_myObject_vars()
 OCSP_OBJ::set_myVarsFrom()
Class Constants
CLASS_SRC_FILE = __FILE__ (line 47)
  • since: pk-08-02-03

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE

Documentation generated on Thu, 08 Jan 2009 17:38:23 +0100 by phpDocumentor 1.4.0a2