Class: BitBase

Source Location: /kernel/BitBase.php

Class Overview

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

Author(s):

Variables

Constants

Methods

Child classes:

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

NotificationLib: A library use to store email addresses registered for specific notification events.

BackupLib: Database Backup Library

BitArticleTopic

BitArticleType

PluginsLib

ExportLib

CopyrightsLib

LibertyBase: Virtual base class (as much as one can have such things in PHP) for all derived bitweaver classes that manage content.

BitLinks: BitLinks class

TikiWikiParser: TikiWikiParser

SearchStatsLib

SearchLib

Bablotron: Spellcheck Library

cssLib: css Library

Class Details

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

Tags:

abstract:

[ Top ]

Class Variables

$dType =

[line 75]

Used to store database type

Tags:

private:

Type:

mixed

[ Top ]

$mCacheTime =

[line 81]

Standard Query Cache Time. Variable can be set to 0 to flush particular queries

Tags:

private:

Type:

mixed

[ Top ]

$mDb =

[line 69]

Used to store database mechanism

Tags:

private:

Type:

mixed

[ Top ]

$mErrors =

[line 51]

Error hash that will contain an error codes we encounter along the way this hash can be used by presentation layer ti give feedback to the user.

Tags:

todo:	not used yet
private:

Type:

mixed

[ Top ]

$mInfo = array()

[line 86]

Data hash that represents this classes row(s) in the db

Type:

mixed

[ Top ]

$mLogs = array()

[line 91]

Data hash that contains logging information relevant to database operations

Type:

mixed

[ Top ]

$mName =

[line 63]

String used to refer to preference caching and database table

Tags:

private:

Type:

mixed

[ Top ]

$mPreventCache = FALSE

[line 93]

Type:

mixed

[ Top ]

$mSuccess =

[line 57]

Same idea as the error hash but this is for successful operations

Tags:

private:

Type:

mixed

[ Top ]

Class Methods

constructor BitBase [line 126]

BitBase BitBase(
[pName
$pName = ''])

During initialisation, we assign a name which is used by the class.

Tags:

usedby:	BitLinks
usedby:	BitThemes
usedby:	BitThemes

Parameters:

pName

$pName

a unique identified used in caching and database mechanisms

[ Top ]

constructor __construct [line 101]

BitBase __construct(
[
$pName = ''])

Overridden in child classes as:

BitSingleton::__construct()

BitSystem::__construct(): base constructor, auto assigns member db variable

LibertySystem::__construct(): Initiate Class

BitLanguage::__construct(): initiate BitLanguage

BitThemes::__construct(): Initiate class

BitArticleTopic::__construct()

BitArticleType::__construct()

LibertyBase::__construct(): Constructor building on BitBase object

LibertyProtector::__construct(): During initialisation, be sure to call our base constructors

LibertyTag::__construct()

LibertyStructure::__construct()

LibertyContent::__construct(): Construct an empty LibertyBase object with a blank permissions array

BitNewsletter::__construct()

BitNewsletterEdition::__construct()

FisheyeGallery::__construct()

LibertyTranslations::__construct()

LibertyStars::__construct(): Initiate Liberty Stars

SearchLib::__construct()

Bablotron::__construct(): Spellchecking and finding of alternative words

Parameters:

$pName

[ Top ]

destructor __destruct [line 112]

void __destruct(
)

[ Top ]

method clearFromCache [line 140]

void clearFromCache(
[
&$pParamHash = NULL])

Tags:

access:

public

Parameters:

&$pParamHash

[ Top ]

method expunge [line 136]

TRUE expunge(
)

Delete content object and all related records

Tags:

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

Overridden in child classes as:

LibertyProtector::expunge(): Delete entry(ies) from liberty_content_role_map table with content_id.

LibertyTag::expunge(): This function removes a tag entry

LibertyContent::expunge(): Delete content object and all related records

BitNewsletter::expunge()

BitArticle::expunge(): Removes currently loaded article

BitBlog::expunge()

BitBlogPost::expunge(): Remove complete blog post set and any comments

BitNewsletterEdition::expunge()

BitUser::expunge(): expunge removes user and associated private data

BitEvents::expunge(): This function removes a events entry

BitPage::expunge(): Remove page from database

BitBoard::expunge(): This function removes a bitboard entry

LibertyComment::expunge()

BitBoardPost::expunge(): This function removes a bitboard entry

FisheyeImage::expunge()

FisheyeGallery::expunge()

LibertyTranslations::expunge()

LibertyStars::expunge(): This function removes a stars entry

[ Top ]

method load [line 117]

void load(
)

Class Constants

CACHE_STATE_ADDED = 1

[line 98]

[ Top ]

CACHE_STATE_DELETE = -1

[line 97]

[ Top ]

CACHE_STATE_NONE = 0

[line 96]

[ Top ]

CACHE_STATE_STORED = 2

[line 99]

[ Top ]

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