sco/behaviors-bundle

Symfony bundle to add dynamics comments

Installs: 26

Dependents: 0

Suggesters: 0

Type:symfony-bundle


README

This bundle allow to

  • add dynamic comment on object passed in reference,
  • reply on a comment,
  • show comments list for object passed in reference,
  • show statistics of comments.

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require sco/behaviors-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            new \Sco\BehaviorsBundle\ScoBehaviorsBundle(),
        ];

        // ...
    }

    // ...
}

Install assets only for bootstrap cms

$ php bin/console assets:install web --symlink

Update doctrine database

$ php bin/console doctrine:schema:update --force

Step 3: Configuration

# app/config/config.yml

parameters:
    sco.behaviors_bundle.commentable_subscriber.user_entity: AppBundle\Entity\User # ~ (default value null)
    sco.behaviors_bundle.reply_limit: 0 # default 0: limit the number of descendants allowed to respond
    sco.behaviors_bundle.cms_front: bootstrap # bootstrap or foundation, default bootstrap

    
sco_behaviors_bundle:
    commentable: true # false, ~ (null) value is false
    
doctrine:
    orm:
        dql:
            string_functions:
                sco_jsonb_contains: Sco\BehaviorsBundle\DQL\JsonbContainsFunction
# app/config/routing.yml
sco_behaviors_bundle:
    resource: "@ScoBehaviorsBundle/Resources/config/routing.yml"
    prefix:   /

Usage

## To render comment form
{{ render(controller('ScoBehaviorsBundle:Comment:form', {'object': your_object, 'extra': {'key': value})) }}
## To render list for one object
{{ render(controller('ScoBehaviorsBundle:Comment:list', {'object': your_object})) }}

## If you want disable reply on comment
{{ render(controller('ScoBehaviorsBundle:Comment:list', {'object': your_object, 'disableReplyOnComment': true})) }}
## To render statistics
{{ render(controller('ScoBehaviorsBundle:Comment:statistic', {'filter': filter, 'order': order})) }}  
## Allowed 
$filter = 'year' // or 'month' default 'year';
// or
$order = 'desc' // or 'asc' default 'desc';