CommentManager Class Reference

Public Member Functions
	CommentManager ()

Static Public Member Functions
static	setDefaults ()
static	setDefaultEmailTemplates ()
	For comment, need default template: new_comment. More...
static	setDefaultMergeCodes ()
	Merge codes for ArticleCommentXref: comment_article_id comment_title article_title article_url. More...
static	onInitialize ()
static	upgradeComponent ($version)
static	registerAdapter ($component, $parentClass, $xrefClass)
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...
static	getAdapters ()
static	getAdapter ()

Static Public Attributes
static	$adapters = array()

Detailed Description

Definition at line 81 of file comment_manager.inc.

Member Function Documentation

CommentManager()

CommentManager::CommentManager

(

)

Definition at line 85 of file comment_manager.inc.

     {
          
     }

deleteUser()

static CommentManager::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 171 of file comment_manager.inc.

     {
          $pk = $user->getPrimaryKey();
          $user_id = $user->$pk;
          
          trace("Component comment is deleting objects dependent on user_id {$user_id}", 3);
     
          $comment = new Comment();
          $comment->delete("WHERE user_id={$user_id}");
          
          return $user;
     }

getAdapter()

static CommentManager::getAdapter ( )

static

Definition at line 193 of file comment_manager.inc.

     {
          $adapters = CommentManager::getAdapters();
          
          trace(print_r($adapters, true), 3);
          
          foreach($_GET as $key => $value)
          {
               if (array_key_exists($key, $adapters))
               {
                    return $adapters[$key];
               }
          }
     }

getAdapters()

static CommentManager::getAdapters ( )

static

Definition at line 184 of file comment_manager.inc.

     {
          if (count(CommentManager::$adapters) == 0)
          {
               ComponentManager::fireEvent("RegisterCommentAdapters");
          }
          return CommentManager::$adapters;
     }

onInitialize()

static CommentManager::onInitialize ( )

static

Definition at line 146 of file comment_manager.inc.

     {
     }

registerAdapter()

static CommentManager::registerAdapter (   $component,   $parentClass,   $xrefClass  )

static

Definition at line 156 of file comment_manager.inc.

     {
          trace("Registering CommentAdapter for $component", 3);
          $adapter = new CommentAdapter($component, $parentClass, $xrefClass);       
          $proto = $adapter->createParent();
          CommentManager::$adapters[$proto->getPrimaryKey()] = $adapter;
     }

setDefaultEmailTemplates()

static CommentManager::setDefaultEmailTemplates ( )

static

For comment, need default template: new_comment.

Definition at line 119 of file comment_manager.inc.

     {
          global $config;
     
          $sitename = $config["sitename"];
          $contact = $config["email_contact"];
          
          $message = "This is an automated message from the {$sitename}.<br><br>A new comment has been posted. To review and publish this comment, click the link below:<br><br>[article_comment_url]";
          EmailTemplate::setDefaultTemplate("new_comment", $contact, "[article_title] Comment ([comment_title])", $message, "ArticleCommentXref");
     }

setDefaultMergeCodes()

static CommentManager::setDefaultMergeCodes ( )

static

Merge codes for ArticleCommentXref: comment_article_id comment_title article_title article_url.

Definition at line 137 of file comment_manager.inc.

     {
          MergeCode::setDefaultMergeCode("comment_article_id", "Article.article_id", "ArticleCommentXref", "Comment Article ID");
          MergeCode::setDefaultMergeCode("comment_title", "Comment.title", "ArticleCommentXref", "Comment Title");
          MergeCode::setDefaultMergeCode("article_title", "Article.title", "ArticleCommentXref", "Article Title");
          MergeCode::setDefaultMergeCode("article_url", "Article.getUrl", "ArticleCommentXref", "URL of article with list of comments");
          MergeCode::setDefaultMergeCode("article_comment_url", "getUrl", "ArticleCommentXref", "URL of article with list of comments");
     }

setDefaults()

static CommentManager::setDefaults ( )

static

Definition at line 90 of file comment_manager.inc.

     {         
          Settings::setDefaultValue("comment", "allow_anonymous_commenting", false, Boolean, "", "Commenting Rules");
          Settings::setDefaultValue("comment", "publish_automatically", true, Boolean, "", "Commenting Rules");
          Settings::setDefaultValue("comment", "use_captcha", "Never", String, "Specify when to use a Captcha to verify the user", "Commenting Rules", "Never\nAnonymous Only\nAlways");
          
          Settings::setDefaultValue("comment", "enable_item_rating", false, Boolean, "Specifies whether to display the rating control", "Comment Configuration", null, 2);
          Settings::setDefaultValue("comment", "show_subject_field", true, Boolean, "Specifies whether users can have a title as part of their comment", "Comment Configuration", null, 1);
          
          Settings::setDefaultValue("comment", "username_format", "Full Name", String, 
               "Specifies whether to display the full name or username (handle) of logged in commenters", "Comment Configuration", "Full Name\nUsername", 3);
          
          Settings::setDefaultValue("comment", "anonymous_preamble_text", "", String, 
                         "Identifier of a Text Lookup item containing preamble text that appears at the top of the comment panel for anonymous users", 
                         "Comment Configuration", null, 4);
          
          Settings::setDefaultValue("comment", "logged_in_preamble_text", "", String,
                         "Identifier of a Text Lookup item containing preamble text that appears at the top of the comment panel for logged in users",
                         "Comment Configuration", null, 5);
          
          CommentManager::setDefaultEmailTemplates();
          CommentManager::setDefaultMergeCodes();
     }

upgradeComponent()

static CommentManager::upgradeComponent (   $version )

static

Definition at line 150 of file comment_manager.inc.

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

Member Data Documentation

$adapters

CommentManager::$adapters = array()

static

Definition at line 83 of file comment_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/comment/comment_manager.inc