rgsystemes/uservoice-bundle

Integrate easily UserVoice into your Symfony2 projects

Introduction

Easily integrate UserVoice into your Symfony2 projects., _(*1)

Installation

1. Add this bundle to your vendor/ dir using the vendors script:, _(*2)

   Add the following to your composer.json:, _(*3)

   "rgsystemes/uservoice-bundle": "dev-master"

   and run:, _(*4)

   php composer.phar install

   The bundle is compatible with Symfony 2.0 upwards., _(*5)

2. Add this bundle to your application's kernel:, _(*6)

   // app/AppKernel.php
   public function registerBundles()
   {
       return array(
           // ...
           new RG\UserVoiceBundle\RGUserVoiceBundle(),
           // ...
       );
   }

3. Configure the rg_user_voice service in your config.yml:, _(*7)

   rg_user_voice:
       domain: %uservoice_domain%
       sso_key: %uservoice_sso_key%
       widget_key: %uservoice_widget_key%
       primary_color: %uservoice_primary_color%
       link_color: %uservoice_link_color%
       forum_id: %uservoice_forum_id%

That's it for basic configuration., _(*8)

Usage

In your template, you can include the widget:, _(*9)

{% include "UserVoiceBundle::widget.html.twig" %}

In your controllers:, _(*10)

$userVoiceOptions = $this->container->get('rg_uservoice_options');
$userVoiceOptions["disabled"] = !$this->getUser()->getAccount()->isUserVoiceEnabled();

Available UserVoice options:, _(*11)

- disabled: true (default: false)

It is also possible to generate your SSO token from a Twig template:, _(*12)

<a href="http://domain.uservoice.com/knowledgebase?sso={{ rg_uservoice_sso(app.user.name) }}">

Overriding the template

You can override the template used by copying the Resources/views/widget.html.twig file out of the bundle and placing it into app/Resources/RGUserVoiceBundle/views, then customising as you see fit., _(*13)