Class: BitBlogPost

Source Location: /blogs/BitBlogPost.php

Class Overview

BitBase
   |
   --LibertyBase
      |
      --LibertyContent
         |
         --LibertyMime
            |
            --BitBlogPost

Inherited Constants

Class: BitBase

BitBase::CACHE_STATE_ADDED
BitBase::CACHE_STATE_DELETE
BitBase::CACHE_STATE_NONE
BitBase::CACHE_STATE_STORED

Inherited Variables

Class: LibertyContent

LibertyContent::$mAdminContentPerm
LibertyContent::$mContentId
LibertyContent::$mContentTypeGuid
LibertyContent::$mCreateContentPerm
LibertyContent::$mExpungeContentPerm
LibertyContent::$mPrefs
LibertyContent::$mStructureId
LibertyContent::$mType
LibertyContent::$mUpdateContentPerm
LibertyContent::$mUserContentPerms
LibertyContent::$mViewContentPerm

Class: BitBase

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

Inherited Methods

Class: LibertyMime

LibertyMime::addDownloadHit(): Increment the item hit flag by 1
LibertyMime::getThumbnailUrl(): getThumbnailUrl will fetch the primary thumbnail for a given content. If nothing has been set, it will fetch the last thumbnail it can find.
LibertyMime::load(): load the attachments for a given content id and then stuff them in mStorage
LibertyMime::pluginStore(): pluginStore will use a given plugin to store uploaded file data
LibertyMime::store(): Store a new upload
LibertyMime::updateAttachmentParams(): updateAttachmentParams will update attachment parameters
LibertyMime::verify(): Verify content that is about to be stored
LibertyMime::verifyAttachment(): verifyAttachment will perform a generic check if a file is valid for processing

Class: LibertyContent

LibertyContent::__construct(): Construct an empty LibertyBase object with a blank permissions array
LibertyContent::addHit(): Increment the content item hit flag by 1
LibertyContent::checkContentPermission(): Check is a user has permission to access the object
LibertyContent::convertQueryHash(): Convert a built up pQueryHash into a single query string and set of bind variables.
LibertyContent::exportHash(): Create an export hash from the data
LibertyContent::exportList()
LibertyContent::expunge(): Delete content object and all related records
LibertyContent::expungeComments(): Delete comment entries relating to the content object
LibertyContent::expungeContentPermissions(): Expunge Content Permissions
LibertyContent::expungeVersion(): Removes a specific version of a page
LibertyContent::generateDescription(): Attempt to create a brief description of this object, most useful for <meta name="description" />
LibertyContent::generateKeywords(): Attempt to create a collection of relevant words about this object, most useful for <meta name="keywords" />
LibertyContent::getAliases(): Get array of aliases for this content object
LibertyContent::getCacheKey()
LibertyContent::getContentDescription(): Return content type description for this content object.
LibertyContent::getContentId(): Access a content item content_id
LibertyContent::getContentListPermissionsSql(): getContentListPermissionsSql
LibertyContent::getContentPermissionsList(): Load all permissions assigned to a given object.
LibertyContent::getContentPermissionsSql(): getContentPermissionsSql
LibertyContent::getContentType(): Access a content item type GUID
LibertyContent::getContentTypeDescription(): getContentTypeDescription
LibertyContent::getContentTypeName(): Get the display name of the content type
LibertyContent::getContentWithPermissionsList(): Get a list of content with permissions
LibertyContent::getDisplayLink(): Pure virtual function that returns link to display a piece of content
LibertyContent::getDisplayUri(): Not-so-pure virtual function that returns fully qualified URI to a piece of content
LibertyContent::getDisplayUriFromHash(): Not-so-pure virtual function that returns fully qualified URI to a piece of content
LibertyContent::getDisplayUrlFromHash(): Not-so-pure virtual function that returns Request_URI to a piece of content
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::getLibertySql(): Default liberty sql for joining a content object table to liberty.
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::getServicesSql2(): getServicesSql2
LibertyContent::getTitle(): Create the generic title for a content item
LibertyContent::getTitleFromHash(): Create the generic title for a content item
LibertyContent::getUserPermissions(): Get specific permissions for the specified user for this content
LibertyContent::getViewTemplate(): returns a path to the template type requested this is intended for package override. while not a requirement please use a naming convention of center_<action>_<content_type_guid>.tpl for new tpls
LibertyContent::hasAdminPermission(): Determine if current user has the ability to administer this type of content
LibertyContent::hasCreatePermission(): Determine if current user has the ability to craete this type of content
LibertyContent::hasEditPermission(): Deprecated, use hasUpdatePermission
LibertyContent::hasExpungePermission(): Determine if current user has the ability to delete/expunge this type of content
LibertyContent::hasPostCommentsPermission(): Determine if current user has the ability to post comments to this type of content
LibertyContent::hasService(): check if a service is active for this content type
LibertyContent::hasUpdatePermission(): Determine if current user has the ability to edit this type of content
LibertyContent::hasUserPermission(): Function that determines if this content specified permission for the current gBitUser.
LibertyContent::hasUserPermissions(): Check to see if the loaded content has individually assigned permissions
LibertyContent::hasViewPermission(): Determine if current user has the ability to view this type of content Note that this will always return TRUE if you haven't set the mViewContentPerm in your class
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::isCacheableClass()
LibertyContent::isCacheableObject()
LibertyContent::isContentType(): Check if content matches content type GUID - must also be a valid content object, it will not work for generic content class
LibertyContent::isEditable(): Check permissions to establish if user has permission to edit the object
LibertyContent::isExcludedPermission(): Check to see if this permission is already in the global permissions table.
LibertyContent::isOwner(): Check user_id to establish if the object that has been loaded was created by the current user
LibertyContent::isServiceRequired(): check if a service is required for this content type
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(): load Assume a derived class has joined on the liberty_content table, and loaded it's columns already.
LibertyContent::loadPreferences(): loadPreferences of the currently loaded object or pass in to get preferences of a specific content_id
LibertyContent::registerContentType(): Register the content type for reference
LibertyContent::removeLastVersion(): Removes last version of the page (from pages) if theres some version in the liberty_content_history then the last version becomes the actual version
LibertyContent::removePermission(): Remove a permission to access the content
LibertyContent::rollbackVersion(): Roll back to a specific version of a page
LibertyContent::setHits(): Set Hits and Last Hit
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::store(): Create a new content object or update an existing one
LibertyContent::storeAliases(): storeAliases will store aliases to a given content item
LibertyContent::storeHistory(): storeHistory will store the previous data into the history table for reference
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::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::verifyAdminPermission(): This code was duplicated _EVERYWHERE_ so here is an easy template to cut that down.
LibertyContent::verifyCreatePermission(): Determine if current user has the ability to create this type of content Note this will always return FALSEif the content isValid
LibertyContent::verifyEditPermission(): Deprecated, use verifyUpdatePermission
LibertyContent::verifyExpungePermission(): It will verify if a given user has a given $permission and if not, it will display the error template and die()
LibertyContent::verifyPostCommentsPermission(): It will verify if a given user has a given $permission and if not, it will display the error template and die()
LibertyContent::verifyUpdatePermission(): This code was duplicated _EVERYWHERE_ so here is an easy template to cut that down.
LibertyContent::verifyUserPermission(): Function that determines if this content specified permission for the current gBitUser, and will throw a fatal error if not.
LibertyContent::verifyViewPermission(): This code was duplicated _EVERYWHERE_ so here is an easy template to cut that down.

Class: LibertyBase

LibertyBase::__construct(): Constructor building on BitBase object
LibertyBase::getLibertyClass(): given a content_type_guid this will return an object of the proper type
LibertyBase::getLibertyObject(): Given a content_id, this will return and object of the proper type
LibertyBase::getNewObject(): Simple method to create a given class with a specified content_id. The purpose of a method is to allow for derived classes to override as necessary.
LibertyBase::getNewObjectById(): Simple method to create a given class with a specified primary_id. The purpose of a method is to allow for derived classes to override as necessary.

Class: BitBase

BitBase::BitBase(): During initialisation, we assign a name which is used by the class.
BitBase::__construct()
BitBase::clearFromCache()
BitBase::expunge(): Delete content object and all related records
BitBase::load()
BitBase::__destruct()

Class Details

[line 32]

[ Top ]

Class Variables

$mPostId =

[line 33]

Type:

mixed

[ Top ]

Class Methods

static method getDateRestrictions [line 1030]

static void getDateRestrictions(

$pListHash, 
&$whereSql, 
&$bindVars)

alters the whereSql and bindVars to limit the posts returned based on the dates

expects the blog_psots table to be aliased as bp

Tags:

access:

public

Parameters:

	$pListHash
	&$whereSql
	&$bindVars

[ Top ]

static method getDisplayUrlFromHash [line 656]

static object Url getDisplayUrlFromHash(
object PostId
&$pParamHash)

Generate a valid url for the Blog

Tags:

return:	String
access:	public

Overrides LibertyContent::getDisplayUrlFromHash() (Not-so-pure virtual function that returns Request_URI to a piece of content)

Parameters:

object PostId

&$pParamHash

of the item to use

[ Top ]

static method getTitleFromHash [line 150]

static void getTitleFromHash(

$pHash, [
$pDefault = TRUE])

Tags:

access:

public

Overrides LibertyContent::getTitleFromHash() (Create the generic title for a content item)

Parameters:

	$pHash
	$pDefault

[ Top ]

constructor BitBlogPost [line 35]

BitBlogPost BitBlogPost(
[
$pPostId = NULL], [
$pContentId = NULL])

Parameters:

	$pPostId
	$pContentId

[ Top ]

method addTrackbackFrom [line 1089]

void addTrackbackFrom(

$url, [
$title = ''], [
$excerpt = ''], [
$blog_name = ''])

Parameters:

	$url
	$title
	$excerpt
	$blog_name

[ Top ]

method clearTrackbacksFrom [line 1129]

void clearTrackbacksFrom(
)

[ Top ]

method clearTrackbacksTo [line 1140]

void clearTrackbacksTo(
)

[ Top ]

method expunge [line 610]

void expunge(
)

Remove complete blog post set and any comments

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

[ Top ]

method expungePostMap [line 596]

void expungePostMap(

$pPostContentId, 
$pBlogContentIds)

Parameters:

	$pPostContentId
	$pBlogContentIds

[ Top ]

method getAvailableContentStatuses [line 1170]

an getAvailableContentStatuses(
[
$pUserMinimum = -6], [
$pUserMaximum = 51])

getContentStatus

Tags:

return:

array of content_status_id, content_status_names the current user can use on this content.

NOTE: pUserMinimum and pUserMaximum are currently NOT inclusive in parent funtion, so these are one beyond the limit we desire

access:

public

Parameters:

	$pUserMinimum
	$pUserMaximum

[ Top ]

method getBlogMemberships [line 169]

void getBlogMemberships(

$pPostContentId)

Parameters:

$pPostContentId

[ Top ]

method getDescription [line 642]

object Url getDescription(
object PostId
0)

Return a summary for this content base on

Tags:

return:

String

Parameters:

object PostId

of the item to use

[ Top ]

method getDisplayLink [line 682]

object Fully getDisplayLink(
[object PostId
$pTitle = NULL], [array
$pMixed = NULL], [
$pAnchor = NULL])

Generate a valid display link for the Blog

Tags:

return:

formatted html link for use by Liberty

Overrides LibertyContent::getDisplayLink() (Pure virtual function that returns link to display a piece of content)

Parameters:

object PostId	$pTitle	of the item to use
array	$pMixed	Not used
	$pAnchor

[ Top ]

method getEditUrl [line 1190]

void getEditUrl(
[number
$pContentId = NULL], [array
$pMixed = NULL])

Returns the create/edit url to a blog post

Parameters:

number	$pContentId	a valid content id
array	$pMixed	a hash of params to add to the url

[ Top ]

method getExpiredList [line 1080]

array getExpiredList(

&$pParamHash, array
$pParamHash)

Get list of posts that have expired and are not displayed on the site anymore

Tags:

return:	of posts
access:	public

Parameters:

array	$pParamHash	contains listing options - same as getList()
	&$pParamHash

[ Top ]

method getFutureList [line 1067]

array getFutureList(

&$pParamHash, array
$pParamHash)

Get a list of posts that are to be published in the future

Tags:

return:	of posts
access:	public

Parameters:

array	$pParamHash	contains listing options - same as getList()
	&$pParamHash

[ Top ]

method getImageThumbnails [line 197]

url getImageThumbnails(
$pParamHash
$pParamHash)

Get the URL for any given post image

Tags:

return:	to image
access:	public

Parameters:

$pParamHash

$pParamHash

pass in full set of data returned from post query

[ Top ]

method getList [line 761]

void getList(

&$pListHash)

Parameters:

&$pListHash

[ Top ]

method getRenderFile [line 704]

the getRenderFile(
)

Returns include file that will

Tags:

return:

fully specified path to file to be included

Overrides LibertyContent::getRenderFile() (Pure virtual function that returns the include file that should render a page of content of this type)

[ Top ]

method getTrackbacksFrom [line 1109]

void getTrackbacksFrom(
)

[ Top ]

method getTrackbacksTo [line 1119]

void getTrackbacksTo(
)

[ Top ]

method getViewTemplate [line 1148]

void getViewTemplate(

$pAction)

Overrides LibertyContent::getViewTemplate() (returns a path to the template type requested this is intended for package override. while not a requirement please use a naming convention of center_<action>_<content_type_guid>.tpl for new tpls)

Parameters:

$pAction

[ Top ]

method isBlogOwner [line 389]

void isBlogOwner(
[
$pUserId = NULL])

Check if the current user is the blog owner

Parameters:

$pUserId

[ Top ]

method isCommentable [line 405]

void isCommentable(
)

Check if the current post can have comments attached to it

[ Top ]

method isValid [line 382]

void isValid(
)

Check that the class has a valid blog loaded

Overrides LibertyContent::isValid() (Check mContentId to establish if the object has been loaded with a valid record)

[ Top ]

method load [line 59]

void load(
[
$pContentId = NULL], [
$pPluginParams = NULL])

Load a Blog Post section

Overrides LibertyMime::load() (load the attachments for a given content id and then stuff them in mStorage)

Parameters:

	$pContentId
	$pPluginParams

[ Top ]

method loadPostMap [line 498]

void loadPostMap(

$pPostContentId, 
$pBlogContentId)

Parameters:

	$pPostContentId
	$pBlogContentId

[ Top ]

method preparePreview [line 217]

array preparePreview(
$previewData
$pParamHash)

Deal with images and text, modify them apprpriately that they can be returned to the form.

Tags:

return:	of data compatible with article form
access:	public

Parameters:

$previewData

$pParamHash

data submitted by form - generally $_REQUEST

[ Top ]

method sendTrackbacks [line 708]

void sendTrackbacks(

$pTrackbacks)

Parameters:

$pTrackbacks

[ Top ]

method store [line 414]

void store(

&$pParamHash)

Store a Blog Post

Tags:

todo:

users_watches is a legacy package and needs refactoring

Overrides LibertyMime::store() (Store a new upload)

Parameters:

&$pParamHash

[ Top ]

method storePostMap [line 518]

void storePostMap(
pPost
$pPost, pBlogMixed
$pBlogMixed, [pCrosspostNote
$pCrosspostNote = NULL], [pAutoProcess
$pAutoProcess = FALSE])

Map a Post to a Blog or multiple Blogs

Parameters:

pPost	$pPost	a Post hash.
pBlogMixed	$pBlogMixed	the content_id or and array of ids of the blogs we want the post to show up in.
pCrosspostNote	$pCrosspostNote	text to display with the blog post when viewed in the blog crossposted to.
pAutoProcess	$pAutoProcess	a bool to distinguish if we are storing from the crosspost interface or from the blog posting interface.

[ Top ]

Documentation generated on Wed, 29 Jul 2015 13:55:42 +0000 by phpDocumentor 1.5.0-lsces