Docs For Class LibertyContent

LibertyContent LibertyContent(
)

Construct an empty LibertyBase object with a blank permissions array

[ Top ]

bool addHit(
)

Increment the content item hit flag by 1

Tags:

return:

true ( will not currently report a failure )

[ Top ]

bool cacheUrl(
string
$url, [string
$data = ''])

Cache given url If \c $data present (passed) it is just associated \c $url and \c $data.

Else it will request data for given URL and store it in DB. Actualy (currently) data may be proviced by TIkiIntegrator only.

Tags:

return:	True if item was successfully cached
todo:	LEGACY FUNCTIONS that need to be cleaned / moved / or deprecated & deleted

Parameters:

string	$url	URL to cache
string	$data	Data to be cached

[ Top ]

bool copyPermissions(
integer
$destinationObjectId)

Copy current permissions to another object

Tags:

return:

true ( will not currently report a failure )

Parameters:

integer

$destinationObjectId

Content Identifier of the target object

[ Top ]

void exportHtml(
[array
$pData = NULL])

Create an export object from the data

Overridden in child classes as:

FisheyeGallery::exportHtml()

FisheyeImage::exportHtml()

Parameters:

array

$pData

Not used

[ Top ]

void expunge(
)

Delete content object and all related records

Overridden in child classes as:

BitBlog::expunge()

LibertyAttachable::expunge()

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

BitNewsletter::expunge()

Pigeonholes::expunge(): Expunge currently loaded pigeonhole

BitSticky::expunge(): Delete stickies object and related content record

[ Top ]

TRUE expungeActionLog(
[array
$pTimeSpan = NULL])

expungeActionLog

Tags:

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

Parameters:

array

$pTimeSpan

Anything older than this timespan will be removed

[ Top ]

TRUE expungeCacheFile(
[array
$pContentId = NULL])

Delete cache file for a given content item

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array

$pContentId

[ Top ]

void expungeComments(
)

Delete comment entries relating to the content object

[ Top ]

TRUE expungeVersion(
[pVersion
$pVersion = NULL], [comment
$comment = ''])

Removes a specific version of a page

Tags:

return:

if completed successfully

Parameters:

pVersion	$pVersion	Version number to roll back to
comment	$comment	Comment text to be added to the action log

[ Top ]

List getActionLogs(

&$pListHash, array
$pListHash)

Get a list of action log entries

Tags:

return:	of entries on success, FALSE on failure
access:	public

Parameters:

array	$pListHash	List options
	&$pListHash

[ Top ]

- getAuthorList(
array
&$pListHash)

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

Tags:

return:

none the hash is updated via the reference

Parameters:

array

&$pListHash

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

[ Top ]

absolute getCacheBasePath(
)

Get the path where we store liberty cached content

Tags:

return:	path
access:	public

[ Top ]

filename getCacheFile(
[array
$pContentId = NULL], [
$pCacheExtension = NULL])

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

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array	$pContentId
	$pCacheExtension

[ Top ]

path getCachePath(
[array
$pContentId = NULL])

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

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array

$pContentId

[ Top ]

string getContentDescription(
)

Return content type description for this content object.

Tags:

return:

content_type_guid description for the object

[ Top ]

string getContentId(
)

Access a content item type GUID

Tags:

return:

content_type_guid for the object

[ Top ]

array getContentList(

$pListHash, string
$pListHash['content_type_guid'], integer
$pListHash['max_records'], integer
$pListHash['offset'], string
$pListHash['sort_mode'], array
$pListHash['find'], integer
$pListHash[''])

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

Tags:

return:

An array of mInfo type arrays of content objects

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
	$pListHash

[ Top ]

- getContentRanking(
array
$pListHash)

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

Tags:

return:

data

Parameters:

array

$pListHash

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

[ Top ]

string getContentType(
)

Access a content item type GUID

Tags:

return:

content_type_guid for the object

[ Top ]

void getContentTypeDescription(
[
$pContentType = NULL])

Parameters:

$pContentType

[ Top ]

string getDisplayLink(
string
$pLinkText, array
$pMixed)

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

Tags:

return:

Formated html the link to display the page.

Overridden in child classes as:

BitBlogPost::getDisplayLink(): Generate a valid display link for the Blog

FisheyeImage::getDisplayLink(): Generate a valid display link for the Blog

TreasuryGallery::getDisplayLink(): Returns HTML link to display a gallery or item

TreasuryItem::getDisplayLink(): Returns HTML link to display a gallery or item

BitUser::getDisplayLink()

BitPage::getDisplayLink(): Returns HTML link to display a page if it exists, or to create if not

Pigeonholes::getDisplayLink(): Returns HTML link to display a pigeonhole

Parameters:

string	$pLinkText	Text for the link unless overriden by object title
array	$pMixed	different possibilities depending on derived class

[ Top ]

string getDisplayUrl(
[string
$pContentId = NULL], [array
$pMixed = NULL])

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

Tags:

return:

Formated URL address to display the page.

Overridden in child classes as:

BitBlog::getDisplayUrl()

BitArticle::getDisplayUrl(): Generates the URL to the article

BitBlogPost::getDisplayUrl(): Generate a valid url for the Blog

BitBoard::getDisplayUrl(): Generates the URL to the bitboard page

BitBoardTopic::getDisplayUrl(): Generates the URL to the bitboard page

FisheyeGallery::getDisplayUrl(): Function that returns link to display a piece of content

FisheyeImage::getDisplayUrl(): Function that returns link to display a piece of content

BitNewsletterEdition::getDisplayUrl(): Generate a valid url for the Newsletter Edition

TreasuryGallery::getDisplayUrl(): Generates the URL to this gallery

TreasuryItem::getDisplayUrl(): Generate URL to view this item in detail

BitUser::getDisplayUrl()

BitPage::getDisplayUrl(): Generates the URL to this wiki page

LibertyComment::getDisplayUrl()

BitBoardPost::getDisplayUrl(): Generates the URL to the bitboard page

BitNewsletter::getDisplayUrl(): Generate a valid url for the Newsletter

Pigeonholes::getDisplayUrl(): Generates the URL to this pigeonhole

Parameters:

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

[ Top ]

void getFilter(

$pContentTypeGuid, 
&$pSql, 
&$pBindVars, [
$pHash = null])

Parameters:

	$pContentTypeGuid
	&$pSql
	&$pBindVars
	$pHash

[ Top ]

array getHistory(
[pExistsHash
$pVersion = NULL], [
$pUserId = NULL], [
$pOffset = 0], [
$max_records = -1])

Get complete set of historical data in order to display a given wiki page version

Tags:

return:

of mInfo data

Parameters:

pExistsHash	$pVersion	the hash that was returned by LibertyContent::pageExists
	$pUserId
	$pOffset
	$max_records

[ Top ]

count getHistoryCount(
)

Get count of the number of historic records for the page

[ Top ]

bool getHits(
)

Get Hits and Last Hit

Tags:

return:

true ( will not currently report a failure )

[ Top ]

string getNumberOfPages(
string
&$data)

Special parsing for multipage articles

Temporarily remove

...

sections to protect from broke

pre

tags and leave well known

pre

behaviour (i.e. type all text inside AS IS w/o any interpretation)

Tags:

return:

Extracted pages

Parameters:

string

&$data

Data to process

[ Top ]

string getPage(
string
&$data, integer
$i)

Special parsing for a particular page of a multipage article

Temporary remove <PRE></PRE> secions to protect from broke <PRE> tags and leave well known <PRE> behaviour (i.e. type all text inside AS IS w/o any interpretation)

Tags:

return:

Extracted page

Parameters:

string	&$data	Data to process
integer	$i	Number of page to extract

[ Top ]

void getPreference(
string
$pPrefName, [string
$pPrefDefault = NULL], [int
$pContentId = NULL])

Returns the content preferences value for the passed in key.

Parameters:

string	$pPrefName	Hash key for the mPrefs value
string	$pPrefDefault	Default value to return if the preference is empty
int	$pContentId	Optional content_id for arbitrary content preference

[ Top ]

the getRenderFile(
)

Pure virtual function that returns the include file that should render a page of content of this type

Tags:

return:

fully specified path to file to be included

Overridden in child classes as:

BitBlogPost::getRenderFile(): Returns include file that will

FisheyeGallery::getRenderFile(): Returns include file that will setup the object for rendering

FisheyeImage::getRenderFile(): Returns include file that will setup vars for display

BitUser::getRenderFile(): Returns include file that will

BitPage::getRenderFile(): Returns include file that will

[ Top ]

void getServicesSql(

$pServiceFunction, 
&$pSelectSql, 
&$pJoinSql, 
&$pWhereSql, 
&$pBindVars, [
$pObject = NULL], [
$pParamHash = NULL])

Set up SQL strings for services used by the object

Parameters:

	$pServiceFunction
	&$pSelectSql
	&$pJoinSql
	&$pWhereSql
	&$pBindVars
	$pObject
	$pParamHash

[ Top ]

void getStructures(
)

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

[ Top ]

string getThumbnailUrl(
[string
$pSize = 'small'], [int
$pContentId = NULL], [int
$pSecondaryId = NULL])

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.

FisheyeGallery, BitUser might return pictures, BitArticle might return the article topic image, etc.

Tags:

return:

Formated URL address to display the page.

Overridden in child classes as:

FisheyeGallery::getThumbnailUrl()

FisheyeImage::getThumbnailUrl()

Parameters:

string	$pSize	Size of the url to return - should be a standard thumbnail size such as 'icon', 'avatar', 'small', 'medium', or 'large'
int	$pContentId	optional contentId tp generate the thumbnail, if empty, the mContentId variable should be used
int	$pSecondaryId	optional secondary id, such as user_id or products_id, etc

[ Top ]

string getTitle(
[array
$pHash = NULL])

Create the generic title for a content item

This will normally be overwriten by extended classes to provide an appropriate title title string

Tags:

return:

Descriptive title for the object

Overridden in child classes as:

BitBlogPost::getTitle()

BitUser::getTitle()

Parameters:

array

$pHash

mInfo type hash of data to be used to provide base data

[ Top ]

array getUserPermissions(
integer
$pUserId)

Get specific permissions for the specified user for this content

Tags:

return:

Array of user permissions

Parameters:

integer

$pUserId

Id of user for whom permissions are to be loaded

[ Top ]

bool hasAdminPermission(
)

Determine if current user has the ability to administer this type of content

Tags:

return:

True if user has this type of content administration permission

[ Top ]

bool hasEditPermission(
)

Determine if current user has the ability to edit this type of content

Tags:

return:

True if user has this type of content administration permission

[ Top ]

bool hasPermission(
integer
$pUserId, integer
$pObjectId, string
$pObjectType, string
$pPermName)

Check is a user has permission to access the object

Tags:

return:

true if access is allowed

Overridden in child classes as:

BitPermUser::hasPermission()

Parameters:

integer	$pUserId	User Identifier
integer	$pObjectId	Content Itentifier
string	$pObjectType	Content Type GUID
string	$pPermName	Name of the permission

[ Top ]

bool hasUserPermission(
string
$pPermName, [bool
$pFatalIfFalse = FALSE], [string
$pFatalMessage = NULL])

Function that determines if this content specified permission for the current gBitUser

Tags:

return:

true if user has permission to access file

Overridden in child classes as:

FisheyeBase::hasUserPermission(): Overloaded function that determines if this content can be edited by the current gBitUser

Parameters:

string	$pPermName	Name of the permission to check
bool	$pFatalIfFalse	Generate fatal message if permission denigned
string	$pFatalMessage	Message if permission denigned

[ Top ]

void invokeServices(

$pServiceFunction, [
$pFunctionParam = NULL])

Set up access to services used by the object

Parameters:

	$pServiceFunction
	$pFunctionParam

[ Top ]

void isAdminable(
[
$pContentId = NULL])

Check permissions to establish if user has permission to admin the object

That would include permission to delete an object or change it's permissions Should be provided by the decendent package

Parameters:

$pContentId

[ Top ]

integer isCached(
string
$url)

Check if given url is currently cached locally

Tags:

return:	Id of the cached item
todo:	LEGACY FUNCTIONS that need to be cleaned / moved / or deprecated & deleted

Parameters:

string

$url

URL to check

[ Top ]

void isContentType(

$pContentGuid)

Check user_id to establish if the object that has been loaded was created by the current user

Parameters:

$pContentGuid

[ Top ]

void isEditable(
[
$pContentId = NULL])

Check permissions to establish if user has permission to edit the object

Should be provided by the decendent package

Parameters:

$pContentId

[ Top ]

void isHidden(
)

[ Top ]

integer isInStructure(
[integer
$pStructureId = NULL])

Check the number of structures that the content object is being used in

Tags:

return:

Number of structures that this content object is located in

Parameters:

integer

$pStructureId

Structure ID ( If NULL or not supplied check all structures )

[ Top ]

TRUE isOwner(
[$pParamHash
$pParamHash = NULL])

Check user_id to establish if the object that has been loaded was created by the current user

Tags:

return:

if user owns the content

Parameters:

$pParamHash

$pParamHash

optionally pass in the hash to check against

[ Top ]

void isPrivate(
)

[ Top ]

void isProtected(
)

[ Top ]

void isValid(
)

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

Overridden in child classes as:

BitBlog::isValid(): Check if there is an article loaded

BitArticle::isValid(): Check if there is an article loaded

BitBlogPost::isValid(): Check that the class has a valid blog loaded

BitBoard::isValid(): Make sure bitboard is loaded and valid

FisheyeGallery::isValid()

FisheyeImage::isValid()

BitNewsletterEdition::isValid()

BitUser::isValid()

BitPage::isValid()

BitNewsletter::isValid()

[ Top ]

void isViewable(
[
$pContentId = NULL])

Check permissions to establish if user has permission to view the object

Should be provided by the decendent package

Parameters:

$pContentId

[ Top ]

void load(
[
$pContentId = NULL])

Assume a derived class has joined on the liberty_content table, and loaded it's columns already.

Overridden in child classes as:

BitBlog::load()

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.)

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()

BitNewsletter::load()

Pigeonholes::load(): load the pigeonhole

BitSticky::load(): Load a sticky object identified by mStickyId, $this->mNotatedContentId or mContentId in that order

Parameters:

$pContentId

[ Top ]

void loadAllObjectPermissions(
[
$pParamHash = NULL])

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();

Tags:

access:

public

Parameters:

$pParamHash

[ Top ]

TRUE loadPermissions(
)

Check permissions for the object that has been loaded against the permission database

Tags:

return:	if permissions were inserted into $this->mPerms
access:	public

Overridden in child classes as:

BitPermUser::loadPermissions()

[ Top ]

void loadPreferences(
[
$pContentId = NULL])

Parameters:

$pContentId

[ Top ]

void pageExists(
pPageName
$pPageName, [pCaseSensitive
$pCaseSensitive = FALSE], [pContentId
$pContentId = NULL])

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.

Parameters:

pPageName	$pPageName	name of the wiki page
pCaseSensitive	$pCaseSensitive	look for case sensitive names
pContentId	$pContentId	if you insert the content id of the currently viewed object, non-existing links can be created immediately

[ Top ]

string parseData(
[pMixed
$pMixed = NULL], [string
$pFormatGuid = NULL], int
2, boolean
3, string
4, string
5)

Process the raw content blob using the speified content GUID processor

This is the "object like" method. It should be more object like, but for now, we'll just point to the old lib style "parse_data" - XOXO spiderr

Tags:

return:

Formated data string

Parameters:

int	2	pMixed['content_id'] content_id or the item to be parsed - required for caching and optimal parser performance
boolean	3	pMixed['no_cache'] disable caching
string	4	pMixed['cache_extension'] cache to a seperate file. useful for truncated displays of parsed content such as article front page
string	5	pFormatGuid processor to use
pMixed	$pMixed	can be a string or a hash - if a string is given, it will be parsed without the use of cache
string	$pFormatGuid	pMixed['data'] string to be parsed

[ Top ]

- postGetList(
array
&$pListHash)

Updates results from any getList function to provide the control set

displaying in the smarty template

Tags:

return:

none the hash is updated via the reference

Parameters:

array

&$pListHash

hash of parameters returned by any getList() function

[ Top ]

void registerContentType(
string
$pContentGuid, array
$pTypeParams)

Copy current permissions to another object

Parameters:

string	$pContentGuid	Content Type GUID
array	$pTypeParams	Array of content type data Populates the mType array with the following entries string content_type_guid string

[ Top ]

void removeLastVersion(
[
$comment = ''])

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

Parameters:

$comment

[ Top ]

bool removePermission(
integer
$pGroupId, string
$pPermName)

Remove a permission to access the object

Tags:

return:

true ( will not currently report a failure )

Parameters:

integer	$pGroupId	Group Identifier
string	$pPermName	Name of the permission

[ Top ]

TRUE rollbackVersion(
pVersion
$pVersion, [comment
$comment = ''])

Roll back to a specific version of a page

Tags:

return:

if completed successfully

Overridden in child classes as:

BitPage::rollbackVersion(): Roll back to a specific version of a page

Parameters:

pVersion	$pVersion	Version number to roll back to
comment	$comment	Comment text to be added to the action log

[ Top ]

bool setHits(

$pHits, [
$pLastHit = 0])

Set Hits and Last Hit

Tags:

return:

true ( will not currently report a failure )

Parameters:

	$pHits
	$pLastHit

[ Top ]

void 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.

Overridden in child classes as:

BitPage::setIndexData()

Parameters:

$pContentId

[ Top ]

void setPreference(
string
$pPrefName, string
$pPrefValue)

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.

Parameters:

string	$pPrefName	Hash key for the mPrefs value
string	$pPrefValue	Value for the mPrefs hash key

[ Top ]

void setStructure(
integer
$pStructureId)

Set content related mStructureId

Parameters:

integer

$pStructureId

Structure ID

[ Top ]

void store(
array
&$pParamHash)

Create a new content object or update an existing one

Overridden in child classes as:

BitBlog::store()

LibertyAttachable::store()

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.

BitBoardPost::store(): This function stores a post

BitNewsletter::store()

Pigeonholes::store(): Store pigeonhole data

BitSticky::store(): Create a new stickies object or update an existing one

Parameters:

array

&$pParamHash

Array of content data to be stored
See verify for details of the values required

[ Top ]

TRUE storeActionLog(
[array
$pParamHash = NULL])

storeActionLog Note: use $gBitSystem throughout that this function can be called statically if needed

Class: LibertyContent

Class Overview

Variables

Methods

Child classes:

Inherited Variables

Class: BitBase

Inherited Methods

Class: LibertyBase

Class: BitBase

Class Details

Class Variables

$mAdminContentPerm =

Tags:

$mContentId =

Tags:

$mContentTypeGuid =

Tags:

$mPerms =

Tags:

$mPrefs =

Tags:

$mStructureId =

Tags:

$mType =

Tags:

Class Methods

constructor LibertyContent [line 91]

method addHit [line 1102]

Tags:

method cacheUrl [line 1915]

Tags:

Parameters:

method copyPermissions [line 990]

Tags:

Parameters:

method exportHtml [line 612]

Parameters:

method expunge [line 364]

method expungeActionLog [line 2269]

Tags:

Parameters:

method expungeCacheFile [line 2064]

Tags:

Parameters:

method expungeComments [line 348]

method expungeVersion [line 581]

Tags:

Parameters:

method getActionLogs [line 2214]

Tags:

Parameters:

method getAuthorList [line 1418]

Tags:

Parameters:

method getCacheBasePath [line 2003]

Tags:

method getCacheFile [line 2049]

Tags:

Parameters:

method getCachePath [line 2014]

Tags:

Parameters:

method getContentDescription [line 1242]

Tags:

method getContentId [line 1229]

Tags:

method getContentList [line 1480]

Tags:

Parameters:

method getContentRanking [line 1449]

Tags:

Parameters:

method getContentType [line 1202]

Tags:

method getContentTypeDescription [line 1216]

Parameters:

method getDisplayLink [line 1270]

Tags:

Parameters: