base-comment.inc.php

Go to the documentation of this file.

<?
abstract class BaseComment extends MyObject
{
    public $class = '';

    function __construct($data, $class)
    {
        parent::__construct($data, "comments_" . strtolower($class));

        $this->class = $class;
        $this->english = "comment";

        if (!class_exists($this->class))
            throw new Exception("Class $this->class doesn't exist!");

        //add in our fulltext fields
        $this->fullTextFields[] = 'body';
    }

    function initDeletePage()
    {
        parent::initDeletePage();

        $this->pageTitle = 'Delete Comment';
    }

    function deletePost()
    {
        parent::deletePost($this->getUrl("$this->class.view?id=$this->content_id"), true);
    }

    function delete()
    {
        dbExecute("
            UPDATE $this->tableName
            SET parent_id = '$this->parent_id'
            WHERE parent_id = '$this->id'
        ");
    
        parent::delete();
    }

    function initEditPage()
    {
        parent::initEditPage();

        if ($this->id)
            $this->pageTitle = 'Edit Comment';
        else
            $this->pageTitle = 'Add New Comment';

        //if its new... get our ids.
        if (!$this->id)
        {
            $parentId = $this->params('parent_id');
            $contentId = $this->params('content_id');
            
            if ($parentId)
            {
                $class = get_class($this);
                $parent = new $class($parentId);
                
                $this->parent_id = $parentId;
                $this->content_id = $parent->content_id;
            }
            else if ($contentId)
            {
                $this->parent_id = 0;
                $this->content_id = $contentId;
            }
            else
                throw new PageError('You must supply either a parent id or a content id.');
        }
    }

    function editFormAddFields($form)
    {
        $form->add('TextAreaField', 'body', array(
            "required" => true,
            "title" => 'Comment',
            "class" => 'BaseComment'
        ));
        if ($this->id)
            $form->addSubmit('Save Comment');
        else
            $form->addSubmit('Post Comment');
    }

    function createReplyForm($contentId = null)
    {
        $form = new Form();

        if ($this->id)
        {
            $form->action = $this->getUrl(".edit?parent_id=$this->id");
            $form->name = "replyForm_$this->id";
            $form->id = "replyForm_$this->id";
        }
        else
            $form->action = $this->getUrl(".edit?content_id=$contentId");

        $form->add('TextAreaField', 'body', array(
            'title' => '',
            'required' => true,
            'class' => 'BaseComment',
            'height' => '75px',
            'width' => '100%'
        ));

        if ($this->id)
            $form->addSubmit('Post Reply');
        else
            $form->addSubmit('Post New Comment');

        return $form;
    }

    function getEditPageParamXml()
    {
        $xml =  <<<XML
    <param name="subject" desc="title of your comment.  pretty important." />
    <param name="body" desc="comment main body" />
    <param name="content_id" desc="id of content in the module you're commenting on" />
    <param name="parent_id" desc="id of the parent comment" />
XML;
        return $xml;
    }

    function editPagePostSuccess($form)
    {
        $this->emailNotification();
        $this->emailReply();
        
        Util::redirect($this->getUrl("$this->class.view?id=$this->content_id"));
    }

    function emailNotification()
    {
        //get our people and our stuff
        $content = new $this->class($this->content_id);

        //we dont want to send to ourself.
        if ($this->creator->id != $content->creator->id)
        {
            //does the this->creator want comment notices?
            if ($content->creator->email_comments)
            {
                $subject = "New $this->class comment";

                $body  = $this->creator->getName() . " has posted a new comment on your $this->class.\n\n";
                $body .= "You can view it here:\n\n";
                $body .= $content->creator->getTicket(array(
                    'module' => $this->class,
                    'page' => 'view',
                    'id' => $content->id
                )) . "\n\n";
                $body .= "Thank you,\nThe Happy MyKin Comment Robot\n\n";
                $body .= "PS.  You can turn these emails off here:\n\n";
                $body .= $content->creator->getUrl(array('page' => 'emailprefs'), null, true);
                
                $html  = $this->creator->getName() . " has posted a new comment on your $this->class.<br/><br/>";
                $html .= $content->creator->getTicket(array(
                    'module' => $this->class,
                    'page' => 'view',
                    'id' => $content->id
                ), 'You can view it here') . ".<br/><br/>";
                $html .= "Thank you,<br/>The Happy MyKin Comment Robot<br/><br/>";
                $html .= "PS.  You can turn these emails off " . $content->creator->getLink('.emailprefs', 'here', null, true);
                
                $content->creator->mail($subject, $body, $html);
            }
        }
    }

    function emailReply()
    {
        //get our stuff
        $content = new $this->class($this->content_id);
        $comClass = get_class($this);
        $parent = new $comClass($this->parent_id);
        
        //if the parent author is the same as content auth... they'll get an email on the content comment.
        //also, dont send an email if they are the this->creator.
        if ($parent->creator->id != $content->creator->id && $parent->creator->id != $this->creator->id)
        {
            //does the this->creator want comment notices?
            if ($parent->creator->email_comment_replies)
            {
                $subject = "New comment reply";

                $body  = $this->creator->getName() . " has posted a new reply to one of your $this->class comments.\n\n";
                $body .= "You can view it here:\n\n";
                $body .= $parent->creator->getTicket(array(
                    'module' => $this->class,
                    'page' => 'view',
                    'id' => $content->id
                )) . "\n\n";
                $body .= "Thank you,\nThe Happy MyKin Comment Robot\n\n";
                $body .= "PS.  You can turn these emails off here:\n\n";
                $body .= $parent->creator->getUrl(array('page' => 'emailprefs'), null, true);
                
                $html  = $this->creator->getName() . " has posted a new reply to one of your $this->class comments.<br/><br/>";
                $html .= $parent->creator->getTicket(array(
                    'module' => $this->class,
                    'page' => 'view',
                    'id' => $content->id
                ), 'You can view it here') . ".<br/><br/>";
                $html .= "Thank you,<br/>The Happy MyKin Comment Robot<br/><br/>";
                $html .= "PS.  You can turn these emails off " . $parent->creator->getLink('.emailprefs', 'here', null, true);
                
                $parent->creator->mail($subject, $body, $html);
            }
        }
    }

    function getRssItem()
    {
        $rss = parent::getRssItem();

        if ($this->hasField('user_id'))
            $rss->title = 'Comment by ' . $this->creator->getName();
        else
            $rss->title = 'Comment';
        
        $rss->description = $this->body;

        return $rss;
    }

    function drawComment($kids = array())
    {
        global $me;
    
        if ($this->canView())
        {
            echo "<li class=\"threaded\">\n";
        
            //our title bar.
            $this->drawTitleBar();
            $this->drawCommentDetails();
        
            //draw our container
            echo "<div class=\"childContainer\">\n";
        
            //our actual content
            $this->drawCommentBody();
            $this->drawCommentReplyForm();
        
            //draw our children
            $this->drawChildComments($kids, $this->id);
            
            echo "</div>";
            
            //end comment
            echo "</li>";
        }
    }
    
    protected function drawTitleBar()
    {
        //heres our title bar
        echo "<div class=\"titlebar\">";
        
        //our title icon
        echo '<table class="struct"><tr><td class="titleLeft">';
        echo $this->creator->getIcon('tiny');
        
        //our title div
        echo $this->creator->getName(true) . " said: ";

        echo Time::formatRelative($this->add_date);

        //mid-structure
        echo '</td><td class="titleRight">';
    
        //our options div
        echo "\t<span class=\"titleLink\" id=\"commentOptions_$this->id\">";
        echo "<a href=\"#\" onclick=\"return showCommentOptions('$this->id');\">options</a>";
        echo "</span>\n";
        echo "\t<span class=\"titleLink\" id=\"commentReplyLink_$this->id\"><a href=\"" . $this->getUrl(array('page' => 'edit', 'parent_id' => $this->id));
        echo "\" onclick=\"return showCommentReplyForm('$this->id');\">reply</a></span>\n";

        //end our stupid structure
        echo "</td></tr></table>";

        //end title bar
        echo "</div>\n";
    }
    
    protected function drawCommentDetails()
    {
        //our hidden detail div.
        echo "<div class=\"commentDetail\" id=\"comment_$this->id\" style=\"display: none;\">";
        echo "Posted by: " . $this->creator->getName(true) . "<br/>\n";
        echo "Posted: " . Time::formatRelative($this->add_date) . "<br/>\n";
        if ($this->edit_date != $this->add_date)
            echo "Last Edited on: " . Time::formatRelative($this->edit_date) . "<br/>\n";
        if ($this->canEdit())
            echo $this->getLink(".edit?id=$this->id", 'Edit Comment') . "<br/>";
        if ($this->canDelete())
            echo $this->getLink(".delete?id=$this->id", 'Delete Comment') . "<br/>";
        echo "</div>\n";
    }
    
    protected function drawCommentBody()
    {
        echo "<div class=\"commentBody\">";
        echo Linkify::bbcode($this->body);
        $this->drawCommentSignature();
        echo "</div>";
    }

    protected function drawCommentSignature()
    {
    }

    protected function drawCommentReplyForm()
    {
        //and our actual reply form
        echo "<div class=\"commentReply\" id=\"commentReply_$this->id\" style=\"display: none;\">\n";
        $form = $this->createReplyForm();
        $form->drawAll();
        echo "</div>\n";
    }

    function drawChildComments($coms, $parent)
    {
        //did we get any comments?
        if (count($coms))
        {
            if ($parent)
                echo "<div class=\"threaded\">";
                
            echo "<ol class=\"threaded\">\n";
            //oh yeah, draw them.
            foreach ($coms AS $com)
                //if they match our parent id.
                if ($com->parent_id == $parent)
                    $com->drawComment($coms);
            echo "</ol>\n";

            if ($parent)
                echo "</div>";
        }
    }

    function drawViewPage()
    {
        Util::redirect($this->getUrl("$this->class.view?id=$this->content_id"));
    }

    function getPublicData()
    {
        $data = parent::getPublicData();

        $data['body'] = $this->body;

        return $data;
    }

    public function getCreateFieldsArray()
    {
        $fields = parent::getCreateFieldsArray();
        
        $fields['content_id'] = "content_id INT(11) default 0 not null";
        $fields['parent_id'] = "parent_id INT(11) default 0 not null";
        $fields['body'] = "body TEXT default '' not null";
    
        return $fields;
    }
    
    public function getCreateIndexesArray()
    {
        $fields = parent::getCreateIndexesArray();
        
        $fields['content_id'] .= "KEY (content_id)";
        $fields['parent_id'] .= "KEY (parent_id)";
    
        return $fields;
    }

    public function save()
    {
        parent::save();
        
        $obj = new $this->class($this->content_id);
        $obj->save();
    }
}
?>

---