/cakephp-feedback

A CakePHP plugin for direct feedback or bugreport (with screenshot!) tab option in your app.

Primary LanguagePHPMIT LicenseMIT

CakePHP Feedback Plugin

CI Coverage Latest Stable Version Minimum PHP Version License Total Downloads

This 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.

This branch is for CakePHP 5.0+. For details see version map.

Currently saves the following on form submit

  • Name of sender (optional)
  • E-mail of sender (optional)
  • Subject
  • Feedback message
  • Current URL
  • Screenshot of body DOM element (with marker as option)
  • Browser and browser version
  • User OS flavor

Name and E-Mail can be auto-retrieved from TinyAuth.AuthUser or plain session Auth.

Save options (configurable and extendable)

Out of the box:

  • Filesystem
  • Database

Easily extendable to:

They can also be stacked (multiple stores at once).

Furthermore

  • This plugin is CakePHP FormProtection component compatible.
  • Fully localizable to your language.

Requirements

Required: jQuery

Optional: Bootstrap (Bootstrap 4/5 compatible)

Includes: html2canvas.js by niklasvh

Installation and Usage

See Documentation.

Demo

https://sandbox.dereuromark.de/

CakePHP 2.x version

This is the original project:

https://github.com/stefanvangastel/CakePHP-FeedbackIt

Website: http://stefanvangastel.nl/feedbackitdemo/