oveleon/contao-recommendation-bundle

Recommendation integration for Contao 4 Open Source CMS

Fund package maintenance!
oveleon

Installs: 1 588

Dependents: 2

Suggesters: 0

Security: 0

Stars: 5

Watchers: 5

Forks: 0

Open Issues: 1

Type:contao-bundle

1.2.1 2022-02-14 20:38 UTC

This package is auto-updated.

Last update: 2022-11-30 12:47:42 UTC


README

The contao recommendation bundle adds recommendations to Contao 4.

Oveleon 68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d3833616130653f7374796c653d666c61742d737175617265 68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6f76656c656f6e2f636f6e74616f2d7265636f6d6d656e646174696f6e2d62756e646c653f636f6c6f723d304137424243267374796c653d666c61742d737175617265


Working with Contao 4.9 and up to Contao 4.13 (PHP ^7.4 and PHP 8)

This plugin adds a new sub-menu Recommendations with recommendation archives and recommendations

Features

  • Compatible with Contao 4.9 and higher versions (PHP 8 Support)
  • Possibility to create multiple recommendation archives
  • Possibility to create recommendation items
  • Frontend- and Backend permissions for archives and items
  • Access protection for modules
  • Recommendation list to display recommendation items
    • Choose multiple archives to display from
    • Filter by rating
    • Pagination
    • Featured recommendations (for sorting)
    • and more
  • Recommendation reader for recommendations
  • Recommendation form to let users submit their recommendations into a specific archive
    • Choose what users can submit
    • Get E-Mail notifications when people submit a recommendation
    • Moderation settings
    • Possibility to add a privacy checkbox
    • Possibility to activate an e-mail verification (opt-in) to verify recommendations
  • No IP-logging
  • Sitemap-Integration
    • Recommendations will be added to the sitemap.xml
  • Automatic purge of non verified recommendations
  • Cache invalidation

Installation

Via composer

composer require oveleon/contao-recommendation-bundle

Via contao-manager

Search for contao recommendation bundle and add it to your extensions.

After installing the contao-recommendation-bundle, you need to run a contao install.

Initial setup

The recommendation bundle is close to the core-bundles of contao cms. If you are familiar using the news- or events bundle, you should be able to set it up without further knowledge.

  1. Create a new archive in Recommendations

    Admin View: Recommendation Archive

  2. Create a new recommendation in your archive and fill out

    • Author
    • Date and time are set automatically but can be changed
    • Recommendation text
    • Choose a Rating (1 to 5)
    • Publish the recommendation

    Admin View: Recommendation

  3. To display your recommendations, you will need a recommendation-list.

    1. Create the front end module recommendation-list
    2. Choose your recommendation archive/s
    3. Choose the meta fields you want to show in your front end
    4. Embed the module in a page

    Admin View: Recommendation List

  4. Setting up colors for your recommendation rating

    • You can go to "settings" within Recommendations (Location of archives) and choose a color for active stars

    Admin View: Recommendation Archive Settings

  5. Setting up a recommendation-reader for a redirect page

    1. Create the front end module recommendation-reader
    2. Choose your recommendation archive/s
    3. Choose the meta fields you want to show in your front end
    4. Embed the module in a page or set it up for your recommendation-list
    5. Set up the redirect page in your recommendation archive/s

    Admin View: Recommendation Reader

Recommendation List on your website Admin View: Recommendation Frontend

Front end modules

Recommendation list

The recommendation list can display published (and verified) recommendations from selected archives.

Settings

Recommendation-List
Option Description
Recommendation archives Here you can select one or more archives to display recommendations from
Recommendation reader module Automatically switches to the recommendation reader if a recommendation has been selected
Minimum rating Filter displayed recommendations based on their rating (e.g. minimum of 3 stars)
Featured items Here you can choose how featured recommendations are handled
Sort order Here you can choose the sort order of recommendations (e.g. by date, rating, random)
Number of items Here you can limit the total number of recommendations that are shown
Items per page Number of recommendations per page - Activates pagination
Meta fields Here you can select meta fields to display
Recommendation template The recommendation template that is being used
Module template The modules template that is being used
Image settings You have the possibility to add pictures to your recommendations. These are the image settings for them
Access protection Show the module for certain member groups only

Recommendation reader

The recommendation list can display published (and verified) recommendations from selected archives.

Settings

Recommendation-Reader
Option Description
Recommendation archives Here you can select one or more archives to read recommendations from
Meta fields Here you can select meta fields to display
Recommendation template The recommendation template that is being used
Module template The modules template that is being used
Image settings You have the possibility to add pictures to your recommendations. These are the image settings for them
Access protection Show the module for certain member groups only

Recommendation form

The recommendation form can be used to let your visitors submit recommendations on your website. These recommendations will be saved in a preconfigured archive.

Settings

Recommendation-Form
Option Description
Recommendation archive Here you can select the archive that will save the submitted recommendations
Optional recommendation fields Here you can select one or more fields that will be added to the form. Author, rating and text are always mandatory.
E-Mail notifications Enable notifying the administrator when a recommendation has been submitted
Moderate If true, recommendations need to be published before appearing on the website.
Disable spam protection Disables the spam protection for the recommendation form
Data security Here you can add a label for a checkbox to make the recommendation form GDPR compliant. A checkbox will appear if you add any text.
Redirect page A redirect page to which visitors will be redirected after submitting the form
Send activation e-mail Enable e-mail opt-in verification for verifying submitted recommendations
Confirmation page A redirect page to which visitors will be redirected after clicking on the confirmation link
Activation message The activation message that users receive after submitting a form
Module template The modules template that is being used
Access protection Show the module for certain member groups only

Sitemap

Recommendation archives that are not protected and have a jumpTo page will add their published recommendations to your sitemap.xml. It is recommended to have a title for your recommendations as they are being used to create an alias. If you do not want certain recommendations to be shown on your sitemap, you can unpublish them.

Verified recommendations / GDPR

When adding a privacy text to the recommendation form, it will create a mandatory checkbox that visitors have to accept to submit their forms.

Recommendations that are created in the backend are verified by default. You have the possibility to set up an activation mail in recommendation forms that will be sent to the visitor. The submitted recommendations will not be shown on any list and can not be verified by the administrator. A cronjob will purge the unverified recommendations after 24 hours.

Admin View: Unverified Recommendations

The recommendation form does not save the IP of the user. However, it will save the e-mail-address of a user if they verified their recommendation with the opt-in token.

Example

An example how to style your reviews on your website

Admin View: Recommendation Exammple