sfUserVoicePlugin - 1.0.1

This plugin is an interface to uservoice.com

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to the Plugins Home

Signin


Forgot your password?
Create an account

Tools

Stats

advanced search
Information Readme Releases Changelog Contribute
Show source

The sfUserVoicePlugin is an interface to uservoice.com feedback. It allows 'feedback' popup tab fetched from uservoice.com website.

Prerequisites

This plugin for symfony 1.3/1.4. Uservoice.com requires registration on it's site to get user id and host data. As for today there is one free plan that can be used to kick starting. More info at [http://uservoice.com/plans]

Installation

1 - Install the plugin.

The easiest way to install sfUserVoicePlugin is to use the symfony command line:

> php symfony plugin:install sfUserVoicePlugin

However recommended method is to fork the latest package from my git hub [https://github.com/zdanozdan/sfUserVoicePluing]

2 - Register feedback on uservoice.com and get key, host and forum parameters.

3 - Configure app.yml

sf_user_voice_plugin: key: my key from uservoice host: my serive address on uservoice forum: my forum id

Those 3 are required to put in user app.yml config. Plugin however have more params to config in plugin/config directory and they can be user do further configure the plugin but they have default values

  >  sf_user_voice_plugin:
  >    key:                  
  >    host: 
  >    forum:
  >    alignment:              right    
  >    background_color:       f00 
  >    text_color:             white
  >    hover_color:            06c
  >    show_tab:               true
  >    lang:                   en
  >    params:                 
  >    no_dialog:              false

4 - Clear the cache to enable the autoloading to find the new classes:

> php symfony cc

5 - Use helper to display javascript

In the template you can use UserVoiceHelper do bind popup feedback

use_helper('UserVoice'); echo add_user_voice($sf_user->getCulture())

User voice should be added before element so probably the best place would be layout.php (and every layout you want to display user voice feedback

 > <body>
 > HTML code here
 > <p>this is apps/frontend/templates/layout.php</p>
 > <?php use_helper('UserVoice'); ?>
 > <?php include_javascripts() ?>
 > <?php echo add_user_voice($sf_user->getCulture()) ?>
 > </body>

TODO

  • add some testing