CommentView Class Reference

Public Member Functions
	CommentView ($obj, $xrefClass, $component, $title="")
	buildCommentList ($obj)
	formatComment ($comment)
	drawButtons ($comment)
	writeScript ()
	drawView ()
	drawForm ()
	buildCommentForm ()
	addXrefRecord ($form)
	save ()
	getMatchingPK ($xref, $obj)

Static Public Member Functions
static	addCommentPanel ($qs=null)
static	fromGET ()
static	onSaveNewComment ($form)
	Called by comment_form handler to save xref and send email for new comments. More...

Public Attributes
	$obj
	$list
	$form
	$xrefClass
	$component
	$title
	$usernameFormat = "{User.first_name} {User.last_name}"

Detailed Description

Definition at line 56 of file comment_view.inc.

Member Function Documentation

addCommentPanel()

static CommentView::addCommentPanel (   $qs = null )

static

Definition at line 89 of file comment_view.inc.

     {
          if (!$qs)
          {
               $qs = getCleanQueryString();
          }
          $panel = new Panel("comment_panel", "/action/comment/comment_panel?$qs");
          $panel->draw();          
     }

addXrefRecord()

CommentView::addXrefRecord

(

$form

)

Definition at line 280 of file comment_view.inc.

     {
          $xref = new $this->xrefClass;
          $xref->set($this->obj->primary_key, $this->obj->get($this->obj->primary_key));
          $xref->set($form->data->primary_key, $form->data->get($form->data->primary_key));
          $xref->save();
     }

buildCommentForm()

CommentView::buildCommentForm

(

)

Definition at line 234 of file comment_view.inc.

     {
          trace("Building Comment Form", 3);
          
          global $user;
 
          $key_name = $this->obj->getPrimaryKey();
          $key_value = $this->obj->get($key_name);
 
          $comment = new Comment();
          if(Settings::getValue("comment", "publish_automatically"))
          {
               $comment->published = true;
          }
          $form = new AutoForm($comment, "POST", "/action/comment/comment_form?comment_id=&xref_class={$this->xrefClass}&key_name=$key_name&key_value=$key_value&xref_component={$this->component}", "Comment_form");
          $form->ajaxSubmit("function(result) {new Comment().commentFormResult(result);}", "function() {document.id('{$form->id}_error').set('text','Failed to communicate with server'); }");
 
          $form->required("description");
          $form->alias("title", "Subject", "author", "Your Name");
          $form->alias("description", "Comment");
          $form->hide(user_id, published);
          $form->onSaveComplete = array($this, addXrefRecord);
          
          if ($user)
          {
               $comment->user_id = $user->get($user->primary_key);
               $form->hide("author");
          }
          else
          {
               $comment->user_id = 0;
               $form->required("author");
          }
 
          $captchaMode = Settings::getValue("comment", "use_captcha");
          if ($captchaMode == "Always" || ($captchaMode == "Anonymous Only" && !$user))
          {
               $captchaMgr = new CaptchaManager();
               $captchaMgr->addCaptchaToForm($form);
          }
          
          if (!Settings::getValue("comment", "show_subject_field")) $form->hide("title");
          
          return $form;
     }

buildCommentList()

CommentView::buildCommentList

(

$obj

)

Definition at line 110 of file comment_view.inc.

     {
          trace("Building Comment List", 3);
          
          if(checkRole("admin"))
          {
               $comments = $obj->Comments("ORDER BY date_posted DESC");    
          }
          else
          {
               $comments = $obj->Comments("Where published=1 ORDER BY date_posted DESC");
          }
          $list = new PagedList($comments, "comment_list", array($this, formatComment));
          $list->CSSclass = "Standard";
          $list->styles = "clear: both";
          $list->paginate = false;
 
          return $list;
     }

CommentView()

CommentView::CommentView	(		$obj,
			$xrefClass,
			$component,
			$title = ""
	)

Parameters

obj	$obj	any DataItem class that can link to Comment
String	$xrefClass	DataItem xref class that links obj to Comment
String	$component
String	$title

Definition at line 73 of file comment_view.inc.

     {
          $this->obj = $obj;
          $this->xrefClass = $xrefClass;
          $this->component = $component;
          $this->title = ($title) ? $title : "Comments";
          $this->list = $this->buildCommentList($obj);
          $this->form = $this->buildCommentForm();
          
          if (Settings::getValue("comment", "username_format") == "Username")
          {
               $mgr = new UserManager();
               $this->usernameFormat = "{User.".$mgr->getUsernameField()."}";
          }
     }

drawButtons()

CommentView::drawButtons

(

$comment

)

Definition at line 162 of file comment_view.inc.

     {
          $edit = "<div class='button_row'>\n";
 
          if($comment->isEditable())
          {
               $edit .= "<a href='#' class='button' onclick=\"new Comment().showCommentDialog({comment_id}, '{$this->xrefClass}', '{$this->component}'); return false\"> Edit </a>&nbsp;&nbsp;";
          }
          if(checkRole("admin") && !Settings::getValue("comment","publish_automatically"))
          {
               if($comment->published)
               {
                    $edit .= "<a href='#' class='button' onclick=\"new Comment().commentPublish({comment_id}); return false;\"> Un-Publish </a>\n";
               }
               else
               {
                    $edit .= "<a href='#' class='button' onclick=\"new Comment().commentPublish({comment_id}); return false;\"> Publish </a>\n";
               }
          }
          $edit .= "<div style='clear:both'></div></div>\n";
          
          return $edit;
     }

drawForm()

CommentView::drawForm

(

)

Definition at line 222 of file comment_view.inc.

     {
          global $user;
          
          if ($user || Settings::getValue("comment", "allow_anonymous_commenting"))
          {
          
               $this->form->drawForm();
          
          }
     }

drawView()

CommentView::drawView

(

)

Definition at line 200 of file comment_view.inc.

     {
          global $user;
          
          if (Settings::getValue("comment", "enable_item_rating"))
          {
               RatingManager::drawRatingWidget($this->obj);
          }
               
          echo "<h3>{$this->title}</h3>\n";
          $preambleIdentifier = $user ? Settings::getValue("comment", "logged_in_preamble_text") : Settings::getValue("comment", "anonymous_preamble_text");
          
          $text = TextLookup::getText($preambleIdentifier);
          
          echo $text;
          
          if(count($this->list->items) > 0)
          {
               $this->list->drawList();
          }
     }

formatComment()

CommentView::formatComment

(

$comment

)

Definition at line 131 of file comment_view.inc.

     {
          $author = ($comment->user_id) ? $comment->format($this->usernameFormat) : $comment->author;
 
          if($comment->published)
          {
               $out = "<div id='comment{$comment->comment_id}' class='message'>\n";
          }
          else
          {
               $out = "<a name='comment{$comment->comment_id}'></a><div id='comment{$comment->comment_id}' class='message_unpublished'>\n";
          }
          $out .=" <div class='title'>";
 
          if ($comment->title)
          {
               $out .= "<strong>{$comment->title}</strong><br/>";
          }
 
          $out .= "<span class='small'>Posted by $author at {$comment->date_posted}</span>\n </div>\n <div class='message_content'>";
          
          if($comment->isEditable() || (checkRole("admin") && !Settings::getValue("comment","publish_automatically")))
          {
               $edit .= $this->drawButtons($comment);
          }
          
          $out .= $comment->format("{description:stripHTML}$edit");
          $out .= "</div></div></a>";
          return $out;
     }

fromGET()

static CommentView::fromGET ( )

static

Definition at line 99 of file comment_view.inc.

     {
          $adapter = CommentManager::getAdapter();
          
          if ($adapter)
          {
               $parent = $adapter->createParent();
               return new CommentView($parent, $adapter->xrefClass, $adapter->component);
          }
     }

getMatchingPK()

CommentView::getMatchingPK	(		$xref,
			$obj
	)

Definition at line 350 of file comment_view.inc.

     {
          $pks = $obj->getPrimaryKeyList();
          foreach($pks as $pk)
          {
               if ($xref->hasField($pk)) return $pk;
          }
 
          throw new DataItemException("No matching foreign key in xref table");
     }

onSaveNewComment()

static CommentView::onSaveNewComment (   $form )

static

Called by comment_form handler to save xref and send email for new comments.

AutoForm's obj can by any obj that links to Comment (e.g, Article)

Parameters

obj

$form

AutoForm

Definition at line 315 of file comment_view.inc.

     {
          $xref_class = $form->data->get("xref_class");
          $xref = new $xref_class;
          
          $obj = $form->data;
          
          // The primary key name of the parent obj (e.g., Article)
          $key_name = $obj->get("key_name");
          $key_value =  $obj->get("key_value");
          
          $xref->set($key_name, $key_value);
          $xref->set("comment_id", $obj->get("comment_id"));
          
          if (method_exists($xref, verifyEnabled))
          {
               if (!$xref->verifyEnabled($key_value))
               {
                    Fakoli::end("No SPAM for you today, Mister!");
               }
          }
          
          // Wait until after verified, if applicable, to save
          $xref->save();
 
          $confirmation_message = "Thank you for your comment.";
          if(!Settings::getValue("comment", "publish_automatically"))
          {
               sendEmailUsingEmailManager($xref, 'new_comment');
               $confimation_message = "Thank you. Your comment has been submitted to the moderator.";
          }
 
          $form->data->set("confirmation_message", $confirmation_message);
     }

save()

CommentView::save

(

)

Definition at line 288 of file comment_view.inc.

     {
          $form = $this->form;
 
          if($form->save())
          {         
               $xref = new $this->xrefClass;
                    
               $obj = $this->obj;
               $pk =  $this->getMatchingPK($xref, $obj);
                    
               $xref->set($pk, $obj->get($pk));
               $xref->set("comment_id", $form->data->get("comment_id"));
               $xref->save();
               return true;
          }
     }

writeScript()

CommentView::writeScript

(

)

Definition at line 186 of file comment_view.inc.

     {
          global $user;
          
          $script .= $this->list->writeScript();
          
          if ($user || Settings::getValue("comment", "allow_anonymous_commenting"))
          {
               $script .= $this->form->writeScript();
          }
 
          return $script;
     }

Member Data Documentation

$component

CommentView::$component

Definition at line 62 of file comment_view.inc.

$form

CommentView::$form

Definition at line 60 of file comment_view.inc.

$list

CommentView::$list

Definition at line 59 of file comment_view.inc.

$obj

CommentView::$obj

Definition at line 58 of file comment_view.inc.

$title

CommentView::$title

Definition at line 63 of file comment_view.inc.

$usernameFormat

CommentView::$usernameFormat = "{User.first_name} {User.last_name}"

Definition at line 64 of file comment_view.inc.

$xrefClass

CommentView::$xrefClass

Definition at line 61 of file comment_view.inc.

---

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

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