bitweaver: LibertyContent Class Reference

LibertyContent::addHit ( )

Increment the content item hit flag by 1

Returns:: bool true ( will not currently report a failure )

Definition at line 1283 of file LibertyContent.php.

References $_REQUEST, $gBitSystem, $gBitUser, $query, $result, BitBase::getField(), isOwner(), mContentId, mDb, and BitBase::verifyId().

Here is the call graph for this function:

LibertyContent::checkContentPermission ( $ pParamHash )

Check is a user has permission to access the object

Parameters:

	integer	User Identifier
	integer	Content Itentifier
	string	Content Type GUID
	string	Name of the permission

Returns:: bool true if access is allowed

Definition at line 813 of file LibertyContent.php.

References $gBitUser, $pParamHash, $query, $ret, FALSE, getContentPermissionsSql(), isValid(), mContentId, mDb, and BitBase::verifyId().

Referenced by BitBlogPost::storePostMap().

Here is the call graph for this function:

LibertyContent::exportHtml ( $ pData = NULL )

Create an export object from the data

Parameters:

array

Not used

Reimplemented in FisheyeGallery, and FisheyeImage.

Definition at line 663 of file LibertyContent.php.

References $ret, FALSE, getDisplayUrl(), mContentId, and url.

Here is the call graph for this function:

LibertyContent::expunge ( )

Delete content object and all related records

Reimplemented in BitArticle, BitBlog, BitBlogPost, BitBoard, BitBoardPost, BitEvents, BitGmap, BitGmapMarker, BitNewsletter, BitNewsletterEdition, BitSticky, BitPermUser, BitUser, and BitPage.

Definition at line 392 of file LibertyContent.php.

References $gBitSystem, $gLibertySystem, $query, $result, $ret, expungeCacheFile(), expungeComments(), expungeVersion(), FALSE, filterData(), BitBase::getField(), invokeServices(), isValid(), mContentId, mDb, mInfo, and storeActionLog().

Referenced by LibertyComment::deleteComment(), TreasuryItem::expunge(), TreasuryGallery::expunge(), Pigeonholes::expunge(), LibertyAttachable::expunge(), FisheyeImage::expunge(), FisheyeGallery::expunge(), BitSticky::expunge(), BitPage::expunge(), BitNewsletterEdition::expunge(), BitGmapMarker::expunge(), BitGmap::expunge(), BitEvents::expunge(), BitBoard::expunge(), BitBlogPost::expunge(), BitArticle::expunge(), TreasuryItem::expungingAttachment(), and FisheyeImage::expungingAttachment().

Here is the call graph for this function:

LibertyContent::expungeActionLog ( $ pTimeSpan = NULL )

expungeActionLog

Parameters:

array

$pTimeSpan Anything older than this timespan will be removed public

Returns:: TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 2570 of file LibertyContent.php.

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

Here is the call graph for this function:

LibertyContent::expungeCache ( )

Delete liberty cache

Parameters:

array

$pContentId public

Returns:: TRUE on success, FALSE on failure

Definition at line 2368 of file LibertyContent.php.

References $gBitSystem, $ret, FALSE, getCacheBasePath(), and unlink_r().

Referenced by LibertySystem::setActivePlugins().

Here is the call graph for this function:

LibertyContent::expungeCacheFile ( $ pContentId = NULL )

Delete cache files for a given content item

Parameters:

array

$pContentId public

Returns:: TRUE on success, FALSE on failure

Definition at line 2346 of file LibertyContent.php.

References FALSE, getCachePath(), and BitBase::verifyId().

Referenced by expunge(), BitLinks::expungeLinks(), removeLastVersion(), BitLinks::renameLinks(), store(), and BitLinks::storeLinks().

Here is the call graph for this function:

LibertyContent::expungeComments ( )

Delete comment entries relating to the content object

Definition at line 376 of file LibertyContent.php.

References $query, mContentId, and mDb.

Referenced by expunge().

LibertyContent::expungeContentPermissions ( )

Expunge Object Permissions

public

Returns:: TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 910 of file LibertyContent.php.

References $query, $ret, FALSE, isValid(), mContentId, and mDb.

Here is the call graph for this function:

LibertyContent::expungeVersion	(	$	pVersion = `NULL`,
		$	comment = `''`
	)

Removes 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

Definition at line 632 of file LibertyContent.php.

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

Referenced by expunge(), BitPage::expunge(), and removeLastVersion().

Here is the call graph for this function:

LibertyContent::filterData	(	&$	pData,
		&$	pFilterHash,
		$	pFilterStage = `'preparse'`
	)

filterData will apply one of the specified filter stages to the input data

Parameters:

	array	$pFilterHash array of data that should be filtered
	string	$pFilterHash[data] is the actual data that needs to be filtered
	keyword	$pFilterStage specify what filter stage the data is at: pre, post, presplit or postsplit public

Returns:: filtered data

Definition at line 2101 of file LibertyContent.php.

References $gLibertySystem, and $guid.

Referenced by expunge(), parseData(), store(), and verify().

LibertyContent::getActionLogs ( &$ pListHash )

Get a list of action log entries

Parameters:

array

$pListHash List options public

Returns:: List of entries on success, FALSE on failure

Definition at line 2515 of file LibertyContent.php.

References $query, $result, $ret, editor, BitUser::getTitle(), mDb, BitBase::postGetList(), and prepGetList().

Here is the call graph for this function:

LibertyContent::getAuthorList ( &$ pListHash )

Get a list of users who have created entries in the content table

Parameters:

array

hash of parameters ( content_type_guid will limit list to a single content type

Returns:: - none the hash is updated via the reference

Definition at line 1577 of file LibertyContent.php.

References $mid, $query, $result, $ret, mDb, and prepGetList().

Here is the call graph for this function:

LibertyContent::getCacheBasePath ( )

Get the path where we store liberty cached content

public

Returns:: absolute path

Definition at line 2259 of file LibertyContent.php.

Referenced by expungeCache(), and getCachePath().

LibertyContent::getCacheFile	(	$	pContentId = `NULL`,
		$	pCacheExtension = `NULL`
	)

Get the path to file where an individual cache item is stored

Parameters:

array

$pContentId Content id of cached item public

Returns:: filename on success, FALSE on failure

Definition at line 2331 of file LibertyContent.php.

References $ret, FALSE, and getCachePath().

Referenced by isCached(), and parseData().

Here is the call graph for this function:

LibertyContent::getCachePath ( $ pContentId = NULL )

Get the path to directory where an individual cache item is stored

Parameters:

array

$pContentId Content id of cached item public

Returns:: path on success, FALSE on failure

Definition at line 2270 of file LibertyContent.php.

References $ret, FALSE, getCacheBasePath(), mContentId, and BitBase::verifyId().

Referenced by expungeCacheFile(), and getCacheFile().

Here is the call graph for this function:

LibertyContent::getContentDescription ( )

Return content type description for this content object.

Returns:: string content_type_guid description for the object

Definition at line 1423 of file LibertyContent.php.

References $gLibertySystem, $ret, and mInfo.

LibertyContent::getContentId ( )

Access a content item type GUID

Returns:: string content_type_guid for the object

Definition at line 1410 of file LibertyContent.php.

References $ret, and mContentId.

LibertyContent::getContentList ( $ pListHash )

Get a list of all structures this content is a member of

Parameters:

	string	$pListHash['content_type_guid'] Content GUID to limit the list to
	integer	$pListHash['max_records'] Number of the first record to access ( used to page the list )
	integer	$pListHash['offset'] Number of records to return
	string	$pListHash['sort_mode'] Name of the field to sort by ( extended by _asc or _desc for sort direction )
	array	$pListHash['find'] List of text elements to filter the results by
	integer	$pListHash[''] User ID - If set, then only the objcets created by that user will be returned $pListHash['last_modified'] date - modified since $pListHash['end_date'] date - modified before

Returns:: array An array of mInfo type arrays of content objects

Definition at line 1639 of file LibertyContent.php.

References $contentTypes, $gBitSmarty, $gBitSystem, $gBitUser, $gLibertySystem, $query, $result, $ret, $type, $userInfo, compare_backlinks(), compare_links(), compare_versions(), editor, getFilter(), getServicesSql(), load(), mDb, mPackages, BitBase::postGetList(), prepGetList(), r_compare_backlinks(), r_compare_links(), r_compare_versions(), title, and BitBase::verifyId().

Here is the call graph for this function:

LibertyContent::getContentPermissionsList ( )

Load all permissions assigned to a given object. This is not for general consumption. This funtions sole purpose is for displaying purposes. if you want to get all permissions assigned to a given object use LibertyContent::loadPermissions();

public

Definition at line 863 of file LibertyContent.php.

References $gBitUser, $query, $ret, FALSE, isValid(), mContentId, and mDb.

Here is the call graph for this function:

LibertyContent::getContentPermissionsSql	(	$	pPermName,
		&$	pSelectSql,
		&$	pJoinSql,
		&$	pWhereSql,
		&$	pBindVars
	)

Definition at line 793 of file LibertyContent.php.

References $gBitUser.

Referenced by checkContentPermission(), and BitBlog::getList().

LibertyContent::getContentRanking ( $ pListHash )

Get a list of content ranked by certain criteria set in $pListHash['sort_mode']

Parameters:

array

hash of parameters ( content_type_guid will limit list to a single content type

Returns:: - data

Definition at line 1608 of file LibertyContent.php.

References $gBitUser, $ret, LibertyContent(), title, and tra().

Here is the call graph for this function:

LibertyContent::getContentStatus	(	$	pUserMinimum = `-100`,
		$	pUserMaximum = `100`
	)

getContentStatus

public

Returns:: an array of content_status_id, content_status_names the current user can use on this content. Subclases may easily override with return LibertyContent::getContentStatus(-100, 0) for example to restrict to only hidden content types.

Definition at line 2588 of file LibertyContent.php.

References $gBitUser, and mDb.

Referenced by BitEvents::getContentStatus(), and verify().

LibertyContent::getContentType ( )

Access a content item type GUID

Returns:: string content_type_guid for the content

Definition at line 1383 of file LibertyContent.php.

References $ret, mInfo, and mType.

Referenced by FisheyeImage::exportHtml(), FisheyeGallery::exportHtml(), getContentTypeDescription(), FisheyeGallery::verifyGalleryData(), FisheyeImage::verifyImageData(), and BitBlog::viewerHasPermission().

LibertyContent::getContentTypeDescription ( $ pContentType = NULL )

Definition at line 1397 of file LibertyContent.php.

References $gLibertySystem, and getContentType().

Referenced by BitBlogPost::getDisplayLink().

Here is the call graph for this function:

LibertyContent::getContentWithPermissionsList ( )

Get a list of content with permissions

public

Returns:: TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 887 of file LibertyContent.php.

References $gBitSystem, $query, and $ret.

LibertyContent::getDisplayLink	(	$	pLinkText = `NULL`,
		$	pMixed = `NULL`,
		$	pAnchor = `NULL`
	)

Pure virtual function that returns link to display a piece of content

Parameters:

	string	$pLinkText Text for the link unless overriden by object title
	array	$pMixed different possibilities depending on derived class
	string	$pAnchor anchor string e.g.: comment_123

Returns:: string Formated html the link to display the page.

Reimplemented in TreasuryItem.

Definition at line 1453 of file LibertyContent.php.

References $gBitSmarty, $ret, mInfo, title, and tra().

Referenced by BitArticle::getList().

Here is the call graph for this function:

LibertyContent::getDisplayUri	(	$	pContentId = `NULL`,
		$	pMixed = `NULL`
	)

Not-so-pure virtual function that returns fully qualified URI to a piece of content

Parameters:

	string	Text for DisplayLink function
	array	different possibilities depending on derived class

Returns:: string Formated URL address to display the page.

Definition at line 1493 of file LibertyContent.php.

References getDisplayUrl().

Here is the call graph for this function:

LibertyContent::getDisplayUrl	(	$	pContentId = `NULL`,
		$	pMixed = `NULL`
	)

Not-so-pure virtual function that returns Request_URI to a piece of content

Parameters:

	string	Text for DisplayLink function
	array	different possibilities depending on derived class

Returns:: string Formated URL address to display the page.


Public Member Functions
	addHit ()
	checkContentPermission ($pParamHash)
	exportHtml ($pData=NULL)
	expunge ()
	expungeActionLog ($pTimeSpan=NULL)
	expungeCache ()
	expungeCacheFile ($pContentId=NULL)
	expungeComments ()
	expungeContentPermissions ()
	expungeVersion ($pVersion=NULL, $comment= '')
	filterData (&$pData, &$pFilterHash, $pFilterStage= 'preparse')
	getActionLogs (&$pListHash)
	getAuthorList (&$pListHash)
	getCacheBasePath ()
	getCacheFile ($pContentId=NULL, $pCacheExtension=NULL)
	getCachePath ($pContentId=NULL)
	getContentDescription ()
	getContentId ()
	getContentList ($pListHash)
	getContentPermissionsList ()
	getContentPermissionsSql ($pPermName, &$pSelectSql, &$pJoinSql, &$pWhereSql, &$pBindVars)
	getContentRanking ($pListHash)
	getContentStatus ($pUserMinimum=-100, $pUserMaximum=100)
	getContentType ()
	getContentTypeDescription ($pContentType=NULL)
	getContentWithPermissionsList ()
	getDisplayLink ($pLinkText=NULL, $pMixed=NULL, $pAnchor=NULL)
	getDisplayUri ($pContentId=NULL, $pMixed=NULL)
	getDisplayUrl ($pContentId=NULL, $pMixed=NULL)
	getFilter ($pContentTypeGuid, &$pSql, &$pBindVars, $pHash=null)
	getHistory ($pVersion=NULL, $pUserId=NULL, $pOffset=0, $max_records=-1)
	getHistoryCount ()
	getHits ()
	getListingPreview ($pMixed)
	getNumberOfPages (&$data)
	getPage (&$data, $i)
	getPreference ($pPrefName, $pPrefDefault=NULL, $pContentId=NULL)
	getPreview ()
	getPreviewUrl ($pContentId=NULL, $pMixed=NULL)
	getRenderFile ()
	getServicesSql ($pServiceFunction, &$pSelectSql, &$pJoinSql, &$pWhereSql, &$pBindVars, $pObject=NULL, $pParamHash=NULL)
	getStructures ()
	getThumbnailUrl ($pSize='small', $pContentId=NULL, $pSecondaryId=NULL)
	getTitle ($pHash=NULL)
	getUserPermissions ($pUserId)
	hasAdminPermission ($pVerifyAccessControl=TRUE)
	hasAssignedPermissions ()
	hasEditPermission ($pVerifyAccessControl=TRUE)
	hasUserPermission ($pPermName, $pVerifyAccessControl=TRUE)
	hasViewPermission ($pVerifyAccessControl=TRUE)
	invokeServices ($pServiceFunction, $pFunctionParam=NULL)
	isAdminable ($pContentId=NULL)
	isCached ($pContentId=NULL)
	isCommentable ()
	isContentType ($pContentGuid)
	isDeleted ()
	isEditable ($pContentId=NULL)
	isExcludedPermission ($pGroupId, $pPermName)
	isHidden ()
	isInStructure ($pStructureId=NULL)
	isOwner ($pParamHash=NULL)
	isPrivate ()
	isProtected ()
	isValid ()
	isViewable ($pContentId=NULL)
	LibertyContent ()
	load ($pContentId=NULL)
	loadPermissions ($pForce=FALSE)
	loadPreferences ($pContentId=NULL)
	pageExists ($pPageName, $pCaseSensitive=FALSE, $pContentId=NULL)
	parseData ($pMixed=NULL, $pFormatGuid=NULL)
	parseSplit ($pParseHash, $pLength=500, $pForceLength=FALSE)
	prepGetList (&$pListHash)
	readCacheFile ($pCacheFile)
	registerContentType ($pContentGuid, $pTypeParams)
	removeLastVersion ($comment= '')
	removePermission ($pGroupId, $pPermName)
	rollbackVersion ($pVersion, $comment= '')
	setHits ($pHits, $pLastHit=0)
	setIndexData ($pContentId=0)
	setPreference ($pPrefName, $pPrefValue)
	setStructure ($pStructureId)
	store (&$pParamHash)
	storeActionLog ($pParamHash=NULL)
	storeHistory ()
	storePermission ($pGroupId, $pPermName)
	storePreference ($pPrefName, $pPrefValue=NULL)
	storeStatus ($pContentStatusId)
	verify (&$pParamHash)
	verifyAccessControl ()
	verifyActionLog (&$pParamHash)
	verifyPermission ($pPermName, $pFatalMessage=NULL)
	writeCacheFile ($pCacheFile, $pData)
Public Attributes
	$mAdminContentPerm
	$mContentId
	$mContentTypeGuid
	$mEditContentPerm
	$mPerms = NULL
	$mStructureId
	$mType
Private Attributes
	$mPrefs = NULL
	$mViewContentPerm

LibertyContent Class Reference

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function Documentation