Adding Fields to Page Comments

What it Does

Adds an email field to page comments.

Requirements

This is based on and tested in Silverstripe 2.3.5 (I believe it will work as far back is 2.3.2, but this is untested)

This isn't as simple as it should be.  I am also sure that things could be done in a better way, please comment if you have improvments.

Override PageComments

You'll need to override the ContentController->PageComments() function.  This is essentially a copy and paste from sapphire/core/control/ContentController.php and change the reference to PageCommentInterface to PageCommentExtendedInterface, which you will create in the next step.
mysite/code/Page.php
<?php class Page extends SiteTree { /*...*/ } class Page_Controller extends ContentController { /*...*/ /** * Returns a page comment system */ function PageComments() { if($this->data() && $this->data()->ProvideComments) { return new PageCommentExtendedInterface($this, 'PageComments', $this->data()); } else { if(isset($_REQUEST['executeForm']) && $_REQUEST['executeForm'] == 'PageComments.PostCommentForm') { echo "Comments have been disabled for this page"; die(); } } } /*...*/ }

Extending PageCommentInterface

PageCommentInterface is the Request Handler for page comments.  You will need to override the function PostCommentForm().  Unfortunately because of the way this function is written calling the parent on it and then adding the new fields is not possible (as far as I know), so you must copy the existing function from the parent class and then add your new field in the fields and then to load the new field from the session you'll also have to add your new field to the loadDataFrom array.  You are not done with this file yet, now you must also set the session for your new field.  To accomplish this you'll have to extend the internal class PageCommentInterface_Form and the function postComment().  In this case you can load up your session and then just call the parent function.  Don't forget to change the reference to PageCommentInterface_Form to your new class.
mysite/code/PageCommentExtendedInterface.php:
<?php class PageCommentExtendedInterface extends PageCommentInterface { function PostCommentForm() { $fields = new FieldSet( new HiddenField("ParentID", "ParentID", $this->page->ID) ); $member = Member::currentUser(); if((self::$comments_require_login || self::$comments_require_permission) && $member && $member->FirstName) { // note this was a ReadonlyField - which displayed the name in a span as well as the hidden field but // it was not saving correctly. Have changed it to a hidden field. It passes the data correctly but I // believe the id of the form field is wrong. $fields->push(new ReadonlyField("NameView", _t('PageCommentInterface.YOURNAME', 'Your name'), $member->getName())); $fields->push(new HiddenField("Name", "", $member->getName())); } else { $fields->push(new TextField("Name", _t('PageCommentInterface.YOURNAME', 'Your name'))); } // optional commenter EMAIL $fields->push(new TextField("CommenterEmail", _t('PageCommentInterface.COMMENTEREMAIL', "Email:"))); // optional commenter URL $fields->push(new TextField("CommenterURL", _t('PageCommentInterface.COMMENTERURL', "Your website URL"))); if(MathSpamProtection::isEnabled()){ $fields->push(new TextField("Math", sprintf(_t('PageCommentInterface.SPAMQUESTION', "Spam protection question: %s"), MathSpamProtection::getMathQuestion()))); } $fields->push(new TextareaField("Comment", _t('PageCommentInterface.YOURCOMMENT', "Comments"))); $form = new NewPageCommentInterface_Form($this, "PostCommentForm", $fields, new FieldSet( new FormAction("postcomment", _t('PageCommentInterface.POST', 'Post')) )); // Set it so the user gets redirected back down to the form upon form fail $form->setRedirectToFormOnValidationError(true); // Optional Spam Protection. if(class_exists('SpamProtectorManager')) { SpamProtectorManager::update_form($form, null, array('Name', 'CommenterURL', 'Comment')); self::set_use_ajax_commenting(false); } // Shall We use AJAX? if(self::$use_ajax_commenting) { Requirements::javascript(THIRDPARTY_DIR . '/behaviour.js'); Requirements::javascript(THIRDPARTY_DIR . '/prototype.js'); Requirements::javascript(THIRDPARTY_DIR . '/scriptaculous/effects.js'); Requirements::javascript(CMS_DIR . '/javascript/PageCommentInterface.js'); } // Load the data from Session $form->loadDataFrom(array( "Name" => Cookie::get("PageCommentInterface_Name"), "Comment" => Cookie::get("PageCommentInterface_Comment"), "CommenterEmail" => Cookie::get("PageCommentInterface_CommenterEmail"), "CommenterURL" => Cookie::get("PageCommentInterface_CommenterURL") )); return $form; } } /** * @package cms * @subpackage comments */ class NewPageCommentInterface_Form extends PageCommentInterface_Form { function postcomment($data) { Cookie::set("PageCommentInterface_CommenterEmail", $data['CommenterEmail']); return parent::postcomment($data); } } ?>

Setuping up your site configuration

You will be creating a decorator, you must include some code in your _config.php to assign it.  You will also be creating an extension to an Admin section you will want to add a rule to redirect the comments action to your new extension, also remove the old admin section.
mysite/_config.php:
DataObject::add_extension('PageComment','PageCommentDecorator'); Director::addRules(50, array( 'admin/comments//$Action/$ID' => 'CommentAdminExtension', )); CMSMenu::remove_menu_item('CommentAdmin');
(NOTE:  I tried to use LeftAndMainDecorator initially instead of extending CommentAdmin, but I ran into several issues)

Decorating PageComment

This could be as simple as just adding a new db static and pushing a new TextField onto CMSFields, however I took it a step further and set it up to send and email after someone posts a comment.  The email needs better formatting and it could use the admin email and the links to delete and mark as spam could be generated more dynamically.  This is not really part of the tutorial but I thought I would share.
mysite/code/PageCommentDecorator.php:
<?php class PageCommentDecorator extends DataObjectDecorator { function extraStatics() { return array( 'db' => array( "CommenterEmail" => "Varchar(255)", ) ); } public function updateCMSFields(FieldSet &$fields) { $fields->push(new TextField('CommenterEmail', 'Commenter Email')); } function updateFieldLabels(&$labels) { parent::updateFieldLabels($labels); $labels['CommenterEmail'] = "Commenter Email"; } function onAfterWrite() { $post = DataObject::get_one('SiteTree', "`SiteTree`.ID=".$this->owner->getField('ParentID')); $e = new Email( $this->owner->getField('CommenterEmail'),//From Address 'comment@yoursite.com',//To Address - Currently hard coded should get admin address and/or posters address "Posted a comment on ".$post->title,//Subject "".$this->owner->getField('Name') . " said " . '"' . $this->owner->getField('Comment') . '"<br/>'. '<a href="http://yoursite.com/admin/comments/EditForm/field/Comments/item/' . $this->owner->getField('ID') . '?methodName=spam">Mark as SPAM</a><br/>'. '<a href="http://yoursite.com/admin/comments/EditForm/field/Comments/item/' . $this->owner->getField('ID') . '/delete">DELETE</a>' );//Body $e->send(); } } ?>

Extending CommentAdmin

And Finally, if you want to see the new data fields in the backend you'll have to extend the CommentAdmin and override EditForm(). Again, I had to copy and paste the function from the source due to the way it was written.  You must add the table field and the PopupFields for your new data field.
mysite/code/CommentAdminExtension:
<?php /*Copied from CommentAdmin.php version 2.3.1 - Added Email field */ class CommentAdminExtension extends CommentAdmin { public function EditForm() { $section = $this->Section(); if($section == 'approved') { $filter = 'IsSpam=0 AND NeedsModeration=0'; $title = "<h2>". _t('CommentAdmin.APPROVEDCOMMENTS', 'Approved Comments')."</h2>"; } else if($section == 'unmoderated') { $filter = 'NeedsModeration=1'; $title = "<h2>"._t('CommentAdmin.COMMENTSAWAITINGMODERATION', 'Comments Awaiting Moderation')."</h2>"; } else { $filter = 'IsSpam=1'; $title = "<h2>"._t('CommentAdmin.SPAM', 'Spam')."</h2>"; } $filter .= ' AND ParentID>0'; $tableFields = array( "Name" => _t('CommentAdmin.AUTHOR', 'Author'), "Comment" => _t('CommentAdmin.COMMENT', 'Comment'), "CommenterEmail" => _t('CommentAdmin.COMMENTEREMAIL', 'Email'), "PageTitle" => _t('CommentAdmin.PAGE', 'Page'), "CommenterURL" => _t('CommentAdmin.COMMENTERURL', 'URL'), "Created" => _t('CommentAdmin.DATEPOSTED', 'Date Posted') ); $popupFields = new FieldSet( new TextField('Name', _t('CommentAdmin.NAME', 'Name')), new TextField('CommenterEmail', _t('CommentAdmin.COMMENTEREMAIL', 'Email')), new TextField('CommenterURL', _t('CommentAdmin.COMMENTERURL', 'URL')), new TextareaField('Comment', _t('CommentAdmin.COMMENT', 'Comment')) ); $idField = new HiddenField('ID', '', $section); $table = new CommentTableField($this, "Comments", "PageComment", $section, $tableFields, $popupFields, array($filter)); $table->setParentClass(false); $fields = new FieldSet( new TabSet( 'Root', new Tab(_t('CommentAdmin.COMMENTS', 'Comments'), new LiteralField("Title", $title), $idField, $table ) ) ); $actions = new FieldSet(); if($section == 'unmoderated') { $actions->push(new FormAction('acceptmarked', _t('CommentAdmin.ACCEPT', 'Accept'))); } if($section == 'approved' || $section == 'unmoderated') { $actions->push(new FormAction('spammarked', _t('CommentAdmin.SPAMMARKED', 'Mark as spam'))); } if($section == 'spam') { $actions->push(new FormAction('hammarked', _t('CommentAdmin.MARKASNOTSPAM', 'Mark as not spam'))); } $actions->push(new FormAction('deletemarked', _t('CommentAdmin.DELETE', 'Delete'))); if($section == 'spam') { $actions->push(new FormAction('deleteall', _t('CommentAdmin.DELETEALL', 'Delete All'))); } $form = new Form($this, "EditForm", $fields, $actions); return $form; } } ?>

That is it.  I'd apreciate any feedback you have as this is my first tutorial.  I'm considering packaging this as a module, it would also be my first module.  I feel the code needs to be a bit better for a module so if you have any improvements don't hesitate contacting me.

Special thanks to Mike Mannix for running through this and proving it works and is somewhat easy to follow, as well as fixing my horrible grammar.  Mike is working on his first Silverstripe site elmbrew.com, he completed the level one tutorials and then moved on to this.  It is a work in progress so keep an eye on it.

About the Author