Docs For Class OCSP

Description

OCSP common class

author: Peter Krebs (pk)<pitlinz@users.sourceforge.net>
abstract:
since: pk-07-10-11
project: Open CSP-Management
license: GNU Public License

Located in /common/OCSP_OBJ.phpclass (line 35)

Direct descendents

Class	Description
OCSP_AJAX	Class OCSP_AJAX
OCSP_TEMPLATE	openCSP class OCSP_TEMPLATE
OCSP_FORM	Database Formular Basic Elements this class is without any layout elements to extend to what ever is needed
OCSP_FORM_BLOCK	class OCSP_FORM_BLOCK
OCSP_FRMCONTR	class OCSP_FRMCONTR
DBMS_TABLEOBJ	Base class DBMS_TABLEOBJ to handel table data in an object
OCSP_TABLEDESC	openCSP class file
PGP_CMS_MENU_NODE	openCSP class PGP_CMS_MENU_NODE
PRO_PART_CMS_PAGE	openCSP class PRO_PART_CMS_PAGE
OCSP_GROUPTREE	handels groups

Class Constant Summary

CLASS_SRC_FILE = __FILE__

Variable Summary

static OCSP_USER $global_currentUser

static mixed $global_defaultDBObj_read

static mixed $global_defaultDBObj_write

static mixed $staticClassVars

OCSP_DB $myDBObj

Method Summary

static object castObj (object &$obj, string $newClassName, [boolean $debug = FALSE])

static OCSP_USER currentUser ([ $instantiate = True], boolean $$instantiate)

static OCSP_DB &defaultDBObj ([string $mode = 'rw'], [boolean $getFromUser = True], [boolean $debug = False])

static OCSP_DB &defaultReadDBObj ()

static OCSP_DB &defaultWriteDBObj ()

static mixed getConf (string $optName)

static boolean isMultiByteStr (string $aString)

static boolean isUTF8 (string $aString, [ $debug = False])

static void setConf (string $optName, mixed $optValue)

object cloneMe (boolean $debug)

boolean dbConnect ([string $confFile = ""], [boolean $reconnect = FALSE], [ $debug = FALSE], boolean $debug#)

OCSP_DB &getDBObj ([string $mode = "r"])

mixed get_myClassConstant (string $aConstName)

array get_myObject_vars ([boolean $asRef = FALSE], [boolean $strict = TRUE], [boolean $debug = FALSE])

string get_mySourceFile ()

boolean isConnected ([boolean $autoConnect = False], [boolean $debug = False])

void setDBObj ( &$dbObj, OCSP_DB $dbObj)

void set_myObject_vars (array $objData, [boolean $strict = FALSE], [boolean $debug = FALSE])

boolean set_myVarsFrom (object $srcobj, [boolean $asRef = FALSE], [boolean $strict = FALSE], [boolean $debug = FALSE])

Variables

static OCSP_USER $global_currentUser = NULL (line 72)

access: protected

static mixed $global_defaultDBObj_read = NULL (line 118)

holdung the efault open connection for reads

staticvar: OCSP_DB $global_defaultDBObj_read:
access: protected

static mixed $global_defaultDBObj_write = NULL (line 140)

holdung the default open connection for writes

staticvar: OCSP_DB $global_defaultDBObj_write:
access: protected

static mixed $staticClassVars = array() (line 51)

staticvar: array $staticClassVars: vars which must not be copied
access: protected

Redefined in descendants as:

OCSP_DB $myDBObj = NULL (line 61)

since: pk-07-05-31
access: protected

Redefined in descendants as:

Methods

static castObj (line 458)

casts an object to an other type the newClass source must already been loaded

access: public

object castObj (object &$obj, string $newClassName, [boolean $debug = FALSE])

object &$obj
string $newClassName
boolean $debug

static currentUser (line 83)

returns the current user object

version: pk-08-06-06
access: public

OCSP_USER currentUser ([ $instantiate = True], boolean $$instantiate)

boolean $$instantiate: (do instantiate a new object if no one was found)
$instantiate

static defaultDBObj (line 173)

returns the default database object

possible modes are:

r (read)
w (write)
rw (read & write)

version: pk-08-06-05
access: public

OCSP_DB &defaultDBObj ([string $mode = 'rw'], [boolean $getFromUser = True], [boolean $debug = False])

string $mode
boolean $getFromUser
boolean $debug

static defaultReadDBObj (line 125)

returns the default database object for read operations

access: public

OCSP_DB &defaultReadDBObj ()

static defaultWriteDBObj (line 147)

returns the default database object for write operations

access: public

OCSP_DB &defaultWriteDBObj ()

static getConf (line 214)

returns a configuration option of $OCSP_CONF

access: public

mixed getConf (string $optName)

string $optName

static isMultiByteStr (line 286)

returns if $aString is a multibyte string

since: pk-08-11-12
access: public

boolean isMultiByteStr (string $aString)

string $aString

static isUTF8 (line 242)

checks if a string is utf8 encoded

since: pk-08-11-12
access: public

boolean isUTF8 (string $aString, [ $debug = False])

string $aString
$debug

static setConf (line 227)

sets a configuration value

since: pk-08-03-18
access: public

void setConf (string $optName, mixed $optValue)

string $optName
mixed $optValue

cloneMe (line 511)

clones the object

returns a new object with the same attribut values

since: pk-08-02-16
access: public

object cloneMe (boolean $debug)

boolean $debug

dbConnect (line 622)

connects to the default database

global: $OCSP_CONF $OCSP_CONF:
todo: check if the current connection
todo: reconnect
since: pk-07-06-15
requires: dirname(__FILE__)."/OCSP_DB.phpclass";
access: public

boolean dbConnect ([string $confFile = ""], [boolean $reconnect = FALSE], [ $debug = FALSE], boolean $debug#)

string $confFile
boolean $reconnect: (init a new DB object even we already have one)
boolean $debug#
$debug

Redefined in descendants as:

OCSP_USER::dbConnect()

getDBObj (line 552)

allowed modes are:

r for read
w for write
rw for read/write

todo: select the right db connection

OCSP_DB &getDBObj ([string $mode = "r"])

string $mode

Redefined in descendants as:

OCSP_FORM::getDBObj() : if $this->myDBObj is NULL a new connection to either the users db or the global database will be establisched
OCSP_FORM_BLOCK::getDBObj() : returns the db object from the form
OCSP_FRMCONTR::getDBObj() : returns the db object from the form

get_myClassConstant (line 321)

returns the value of a class constant set with const aConstName=....

since: pk-08-01-19
access: public

mixed get_myClassConstant (string $aConstName)

string $aConstName

get_myObject_vars (line 352)

returns the object vars as array

access: public

array get_myObject_vars ([boolean $asRef = FALSE], [boolean $strict = TRUE], [boolean $debug = FALSE])

boolean $asRef: (return an array of references to the vars array[$var]=&$this->var)
boolean $strict: (only return declared vars)
boolean $debug

get_mySourceFile (line 332)

returns the class source file (if set)

access: public

string get_mySourceFile ()

isConnected (line 578)

returns if the dbObj is connected

since: pk-07-05-31

boolean isConnected ([boolean $autoConnect = False], [boolean $debug = False])

boolean $autoConnect: try to connect
boolean $debug

Redefined in descendants as:

OCSP_USER::isConnected() : returns if the dbObj is connected

setDBObj (line 536)

sets the database object (link)

since: pk-07-05-31
access: public

void setDBObj ( &$dbObj, OCSP_DB $dbObj)

OCSP_DB $dbObj
&$dbObj

Redefined in descendants as:

set_myObject_vars (line 392)

sets the object vars from an array

access: protected

void set_myObject_vars (array $objData, [boolean $strict = FALSE], [boolean $debug = FALSE])

array $objData
boolean $strict: (set only declared vars)
boolean $debug

set_myVarsFrom (line 427)

sets the object vars from another object to $this

access: public

boolean set_myVarsFrom (object $srcobj, [boolean $asRef = FALSE], [boolean $strict = FALSE], [boolean $debug = FALSE])

object $srcobj
boolean $asRef: (return an array of references to the vars array[$var]=&$this->var)
boolean $strict: (only return declared vars)
boolean $debug

Class Constants

CLASS_SRC_FILE = __FILE__ (line 44)

abstract: