BitBoard Class Reference

Inheritance diagram for BitBoard:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 addContent ($content_id)
 BitBoard ($pBitBoardId=NULL, $pContentId=NULL)
 expunge ()
 fixContentMap ()
 getAllMap ()
 getBoard ($contentId)
 getBoardSelectList ($pBlankFirst=FALSE)
 getDisplayUrl ()
 getLastTopic ($data)
 getLinkedBoard ($pContentId)
 getList (&$pParamHash)
 getMap ()
 getUnMapped ()
 isValid ()
 load ()
 lookupByMigrateBoard ($pMigrateBoardId)
 lookupMapRev ($content_id)
 prepGetList (&$pParamHash)
 removeContent ($content_id)
 store (&$pParamHash)
 verify (&$pParamHash)
 verifyIntegrity ()

Public Attributes

 $mBitBoardId

Detailed Description

Definition at line 27 of file BitBoard.php.


Member Function Documentation

BitBoard::addContent ( content_id  ) 

Definition at line 297 of file BitBoard.php.

References $data, mContentId, mDb, and BitBase::verifyId().

Referenced by fixContentMap().

Here is the call graph for this function:

BitBoard::BitBoard ( pBitBoardId = NULL,
pContentId = NULL 
)

During initialisation, be sure to call our base constructors

Definition at line 37 of file BitBoard.php.

References LibertyAttachable::LibertyAttachable(), mContentId, and LibertyContent::registerContentType().

Referenced by getAllMap().

Here is the call graph for this function:

BitBoard::expunge (  ) 

This function removes a bitboard entry

Reimplemented from LibertyContent.

Definition at line 218 of file BitBoard.php.

References $query, $result, $ret, LibertyContent::expunge(), FALSE, isValid(), mContentId, and mDb.

Here is the call graph for this function:

BitBoard::fixContentMap (  ) 

Definition at line 330 of file BitBoard.php.

References addContent(), isValid(), mContentId, removeContent(), and BitBase::verifyId().

Here is the call graph for this function:

BitBoard::getAllMap (  ) 

Definition at line 243 of file BitBoard.php.

References $b, $board, $content, $listHash, $ret, and BitBoard().

Here is the call graph for this function:

BitBoard::getBoard ( contentId  ) 

Definition at line 570 of file BitBoard.php.

References $gBitDb, $gBitUser, $query, $result, $ret, editor, and BitBase::verifyId().

Here is the call graph for this function:

BitBoard::getBoardSelectList ( pBlankFirst = FALSE  ) 

Definition at line 546 of file BitBoard.php.

References $gBitDb, $query, $ret, $row, $rs, and title.

Referenced by boards_content_edit().

BitBoard::getDisplayUrl (  ) 

Generates the URL to the bitboard page

Parameters:
pExistsHash the hash that was returned by LibertyContent::pageExists
Returns:
the link to display the page.

Definition at line 538 of file BitBoard.php.

References $ret, and BitBase::verifyId().

Referenced by load().

Here is the call graph for this function:

BitBoard::getLastTopic ( data  ) 

Definition at line 512 of file BitBoard.php.

References $data, $gBitSystem, $query, $result, mDb, and url.

Referenced by getList().

BitBoard::getLinkedBoard ( pContentId  ) 

Definition at line 601 of file BitBoard.php.

References $gBitDb, $ret, $sql, and BitBase::verifyId().

Referenced by boards_content_display(), boards_content_edit(), and boards_content_store().

Here is the call graph for this function:

BitBoard::getList ( &$  pParamHash  ) 

This function generates a list of records from the liberty_content database for use in a list page

Definition at line 390 of file BitBoard.php.

References $find, $gBitSystem, $gBitUser, $pParamHash, $query, $res, $result, $ret, $sort_mode, getLastTopic(), LibertyContent::getServicesSql(), mDb, LibertyContent::parseData(), BitBase::postGetList(), prepGetList(), and url.

Here is the call graph for this function:

BitBoard::getMap (  ) 

Definition at line 347 of file BitBoard.php.

References $gBitSystem, $ret, $row, $rs, $sql, isValid(), and mDb.

Here is the call graph for this function:

BitBoard::getUnMapped (  ) 

Definition at line 264 of file BitBoard.php.

References $gBitSystem, $ret, $row, $rs, $sql, and mDb.

BitBoard::isValid (  ) 

Make sure bitboard is loaded and valid

Reimplemented from LibertyContent.

Definition at line 239 of file BitBoard.php.

References BitBase::verifyId().

Referenced by expunge(), fixContentMap(), getMap(), and verifyIntegrity().

Here is the call graph for this function:

BitBoard::load (  ) 

Load the data from the database

Parameters:
pParamHash be sure to pass by reference in case we need to make modifcations to the hash

Definition at line 61 of file BitBoard.php.

References $query, $result, editor, getDisplayUrl(), LibertyContent::getServicesSql(), LibertyAttachable::load(), mContentId, mDb, mInfo, LibertyContent::parseData(), and BitBase::verifyId().

Referenced by store(), and verify().

Here is the call graph for this function:

BitBoard::lookupByMigrateBoard ( pMigrateBoardId  ) 

Definition at line 98 of file BitBoard.php.

References $gBitDb, $ret, and BitBase::verifyId().

Here is the call graph for this function:

BitBoard::lookupMapRev ( content_id  ) 

Definition at line 337 of file BitBoard.php.

References $gBitDb, $ret, $sql, and BitBase::verifyId().

Here is the call graph for this function:

BitBoard::prepGetList ( &$  pListHash  ) 

Liberty override to stuff content_status_id and 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 from LibertyContent.

Definition at line 379 of file BitBoard.php.

References $pParamHash, and LibertyContent::prepGetList().

Referenced by getList().

Here is the call graph for this function:

BitBoard::removeContent ( content_id  ) 

Definition at line 307 of file BitBoard.php.

References $result, $sql, mContentId, mDb, and BitBase::verifyId().

Referenced by fixContentMap().

Here is the call graph for this function:

BitBoard::store ( &$  pParamHash  ) 

Any method named Store inherently implies data will be written to the database

Parameters:
pParamHash be sure to pass by reference in case we need to make modifcations to the hash This is the ONLY method that should be called in order to store( create or update )an bitboard! It is very smart and will figure out what to do for you. It should be considered a black box.
array pParams hash of values that will be used to store the page
Returns:
bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why
public

Reimplemented from LibertyAttachable.

Definition at line 119 of file BitBoard.php.

References $pParamHash, $result, load(), mDb, LibertyAttachable::store(), verify(), and BitBase::verifyId().

Here is the call graph for this function:

BitBoard::verify ( &$  pParamHash  ) 

Make sure the data is safe to store

Parameters:
pParamHash be sure to pass by reference in case we need to make modifcations to the hash This function is responsible for data integrity and validation before any operations are performed with the $pParamHash NOTE: This is a PRIVATE METHOD!!!! do not call outside this class, under penalty of death!
array pParams reference to hash of values that will be used to store the page, they will be modified where necessary
Returns:
bool TRUE on success, FALSE if verify failed. If FALSE, $this->mErrors will have reason why
private

Reimplemented from LibertyAttachable.

Definition at line 159 of file BitBoard.php.

References $pParamHash, load(), mInfo, title, and BitBase::verifyId().

Referenced by store().

Here is the call graph for this function:

BitBoard::verifyIntegrity (  ) 

Definition at line 314 of file BitBoard.php.

References $count, $gBitSystem, $ret, $sql, isValid(), and mDb.

Here is the call graph for this function:


Member Data Documentation

BitBoard::$mBitBoardId

Primary key for our mythical BitBoard class object & table

Definition at line 32 of file BitBoard.php.


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