Class: LibertyAttachable

Source Location: d:\website\PhpDocumentor\/liberty/LibertyAttachable.php

Class Overview

BitBase
   |
   --LibertyBase
      |
      --LibertyContent
         |
         --LibertyAttachable

LibertyAttachable class

Variables

Methods

Child classes:

BitArticle

BitBlogPost

BitBoard

BitBoardTopic

FisheyeBase

BitNewsletterEdition

TreasuryBase: TreasuryBase

BitUser: Class that holds all information for a given user

BitPage: Sample class to illustrate best practices when creating a new bitweaver package that builds on core bitweaver functionality, such as the Liberty CMS engine

Inherited Variables

Class: LibertyContent

LibertyContent::$mAdminContentPerm
LibertyContent::$mContentTypeGuid
LibertyContent::$mPerms
LibertyContent::$mPrefs
LibertyContent::$mStructureId
LibertyContent::$mType

Class: BitBase

BitBase::$dType
BitBase::$mCacheTime
BitBase::$mDb
BitBase::$mErrors
BitBase::$mInfo
BitBase::$mLogs
BitBase::$mName
BitBase::$mSuccess

Inherited Methods

Class: LibertyContent

LibertyContent::LibertyContent(): Construct an empty LibertyBase object with a blank permissions array
LibertyContent::addHit(): Increment the content item hit flag by 1
LibertyContent::cacheUrl(): Cache given url If \c $data present (passed) it is just associated \c $url and \c $data.
LibertyContent::copyPermissions(): Copy current permissions to another object
LibertyContent::exportHtml(): Create an export object from the data
LibertyContent::expunge(): Delete content object and all related records
LibertyContent::expungeActionLog(): expungeActionLog
LibertyContent::expungeCacheFile(): Delete cache file for a given content item
LibertyContent::expungeComments(): Delete comment entries relating to the content object
LibertyContent::expungeVersion(): Removes a specific version of a page
LibertyContent::getActionLogs(): Get a list of action log entries
LibertyContent::getAuthorList(): Get a list of users who have created entries in the content table
LibertyContent::getCacheBasePath(): Get the path where we store liberty cached content
LibertyContent::getCacheFile(): Get the path to file where an individual cache item is stored
LibertyContent::getCachePath(): Get the path to directory where an individual cache item is stored
LibertyContent::getContentDescription(): Return content type description for this content object.
LibertyContent::getContentId(): Access a content item type GUID
LibertyContent::getContentList(): Get a list of all structures this content is a member of
LibertyContent::getContentRanking(): Get a list of content ranked by certain criteria set in $pListHash['sort_mode']
LibertyContent::getContentType(): Access a content item type GUID
LibertyContent::getContentTypeDescription()
LibertyContent::getDisplayLink(): Pure virtual function that returns link to display a piece of content
LibertyContent::getDisplayUrl(): Not-so-pure virtual function that returns Request_URI to a piece of content
LibertyContent::getFilter()
LibertyContent::getHistory(): Get complete set of historical data in order to display a given wiki page version
LibertyContent::getHistoryCount(): Get count of the number of historic records for the page
LibertyContent::getHits(): Get Hits and Last Hit
LibertyContent::getNumberOfPages(): Special parsing for multipage articles
LibertyContent::getPage(): Special parsing for a particular page of a multipage article
LibertyContent::getPreference(): Returns the content preferences value for the passed in key.
LibertyContent::getRenderFile(): Pure virtual function that returns the include file that should render a page of content of this type
LibertyContent::getServicesSql(): Set up SQL strings for services used by the object
LibertyContent::getStructures(): Get a list of all structures this content is a member of
LibertyContent::getThumbnailUrl(): Not-so-pure virtual function that returns Request_URI to a content's thumbnail representation. It is up to the derived content what exactly this means If not implemented in the content's class, this class will return NULL, which is an acceptable case meaning no thumbnail is available.
LibertyContent::getTitle(): Create the generic title for a content item
LibertyContent::getUserPermissions(): Get specific permissions for the specified user for this content
LibertyContent::hasAdminPermission(): Determine if current user has the ability to administer this type of content
LibertyContent::hasEditPermission(): Determine if current user has the ability to edit this type of content
LibertyContent::hasPermission(): Check is a user has permission to access the object
LibertyContent::hasUserPermission(): Function that determines if this content specified permission for the current gBitUser
LibertyContent::invokeServices(): Set up access to services used by the object
LibertyContent::isAdminable(): Check permissions to establish if user has permission to admin the object
LibertyContent::isCached(): Check if given url is currently cached locally
LibertyContent::isContentType(): Check user_id to establish if the object that has been loaded was created by the current user
LibertyContent::isEditable(): Check permissions to establish if user has permission to edit the object
LibertyContent::isHidden()
LibertyContent::isInStructure(): Check the number of structures that the content object is being used in
LibertyContent::isOwner(): Check user_id to establish if the object that has been loaded was created by the current user
LibertyContent::isPrivate()
LibertyContent::isProtected()
LibertyContent::isValid(): Check mContentId to establish if the object has been loaded with a valid record
LibertyContent::isViewable(): Check permissions to establish if user has permission to view the object
LibertyContent::load(): Assume a derived class has joined on the liberty_content table, and loaded it's columns already.
LibertyContent::loadAllObjectPermissions(): Load all permissions assigned to a given object. This is not for general consumption.
LibertyContent::loadPermissions(): Check permissions for the object that has been loaded against the permission database
LibertyContent::loadPreferences()
LibertyContent::pageExists(): Determines if a wiki page (row in wiki_pages) exists, and returns a hash of important info. If N pages exists with $pPageName, returned existsHash has a row for each unique pPageName row.
LibertyContent::parseData(): Process the raw content blob using the speified content GUID processor
LibertyContent::postGetList(): Updates results from any getList function to provide the control set
LibertyContent::registerContentType(): Copy current permissions to another object
LibertyContent::removeLastVersion(): Removes last version of the page (from pages) if theres some
LibertyContent::removePermission(): Remove a permission to access the object
LibertyContent::rollbackVersion(): Roll back to a specific version of a page
LibertyContent::setHits(): Set Hits and Last Hit
LibertyContent::setIndexData(): 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.
LibertyContent::setPreference(): Set a hash value in the mPrefs hash. This does *NOT* store the value in the database. It does no checking for existing or duplicate values. the main point of this function is to limit direct accessing of the mPrefs hash. I will probably make mPrefs private one day.
LibertyContent::setStructure(): Set content related mStructureId
LibertyContent::store(): Create a new content object or update an existing one
LibertyContent::storeActionLog(): storeActionLog Note: use $gBitSystem throughout that this function can be called statically if needed
LibertyContent::storeHistory()
LibertyContent::storePermission(): Store a permission for the object that has been loaded in the permission database
LibertyContent::storePreference(): Saves a preference to the liberty_content_prefs database table with the given pref name and value. If the value is NULL, the existing value will be delete and the value will not be saved. However, a zero will be stored. This will update the mPrefs hash.
LibertyContent::updateUserPermissions(): This function will replace all permissions for a particular package with the ones set using the content permissions
LibertyContent::verify(): Verify the core class data required to update the liberty_content table entries
LibertyContent::verifyAccessControl(): Check permissions to establish if user has permission to access the object
LibertyContent::verifyActionLog(): verify the data in the action log is ready for storing First checks $pParamHash['action_log'] for information and then the content_store stuff Note: use $gBitSystem throughout that this function can be called statically if needed

Class: LibertyBase

LibertyBase::LibertyBase(): Constructor building on BitBase object
LibertyBase::getLibertyObject(): Given a content_id, this will return and object of the proper type

Class: BitBase

BitBase::BitBase(): During initialisation, we assign a name which is used by the class.
BitBase::debug(): Switch debug level in database
BitBase::display(): This method should be THE method used to display a template. php files should not access $gBitSmarty directly.
BitBase::getDb(): Return pointer to current Database
BitBase::getField(): Returns entry from the mInfo hash if field exists
BitBase::isDatabaseValid(): Determines if there is a valide database connection
BitBase::prepGetList(): Prepares parameters with default values for any getList function
BitBase::setDatabase(): Sets database mechanism for the instance
BitBase::verifyId(): Determines if any given variable exists and is a number

Class Details

[line 40]
LibertyAttachable class

[ Top ]

Class Variables

$mContentId =

[line 41]

Type:	mixed
Overrides:	Array

[ Top ]

$mStorage =

[line 42]

Type:

mixed

[ Top ]

Class Methods

constructor LibertyAttachable [line 44]

LibertyAttachable LibertyAttachable(
)

Tags:

usedby:

TreasuryBase

[ Top ]

method cloneAttachment [line 382]

void cloneAttachment(

$pAttachmentId, 
$pNewContentId)

Parameters:

	$pAttachmentId
	$pNewContentId

[ Top ]

method detachAttachment [line 457]

TRUE detachAttachment(
array
$pAttachmentId)

detach attachment from content

Tags:

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

Parameters:

array

$pAttachmentId

Attachment id that needs to be detached from the content loaded

[ Top ]

method expunge [line 398]

void expunge(
)

Overridden in child classes as:

BitArticle::expunge(): Removes currently loaded article

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

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

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

FisheyeGallery::expunge()

FisheyeImage::expunge()

BitNewsletterEdition::expunge()

TreasuryGallery::expunge(): expunge a gallery

TreasuryItem::expunge(): Expunge data associated with an uploaded file

BitUser::expunge()

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

BitPage::expunge(): Remove page from database

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

[ Top ]

method expungeAttachment [line 414]

TRUE expungeAttachment(
array
$pAttachmentId)

expunge attachment from the database

Tags:

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

Parameters:

array

$pAttachmentId

attachment id of the item that should be deleted

[ Top ]

method getAttachment [line 515]

TRUE getAttachment(
array
$pAttachmentId)

load details of a given attachment allow an optional content_id to be passed in to ease legacy lib style objects (like blogs, articles, etc.)

Tags:

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

Parameters:

array

$pAttachmentId

[ Top ]

method getAttachmentList [line 324]

TRUE getAttachmentList(

&$pListHash, array
$pListHash)

Get a list of all available attachments

Tags:

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

Parameters:

array	$pListHash
	&$pListHash

[ Top ]

method getSiblingAttachments [line 542]

array getSiblingAttachments(
array
$pAttachmentId)

Get a list of attachments which also reference the foreign_id of the given attachment

Tags:

return:	with details of sibling attachments
access:	public

Parameters:

array

$pAttachmentId

[ Top ]

method getStorageBranch [line 87]

string getStorageBranch(
[$pSubDir
$pSubDir = NULL], [$pUserId
$pUserId = NULL], [$pRootDir
$pPackage = ACTIVE_PACKAGE], [
$pPermissions = 0755], [
$pRootDir = NULL])

getStorageBranch - get url to store files for the feature site_upload_dir. It creates a calculable hierarchy of directories

Tags:

return:	full path on local filsystem to store files.
author:	Christian Fowler<spider@steelsun.com>
access:	public

Parameters:

$pSubDir	$pSubDir	any desired directory below the StoragePath. this will be created if it doesn't exist
$pUserId	$pUserId	indicates the 'users/.../<user_id>' branch or use the 'common' branch if null
$pRootDir	$pPackage	override BIT_ROOT_DIR with a custom absolute path - useful for areas where no we access should be allowed
	$pPermissions
	$pRootDir

[ Top ]

method getStoragePath [line 58]

string getStoragePath(
[$pSubDir
$pSubDir = NULL], [$pCommon
$pUserId = NULL], [$pRootDir
$pPackage = ACTIVE_PACKAGE], [
$pPermissions = 0755], [
$pRootDir = NULL])

getStoragePath - get path to store files for the feature site_upload_dir. It creates a calculable hierarchy of directories

Tags:

return:	full path on local filsystem to store files.
author:	Christian Fowler<spider@steelsun.com>
access:	public

Parameters:

$pSubDir	$pSubDir	any desired directory below the StoragePath. this will be created if it doesn't exist
$pCommon	$pUserId	indicates not to use the 'common' branch, and not the 'users/.../<user_id>' branch
$pRootDir	$pPackage	override BIT_ROOT_DIR with a custom absolute path - useful for areas where no we access should be allowed
	$pPermissions
	$pRootDir

[ Top ]

method getStorageSubDirName [line 73]

void getStorageSubDirName(
)

[ Top ]

method getStorageUrl [line 69]

void getStorageUrl(
[
$pSubDir = NULL], [
$pUserId = NULL], [
$pPackage = ACTIVE_PACKAGE], [
$pPermissions = 0755], [
$pRootDir = NULL])

Parameters:

	$pSubDir
	$pUserId
	$pPackage
	$pPermissions
	$pRootDir

[ Top ]

method load [line 484]

TRUE load(
[array
$pContentId = NULL])

fully load content and insert any attachments in $this->mStorage allow an optional content_id to be passed in to ease legacy lib style objects (like blogs, articles, etc.)

Tags:

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

Overridden in child classes as:

BitArticle::load(): Load the data from the database

BitBlogPost::load(): Load a Blog Post section

BitBoard::load(): Load the data from the database

BitBoardTopic::load(): Load the data from the database

FisheyeGallery::load()

FisheyeImage::load()

BitNewsletterEdition::load()

TreasuryGallery::load(): load the treasury gallery

TreasuryItem::load(): load the treasury item

BitUser::load(): load - loads all settings & preferences for this user

BitPermUser::load()

BitPage::load()

Overrides LibertyContent::load() (Assume a derived class has joined on the liberty_content table, and loaded it's columns already.)

Parameters:

array

$pContentId

[ Top ]

method scanForAttchmentUse [line 563]

array scanForAttchmentUse(
array
$pAttachmentId)

This function will scan through liberty_content.data and will search for any occurrances of {attachemt id=<id>}

Tags:

return:	of content using a given attachment
access:	public

Parameters:

array

$pAttachmentId

Attachment id of interest

[ Top ]

method store [line 234]

void store(

&$pParamHash)

Overridden in child classes as:

BitArticle::store(): Store article data after submission

BitBlogPost::store(): Store a Blog Post

BitBoard::store(): Any method named Store inherently implies data will be written to the database

BitBoardTopic::store(): This function stickies a topic

FisheyeGallery::store()

FisheyeImage::store()

BitNewsletterEdition::store()

TreasuryGallery::store(): Store TreasuryGallery

TreasuryItem::store(): Store TreasuryItem

BitUser::store()

BitPermUser::store()

BitPage::store(): 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.

Overrides LibertyContent::store() (Create a new content object or update an existing one)

Parameters:

&$pParamHash

[ Top ]

method verify [line 160]

on verify(
$pFileName
&$pParamHash, $pSubDir
1, $pCommon
2, $pPackage
3)

verifyStorageFile - verify if a file exists

Tags:

return:	success return full path to file, if it fails to find the file, returns false
author:	Christian Fowler<spider@steelsun.com>
access:	public

Overridden in child classes as:

BitBlogPost::verify(): Verify that the store hash is valid and complete missing values

BitBoardTopic::verify()

BitNewsletterEdition::verify()

TreasuryItem::verify(): Verify content that is about to be stored

BitUser::verify()

Overrides LibertyContent::verify() (Verify the core class data required to update the liberty_content table entries)

Parameters:

$pSubDir	1	any desired directory below the StoragePath.
$pCommon	2	indicates usage of the 'common' branch, and not the 'users/.../<user_id>' branch
$pPackage	3	indicates what package the data is from. defaults to the currently active package
$pFileName	&$pParamHash	name of the file that needs to be checked for

[ Top ]

Documentation generated on Thu, 15 Feb 2007 20:41:54 +0000 by phpDocumentor 1.3.0