vjCommentPlugin
=================

This readme presents briefly how to use this plugin.
A presentation of the plugin is available [here](http://www.ville-villejuif.fr/symfony/vjCommentPlugin/).

Installation
------------

  * Install the plugin

        $ symfony plugin:install vjCommentPlugin
        $ symfony plugin:publish-assets
        $ symfony cc


How to make something commentable ?
-------------

Add behavior in your schema

  * edit config/doctrine/schema.yml

        News:
          actAs:
            Commentable:
            # others behaviors

Build your project

  * It's a new project (you don't have build all, so do it !)

        $ symfony doctrine:build --all

  * It's an old project (you created it before this plugin :p), I've tried migration but it seems to be a problem with behavior in migration so you'll need to rebuild your model ...

        $ symfony doctrine:build --all

Activate module in frontend

  * edit apps/your_frontend_app/config/settings.yml

        enabled_modules:        [..., comment]

Add the form and/or the list of comments wherever you want

  * edit your action file

        public function executeIndex(sfWebRequest $request)
        {
          $this->news = Doctrine::getTable('News')->find($request->getParameter('id'));
        }

  * edit your template file

        <?php include_component('comment', 'formComment', array('object' => $news)) ?>
        <?php include_component('comment', 'list', array('object' => $news, 'i' => 0)) ?>

And ... that's all !
You only need to get your object and to pass it to the template and two components do the rest.


How to moderate comments and/or reports ?
-------------

Activate modules in backend

  * edit apps/your_backend_app/config/settings.yml

        enabled_modules:        [..., commentAdmin, commentReportAdmin]

**Moderate comments**
You can edit a comment, reply to or delete one. Deletion is not permanent ; the comment appears in frontend with the mention 'deleted by moderator'.
You can restore it.
Reply in backend is same as reply in frontend. You can use the user object to override author values in the form.

**Moderate reports**
You can remove, validate or invalidate a report and edit or remove a comment.
There's three states : untreated, validated and invalidated. By default, list only shows untreated reports. You can switch in filters.

Internationalization
-------------

English (default) and French translations are embed in the plugin.

To use french :

  * edit apps/your_apps/config/settings.yml

        default_culture:        fr #en
        i18n:                   true

  * copy the generator.yml files

        $ cp -r plugins/vjCommentPlugin/more/modules/fr/commentAdmin/ apps/your_backend_app/modules/
        $ cp -r plugins/vjCommentPlugin/more/modules/fr/commentReportAdmin/ apps/your_backend_app/modules/
        $ symfony cc

  * don't forget to delete your cookies !


TODO
-------------

* Integrate the tests provided
* Add recaptcha support


Contact
-------------
Please contact me if you see a problem, an error or if you think that something can be enhanced !
Advice are cool too !