https://github.com/vulcandigital/silverstripe-pagefeedback
This module allows you to add a form to any page type for the purpose of accruing feedback about how a user perceives that page.
https://github.com/vulcandigital/silverstripe-pagefeedback
feedback rating silverstripe-4 vote
Last synced: 5 months ago
JSON representation
This module allows you to add a form to any page type for the purpose of accruing feedback about how a user perceives that page.
- Host: GitHub
- URL: https://github.com/vulcandigital/silverstripe-pagefeedback
- Owner: vulcandigital
- License: bsd-3-clause
- Created: 2017-05-02T02:20:05.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-13T12:01:27.000Z (over 3 years ago)
- Last Synced: 2025-10-26T11:25:04.026Z (10 months ago)
- Topics: feedback, rating, silverstripe-4, vote
- Language: PHP
- Size: 35.2 KB
- Stars: 9
- Watchers: 0
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://travis-ci.org/vulcandigital/silverstripe-pagefeedback)
[](https://packagist.org/packages/vulcandigital/silverstripe-pagefeedback)
[](https://packagist.org/packages/vulcandigital/silverstripe-pagefeedback)
[](https://packagist.org/packages/vulcandigital/silverstripe-pagefeedback)
[](https://packagist.org/packages/vulcandigital/silverstripe-pagefeedback)
[](https://packagist.org/packages/vulcandigital/silverstripe-pagefeedback)
# silverstripe-pagefeedback
This module allows you to add a form to any page type for the purpose of accruing feedback about how a user perceives that page.
Commonly found on help desk pages under a label similar to "How helpful did you find this page?".
It allows the user to rate the page out of five (5) and allows them to optionally provide a comment
The users IP address and their PHP Session ID is recorded on a per-page basis so that a user can only submit feedback once for that specific page.
## Requirements
* silverstripe/cms: "^4.0"
## Installation
Installation is supported via composer only:
```
composer require vulcandigital/silverstripe-pagefeedback "^2"
```
## Configuration
This module is predominantly both a `DataExtension` and a `Extension`. You must apply them on the page type(s) and their respective controller(s) where you wish to be able to render the feedback form.
If you wanted to enable it's functionality on all pages you would:
```yml
Page:
extensions:
- Vulcan\PageFeedback\Extensions\PageFeedbackExtensions
PageController:
extensions:
- Vulcan\PageFeedback\Extensions\PageFeedbackControllerExtensions
```
or for a specific page type
```yml
Vulcan\UserDocs\UserDocsPage:
extensions:
- Vulcan\PageFeedback\Extensions\PageFeedbackExtension
Vulcan\UserDocs\UserDocsPageController:
extensions:
- Vulcan\PageFeedback\Extensions\PageFeedbackControllerExtensions
```
## Modes
By default, the mode is set to "form" which will generate a form allowing a user to rate between 1-5 and optionally provide a comment
An alternate mode, "thumbs" is available which will generate a form containing two buttons `+1` and `-1`, which can be beautifully styled:
You can change the mode via YML on the controllers of the pages you desire
```
Vulcan\UserDocs\UserDocsPageController:
pagefeedback_mode: "thumbs"
```
#### Adding the form
In order for the form to show you will need to add `$PageFeedbackForm` into your template, in the location you wish for it to display.
e.g.
```html
$PageFeedbackForm
```
If you wish to hide the form if feedback has already been supplied by the user:
```html
<% if not $GivenFeedback %>
$PageFeedbackForm
<% end_if %>
```
If you wish to display information about the feedback the user has provided:
```html
<% if $GivenFeedback %>
<% with $GivenFeedback %>
<% if not $Rating %>
Rating: $Rating
Comment: $Comment
<% else %>
You gave this page a thumbs $Thumbs
<% end_if %>
<% end_with %>
<% end_if %>
```
## Features
- Adds a "Page Rating" section to the CMS Page Editor
- Adds a "Page Feedback" tab containing a `GridField` of all feedback for that specific page
## Inspiration
The form is provided to you unstyled, but each of the five radio buttons on the form have a class of `pagefeedback-option-n` where `n` is `1` through to `5` for easier customisation (ie swap the radio buttons with smiley faces that have different expressions; sad through to happy)
(inspiration courtesy of shopify docs)
## License
[BSD-3-Clause](LICENSE.md) - [Vulcan Digital Ltd](https://vulcandigital.co.nz)