dmCommentPlugin

• In a console, from your project root dir, run:

git clone git://github.com/ornicar/dmCommentPlugin.git plugins/dmCommentPlugin  

• In config/ProjectConfiguration.class.php, add dmCommentPlugin to the list of enabled plugins:

class ProjectConfiguration extends dmProjectConfiguration
{  
  public function setup()  
  {  
    parent::setup();  
 
    $this->enablePlugins(array(  
      // your enabled plugins  
      'dmCommentPlugin'  
    ));  

• In a console, from your project root dir, run:

php symfony doctrine:generate-migrations-diff  

php symfony doctrine:migrate  

php symfony dm:setup  

Declare a model as commentable

As this plugin is intended to provide commentable capabilities to your models, the first thing to do is declare that a model act as DmCommentable.
In this documentation we will assume we have an Article model.
schema.yml

Article:  
  actAs:  
    DmCommentable:  

Then, in a console, from your project root dir, run:

php symfony dm:setup    

Available methods

The article model now has some additional methods to manipulate the comments:

// get active comments (with is_active field = true)
$comments = $article->getComments();  
 
// get all comments, active and inactive  
$comments = $article->getAllComments();  
 
// get the number of comments  
$nbComments = $article->getNbComments();  

The DmComment model has a method to fetch the record it is linked to:

$article = $comment->getRecord();

Admin interface

In Admin menu->Content->Feedback->Comments, you can manage the comments list.

Customize comment admin interface

As for any symfony plugin, you can copy and paste files from the plugin to your app and modify them.
The more usefull file is generator.yml. Copy
plugins/dmCommentPlugin/modules/dmCommentAdmin/config/generator.yml
to
apps/admin/modules/dmCommentAdmin/config/generator.yml
to modify it.

Show comments in article admin interface

Add a comments partial to the list display of your article admin module generator file:
apps/admin/modules/article/config/generator.yml

...  
      list:  
        display:  
          - =title  
          - _comments   # insert a comments partial here  
          - is_active  
          - created_at  
          - updated_at  
...  

Then add the comments partial in
apps/admin/modules/article/templates/_comments.php

include_partial('dmCommentAdmin/comments', array('record' => $article));

Front interface

Display article comments

Go on an article page, open the "Add" menu, find the "comment/page comments" widget, take it and drop it on the page. Only active comments are shown.

Display the comment form

Go on an article page, open the "Add" menu, find the "comment/form" widget, take it and drop it on the page.

Enable captcha validation

This step is facultative, but will help you fighting against spam.
Add this configuration in
apps/front/config/app.yml

all:  
  recaptcha:  
    # get your recaptcha keys on http://recaptcha.net/api/getkey  
    public_key:   6LeefAkAAAAAAF-this-is-a-dummy-public-key  
    private_key:  6LeefAkAAAAAA-this-is-a-dummy-private-key  
    enabled:      true  

You will need to get API keys from the recaptcha website. It's free.

Customize form style

You may just use CSS if the default outputed HTML looks fine to you.

Or you can override the form template by copying
dmCommentPlugin/modules/dmComment/templates/_form.php
to
apps/front/modules/dmComment/templates/_form.php

Customize form template

Copy
dmCommentPlugin/modules/dmComment/templates/_form.php
to
apps/front/modules/dmComment/templates/_form.php

More customization

Customize model and form

you can override the DmComment model in your project
lib/model/doctrine/dmCommentPlugin/DmComment.class.php

and the DmCommentForm form in your project
lib/form/doctrine/dmCommentPlugin/DmCommentForm.class.php

Do something when a comment is saved.

Listen to the 'dm_comment.saved' event in
apps/front/config/frontConfiguration.class.php

require_once(dm::getDir().'/dmFrontPlugin/lib/config/dmFrontApplicationConfiguration.php');
 
class frontConfiguration extends dmFrontApplicationConfiguration  
{  
  public function configure()  
  {      
    $this->dispatcher->connect('dm_comment.saved', array($this, 'listenToCommentSavedEvent'));  
  }  
 
  public function listenToCommentSavedEvent(sfEvent $e)  
  {  
    $comment = $e['comment'];  
    // do something with the freshly saved $comment  
  }  
}