BitBase Class Reference

Inheritance diagram for BitBase:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 BitBase ($pName= '')
 debug ($pLevel=99)
 display ($pPackage, $pTemplate)
 getDb ()
 getField ($pFieldName, $pDefault=NULL)
 isDatabaseValid ()
 postGetList (&$pListHash)
 prepGetList (&$pListHash)
 setDatabase (&$pDB)
 verifyId ($pId)

Public Attributes

 $mInfo = array()
 $mLogs = array()

Private Attributes

 $dType
 $mCacheTime
 $mDb
 $mErrors
 $mName
 $mSuccess

Detailed Description

Definition at line 34 of file BitBase.php.


Member Function Documentation

BitBase::BitBase ( pName = ''  ) 

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

Parameters:
pName a unique identified used in caching and database mechanisms

Definition at line 89 of file BitBase.php.

References $gBitDb, mInfo, and setDatabase().

Referenced by Bablotron::Bablotron(), BackupLib::BackupLib(), BitArticleTopic::BitArticleTopic(), BitArticleType::BitArticleType(), BitLanguage::BitLanguage(), BitLinks::BitLinks(), BitSystem::BitSystem(), BitThemes::BitThemes(), CopyrightsLib::CopyrightsLib(), ExportLib::ExportLib(), iLike::iLike(), LibertyBase::LibertyBase(), Messages::Messages(), Multisites::Multisites(), NotificationLib::NotificationLib(), PackagerBase::PackagerBase(), PluginsLib::PluginsLib(), QuickTags::QuickTags(), RSSLib::RSSLib(), SearchLib::SearchLib(), SearchStatsLib::SearchStatsLib(), Shoutbox::Shoutbox(), Statistics::Statistics(), and TikiWikiParser::TikiWikiParser().

Here is the call graph for this function:

BitBase::debug ( pLevel = 99  ) 

Switch debug level in database

Definition at line 128 of file BitBase.php.

References mDb.

BitBase::display ( pPackage,
pTemplate 
)

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

Parameters:
string pMsg error message to be displayed
Returns:
none this function will DIE DIE DIE!!! public

Reimplemented in BitInstaller, and BitSystem.

Definition at line 161 of file BitBase.php.

References $gBitLanguage, $gBitSmarty, and $style.

BitBase::getDb (  ) 

Return pointer to current Database

Definition at line 120 of file BitBase.php.

References mDb.

BitBase::getField ( pFieldName,
pDefault = NULL 
)

Returns entry from the mInfo hash if field exists

Parameters:
pFieldName the instance of the database mechanism

Definition at line 188 of file BitBase.php.

References mInfo.

Referenced by LibertyContent::addHit(), LibertyStars::calculateUserWeight(), BitUser::createTempPassword(), LibertyComment::deleteComment(), FisheyeImage::exportHtml(), LibertyContent::expunge(), LibertyAttachable::extractMetaData(), BitBlogPost::getDisplayLink(), BitUser::getThumbnailUrl(), BitBoardPost::getTopicId(), BitUser::getUserDomain(), LibertyContent::isCommentable(), LibertyContent::isDeleted(), BitNewsletterEdition::isDraft(), LibertyContent::isHidden(), BitPage::isLocked(), LibertyContent::isPrivate(), LibertyContent::isProtected(), BitBoardTopic::load(), BitBlog::load(), FisheyeGallery::loadImages(), BitUser::purgeImage(), LibertyContent::store(), LibertyContent::storeHistory(), BitUser::storePassword(), BitNewsletter::subscribe(), and BitBlog::viewerCanPostIntoBlog().

BitBase::isDatabaseValid (  ) 

Determines if there is a valide database connection

Definition at line 113 of file BitBase.php.

References mDb.

Referenced by BitUser::updateSession().

BitBase::postGetList ( &$  pListHash  ) 

Updates results from any getList function to provide the control set displaying in the smarty template

Parameters:
array hash of parameters returned by any getList() function
Returns:
- none the hash is updated via the reference

Definition at line 281 of file BitBase.php.

References $gBitSystem, $i, $max, $next, and $prev.

Referenced by LibertyContent::getActionLogs(), Pigeonholes::getAssignableContent(), LibertyAttachable::getAttachmentList(), LibertyContent::getContentList(), LibertyContent::getHistory(), TreasuryItem::getList(), TreasuryGallery::getList(), Shoutbox::getList(), QuickTags::getList(), Pigeonholes::getList(), PackagerVersions::getList(), Packager::getList(), Messages::getList(), LibertyStars::getList(), LibertyRecommends::getList(), BitUser::getList(), BitPage::getList(), BitGmap::getList(), BitEvents::getList(), BitBoardTopic::getList(), BitBoard::getList(), BitBlogPost::getList(), BitBlog::getList(), BitArticle::getList(), Statistics::getRefererList(), and BitUser::getUserActivity().

BitBase::prepGetList ( &$  pListHash  ) 

Prepares parameters with default values for any getList function

Parameters:
pParamHash hash of parameters for any getList() function
Returns:
the link to display the page.

Reimplemented in BitBoard, Calendar, and LibertyContent.

Definition at line 197 of file BitBase.php.

References $_REQUEST, $gBitSmarty, $gBitSystem, date, and FALSE.

Referenced by Shoutbox::getList(), QuickTags::getList(), Messages::getList(), LibertyStructure::getList(), LibertyStars::getList(), BitNewsletterEdition::getList(), BitNewsletter::getList(), and iLike::search().

BitBase::setDatabase ( &$  pDB  ) 

Sets database mechanism for the instance

Parameters:
pDB the instance of the database mechanism

Definition at line 104 of file BitBase.php.

References mDb.

Referenced by BitBase().

BitBase::verifyId ( pId  ) 

Determines if any given variable exists and is a number

Definition at line 139 of file BitBase.php.

Referenced by BitBoard::addContent(), LibertyContent::addHit(), FisheyeGallery::addItem(), BitPermUser::addUserToGroup(), BitBlog::BitBlog(), BitNewsletter::BitNewsletter(), BitUser::BitUser(), boards_content_store(), LibertyStars::calculateRating(), LibertyStars::calculateUserWeight(), LibertyContent::checkContentPermission(), Nexus::createMenuTree(), data_attachment(), data_file(), data_image(), data_toc(), LibertyAttachable::detachAttachment(), Pigeonholes::expunge(), Multisites::expunge(), LibertyTranslations::expunge(), LibertyContent::expungeActionLog(), LibertyAttachable::expungeAttachment(), LibertyContent::expungeCacheFile(), BitUser::expungeFavorite(), BitPage::expungeFootnote(), Nexus::expungeItem(), Pigeonholes::expungePigeonholeMember(), Multisites::expungePreferences(), BitMailer::expungeQueueRow(), Multisites::expungeRestrictions(), LibertyGatekeeper::expungeSecurity(), Messages::expungeSystemMessage(), LibertyTag::expungeTags(), BitPage::findByPageName(), BitBoard::fixContentMap(), Messages::flagMessage(), FisheyeGallery::galleryExistsInDatabase(), BitBlog::get_random_blog_post(), BitLinks::getAllPages(), BitArticle::getArticleImageStorageName(), BitArticle::getArticleImageStoragePath(), BitArticle::getArticleImageStorageUrl(), Pigeonholes::getAssignableContent(), LibertyAttachable::getAttachment(), BitBlog::getBlog(), BitBlogPost::getBlogMemberships(), BitBoard::getBoard(), LibertyContent::getCachePath(), LibertyContent::getContentList(), LibertyTranslations::getContentTranslations(), TreasuryBase::getDefaultGalleryId(), LibertyComment::getDisplayLink(), BitUser::getDisplayName(), TreasuryBase::getDisplayPath(), Pigeonholes::getDisplayPath(), TreasuryItem::getDisplayUrl(), TreasuryGallery::getDisplayUrl(), Pigeonholes::getDisplayUrl(), LibertyQuota::getDisplayUrl(), LibertyContent::getDisplayUrl(), LibertyComment::getDisplayUrl(), FisheyeImage::getDisplayUrl(), FisheyeGallery::getDisplayUrl(), BitNewsletterEdition::getDisplayUrl(), BitNewsletter::getDisplayUrl(), BitEvents::getDisplayUrl(), BitBoardTopic::getDisplayUrl(), BitBoardPost::getDisplayUrl(), BitBoard::getDisplayUrl(), BitBlogPost::getDisplayUrl(), BitBlog::getDisplayUrl(), BitArticle::getDisplayUrl(), BitUser::getDomain(), TreasuryItem::getDownloadUrl(), BitNewsletter::getEditions(), BitPage::getFootnote(), TreasuryBase::getGalleryPath(), TreasuryGallery::getGalleryThumbBaseUrl(), TreasuryGallery::getGalleryThumbUrl(), BitPermUser::getGroupPermissions(), BitPermUser::getGroupUserData(), LibertyContent::getHistory(), BitArticle::getImageUrl(), LibertyBase::getLibertyObject(), BitBoard::getLinkedBoard(), TreasuryItem::getList(), TreasuryGallery::getList(), Pigeonholes::getList(), LibertyStructure::getList(), FisheyeImage::getList(), FisheyeGallery::getList(), BitPage::getList(), BitNewsletterEdition::getList(), BitNewsletter::getList(), BitEvents::getList(), BitBoardPost::getList(), BitBlogPost::getList(), BitBlog::getList(), BitArticle::getList(), Pigeonholes::getMemberList(), Nexus::getMenu(), BitThemes::getModuleData(), BitThemes::getModuleParameters(), Multisites::getMultisites(), Messages::getNeighbourMessage(), LibertyStructure::getNode(), FisheyeBase::getParentGalleries(), Pigeonholes::getPigeonholePath(), Pigeonholes::getPigeonholesFromContentId(), Pigeonholes::getPigeonholesPathList(), BitBlog::getPostsCount(), LibertyContent::getPreviewUrl(), LibertyStars::getRatingSummary(), LibertyRecommends::getRecommending(), LibertyRecommends::getRecommendingSummary(), LibertyStructure::getRootStructureId(), LibertyGatekeeper::getSecurityList(), LibertyStructure::getStructure(), LibertyStructure::getStructureParentInfo(), LibertyStructure::getSubTree(), FisheyeGallery::getThumbnailImage(), LibertyStructure::getToc(), BitArticleTopic::getTopicImageBaseUrl(), BitArticleTopic::getTopicImageStorageName(), BitArticleTopic::getTopicImageStoragePath(), BitArticleTopic::getTopicImageStorageUrl(), BitArticleTopic::getTopicImageThumbUrl(), BitUser::getUserActivity(), BitUser::getUserFromContentId(), BitUser::getUserPreference(), LibertyStars::getUserRating(), LibertyRecommends::getUserRecommending(), LibertyContent::isCached(), LibertyContent::isExcludedPermission(), FisheyeBase::isInGallery(), BitPage::isLocked(), LibertyContent::isOwner(), BitUser::isPasswordDue(), BitMailer::isRecipientQueued(), LibertyStructure::isRootNode(), Messages::isSystemMessage(), PackagerVersions::isValid(), Nexus::isValid(), LibertyTag::isValid(), LibertyStructure::isValid(), LibertyStars::isValid(), LibertyRecommends::isValid(), LibertyQuota::isValid(), LibertyGatekeeper::isValid(), LibertyContent::isValid(), FisheyeImage::isValid(), FisheyeGallery::isValid(), BitUser::isValid(), BitPage::isValid(), BitNewsletterEdition::isValid(), BitNewsletter::isValid(), BitEvents::isValid(), BitBoard::isValid(), BitBlogPost::isValid(), BitBlog::isValid(), BitArticleType::isValid(), BitArticleTopic::isValid(), BitArticle::isValid(), TreasuryItem::load(), TreasuryGallery::load(), Pigeonholes::load(), PackagerVersions::load(), Nexus::load(), Multisites::load(), LibertyAttachable::load(), FisheyeImage::load(), FisheyeGallery::load(), BitUser::load(), BitSticky::load(), BitPage::load(), BitNewsletterEdition::load(), BitNewsletter::load(), BitGmapMarker::load(), BitGmap::load(), BitEvents::load(), BitBoardTopic::load(), BitBoard::load(), BitBlogPost::load(), BitArticle::load(), FisheyeGallery::loadImages(), LibertyContent::loadPreferences(), BitArticleTopic::loadTopic(), FisheyeImage::lookup(), FisheyeGallery::lookup(), BitBoard::lookupByMigrateBoard(), BitBoardTopic::lookupByMigratePost(), BitBoardTopic::lookupByMigrateTopic(), BitUser::lookupHomepage(), BitBoard::lookupMapRev(), Nexus::moveItemWest(), BitThemes::moveModule(), BitThemes::moveModuleDown(), BitThemes::moveModuleToArea(), BitThemes::moveModuleUp(), LibertyStructure::moveNodeWest(), RSSLib::parse_feeds(), TikiWikiParser::parseData(), BitThemes::parseGroups(), Messages::postSystemMessage(), BitBlogPost::preparePreview(), BitArticle::preparePreview(), PackagerInstall::prepareVersionForInstall(), BitUser::purgeImage(), BitMailer::queueRecipients(), BitBoard::removeContent(), FisheyeGallery::removeItem(), LibertyStructure::removeStructureNode(), LibertyAttachable::scanForAttchmentUse(), BitPage::setLock(), BitArticle::setStatus(), LibertyContent::setStructure(), smarty_function_captcha(), QuickTags::store(), Multisites::store(), LibertyContent::store(), BitSticky::store(), BitPage::store(), BitEvents::store(), BitBoard::store(), BitBlogPost::store(), BitSystem::storeConfig(), LibertyAttachable::storeExistingAttachments(), BitUser::storeFavorite(), BitPage::storeFootnote(), Nexus::storeItem(), Nexus::storeMenu(), BitThemes::storeModule(), LibertyAttachable::storeNewAttachments(), LibertyStructure::storeNode(), LibertyContent::storePermission(), BitBlogPost::storePostMap(), LibertyGatekeeper::storeSecurity(), LibertyTranslations::storeTranslation(), BitNewsletter::subscribe(), translation_content_edit(), translation_content_store(), treasury_default_expunge(), treasury_default_load(), treasury_default_verify(), treasury_flash_store(), treasury_flash_update(), treasury_flv_add_process(), treasury_flv_calculate_videosize(), treasury_flv_converter(), BitThemes::unassignModule(), BitUser::update_lastlogin(), TreasuryBase::updatePosition(), FisheyeBase::updatePosition(), TreasuryGallery::verify(), QuickTags::verify(), Pigeonholes::verify(), Multisites::verify(), LibertyTranslations::verify(), LibertyTag::verify(), LibertyContent::verify(), LibertyAttachable::verify(), BitUser::verify(), BitSticky::verify(), BitPage::verify(), BitNewsletterEdition::verify(), BitEvents::verify(), BitBoard::verify(), BitBlogPost::verify(), BitArticleType::verify(), BitArticleTopic::verify(), BitArticle::verify(), LibertyContent::verifyActionLog(), BitPermUser::verifyGroup(), Nexus::verifyItem(), Messages::verifyMessage(), LibertyStructure::verifyNode(), Pigeonholes::verifyPigeonholeMember(), LibertyAttachable::verifyPrimaryAttachmentId(), Multisites::verifyRestrictions(), LibertyStructure::verifyStructure(), and Nexus::writeMenuCache().


Member Data Documentation

BitBase::$dType [private]

Used to store database type

Definition at line 66 of file BitBase.php.

BitBase::$mCacheTime [private]

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

Definition at line 72 of file BitBase.php.

BitBase::$mDb [private]

Used to store database mechanism

Definition at line 60 of file BitBase.php.

BitBase::$mErrors [private]

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.

Todo:
not used yet

Definition at line 42 of file BitBase.php.

BitBase::$mInfo = array()

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

Reimplemented in BitUser.

Definition at line 77 of file BitBase.php.

BitBase::$mLogs = array()

Data hash that contains logging information relevant to database operations

Definition at line 82 of file BitBase.php.

BitBase::$mName [private]

String used to refer to preference caching and database table

Definition at line 54 of file BitBase.php.

BitBase::$mSuccess [private]

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

Definition at line 48 of file BitBase.php.


The documentation for this class was generated from the following file:
Generated on Wed Aug 22 19:34:05 2007 for bitweaver by  doxygen 1.5.2