2017 © Pedro Peláez
 

october-plugin oc-reviews-plugin

image

vojtasvoboda/oc-reviews-plugin

  • Thursday, April 5, 2018
  • by VojtaSvoboda
  • Repository
  • 3 Watchers
  • 6 Stars
  • 1 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 1 Open issues
  • 6 Versions
  • 0 % Grown

The README.md

Review plugin for OctoberCMS

Build Status Codacy License, (*1)

Show reviews, ratings or testimonials of your customers. No other plugin dependency. Tested with latest OctoberCMS build 389., (*2)

  • reviews management with sort order and bulk actions
  • rating by stars, sorting to categories
  • component build with HTML5 markup using <figure> and <cite>
  • internal methods for creating new reviews, get approved reviews etc.

Show reviews

Just place component Reviews to your page., (*3)

[reviews]
==
{% if reviews is not empty %}
<div class="reviews">
    <h3>What our customers say about us?</h3>
    <div class="stories">
        {% component 'reviews' %}
    </div>
</div>
{% endif %}

Dependencies

This plugin using https://fontawesome.com/ classes to show stars at Reviews front-end component. You have to include this library or override Reviews component to use your own icons., (*4)

Public facade

You can use plugin's facade vojtasvoboda.reviews.facade with this public methods:, (*5)

$facade = App::make('vojtasvoboda.reviews.facade');
$facade->storeReview(array $data);
$facade->getApprovedReviews();
$facede->getNonApprovedReviews();
$facade->findOne($value, $key);

When using storeReview, check Review validation rules has to be satisfied., (*6)

TODO

  • [ ] frontend form for adding new review
  • [ ] config for stars order (ltr, rtl)
  • [ ] config for number of stars
  • [ ] avarage reviews graph (above the reviews listing)
  • [ ] graph of non approved reviews
  • [ ] email when new review created and needs to be approved

Contributing

Please send Pull Request to the master branch., (*7)

License

Reviews plugin is open-sourced software licensed under the MIT license same as OctoberCMS platform., (*8)

The Versions

05/04 2018

1.0.1

1.0.1.0

  Sources   Download

10/01 2017

dev-master

9999999-dev https://github.com/vojtasvoboda/oc-reviews-plugin

Reviews plugin for OctoberCMS

  Sources   Download

MIT

The Requires

 

by Vojta Svoboda

plugin october reviews

30/12 2016

1.0.5

1.0.5.0 https://github.com/vojtasvoboda/oc-reviews-plugin

Reviews plugin for OctoberCMS

  Sources   Download

MIT

The Requires

 

by Vojta Svoboda

plugin october reviews

30/12 2016

1.0.4

1.0.4.0 https://github.com/vojtasvoboda/oc-reviews-plugin

Reviews plugin for OctoberCMS

  Sources   Download

MIT

The Requires

 

by Vojta Svoboda

plugin october reviews

30/12 2016

1.0.3

1.0.3.0 https://github.com/vojtasvoboda/oc-reviews-plugin

Reviews plugin for OctoberCMS

  Sources   Download

MIT

The Requires

 

by Vojta Svoboda

plugin october reviews

20/12 2016

1.0.2

1.0.2.0 https://github.com/vojtasvoboda/oc-reviews-plugin

Reviews plugin for OctoberCMS

  Sources   Download

MIT

The Requires

 

by Vojta Svoboda

plugin october reviews