openCSP class OCSP_MODULE uses the singleton pattern

• author: Peter Krebs <pitlinz@users.sourceforge.net>
• version: $Id: OCSP_MODULE.phpclass,v 1.11 2008/11/17 21:50:38 pitlinz Exp $
• since: pk-13.06.2008
• project: Open CSP-Management
• license: GNU Public License

Located in /modules/OCSP_MODULE.phpclass (line 36)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --OCSP_MODULE

static mixed $knownModules = array() (line 63)

arry containing module id's

[ID] => prefix

• staticvar: array $knownModules:
• access: protected

static array $loadedModules = array() (line 54)

array containing already loaded modules

• access: protected

array $myLoadedConfValues = array() (line 142)

array of already loaded configuration values

• access: protected

timestamp $myLoadedConfValuesTS = 0 (line 149)

timestamp the configurations have been populated

• access: protected

string $myTable = "T_MOD_MODULES" (line 158)

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 factoryAllInstalledModules (line 113)

returns an array with all installed modules

• return: of OCSP_MODULE
• access: public

array factoryAllInstalledModules ([boolean $refreshCache = True], [boolean $debug = False])

• boolean $refreshCache
• boolean $debug

static factoryFromDB (line 277)

factory the object from the database

• access: public

OCSP_MODULE factoryFromDB (mixed $aKey, boolean $debug)

• mixed $aKey: value of [MOD_ID|MOD_PREFIX]
• boolean $debug

static factoryFromId (line 170)

factories a module

• access: public

OCSP_MODULE &factoryFromId ( $modId, [boolean $debug = False], string $$modPrefix)

• string $$modPrefix
• boolean $debug
• $modId

static factoryFromPrefix (line 198)

factories a module

first tries APC and FILE cache

• access: public

OCSP_MODULE &factoryFromPrefix ( $modPrefix, [ $forceReload = False], [boolean $debug = False], string $$modPrefix)

• string $$modPrefix
• boolean $debug
• $modPrefix
• $forceReload

static factoryFromRow (line 310)

factory the object from a data row

• access: public

OCSP_MODULE &factoryFromRow (string $modPrefix, array $dbRow, [boolean $debug = False])

• string $modPrefix
• array $dbRow
• boolean $debug

static getInstance (line 76)

returns a loaded instance of the module with prefix

• access: public

OCSP_MODULE &getInstance (string $modPrefix, [boolean $debug = False])

• string $modPrefix
• boolean $debug

static getInstanceByModId (line 95)

returns the module unit of work with module id $modId

• since: pk-08-10-06
• access: public

OCSP_MODULE &getInstanceByModId (int $modId, [boolean $debug = False])

• int $modId
• boolean $debug

cacheToApc (line 422)

caches the module to APC

• access: public

boolean cacheToApc ([int $ttl = 0], boolean $debug)

• int $ttl
• boolean $debug

cacheToFile (line 444)

caches the module row to the file cache

• access: public

boolean cacheToFile ([int $ttl = 0], boolean $debug)

• int $ttl
• boolean $debug

clearCache (line 464)

clears the used caches

• access: public

void clearCache ([boolean $debug = False])

• boolean $debug

getAdminUrl (line 397)

returns the admin root url of the module

• access: public

string getAdminUrl ()

getCacheGroup (line 409)

returns the cache group name

• access: public

unknown getCacheGroup ()

getId (line 326)

returns the module id

• access: public

int getId ()

getModuleIncPath (line 366)

returns the absolute module include path

• access: public

string getModuleIncPath ()

getModulePath (line 348)

returns the absolute module path

• access: public

string getModulePath ([ $debug = False])

• $debug

getMyConf (line 522)

returns a configuration value

• since: pk-08-10-28
• access: public

mixed getMyConf (string $key, [boolean $debug = False])

• string $key
• boolean $debug

getPrefix (line 334)

• access: public

string getPrefix ()

populateMyConf (line 488)

populates all configuration values from the database

• access: protected

void populateMyConf ([boolean $debug = False])

• boolean $debug

require_class (line 378)

requires a class file for $className

• access: public

void require_class (string $className, [string $subPath = ""], [boolean $debug = False])

• string $className
• string $subPath
• boolean $debug

setMyConf (line 552)

sets a configuration option

• since: pk-08-10-28
• access: public

void setMyConf (string $key, mixed $value, [boolean $debug = False])

• string $key
• mixed $value
• boolean $debug

setNewMyConf (line 573)

sets a config setting only if it's not already set

• access: public

void setNewMyConf (string $key, mixed $value, [boolean $debug = False])

• string $key
• mixed $value
• 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_SRC_FILE = __FILE__ (line 45)

• abstract:

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE