Docs For Class BitThemes

static method isCacheableClass [line 60]

static void isCacheableClass(
)

Tags:

access:

public

[ Top ]

constructor __construct [line 53]

void __construct(
)

Initiate class

Overrides BitSingleton::__construct() (parent method not documented)

[ Top ]

method cloneLayout [line 794]

boolean cloneLayout(
array
$pFromLayout, array
$pToLayout)

cloneLayout

Tags:

return:	TRUE
access:	public

Parameters:

array	$pFromLayout
array	$pToLayout

[ Top ]

method displayLayoutColumn [line 461]

void displayLayoutColumn(

$pColumn)

Parameters:

$pColumn

[ Top ]

method expungeCustomModule [line 1395]

TRUE expungeCustomModule(
array
$pName)

expungeCustomModule

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pName

[ Top ]

method expungeLayout [line 819]

TRUE expungeLayout(
[array
$pLayout = NULL])

expungeLayout

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pLayout

[ Top ]

method fixPositions [line 740]

void fixPositions(
[
$pLayout = NULL])

fix postional data in database using increments of 10 to make it easy for inserting new modules

Tags:

access:

public

Parameters:

$pLayout

[ Top ]

method generateModuleNames [line 1136]

void generateModuleNames(

&$p2DHash, array
$p2DHash)

generates module names on full hash by reference

Tags:

access:

public

Parameters:

array	$p2DHash	layout hash
	&$p2DHash

[ Top ]

method getAllLayouts [line 765]

TRUE getAllLayouts(
)

get a brief summary of set layouts

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

[ Top ]

method getAllModules [line 1168]

TRUE getAllModules(
[string
$pDir = 'modules'], [string
$pPrefix = 'mod_'])

getAllModules

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

string	$pDir
string	$pPrefix

[ Top ]

method getBrowserStyleCssFile [line 186]

path getBrowserStyleCssFile(
[none
$pUrl = FALSE])

get browser specific css file

Tags:

return:	to browser specific css file
access:	public

Parameters:

none

$pUrl

[ Top ]

method getCustomModule [line 1372]

TRUE getCustomModule(
array
$pName)

getCustomModule

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pName

[ Top ]

method getCustomModuleList [line 1384]

TRUE getCustomModuleList(
)

getCustomModuleList

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

[ Top ]

method getGraphvizEdgeAttributes [line 2138]

array getGraphvizEdgeAttributes(
[array
$pParams = array()])

getGraphvizEdgeAttributes

Tags:

return:	Hash of default values
access:	public

Parameters:

array

$pParams

Override any of the settings coming out of this function

[ Top ]

method getGraphvizGraphAttributes [line 2073]

array getGraphvizGraphAttributes(
[array
$pParams = array()])

getGraphvizGraphAttributes

Tags:

return:	Hash of default values
access:	public

Parameters:

array

$pParams

Override any of the settings coming out of this function

[ Top ]

method getGraphvizNodeAttributes [line 2104]

array getGraphvizNodeAttributes(
[array
$pParams = array()])

getGraphvizNodeAttributes

Tags:

return:	Hash of default values
access:	public

Parameters:

array

$pParams

Override any of the settings coming out of this function

[ Top ]

method getIconCachePath [line 403]

absolute getIconCachePath(
)

get the icon cache path

Tags:

return:	path on where the system should store it's icons
access:	public

[ Top ]

method getLayout [line 575]

TRUE getLayout(
[array
$pParamHash = NULL])

get the current layout from the database, layouts are fetched in this order in this order until one is successfully loaded: 'layout', 'fallback_layout', ACTIVE_PACKGE, DEFAULT_PACKAGE"

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pParamHash

[ Top ]

method getLayoutCssFile [line 212]

path getLayoutCssFile(
none
0)

get browser specific css file

Tags:

return:	to browser specific css file
access:	public

Parameters:

none

[ Top ]

method getModuleData [line 980]

module getModuleData(
array
$pModuleId)

getModuleData

Tags:

return:	details of the requested module id
access:	public

Parameters:

array

$pModuleId

[ Top ]

method getModuleId [line 2181]

void getModuleId(

$mod_rsrc)

Tags:

deprecated:

deprecated since version 2.0.0

Parameters:

$mod_rsrc

[ Top ]

method getModuleParameters [line 1288]

array getModuleParameters(
array
$pModuleId)

get a module-specfic parameters

Tags:

return:	or parameters
access:	public

Parameters:

array

$pModuleId

[ Top ]

method getStyle [line 130]

none getStyle(
string
$)

figure out the current style

Tags:

access:

public

Parameters:

string

pScanFile file to be looked for

[ Top ]

method getStyleCss [line 2187]

void getStyleCss(
[
$pStyle = NULL])

Tags:

deprecated:

deprecated since version 2.0.0

Parameters:

$pStyle

[ Top ]

method getStyleCssFile [line 158]

none getStyleCssFile(
[
$pStyle = NULL], [
$pUrl = FALSE], string
$)

figure out the current style

Tags:

access:

public

Parameters:

string	$	pScanFile file to be looked for
	$pStyle
	$pUrl

[ Top ]

method getStyleLayouts [line 302]

TRUE getStyleLayouts(
)

getStyleLayouts

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

[ Top ]

method getStylePath [line 241]

none getStylePath(
[
$pStyle = NULL], string
$)

figure out the current style URL

Tags:

access:

public

Parameters:

string	$	pScanFile file to be looked for
	$pStyle

[ Top ]

method getStyles [line 257]

TRUE getStyles(
[array
$pDir = NULL], [array
$pNullOption = NULL], [array
$bIncludeCustom = FALSE])

getStyles

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pDir
array	$pNullOption
array	$bIncludeCustom

[ Top ]

method getStylesList [line 336]

TRUE getStylesList(
[$pSubDirs
$pDir = NULL], [array
$pNullOption = NULL], [array
$pSubDirs = NULL])

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

$pSubDirs	$pDir	a subdirectory to scan as well - you can pass in multiple dirs using an array
array	$pNullOption
array	$pSubDirs

[ Top ]

method getStyleUrl [line 227]

none getStyleUrl(
[
$pStyle = NULL], string
$)

figure out the current style URL

Tags:

access:

public

Parameters:

string	$	pScanFile file to be looked for
	$pStyle

[ Top ]

method hasColumnModules [line 457]

void hasColumnModules(

$pColumn)

Parameters:

$pColumn

[ Top ]

method isAjaxLib [line 1537]

TRUE isAjaxLib(
array
$pAjaxLib)

check to see if a given ajax library is loaded

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array

$pAjaxLib

[ Top ]

method isAjaxRequest [line 1439]

void isAjaxRequest(
)

Statically callable function to determine if the current call was made using Ajax

Tags:

access:

public

[ Top ]

method isAuxFile [line 1995]

TRUE isAuxFile(
[array
$pFile = NULL], [string
$pType = NULL], [
$pAuxFile = TRUE])

isAuxFile

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array	$pFile	Full path to file
string	$pType	specifies what files to check. typical values include 'js', 'css'
	$pAuxFile

[ Top ]

method isCustomModule [line 1410]

TRUE isCustomModule(
array
$pMixed)

isCustomModule

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pMixed

either name of module or the rsrc of a module

[ Top ]

method isJavascriptEnabled [line 1429]

void isJavascriptEnabled(
)

Statically callable function to see if browser supports javascript

determined by cookie set in bitweaver.js

Tags:

access:

public

[ Top ]

method isModuleLoaded [line 710]

TRUE isModuleLoaded(
string
$pModuleResource, [string
$pArea = NULL])

isModuleLoaded will check if a given modules is being used in the currently active layout

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

string	$pModuleResource	the module resource
string	$pArea	optionally specify the area the module should be found in

[ Top ]

method loadAjax [line 1453]

TRUE loadAjax(
array
$pAjaxLib, [array
$pLibHash = NULL], [
$pLibPath = NULL], [boolean
$pPack = FALSE])

Load Ajax libraries

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pAjaxLib	Name of the library we want to use e.g.: prototype or mochikit
array	$pLibHash	Array of additional libraries we need to load
boolean	$pPack	Set to true if you want to pack the javascript file
	$pLibPath

[ Top ]

method loadAuxFile [line 1584]

TRUE loadAuxFile(
[array
$pFile = NULL], [string
$pType = NULL], [numeric
$pPosition = 1], [
$pAuxFile = TRUE])

loadAuxFile will add a file to the mAuxFiles hash for later processing

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array	$pFile	Full path to the file in question
string	$pType	specifies what files to join. typical values include 'js', 'css'
numeric	$pPosition	Specify the position of the javascript file in the load process. If the selected position is occupied, it will search for the next free position in the hash.
	$pAuxFile

[ Top ]

method loadCss [line 1663]

TRUE loadCss(
array
$pCssFile, [
$pPack = TRUE], [numeric
$pPosition = 300], [boolean
$pJoined = TRUE], [boolean
$pForce = FALSE])

Load an additional CSS file

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array	$pCssFile	Full path to CSS file
numeric	$pPosition	Specify the position of the javascript file in the load process
boolean	$pJoined	Adds the file to the list of files to be concatenated into a single file
boolean	$pForce	Forces the css file to always be loaded, should only be used by active style
	$pPack

[ Top ]

method loadJavascript [line 1623]

TRUE loadJavascript(
string
$pJavascriptFile, [boolean
$pPack = FALSE], [numeric
$pPosition = 600], [
$pJoined = TRUE])

Load an addition javascript file

Parameters:

string	$pJavascriptFile	Full path to javascript file
boolean	$pPack	Set to true if you want to pack the javascript file
numeric	$pPosition	Specify the position of the javascript file in the load process
	$pJoined

[ Top ]

method loadLayout [line 433]

none loadLayout(
[$pParamHash
$pParamHash = NULL])

load current layout into mLayout

Tags:

access:

public

Parameters:

$pParamHash

$pParamHash

[ Top ]

method loadStyle [line 97]

void loadStyle(
)

[ Top ]

method moveModule [line 1024]

TRUE moveModule(
array
$pModuleId, [
$pDirection = 'down'], string
$pOrientation)

generic function to move module up or down

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pModuleId
string	$pOrientation
	$pDirection

[ Top ]

method moveModuleDown [line 1009]

TRUE moveModuleDown(
array
$pModuleId)

moduleDown

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pModuleId

[ Top ]

method moveModuleToArea [line 1085]

TRUE moveModuleToArea(
array
$pModuleId, array
$pArea)

moveModuleToArea

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pModuleId
array	$pArea

[ Top ]

method moveModuleUp [line 995]

TRUE moveModuleUp(
array
$pModuleId)

moduleUp

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pModuleId

[ Top ]

method overrideCss [line 1969]

boolean overrideCss(
array
$pOriginalFile, array
$pNewFile)

overrideCss

Tags:

return:	TRUE on success, FALSE on failure
note:	See overrideAuxFile note
access:	public

Parameters:

array	$pOriginalFile	Path to old file
array	$pNewFile	Path to new file

[ Top ]

method overrideJavascript [line 1982]

boolean overrideJavascript(
array
$pOriginalFile, array
$pNewFile)

overrideJavascript

Tags:

return:	TRUE on success, FALSE on failure
note:	See overrideAuxFile note
access:	public

Parameters:

array	$pOriginalFile	Path to old file
array	$pNewFile	Path to new file

[ Top ]

method parseGroups [line 835]

array parseGroups(
array
$pParseString)

transform groups string to handy array

Tags:

return:	of groups
access:	public

Parameters:

array

$pParseString

either space separated list of groups or serialised array

[ Top ]

method parseRoles [line 868]

array parseRoles(
array
$pParseString)

transform roles string to handy array

Tags:

return:	of roles
access:	public

Parameters:

array

$pParseString

either space separated list of roles or serialised array

[ Top ]

method parseString [line 1306]

array parseString(
array
$pParseString)

parse URL-like parameter string

Tags:

return:	or parameters
access:	public

Parameters:

array

$pParseString

[ Top ]

method preLoadStyle [line 79]

void preLoadStyle(
)

load up style related information that must be loaded before template rendering begins

Tags:

see:	BitSystem::preDisplay
note:	this is a interim method as we continue sorting out the optimal order of operations for rendering pages. there was some conflict between rendering module templates and loading styles, where some style information needs to be loaded before the templates are rendered, and some such as packing javascript and css should happen after

[ Top ]

method registerModule [line 1238]

void registerModule(

$pMixed)

Parameters:

$pMixed

[ Top ]

method setDisplayMode [line 2017]

void setDisplayMode(
string
$pDisplayMode)

setDisplayMode

Tags:

access:

public

Parameters:

string

$pDisplayMode

[ Top ]

method setFormatHeader [line 2029]

void setFormatHeader(
[$pFormat
$pFormat = 'html'])

Set the proper headers for requested output

Tags:

access:

public

Parameters:

$pFormat

$pFormat

the output headers. Available options include: html, json, xml or none

[ Top ]

method setModulePosition [line 1061]

TRUE setModulePosition(
array
$pModuleId, array
$pPos, [
$pCol = NULL])

setModulePosition

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pModuleId
array	$pPos
	$pCol

[ Top ]

method setStyle [line 145]

none setStyle(

$pStyle, string
$)

figure out the current style

Tags:

access:

public

Parameters:

string	$	pScanFile file to be looked for
	$pStyle

[ Top ]

method storeCustomModule [line 1356]

TRUE storeCustomModule(
array
$pParamHash)

storeCustomModule

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pParamHash

[ Top ]

method storeLayout [line 2169]

void storeLayout(
)

Tags:

deprecated:

deprecated since version 2.0.0

[ Top ]

method storeModule [line 957]

TRUE storeModule(

&$pHash, array
$pHash)

storeModule

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pHash
	&$pHash

[ Top ]

method storeModuleParameters [line 2175]

void storeModuleParameters(

$mod_rsrc, 
$user_id, 
$params)

Tags:

deprecated:

deprecated since version 2.0.0

Parameters:

	$mod_rsrc
	$user_id
	$params

[ Top ]

method unassignModule [line 1104]

TRUE unassignModule(

$pModuleMixed, array
$pModuleId)

unassignModule

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pModuleId	can be a module id or a resource path. if it is a resource path, all modules with that resource will be removed
	$pModuleMixed

[ Top ]

method unloadCss [line 1917]

void unloadCss(
array
$pFile)

unloadCss

Tags:

access:

public

Parameters:

array

$pFile

Full path to the file in question

[ Top ]

method unloadJavascript [line 1928]

void unloadJavascript(
array
$pFile)

unloadJvascript

Tags:

access:

public

Parameters:

array

$pFile

Full path to the file in question

[ Top ]

method upgradeModulesPaths [line 1249]

void upgradeModulesPaths(
)

[ Top ]

method verifyArea [line 1125]

valid verifyArea(

&$pArea, array
$pArea)

if the specified area doesn't make any sense, we just dump it in the left column

Tags:

return:	area
access:	public

Parameters:

array	$pArea	l --> left r --> right c --> center b --> bottom t --> top
	&$pArea

[ Top ]

method verifyCustomModule [line 1329]

TRUE verifyCustomModule(

&$pParamHash, array
$pParamHash)

verifyCustomModule

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pParamHash
	&$pParamHash

[ Top ]

method verifyModuleParams [line 904]

TRUE verifyModuleParams(

&$pHash, array
$pHash)

Verfiy module parameters when storing a new module

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pHash
	&$pHash

[ Top ]

Class: BitThemes

Class Overview

Author(s):

Variables

Methods

Inherited Constants

Class: BitBase

Inherited Variables

Class: BitSingleton

Class: BitBase

Inherited Methods

Class: BitSingleton

Class: BitBase

Class Details

Tags:

Class Variables

$mAjaxLibs = array()

$mAuxFiles = array( 'js' => array(),'css'=>array())

$mDisplayMode =

$mLayout = array()

$mModules = array()

$mRawFiles = array( 'js' => array(),'css'=>array())

$mStyle =

$mStyles = array()

Class Methods

static method isCacheableClass [line 60]

Tags:

constructor __construct [line 53]

method cloneLayout [line 794]

Tags:

Parameters:

method displayLayoutColumn [line 461]

Parameters:

method expungeCustomModule [line 1395]

Tags:

Parameters:

method expungeLayout [line 819]

Tags:

Parameters:

method fixPositions [line 740]

Tags:

Parameters:

method generateModuleNames [line 1136]

Tags:

Parameters:

method getAllLayouts [line 765]

Tags:

method getAllModules [line 1168]

Tags:

Parameters:

method getBrowserStyleCssFile [line 186]

Tags:

Parameters:

method getCustomModule [line 1372]

Tags:

Parameters:

method getCustomModuleList [line 1384]

Tags:

method getGraphvizEdgeAttributes [line 2138]

Tags:

Parameters:

method getGraphvizGraphAttributes [line 2073]

Tags:

Parameters:

method getGraphvizNodeAttributes [line 2104]

Tags:

Parameters:

method getIconCachePath [line 403]

Tags:

method getLayout [line 575]

Tags:

Parameters:

method getLayoutCssFile [line 212]

Tags:

Parameters:

method getModuleData [line 980]

Tags:

Parameters:

method getModuleId [line 2181]

Tags:

$mAuxFiles = array(
'js' => array(),'css'=>array())

$mRawFiles = array(
'js' => array(),'css'=>array())