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

Class: BitNewsletter

Source Location: d:\website\PhpDocumentor\/newsletters/BitNewsletter.php

Class Overview

BitBase
   |
   --LibertyBase
      |
      --LibertyContent
         |
         --BitNewsletter



Methods


Inherited Variables

Inherited Methods

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


[ Top ]


Class Methods


constructor BitNewsletter [line 34]

BitNewsletter BitNewsletter( [ $pNlId = NULL], [ $pContentId = NULL])



Parameters:

   $pNlId  
   $pContentId  

[ Top ]

method confirmSubscription [line 207]

void confirmSubscription( $pUrlCode, [ $notify = FALSE])



Parameters:

   $pUrlCode  
   $notify  

[ Top ]

method expunge [line 372]

void expunge( )



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

[ Top ]

method getDisplayUrl [line 404]

object Url getDisplayUrl( [object $pNewsletterId = NULL])

Generate a valid url for the Newsletter



Tags:

return:  String


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

Parameters:

object   $pNewsletterId   of the item to use

[ Top ]

method getEditions [line 423]

void getEditions( [ $pNewsletterId = NULL])



Parameters:

   $pNewsletterId  

[ Top ]

method getList [line 295]

void getList( &$pListHash)



Parameters:

   &$pListHash  

[ Top ]

method getSubscriberInfo [line 117]

void getSubscriberInfo( $pLookup)



Parameters:

   $pLookup  

[ Top ]

method getSubscribers [line 139]

void getSubscribers( [ $pAll = FALSE])



Parameters:

   $pAll  

[ Top ]

method getUserSubscriptions [line 437]

void getUserSubscriptions( $pUserId, $pEmail)



Parameters:

   $pUserId  
   $pEmail  

[ Top ]

method get_unsub_msg [line 361]

void get_unsub_msg( $nl_id, $email)



Parameters:

   $nl_id  
   $email  

[ Top ]

method isValid [line 393]

void isValid( )



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

[ Top ]

method load [line 49]

void load( [ $pUserId = NULL])



Overrides LibertyContent::load() (Assume a derived class has joined on the liberty_content table, and loaded it's columns already.)

Parameters:

   $pUserId  

[ Top ]

method loadEditions [line 81]

void loadEditions( )



[ Top ]

method removeSubscription [line 151]

void removeSubscription( $email, [ $notify = FALSE], [ $del_record = FALSE])



Parameters:

   $email  
   $notify  
   $del_record  

[ Top ]

method store [line 87]

void store( &$pParamHash)



Overrides LibertyContent::store() (Create a new content object or update an existing one)

Parameters:

   &$pParamHash  

[ Top ]

method subscribe [line 160]

void subscribe( $pSubscribeHash)



Parameters:

   $pSubscribeHash  

[ Top ]

method unsubscribe [line 231]

void unsubscribe( $pMixed, [ $notify = TRUE])



Parameters:

   $pMixed  
   $notify  

[ Top ]

method verify [line 105]

void verify( &$pParamHash)



Overrides LibertyContent::verify() (Verify the core class data required to update the liberty_content table entries)

Parameters:

   &$pParamHash  

[ Top ]


Documentation generated on Thu, 15 Feb 2007 20:31:18 +0000 by phpDocumentor 1.3.0