cakephp-plugin feedback-it

stefanvangastel/feedback-it

Feedback or bugreport (with screenshot!) tab option in your CakePHP application. Data can be posted directly to Mantis, E-mail, Github issues, filesystem, etc.

Table of Contents

• Intro
• Requirements
• Installation and setup
• Usage / Demo
• Examples

, _(*1)

Intro

This CakePHP plugin provides a static feedback tab on the side of the screen that enables website visitor to submit feedback or bugreports. Features pure client-side screenshot function including user-placed highlight / accent., _(*2)

Currently saves the following on form submit:, _(*3)

• Name of sender (optional, can work with AuthComponent)
• E-mail of sender (optional)
• Subject
• Message
• Current URL
• Screenshot of body DOM element
• Browser and browser version
• User OS flavor

Save options include (configurable):, _(*4)

• Filesystem
• Mantis Bugtracker
• GitHub (repo issues)
• Email
• Bitbucket (repo issues)
• Jira
• Redmine

, _(*5)

Requirements

This plugin is CakePHP Security component compatible., _(*6)

Required:, _(*7)

• jQuery

Optional:, _(*8)

• Bootstrap (Bootstrap 2 and 3 compatible)

Includes:, _(*9)

• html2canvas.js by niklasvh

, _(*10)

Installation and Setup

1. Check out a copy of the FeedbackIt CakePHP plugin from the repository using Git :, _(*11)

   git clone http://github.com/stefanvangastel/CakePHP-FeedbackIt.git, _(*12)

   or download the archive from Github:, _(*13)

   https://github.com/stefanvangastel/CakePHP-FeedbackIt/archive/master.zip, _(*14)

   You must place the FeedbackIt CakePHP plugin within your CakePHP 2.x app/Plugin directory., _(*15)

   or load it with composer:, _(*16)

   "stefanvangastel/feedback-it": "dev-master", _(*17)

2. Load the plugin in app/Config/bootstrap.php:, _(*18)

   CakePlugin::load('FeedbackIt');, _(*19)

3. Copy the default feedbackit-config file:, _(*20)

   Copy ../app/Plugin/FeedbackIt/Config/feedbackit-config.php.default to ../app/Plugin/FeedbackIt/Config/feedbackit-config.php, _(*21)

   And adjust it to your needs., _(*22)

4. Use the feedbackbar element in a view or layout to place the feedback tab on that (or those) pages. It doesn't matter where you place the following line since it uses absolute DOM element positioning., _(*23)

   <?php echo $this->element('FeedbackIt.feedbackbar');?>, _(*24)

, _(*25)

Usage

To testdrive this puppy; http://stefanvangastel.nl/feedbackitdemo/, _(*26)

, _(*27)

Examples

, _(*28)

End, _(*29)