boards
[ class tree: boards ] [ index: boards ] [ all elements ]

Class: BitBoard

Source Location: /boards/BitBoard.php

Class Overview

BitBase
   |
   --LibertyBase
      |
      --LibertyContent
         |
         --LibertyMime
            |
            --BitBoard



Variables

Methods


Inherited Constants

Inherited Variables

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


[ Top ]


Class Variables

$mBitBoardId =

[line 32]

Primary key for our mythical BitBoard class object & table



Tags:

public:  

Type:   mixed


[ Top ]



Class Methods


static method getDisplayUrlFromHash [line 613]

static the getDisplayUrlFromHash( &$pParamHash)

Generates the URL to the bitboard page



Tags:

return:  link to display the page.
access:  public


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

Parameters:

   &$pParamHash  

[ Top ]

static method getLinkedBoard [line 718]

static void getLinkedBoard( $pContentId)



Tags:

access:  public


Parameters:

   $pContentId  

[ Top ]

static method prepGetList [line 443]

static void prepGetList( &$pParamHash)



Tags:

access:  public


Parameters:

   &$pParamHash  

[ Top ]

constructor BitBoard [line 37]

BitBoard BitBoard( [ $pBitBoardId = NULL], [ $pContentId = NULL])

During initialisation, be sure to call our base constructors



Parameters:

   $pBitBoardId  
   $pContentId  

[ Top ]

method addContent [line 361]

void addContent( $content_id)



Parameters:

   $content_id  

[ Top ]

method expunge [line 275]

void expunge( )

This function removes a bitboard entry



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

[ Top ]

method fixContentMap [line 394]

void fixContentMap( )



[ Top ]

method getAllMap [line 307]

void getAllMap( )



[ Top ]

method getBoard [line 687]

void getBoard( $contentId)



Parameters:

   $contentId  

[ Top ]

method getBoardMailingList [line 744]

void getBoardMailingList( )



[ Top ]

method getBoardSelectList [line 644]

void getBoardSelectList( [ $pBlankFirst = FALSE])



Parameters:

   $pBlankFirst  

[ Top ]

method getBoardSyncInbox [line 735]

void getBoardSyncInbox( )



[ Top ]

method getLastTopic [line 587]

void getLastTopic( $data)



Parameters:

   $data  

[ Top ]

method getList [line 454]

void getList( &$pParamHash)

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



Parameters:

   &$pParamHash  

[ Top ]

method getMap [line 411]

void getMap( )



[ Top ]

method getUnMapped [line 328]

void getUnMapped( )



[ Top ]

method isValid [line 303]

void isValid( )

Make sure bitboard is loaded and valid



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

[ Top ]

method load [line 63]

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

Load the data from the database



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

Parameters:

pParamHash   $pContentId   be sure to pass by reference in case we need to make modifcations to the hash
   $pPluginParams  

[ Top ]

method lookupByMigrateBoard [line 100]

void lookupByMigrateBoard( $pMigrateBoardId)



Parameters:

   $pMigrateBoardId  

[ Top ]

method lookupMapRev [line 401]

void lookupMapRev( $content_id)



Parameters:

   $content_id  

[ Top ]

method preparePreview [line 246]

void preparePreview( $pParamHash)

Prepare data for preview



Parameters:

   $pParamHash  

[ Top ]

method removeContent [line 371]

void removeContent( $content_id)



Parameters:

   $content_id  

[ Top ]

method store [line 121]

bool store( pParamHash &$pParamHash, array 1)

Any method named Store inherently implies data will be written to the database



Tags:

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


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

Parameters:

array   1   pParams hash of values that will be used to store the page
pParamHash   &$pParamHash   be sure to pass by reference in case we need to make modifcations to the hash This is the ONLY method that should be called in order to store( create or update )an bitboard! It is very smart and will figure out what to do for you. It should be considered a black box.

[ Top ]

method verifyIntegrity [line 378]

void verifyIntegrity( )



[ Top ]


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