Class CLI_TYPE

Description

Class file CLI_TYPE.phpclass

  • author: Peter Krebs <p.krebs@wpus.at>
  • version: $Id: CLI_TYPE.phpclass,v 1.12 2008/12/02 15:08:57 peterkrebs Exp $
  • since: pk-06-10-02
  • project: Open CSP-Management
  • license: GNU Public License

Located in /client/CLI_TYPE.phpclass (line 42)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --CLI_TYPE
Class Constant Summary
 CLASS_SRC_FILE = __FILE__
Variable Summary
 static mixed $clientTypeLst
 static mixed $loadedCliTypes
 mixed $myTable
Method Summary
 static void factoryFromId ( $aId)
 static CLI_TYPE &getInstance (int $aId, [boolean $debug = False])
 static array getInstanceList ([ $filter = Null], [ $debug = False])
 CLI_TYPE CLI_TYPE ([ $ctyId = 0], [bool $debug = False], int $cliId, int $cstId)
 CLIENT &factoryClientFromId (int $aId, [boolean $debug = False])
 void &getAddressForm ()
 CLI_FORM &getAdminForm ([boolean $frmMode = FRM_MODE_READONLY], [boolean $debug = False])
 string getCliClassName ([boolean $debug = False])
 CLIENT getCliObjectFromArray (array $cliRow, boolean $debug)
 DBMS_FORM &getCliUserForm ([boolean $debug = False])
 CLI_STAFF_TYPE getDefaultStaffType ([boolean $debug = False])
 int getId ()
 array() getInterestNodes ([boolean $debug = False])
 string getName ()
 CLI_FORM &getStaffLstForm ([boolean $frmMode = FRM_MODE_LIST], [boolean $debug = False])
 void getStaffType ([int $typeId = 0], [boolean $debug = False])
 CLI_FORM &getUserForm ([boolean $frmMode = FRM_MODE_READONLY], [boolean $debug = False])
 boolean hasProfiles ([boolean $doDBCheck = False], [boolean $debug = False])
 boolean hasStaff ()
 boolean incCliClassSource ([boolean $debug = False])
 void setFormTblObj ( &$frmObj, [boolean $debug = False], CLI_FORM $frmObj)
 void setId (int $aId)
 boolean userCanDeleteClients (boolean $debug)
 boolean userCanEditClients ([boolean $debug = False])
 boolean userCanSelfEdit ([boolean $debug = False])
 boolean userCanShowClients ([boolean $debug = False])
 boolean userIsAdmin ([boolean $debug = False])
Variables
Methods
static factoryFromId (line 138)
  • access: public
void factoryFromId ( $aId)
  • $aId
static getInstance (line 78)

returns an instance out of the identity map

  • access: public
CLI_TYPE &getInstance (int $aId, [boolean $debug = False])
  • int $aId
  • boolean $debug
static getInstanceList (line 96)

returns an array with all instances

  • access: public
array getInstanceList ([ $filter = Null], [ $debug = False])
  • $filter
  • $debug
Constructor CLI_TYPE (line 157)

init the object and populate if an id is submitted

  • version: pk-07-08-29
CLI_TYPE CLI_TYPE ([ $ctyId = 0], [bool $debug = False], int $cliId, int $cstId)
  • int $cliId: CLI_ID
  • int $cstId
  • bool $debug
  • $ctyId
factoryClientFromId (line 349)

factories a client from an id

  • access: public
CLIENT &factoryClientFromId (int $aId, [boolean $debug = False])
  • int $aId
  • boolean $debug
getAddressForm (line 722)
  • access: public
void &getAddressForm ()
getAddressFormId (line 710)

returns the address form id

  • since: pk-08-11-29
  • access: public
int getAddressFormId ()
getAdminForm (line 651)

returns the form used in admin section

  • since: pk-06-10-25
CLI_FORM &getAdminForm ([boolean $frmMode = FRM_MODE_READONLY], [boolean $debug = False])
  • boolean $frmMode
  • boolean $debug
getCliClassName (line 300)

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

string getCliClassName ([boolean $debug = False])
  • boolean $debug
getClientTableName (line 201)

in future it is planed to be able to split the clients into more than one table

therefore the type must know wher to search

  • access: public
void getClientTableName ()
getCliObjectFromArray (line 324)

generates a new client object with this type

  • return: or an instance of it
CLIENT getCliObjectFromArray (array $cliRow, boolean $debug)
  • array $cliRow
  • boolean $debug
getCliUserForm (line 798)

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-24
DBMS_FORM &getCliUserForm ([boolean $debug = False])
  • boolean $debug
getDefaultStaffType (line 413)

returns the first staff type in T_CLI_STAFF_TYPE fits for this type by using the query:

  1. SELECT FROM T_CLI_STAFF_TYPE WHERE CTY_ID IN($this->getId(),0ORDER BY CTY_ID DESC,CSTTYPE_SORTORDER
;

CLI_STAFF_TYPE getDefaultStaffType ([boolean $debug = False])
  • boolean $debug
getId (line 173)

returns the id

int getId ()
getInterestNodes (line 466)

returns the interests for available

  • access: public
array() getInterestNodes ([boolean $debug = False])
  • boolean $debug
getName (line 189)

returns the name of the staff

string getName ()
getStaffLstForm (line 748)

returns the form used in admin section

  • since: pk-06-10-25
CLI_FORM &getStaffLstForm ([boolean $frmMode = FRM_MODE_LIST], [boolean $debug = False])
  • boolean $frmMode
  • boolean $debug
getStaffType (line 445)

returns a staff type if $typeId is 0 $this->getDefaultStaffType is returned

void getStaffType ([int $typeId = 0], [boolean $debug = False])
  • int $typeId
  • boolean $debug
getUserForm (line 682)

returns the form used in admin section

  • since: pk-06-10-25
CLI_FORM &getUserForm ([boolean $frmMode = FRM_MODE_READONLY], [boolean $debug = False])
  • boolean $frmMode
  • boolean $debug
hasProfiles (line 214)

returns if the type has profiles enabled

boolean hasProfiles ([boolean $doDBCheck = False], [boolean $debug = False])
  • boolean $doDBCheck: check if there are also profiles defined in the databas
  • boolean $debug
hasStaff (line 393)

returns if the client type has staffs enabled

  • since: pk-07-09-18
  • access: public
boolean hasStaff ()
incCliClassSource (line 253)

includes the client class source file

boolean incCliClassSource ([boolean $debug = False])
  • boolean $debug
setFormTblObj (line 624)

sets the forms DBMS_TABLEOBJ

  • since: pk-07-01-15
void setFormTblObj ( &$frmObj, [boolean $debug = False], CLI_FORM $frmObj)
  • CLI_FORM $frmObj
  • boolean $debug
  • &$frmObj
setId (line 181)

sets the id

void setId (int $aId)
  • int $aId
userCanDeleteClients (line 553)

returns if the current user can delete clients of this type

  • version: pk-07-01-11
  • since: pk-06-10-02
boolean userCanDeleteClients (boolean $debug)
  • boolean $debug
userCanEditClients (line 527)

returns if the current user can edit clients of this type

  • since: pk-06-10-02
boolean userCanEditClients ([boolean $debug = False])
  • boolean $debug
userCanSelfEdit (line 606)

return if a user can edit his own client data

  • since: pk-06-10-02
boolean userCanSelfEdit ([boolean $debug = False])
  • boolean $debug
userCanShowClients (line 506)

returns if the current user can show clients of this type

  • since: pk-06-10-02
boolean userCanShowClients ([boolean $debug = False])
  • boolean $debug
userIsAdmin (line 576)

returns if the current user can delete clients of this type

  • version: pk-07-01-11
  • since: pk-06-10-02
boolean userIsAdmin ([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 53)
  • since: pk-08-02-04

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:29 +0100 by phpDocumentor 1.4.0a2