Class: BitArticle

Source Location: d:\website\PhpDocumentor\/articles/BitArticle.php

Class Overview

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

Inherited Variables

Inherited Methods

Class: LibertyAttachable

LibertyAttachable::LibertyAttachable()
LibertyAttachable::cloneAttachment()
LibertyAttachable::detachAttachment(): detach attachment from content
LibertyAttachable::expunge()
LibertyAttachable::expungeAttachment(): expunge attachment from the database
LibertyAttachable::getAttachment(): 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.)
LibertyAttachable::getAttachmentList(): Get a list of all available attachments
LibertyAttachable::getSiblingAttachments(): Get a list of attachments which also reference the foreign_id of the given attachment
LibertyAttachable::getStorageBranch(): getStorageBranch - get url to store files for the feature site_upload_dir. It creates a calculable hierarchy of directories
LibertyAttachable::getStoragePath(): getStoragePath - get path to store files for the feature site_upload_dir. It creates a calculable hierarchy of directories
LibertyAttachable::getStorageSubDirName()
LibertyAttachable::getStorageUrl()
LibertyAttachable::load(): 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.)
LibertyAttachable::scanForAttchmentUse(): This function will scan through liberty_content.data and will search for any occurrances of {attachemt id=<id>}
LibertyAttachable::store()
LibertyAttachable::verify(): verifyStorageFile - verify if a file exists

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 36]

[ Top ]

Class Variables

$mArticleId =

[line 41]

Primary key for articles

Tags:

access:

public

Type:

mixed

[ Top ]

$mTopicId =

[line 43]

Type:

mixed

[ Top ]

$mTypeId =

[line 42]

Type:

mixed

[ Top ]

Class Methods

method expunge [line 605]

bool expunge(
)

Removes currently loaded article

Tags:

return:	TRUE on success, FALSE on failure
access:	public

Overrides LibertyAttachable::expunge() (parent method not documented)

[ Top ]

method expungeImage [line 583]

bool expungeImage(
[$pArticleId
$pArticleId = NULL], [$pImagePath
$pImagePath = NULL])

Remove a custom article image - will result in the usage of the default image if a topic with image is selected

Tags:

return:	TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why
access:	public

Parameters:

$pArticleId	$pArticleId	ID of the article that needs the image removed
$pImagePath	$pImagePath	path to the image that needs removing - generally used during preview - will override article id

[ Top ]

method getArticleImageStorageName [line 373]

TRUE getArticleImageStorageName(
[array
$pArticleId = NULL])

Get the name of the article image file

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array

$pArticleId

article id

[ Top ]

method getArticleImageStoragePath [line 392]

path getArticleImageStoragePath(
[$pArticleId
$pArticleId = NULL], [$pBasePathOnly
$pBasePathOnly = FALSE])

Work out the path to the image for this article

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

$pArticleId	$pArticleId	id of the article we need the image path for
$pBasePathOnly	$pBasePathOnly	bool TRUE / FALSE - specify whether you want full path or just base path

[ Top ]

method getArticleImageStorageUrl [line 424]

URL getArticleImageStorageUrl(
[$pArticleId
$pArticleId = NULL], [$pBasePathOnly
$pBasePathOnly = FALSE], [
$pForceRefresh = FALSE])

Work out the URL to the image for this article

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

$pArticleId	$pArticleId	id of the article we need the image path for
$pBasePathOnly	$pBasePathOnly	bool TRUE / FALSE - specify whether you want full path or just base path
	$pForceRefresh

[ Top ]

method getDisplayUrl [line 796]

the getDisplayUrl(
[
$pArticleId = NULL])

Generates the URL to the article

Tags:

return:

link to the full article

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

Parameters:

$pArticleId

[ Top ]

method getImagePath [line 542]

url getImagePath(
$pParamHash
0)

Get the URL for any given article image

Tags:

return:	to image
access:	public

Parameters:

$pParamHash

pass in full set of data returned from article query

[ Top ]

method getImageUrl [line 556]

url getImageUrl(
$pParamHash
$pParamHash)

Get the URL for any given article image

Tags:

return:	to image
access:	public

Parameters:

$pParamHash

$pParamHash

pass in full set of data returned from article query

[ Top ]

method getList [line 640]

array getList(
$pParamHash
&$pParamHash)

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

Tags:

return:	['data'] which contains all articles that match pParamHash conditions ['cant'] which contains the number of articles that matched the pParamHash conditions
access:	public

Parameters:

$pParamHash

&$pParamHash

contains an array of conditions to sort by

[ Top ]

method getStatusList [line 822]

an getStatusList(
)

get a list of all available statuses

Tags:

return:	array of available statuses
access:	public

[ Top ]

method isValid [line 628]

bool isValid(
)

Check if there is an article loaded

Tags:

return:	TRUE on success, FALSE on failure
access:	public

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

[ Top ]

method load [line 78]

void load(
[
$pVersion = 0])

Load the data from the database

Tags:

access:

public

Overrides LibertyAttachable::load() (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.))

Parameters:

$pVersion

[ Top ]

method preparePreview [line 452]

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 setStatus [line 836]

new setStatus(
$pStatusId
$pStatusId, [$pArticleId
$pArticleId = NULL], [
$pContentId = NULL])

set the status of an article

Tags:

return:	status of article on success - else returns NULL
access:	public

Parameters:

$pStatusId	$pStatusId	new status id of the article
$pArticleId	$pArticleId	of the article that is being changed - if not set, it will attemtp to change the currently loaded article
	$pContentId

[ Top ]

method store [line 145]

bool store(
array
&$pParamHash)

Store article data after submission

Tags:

return:	TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why
access:	public

Overrides LibertyAttachable::store() (parent method not documented)

Parameters:

array

&$pParamHash

pParamHash of values that will be used to store the page

[ Top ]

method storeImage [line 337]

bool storeImage(
array
&$pParamHash, array
$pFileHash)

Store article image

Tags:

return:	TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why
access:	public

Parameters:

array	&$pParamHash	pParamHash of values that will be used to store the page
array	$pFileHash	pFileHash hash returned by $_FILES[<name>]

[ Top ]

Documentation generated on Thu, 15 Feb 2007 20:29:00 +0000 by phpDocumentor 1.3.0