Procedural File: BitBase.php

Source Location: /kernel/BitBase.php

Classes:

Virtual base for BitCacheable.

Virtual base class (as much as one can have such things in PHP) for all derived bitweaver classes that require database access.

Page Details:

Virtual bitweaver base class

Tags:

author:

spider <spider@steelsun.com>

version:

$Header$

Copyright (c) 2004 bitweaver.org All Rights Reserved. See below for details and a complete list of authors. Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See http://www.gnu.org/copyleft/lesser.html for details

Virtual base class (as much as one can have such things in PHP) for all derived tikiwiki classes that require database access.

created 2004/8/15

filesource:

Source Code for this file

Includes:

require_once(KERNEL_PKG_PATH.'BitDbBase.php') [line 23]
required setup

STORAGE_BINARY [line 25]

STORAGE_BINARY = 1

[ Top ]

STORAGE_IMAGE [line 26]

STORAGE_IMAGE = 2

[ Top ]

debugMarkTime [line 255]

void debugMarkTime(
)

[ Top ]

debugOutput [line 259]

void debugOutput(
 $pString)

Parameters

$pString

[ Top ]

display [line 338]

none display(
string $pPackage,  $pTemplate)

This method should be THE method used to display a template. php files should not access $gBitSmarty directly.

Tags:

return:	this function will DIE DIE DIE!!!
access:	public

Parameters

string	$pPackage	pMsg error message to be displayed
	$pTemplate

[ Top ]

getCacheUuid [line 186]

void getCacheUuid(
)

[ Top ]

getCacheUuidFromKey [line 190]

void getCacheUuidFromKey(
[ $pCacheUuid = ''])

Parameters

$pCacheUuid

[ Top ]

getClass [line 217]

void getClass(
)

[ Top ]

getConfig [line 221]

void getConfig(
 $pName, [ $pDefault = NULL])

Parameters

	$pName
	$pDefault

[ Top ]

getDb [line 251]

void getDb(
)

Return pointer to current Database

[ Top ]

getField [line 380]

void getField(
pFieldName $pFieldName, [pDefault $pDefault = NULL])

Returns entry from the mInfo hash if field exists

Parameters

pFieldName	$pFieldName	the hash key to retrieve the value
pDefault	$pDefault	the value to return of there is now hash value present

[ Top ]

getObjectById [line 177]

void getObjectById(
 $pObjectId)

Parameters

$pObjectId

[ Top ]

getParameter [line 320]

TRUE getParameter(
 &$pParamHash,  $pKey, [ $pDefaultValue = NULL], associativearray $pParamHash, string $pHashKey, string $pDefault)

getParameter Gets a hash value it exists, or returns an optional default

Tags:

return:	if the input was numeric, FALSE if it wasn't
access:	public

Parameters

associativearray	$pParamHash	Hash of key=>value pairs
string	$pHashKey	Key used to search for value
string	$pDefault	Default value to return if not found. NULL if nothing is passed in.
	&$pParamHash
	$pKey
	$pDefaultValue

[ Top ]

isCacheableClass [line 205]

void isCacheableClass(
)

[ Top ]

isCacheableObject [line 201]

void isCacheableObject(
)

[ Top ]

isCacheActive [line 196]

void isCacheActive(
)

[ Top ]

isCached [line 209]

void isCached(
)

[ Top ]

isDatabaseValid [line 244]

void isDatabaseValid(
)

Determines if there is a valide database connection

[ Top ]

isFeatureActive [line 226]

void isFeatureActive(
 $pFeatureName)

Parameters

$pFeatureName

[ Top ]

loadFromCache [line 167]

void loadFromCache(
 $pCacheKey)

Parameters

$pCacheKey

[ Top ]

postGetList [line 487]

- postGetList(
array &$pListHash)

Updates results from any getList function to provide the control set

displaying in the smarty template

Tags:

return:

none the hash is updated via the reference

Parameters

array

&$pListHash

hash of parameters returned by any getList() function

[ Top ]

prepGetList [line 389]

the prepGetList(
pParamHash &$pListHash)

Prepares parameters with default values for any getList function

Tags:

return:

link to display the page.

Parameters

pParamHash

&$pListHash

hash of parameters for any getList() function

[ Top ]

setCacheableObject [line 213]

void setCacheableObject(
[ $pCacheState = TRUE])

Parameters

$pCacheState

[ Top ]

setDatabase [line 235]

void setDatabase(
pDB &$pDB)

Sets database mechanism for the instance

Parameters

pDB

&$pDB

the instance of the database mechanism

[ Top ]

setField [line 366]

void setField(
pFieldName $pFieldName, pValue $pValue)

Assign an entry to the mInfo hash if the current object is valid

Parameters

pFieldName	$pFieldName	the hash key to retrieve the value
pValue	$pValue	the value of the hash key

[ Top ]

storeInCache [line 154]

TRUE storeInCache(
[string $pCacheKey = unique identifier for object in cache store])

storeInCache

Tags:

return:	on success, FALSE on failure
access:	public

Parameters

string

$pCacheKey

unique identifier for object in cache store

[ Top ]

verifyId [line 295]

TRUE verifyId(
mixed $pId)

verifyId Determines if any given variable exists and is a number

Tags:

return:	if the input was numeric, FALSE if it wasn't
access:	public

Parameters

mixed

$pId

this can be a string, number or array. if it's an array, all values in the array will be checked to see if they are numeric

[ Top ]

verifyIdParameter [line 283]

TRUE verifyIdParameter(
 &$pParamHash,  $pKey, mixed $pId)

verifyIdParamter Determines if any given variable exists and is a number

Tags:

return:	if the input was numeric, FALSE if it wasn't
access:	public

Parameters

mixed	$pId	this can be a string, number or array. if it's an array, all values in the array will be checked to see if they are numeric
	&$pParamHash
	$pKey

[ Top ]

verifySortMode [line 467]

TRUE verifySortMode(
string $pSortMode, array $pValidSortModes)

verifySortMode is used to validate a given sort_mode agains an array of valid sort modes

Tags:

return:	on success, FALSE on failure
access:	public

Parameters

string	$pSortMode	sort mode to check
array	$pValidSortModes	array of available sort modes

[ Top ]

__wakeup [line 162]

void __wakeup(
)

[ Top ]

Documentation generated on Wed, 29 Jul 2015 13:55:39 +0000 by phpDocumentor 1.5.0-lsces