kitpages/user-generated-bundle

This bundle is an way to add comments on any content of a website.

KitpagesUserGeneratedBundle

Used for common user generated contents like comments, rating,..., _(*1)

For the moment there is only comments with the following features :, _(*2)

• moderation
• email to webmaster

URL : http://www.kitpages.fr/fr/cms/108/kitpagesusergeneratedbundle (in french), _(*3)

Current status

Beta state, _(*4)

comming soon :, _(*5)

• an administration

Installation

If you are using DEPS :, _(*6)

[gedmo-doctrine-extensions]
    git=http://github.com/l3pp4rd/DoctrineExtensions.git
    target=/gedmo-doctrine-extensions

[StofDoctrineExtensionsBundle]
    git=https://github.com/stof/StofDoctrineExtensionsBundle.git
    target=/bundles/Stof/DoctrineExtensionsBundle

[KitpagesUtilBundle]
    git=https://github.com/kitpages/KitpagesUtilBundle.git
    target=/bundles/Kitpages/UtilBundle

[KitpagesUserGeneratedBundle]
    git=https://github.com/kitpages/KitpagesUserGeneratedBundle.git
    target=/bundles/Kitpages/UserGeneratedBundle

Add Kitpages namespace to your autoloader :, _(*7)

``` php <?php // app/autoload.php, <sub>(*8)</sub>

$loader->registerNamespaces(array( // ... 'Gedmo' => DIR.'/../vendor/gedmo-doctrine-extensions/lib', 'Stof' => DIR.'/../vendor/bundles', 'Kitpages' => DIR.'/../vendor/bundles', ));, <sub>(*9)</sub>

Enable the bundles in your kernel :

``` php 
<?php // app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new Kitpages\UtilBundle\KitpagesUtilBundle(),
        new Kitpages\UserGeneratedBundle\KitpagesUserGeneratedBundle(),
    );
}

Import the routing file :, <sub>(*10)</sub>

``` yaml, <sub>(*11)</sub>

app/config/routing.yml

KitpagesUserGeneratedBundle: resource: "@KitpagesUserGeneratedBundle/Resources/config/routing.xml", <sub>(*12)</sub>

Configure KitpagesUserGenerated :

``` yaml
# app/config/config.yml
kitpages_user_generated:
    comment:
        default_status: "validated"
        from_email: "webmaster@mywebsite.fr"
        admin_email_list: ["admin@mywebsite.fr"]

Configure StofDoctrineExtensionsBundle :, <sub>(*13)</sub>

``` yaml, <sub>(*14)</sub>

app/config/config.yml

stof_doctrine_extensions: default_locale: en_US orm: default: timestampable: true sortable: true sluggable: true tree: true, <sub>(*15)</sub>

And then update your database schema :

``` bash
php app/console doctrine:schema:update

User's guide

If you want to add a comment system in a given page, you should add this code wherever you want in your twig template :, <sub>(*16)</sub>

html <h3>Form to add a comment</h3> {% render 'KitpagesUserGeneratedBundle:Comment:newPost' with { 'itemReference': 'myItem' } %} <h3>commentList</h3> {% render 'KitpagesUserGeneratedBundle:Comment:displayPostList' with { 'itemReference': 'myItem' } %}, <sub>(*17)</sub>

The "itemReference" parameter is a reference to a comment list. For example if you want comments on the product #45 of your shop, you can use "product-45" as itemReference, <sub>(*18)</sub>