openCSP class OCSP_MOD_CONF

• author: Peter Krebs <pitlinz@users.sourceforge.net>
• version: $Id: OCSP_MOD_CONF.phpclass,v 1.2 2008/10/30 07:35:28 pitlinz Exp $
• deprecated: since pk-08-10-28
• project: Open CSP-Management
• since: pk-17.03.2008
• license: GNU Public License

Located in /modules/OCSP_MOD_CONF.phpclass (line 50)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --OCSP_MOD_CONF

static array $modules = array() (line 68)

array of configured modules

• access: private

static mixed $settingTbl = "T_MOD_SETTINGS" (line 75)

name of the table the settings are stored

• staticvar: string $settingTbl:
• access: private

array $mySettings = array() (line 93)

array of conf settings

• access: protected

string $myTable = "T_MOD_MODULES" (line 86)

table name

• access: protected

---

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

static getCachePath (line 104)

returns the modul cache path

• access: public

string getCachePath ()

static getConfObj (line 213)

returns a module configuration

• access: public

mixed getConfObj (string $modName, [boolean $debug = false])

• string $modName
• boolean $debug

static installModule (line 142)

• access: public

void installModule ( $modName, [ $debug = false])

• $modName
• $debug

static loadModule (line 110)

• access: public

void loadModule ( $modName, [ $debug = false])

• $modName
• $debug

static registerCachedModules (line 171)

register all modules cached in self::getCachePath()

• access: public

void registerCachedModules ([boolean $debug = false])

• boolean $debug

static registerModule (line 195)

register a module

• access: public

OCSP_MOD_CONF registerModule (string $modName, [boolean $debug = false])

• string $modName
• boolean $debug

Constructor __construct (line 232)

* constructor -----------------------------------------------

• access: protected

OCSP_MOD_CONF __construct ( $modName)

• $modName

Destructor __destruct (line 270)

cache the module

• todo: write to cache
• access: public

void __destruct ()

addHook (line 575)

• access: public

void addHook ( $system,  $part,  $cmd,  $className)

• $system
• $part
• $cmd
• $className

dbInsert (line 447)

inserts the module with settings and hooks

int dbInsert ([boolean $debug = false])

• boolean $debug

---

Redefinition of:

DBMS_TABLEOBJ::dbInsert()

inserts a new row to the table

dbPopulate (line 405)

populates the module configuration, settings and hooks

boolean dbPopulate ([debug $debug = False])

• debug $debug

---

Redefinition of:

DBMS_TABLEOBJ::dbPopulate()

populates the object values form the database

dbReplace (line 467)

replaces (update) a module configuration

boolean dbReplace ([boolean $debug = FALSE], [boolean $ignorPopulated = FALSE])

• boolean $debug
• boolean $ignorPopulated

---

Redefinition of:

DBMS_TABLEOBJ::dbReplace()

replaces a row in the table

factoryModuleObject (line 641)

returns the module main object

• return: object
• access: public

INFA_MODULE factoryModuleObject ([boolean $debug = false])

• boolean $debug

getId (line 283)

* getter / setter ------------------------------------------

• access: public

void getId ()

getModuleClassName (line 602)

returns the name of the main class

which has to implement INFA_MODULE

• access: public

string getModuleClassName ()

getModuleName (line 297)

returns the module name

• since: pk-08-03-20
• access: public

string getModuleName ([boolean $debug = false])

• boolean $debug

getModulePath (line 321)

returns the root path of the module

• since: pk-08-03-20
• access: public

string getModulePath ([boolean $debug = false])

• boolean $debug

getMyCachePath (line 307)

returns the module cache path

• access: public

string getMyCachePath ()

getMySetting (line 539)

returns a module setting

• access: public

mixed getMySetting (string $optName, [boolean $debug = false])

• string $optName
• boolean $debug

getTemplatePath (line 365)

returns the template path for the module

• access: public

string getTemplatePath ([boolean $debug = false])

• boolean $debug

getWhere (line 384)

generates a where clause to select the object identfied by DBMS_TBLOBJ::myKeys

• version: pk-08-03-20

string getWhere ([boolean $debug = FALSE])

• boolean $debug

---

Redefinition of:

DBMS_TABLEOBJ::getWhere()

generates a where clause to select the object identfied by DBMS_TBLOBJ::myKeys

includeModuleObject (line 614)

returns the main object of the modul

• return: class
• access: public

INFA_MODULE includeModuleObject ([boolean $debug = false])

• boolean $debug

populateHooks (line 570)

populates the hooks

• access: protected

void populateHooks (boolean $debug)

• boolean $debug

populateSettings (line 484)

populates the module settings

• access: protected

void populateSettings (boolean $debug)

• boolean $debug

saveMySettings (line 514)

stores the settings to the database

• access: protected

void saveMySettings (boolean $debug)

• boolean $debug

setMySetting (line 558)

• access: public

void setMySetting ( $optName,  $value)

• $optName
• $value

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_SRC_FILE = __FILE__ (line 59)

• abstract:

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE