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

Class: LibertyBase

Source Location: /liberty/LibertyBase.php

Class Overview

BitBase
   |
   --LibertyBase

Virtual base class (as much as one can have such things in PHP) for all derived bitweaver classes that manage content.


Methods


Child classes:

BitMailer
BitMailer
LibertyProtector
Protector class to illustrate best practices when creating a new bitweaver package that builds on core bitweaver functionality, such as the Liberty CMS engine
LibertyTag
LibertyStructure
System class for handling the liberty package
LibertyContent
Virtual base class (as much as one can have such things in PHP) for all derived tikiwiki classes that require database access.
LibertyTranslations
LibertyStars
Liberty Stars

Inherited Constants

Inherited Variables

Inherited Methods

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 33]
Virtual base class (as much as one can have such things in PHP) for all derived bitweaver classes that manage content.



[ Top ]


Class Methods


static method getLibertyObject [line 67]

static object of getLibertyObject( integer $pContentId, [string $pContentGuid = NULL], [call $pLoadContent = TRUE])

Given a content_id, this will return and object of the proper type



Tags:

return:  the appropriate content type class
access:  public


Parameters:

integer   $pContentId   content_id of the object to be returned
string   $pContentGuid   optional content_type_guid of pConId. This will save a select if you happen to have this info. If not, this method will look it up for you.
call   $pLoadContent   load on the content. Defaults to true.

[ Top ]

constructor __construct [line 42]

LibertyBase __construct( )

Constructor building on BitBase object

Object need to init the database connection early Database will be linked via a previously activated BitDb object which will provide the mDb pointer to that database




Overridden in child classes as:

LibertyProtector::__construct()
During initialisation, be sure to call our base constructors
LibertyTag::__construct()
LibertyStructure::__construct()
LibertyContent::__construct()
Construct an empty LibertyBase object with a blank permissions array
BitNewsletter::__construct()
BitNewsletterEdition::__construct()
FisheyeGallery::__construct()
LibertyTranslations::__construct()
LibertyStars::__construct()
Initiate Liberty Stars

Overrides BitBase::__construct() (parent method not documented)

[ Top ]

method getLibertyClass [line 51]

void getLibertyClass( the $pContentGuid)

given a content_type_guid this will return an object of the proper type



Parameters:

the   $pContentGuid   content type to be loaded

[ Top ]

method getNewObject [line 110]

object of getNewObject( string $pClass, integer $pContentId, [call $pLoadContent = TRUE])

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.



Tags:

return:  the appropriate content type class
access:  public


Parameters:

string   $pClass   class to be created
integer   $pContentId   content_id of the object to be returned
call   $pLoadContent   load on the content. Defaults to true.

[ Top ]

method getNewObjectById [line 94]

object of getNewObjectById( string $pClass, integer $pPrimaryId, [call $pLoadContent = TRUE])

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.



Tags:

return:  the appropriate content type class
access:  public


Parameters:

string   $pClass   class to be created
integer   $pPrimaryId   id from the secondary table of the object to be returned
call   $pLoadContent   load on the content. Defaults to true.

[ Top ]


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