ForumManager Class Reference

Public Member Functions
	ForumManager ()

Static Public Member Functions
static	initializeUserProfileHandler ()
static	registerUserProfileHandler ($handler)
static	formatUserProfile ($u)
static	defaultUserProfileHandler ($user)
static	displayForum ($identifier, &$continue)
static	enumerateFora ($items)
static	setDefaults ()
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...
static	deleteForum ($forum)
	When deleting a forum, we must delete topics, messages, attachments and site xrefs. More...
static	deleteForumMessage ($message)
static	upgradeComponent ($version)
static	registerTaxonomyClasses ($classes)

Static Public Attributes
static	$userProfileHandler = null

Detailed Description

Definition at line 40 of file forum_manager.inc.

Member Function Documentation

defaultUserProfileHandler()

static ForumManager::defaultUserProfileHandler (   $user )

static

Definition at line 69 of file forum_manager.inc.

     {
          return $user->getFullName();
     }

deleteForum()

static ForumManager::deleteForum (   $forum )

static

When deleting a forum, we must delete topics, messages, attachments and site xrefs.

Parameters

unknown

$forum

Exceptions

Exception

Definition at line 183 of file forum_manager.inc.

     {
          $forum_id = $forum->forum_id;
          
          $tx = new DataTransaction();
          
          try
          {
               $forum->joinTransaction($tx);
               
               $topic = new ForumTopic();
               $topic->joinTransaction($tx);
               $topic->delete("WHERE forum_id={$forum_id}");
               
               $messages = $forum->Messages();
               
               if(count($messages))
               {
                    foreach($messages as $message)
                    {
                         $message->joinTransaction($tx);
                         ForumManager::deleteForumMessage($message);
                    }
               }
               
               $xref = new ForumSiteXref();
               $xref->joinTransaction($tx);
               $xref->delete("WHERE forum_id={$forum_id}");
               
               $forum->delete();
               
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }
     }

deleteForumMessage()

static ForumManager::deleteForumMessage (   $message )

static

Definition at line 223 of file forum_manager.inc.

     {
          $tx = new DataTransaction();
          
          try
          {
               $message->joinTransaction($tx);
               
               $attachments = $message->Attachments();
               if(count($attachments))
               {
                    $xref = new ForumMessageAttachmentXref();
                    $xref->joinTransaction($tx);
                    
                    foreach($attachments as $attachment)
                    {
                         $attachment->joinTransaction($tx);
                         $attachment->delete();
                         $xref->delete("WHERE attachment_id={$attachment->attachment_id}");
                    }         
               }
               $message->delete();      
                    
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }                   
     }

deleteUser()

static ForumManager::deleteUser (   $user )

static

Respond to fired event DeleteUser.

Delete any records in this component that have dependencies on user object.

Parameters

obj

$user

- class SiteUser or custom user class

Definition at line 128 of file forum_manager.inc.

     {
          $pk = $user->getPrimaryKey();
          $user_id = $user->$pk;
          
          trace("Component forum is deleting objects dependent on user_id {$user_id}", 3);
     
          $tx = new DataTransaction();
          
          try
          {
               $forums = Query::create(Forum, "WHERE owner_id=:owner_id")
                         ->bind(":owner_id", $user_id)
                         ->execute();
               
               if(count($forums))
               {
                    foreach($forums as $forum)
                    {
                         $forum->joinTransaction($tx);
                         ForumManager::deleteForum($forum);
                    }
               }
               
               $messages = Query::create(ForumMessage, "WHERE author_id=:author_id")
                    ->bind(":author_id", $user_id)
                    ->execute();
               
               if(count($messages))
               {
                    foreach($messages as $message)
                    {                   
                         $message->joinTransaction($tx);
                         ForumManager::deleteForumMessage($message);
                    }
               }    
               
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }
          
          return $user;
     }

displayForum()

static ForumManager::displayForum (   $identifier, &  $continue  )

static

Definition at line 74 of file forum_manager.inc.

     {
          global $page_role;
          
          try
          {
               $forum = Forum::findByIdentifier($identifier);
               $page = ComponentPage::findByIdentifier("forum_details", "WHERE enabled=1");
               $_GET["forum_id"] = $forum->forum_id;
          
               $pageView = new ComponentPageView($page, "{$page->template}.tpl");
          
               $page_role = $page->role;
               
               if (!checkRole($page->role))
               {
                    LoginManager::storeRedirectPage();
                    redirect("/login");
               }
               
               echo $pageView->drawView();
               
               $continue = false;
          }
          catch(DataNotFoundException $e)
          {
               
          }
          
          return $identifier;
     }

enumerateFora()

static ForumManager::enumerateFora (   $items )

static

Definition at line 106 of file forum_manager.inc.

     {
          $pages = Query::create(Forum, "WHERE identifier IS NOT NULL AND identifier != '' ORDER BY title")->execute();
          
          $items["Discussion Forums"] = $pages;
          return $items;
     }

formatUserProfile()

static ForumManager::formatUserProfile (   $u )

static

Definition at line 63 of file forum_manager.inc.

     {
          ForumManager::initializeUserProfileHandler();
          return call_user_func_array(ForumManager::$userProfileHandler, array($u));
     }

ForumManager()

ForumManager::ForumManager

(

)

Definition at line 42 of file forum_manager.inc.

     {
          
     }

initializeUserProfileHandler()

static ForumManager::initializeUserProfileHandler ( )

static

Definition at line 49 of file forum_manager.inc.

     {
          if (!ForumManager::$userProfileHandler)
          {
               ForumManager::$userProfileHandler = array(ForumManager, defaultUserProfileHandler);
               ComponentManager::fireEvent("RegisterForumUserProfileHandler");
          }
     }

registerTaxonomyClasses()

static ForumManager::registerTaxonomyClasses (   $classes )

static

Definition at line 261 of file forum_manager.inc.

     {
          $classes[] = Forum;
          return $classes;
     }

registerUserProfileHandler()

static ForumManager::registerUserProfileHandler (   $handler )

static

Definition at line 58 of file forum_manager.inc.

     {
          ForumManager::$userProfileHandler = $handler;
     }

setDefaults()

static ForumManager::setDefaults ( )

static

Definition at line 114 of file forum_manager.inc.

     {
          Settings::setDefaultValue("forum", "forum_list_items_per_page", 0, Number, "Number of items per page on the forum list (0 for no pagination)");
          Settings::setDefaultValue("forum", "forum_topics_per_page", 0, Number, "Number of topics per page on the forum list (0 for no pagination)");
     }

upgradeComponent()

static ForumManager::upgradeComponent (   $version )

static

Definition at line 255 of file forum_manager.inc.

     {
          $mgr = new ForumUpgradeManager();
          $mgr->upgrade($version);
     }

Member Data Documentation

$userProfileHandler

ForumManager::$userProfileHandler = null

static

Definition at line 47 of file forum_manager.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/forum/forum_manager.inc