Forum

Classes
class	Forum
class	ForumSiteXref
class	ForumMessage
class	ForumMessageAttachmentXref
class	ForumTopic
class	ForumSummary
class	ForumSubscription
class	ForumManager
class	ForumSearchResultsView
class	ForumUpgradeManager
class	ForumListView
class	ForumDetailsView
class	ForumManifest
class	SubscriptionManager
class	ForumTopicView

Functions
	SubscriptionManager::SubscriptionManager ()
static	SubscriptionManager::sendInstantNotifications ($message)
static	SubscriptionManager::formatTopicInstantNotification ($message)
static	SubscriptionManager::formatUnsubscribeMessageFooter ()
static	SubscriptionManager::updateSubscription ($subscription, $subscription_type)
static	SubscriptionManager::renderSubscriptionType ($subscription)
static	SubscriptionManager::formatSubscriptionOptions ($forum, $forumSubscription, $topicSubscriptionCount=0)

Variables
const	subscription_daily_digest 1
const	subscription_instant_notification 2
const	subscription_unsubscribe 3

Detailed Description

Function Documentation

formatSubscriptionOptions()

static SubscriptionManager::formatSubscriptionOptions (   $forum,   $forumSubscription,   $topicSubscriptionCount = 0  )

static

Definition at line 116 of file subscription_manager.inc.

     {
          $options = ForumSubscription::$subscriptionOptions;
     
          if($forumSubscription)
          {
               unset($options[0]);
          }
          
          if(!$forumSubscription && !$topicSubscriptionCount)
          {
               unset($options[subscription_unsubscribe]);
          }
     
          if($topicSubscriptionCount > 0)
          {
               $options[subscription_daily_digest] = "Subscribe to <b>" . $options[subscription_daily_digest] . "</b> for {$forum->title}";
               $options[subscription_instant_notification] = "Subscribe to <b>" . $options[subscription_instant_notification] . "</b> for {$forum->title}";
               $options[subscription_unsubscribe] .= " from topic(s) in {$forum->title}";
          }
     
          return $options;
     }

formatTopicInstantNotification()

static SubscriptionManager::formatTopicInstantNotification (   $message )

static

Definition at line 49 of file subscription_manager.inc.

     {
          global $config;
          
          $firstPost = $message->Topic()->FirstPost();
          $url = "http://" . $config["http_host"] . "/forum_topic?forum_id={$firstPost->forum_id}&topic_id={$firstPost->topic_id}";
 
          $content = "Forum Topic: \"{$firstPost->title}\" posted by {$firstPost->Author()->getFullName()}\n";
          $content .= "http://" . $config["http_host"] . "/forum_topic?forum_id={$firstPost->forum_id}&topic_id={$firstPost->topic_id}\n\n";
          $content .= "Reply: \"{$message->title}\" posted by {$message->Author()->getFullName()}\n\n";
          $content .= strip_tags($message->message);  
          $content .= SubscriptionManager::formatUnsubscribeMessageFooter();  
          
          return $content;
     }

formatUnsubscribeMessageFooter()

static SubscriptionManager::formatUnsubscribeMessageFooter ( )

static

Definition at line 65 of file subscription_manager.inc.

     {
          global $config;
          
          $messageFooter = "\n\nTo unsubscribe to these messages or change your subscription preferences, go to ";
          $messageFooter .= "http://" . $config["http_host"]  . "/forum_subscription_preferences\n\n";
          
          return $messageFooter;
     }

renderSubscriptionType()

static SubscriptionManager::renderSubscriptionType (   $subscription )

static

Definition at line 100 of file subscription_manager.inc.

     {
          $options = SubscriptionManager::formatSubscriptionOptions($subscription->Forum(), $subscription);
          $current = $subscription->subscription_type;
          $forum_subscription_id = $subscription->forum_subscription_id;
     
          unset($options[0]);
          foreach($options as $value => $name)
          {
               $selected = ($current == $value) ? " checked" : "";
               $html .= "<input style='border: none' type='radio' id='subscription[{$forum_subscription_id}]' name='subscription[{$forum_subscription_id}]' value='$value' $selected>$name</option><br>\n";
          }
     
          return $html;
     }

sendInstantNotifications()

static SubscriptionManager::sendInstantNotifications (   $message )

static

Definition at line 16 of file subscription_manager.inc.

     {
          global $config;
          
          // Don't query if this is a new topic.
          if($message->topic_id)
          {
               $constraint = "WHERE forum_id = {$message->forum_id} AND subscription_type = ". subscription_instant_notification ." AND (topic_id = 0 OR topic_id = {$message->topic_id})";
               $subscribers = query(ForumSubscription, $constraint);
          }
 
          if(count($subscribers) > 0)
          {
               $mgr = new UserManager();
               $emailField = $mgr->getEmailField();
               $emailContent = SubscriptionManager::formatTopicInstantNotification($message);
               $subject = $config["sitename"] . " Forum Instant Notification"; 
               trace("instant_notification:: email content $emailContent", 3);
     
               foreach($subscribers as $subscriber)
               {         
                    $l_user = $subscriber->User();
                    if($l_user)
                    {
                         $emailTo = $l_user->$emailField;
                         $emailHandler = new EmailHandler($emailTo, $subject, $emailContent);
                         $emailHandler->send();
                    }
               }
          }
     }

SubscriptionManager()

SubscriptionManager::SubscriptionManager

(

)

Definition at line 11 of file subscription_manager.inc.

     {
          
     }

updateSubscription()

static SubscriptionManager::updateSubscription (   $subscription,   $subscription_type  )

static

Definition at line 82 of file subscription_manager.inc.

     {
          // update subscription type for either a forum or topic subscription
          if($subscription_type != subscription_unsubscribe AND
               $subscription_type != $subscription->subscription_type)
          {
               trace("update_subscription:: subscription change", 3);
               $subscription->filter = new InclusionFilter("subscription_type");
               $subscription->subscription_type = $subscription_type;
               $subscription->save();
          }
          elseif($subscription_type == subscription_unsubscribe)
          {
               trace("update_subscription:: unsubscribe", 3);
               $subscription->delete();
          }
     }

Variable Documentation

subscription_daily_digest

const subscription_daily_digest 1

Definition at line 7 of file forum_subscription.inc.

subscription_instant_notification

const subscription_instant_notification 2

Definition at line 8 of file forum_subscription.inc.

subscription_unsubscribe

const subscription_unsubscribe 3

Definition at line 9 of file forum_subscription.inc.