BitPage Class Reference

Inheritance diagram for BitPage:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 BitPage ($pPageId=NULL, $pContentId=NULL)
 countSubPages ($data)
 expunge ()
 expungeFootnote ($pUserId)
 findByPageName ($pPageName, $pUserId=NULL)
 getBacklinks ()
 getDisplayLink ($pPageName, $pExistsHash)
 getDisplayUrl ($pPageName=NULL, $pMixed=NULL)
 getFootnote ($pUserId)
 getLikePages ($pPageTitle)
 getList (&$pListHash)
 getListLink ($pPageHash)
 getRenderFile ()
 getStats ()
 getSubPage ($data, $i)
 isCommentable ()
 isLocked ()
 isUserPage ()
 isValid ()
 load ()
 lock ($pModUserId=NULL)
 rollbackVersion ($pVersion, $comment= '')
 setIndexData ($pContentId=0)
 setLock ($pLock, $pModUserId=NULL)
 store (&$pParamHash)
 storeFootnote ($pUserId, $data)
 unlock ($pModUserId=NULL)
 update ($pHashOld, $pHashNew)
 verify (&$pParamHash)

Public Attributes

 $mPageId
 $mPageName

Detailed Description

Definition at line 27 of file BitPage.php.


Member Function Documentation

BitPage::BitPage ( pPageId = NULL,
pContentId = NULL 
)

Definition at line 31 of file BitPage.php.

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

Referenced by BitBook::BitBook(), and WikiLib::WikiLib().

Here is the call graph for this function:

BitPage::countSubPages ( data  ) 

Definition at line 734 of file BitPage.php.

References $data.

BitPage::expunge (  ) 

Remove page from database

Reimplemented from LibertyContent.

Definition at line 276 of file BitPage.php.

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

Here is the call graph for this function:

BitPage::expungeFootnote ( pUserId  ) 

Delete footnote

Definition at line 362 of file BitPage.php.

References $query, mDb, and BitBase::verifyId().

Here is the call graph for this function:

BitPage::findByPageName ( pPageName,
pUserId = NULL 
)

Definition at line 51 of file BitPage.php.

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

Here is the call graph for this function:

BitPage::getBacklinks (  ) 

Returns content_id's that link to this page

Returns:
hash of content

Definition at line 466 of file BitPage.php.

References $query, $ret, isValid(), mDb, mInfo, and title.

Here is the call graph for this function:

BitPage::getDisplayLink ( pPageName,
pExistsHash 
)

Returns HTML link to display a page if it exists, or to create if not

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

Definition at line 431 of file BitPage.php.

References $gBitSystem, $gBitUser, $ret, description, FALSE, title, and tra().

Referenced by getListLink(), and BitLinks::parseLinks().

Here is the call graph for this function:

BitPage::getDisplayUrl ( pPageName = NULL,
pMixed = NULL 
)

Generates the URL to this wiki page

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

Reimplemented from LibertyContent.

Definition at line 404 of file BitPage.php.

References $gBitSystem, and title.

Referenced by BitSystem::getDefaultPage(), getList(), and load().

BitPage::getFootnote ( pUserId  ) 

Get footnote

Definition at line 372 of file BitPage.php.

References $count, mDb, and BitBase::verifyId().

Here is the call graph for this function:

BitPage::getLikePages ( pPageTitle  ) 

Definition at line 750 of file BitPage.php.

References $query, $res, $result, $ret, LibertyContent::getServicesSql(), and mDb.

Here is the call graph for this function:

BitPage::getList ( &$  pListHash  ) 

getList

Parameters:
array $pListHash array of list parameters
boolean $pListHash['orphans_only'] only return orphan wiki pages
boolean $pListHash['extras'] load extra infrmation such as backlinks and links
boolean $pListHash['get_data'] return the wiki page data along with the listed information
string $pListHash['find_title'] filter by the page title
string $pListHash['find_author'] filter by the login name of the page author
string $pListHash['find_last_editor'] filter by the login name of the last editor of the page public
Returns:
array of wiki pages

Reimplemented in BitBook.

Definition at line 510 of file BitPage.php.

References $gBitSystem, $gBitUser, $query, $res, $result, $ret, compare_backlinks(), compare_links(), compare_versions(), editor, getDisplayUrl(), LibertyContent::getServicesSql(), mDb, BitBase::postGetList(), LibertyContent::prepGetList(), r_compare_backlinks(), r_compare_links(), r_compare_versions(), title, and BitBase::verifyId().

Referenced by getStats().

Here is the call graph for this function:

BitPage::getListLink ( pPageHash  ) 

Generates a link to a wiki page within lists of pages

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

Definition at line 386 of file BitPage.php.

References getDisplayLink(), and title.

Here is the call graph for this function:

BitPage::getRenderFile (  ) 

Returns include file that will

Returns:
the fully specified path to file to be included

Reimplemented from LibertyContent.

Definition at line 395 of file BitPage.php.

BitPage::getStats (  ) 

Definition at line 778 of file BitPage.php.

References $gBitSystem, $listHash, $query, $ret, getList(), and mDb.

Here is the call graph for this function:

BitPage::getSubPage ( data,
i 
)

Definition at line 739 of file BitPage.php.

References $data, $i, $parts, and $ret.

BitPage::isCommentable (  ) 

isCommentable will check allow_comments in mInfo or if it's set as a preference.

public

Returns:
TRUE on success, FALSE on failure

Reimplemented from LibertyContent.

Definition at line 317 of file BitPage.php.

References $gBitSystem.

BitPage::isLocked (  ) 

Definition at line 306 of file BitPage.php.

References $ret, FALSE, BitBase::getField(), load(), mInfo, and BitBase::verifyId().

Here is the call graph for this function:

BitPage::isUserPage (  ) 

Definition at line 293 of file BitPage.php.

References $ret, and FALSE.

BitPage::isValid (  ) 

Check mContentId to establish if the object has been loaded with a valid record

Reimplemented from LibertyContent.

Definition at line 301 of file BitPage.php.

References BitBase::verifyId().

Referenced by expunge(), getBacklinks(), and verify().

Here is the call graph for this function:

BitPage::load (  ) 

Definition at line 62 of file BitPage.php.

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

Referenced by isLocked(), store(), and verify().

Here is the call graph for this function:

BitPage::lock ( pModUserId = NULL  ) 

Definition at line 338 of file BitPage.php.

References setLock().

Here is the call graph for this function:

BitPage::rollbackVersion ( pVersion,
comment = '' 
)

Roll back to a specific version of a page

Parameters:
pVersion Version number to roll back to
comment Comment text to be added to the action log
Returns:
TRUE if completed successfully

Reimplemented from LibertyContent.

Definition at line 484 of file BitPage.php.

References $_SERVER, $action, $comment, $gBitSystem, $query, $result, $ret, FALSE, mContentId, and mDb.

BitPage::setIndexData ( pContentId = 0  ) 

This is a generic liberty content function to gather indexable words. Override this function in your BitPackage.php file if you need to add more indexable words from files other than tiki_content and users_users.

Reimplemented from LibertyContent.

Definition at line 688 of file BitPage.php.

References $gBitSystem, $res, $sql, mContentId, and mInfo.

BitPage::setLock ( pLock,
pModUserId = NULL 
)

Definition at line 322 of file BitPage.php.

References $query, $result, mDb, mInfo, and BitBase::verifyId().

Referenced by lock(), and unlock().

Here is the call graph for this function:

BitPage::store ( &$  pParamHash  ) 

This is the ONLY method that should be called in order to store (create or update) a wiki page! It is very smart and will figure out what to do for you. It should be considered a black box.

Parameters:
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 114 of file BitPage.php.

References $_SERVER, $foo, $gBitSmarty, $gBitSystem, $gBitUser, $machine, $mail_data, $notificationlib, $parts, $pParamHash, $result, httpPrefix(), load(), mContentId, mDb, mInfo, LibertyAttachable::store(), title, tra(), verify(), and BitBase::verifyId().

Here is the call graph for this function:

BitPage::storeFootnote ( pUserId,
data 
)

Store footnote

Definition at line 350 of file BitPage.php.

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

Here is the call graph for this function:

BitPage::unlock ( pModUserId = NULL  ) 

Definition at line 342 of file BitPage.php.

References setLock().

Here is the call graph for this function:

BitPage::update ( pHashOld,
pHashNew 
)

Definition at line 705 of file BitPage.php.

References $query, mDb, and title.

BitPage::verify ( &$  pParamHash  ) 

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!

Parameters:
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 190 of file BitPage.php.

References $gBitSystem, $gBitUser, $pParamHash, description, isValid(), load(), mInfo, mUserId, LibertyContent::pageExists(), title, and BitBase::verifyId().

Referenced by store().

Here is the call graph for this function:


Member Data Documentation

BitPage::$mPageId

Reimplemented in BitBook.

Definition at line 28 of file BitPage.php.

BitPage::$mPageName

Reimplemented in BitBook.

Definition at line 29 of file BitPage.php.


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