oachoor/rating-bundle

Provides star rating functionality for Symfony3

RatingBundle :star:

This Symfony bundle provides integration of a star rating system., _(*1)

Requirements

• PHP 7.2+
• MySQL 5.7.20+
• Symfony 4.3+

:package: Installation

Install bundle with Composer dependency manager first by running the command:, _(*2)

$ composer req oachoor/rating-bundle, _(*3)

Add routes

``` yaml oa_rating: resource: '@RatingBundle/Controller' type: annotation, <sub>(*4)</sub>

### (Optional) Create your own Entities 

Entities doesn't fully meet your requirements?, then you can create yours based on [Rating](Entity/Rating.php) and [Vote](Entity/Vote.php).

### Resolve abstract Entities with RatingBundle or your custom ones

``` yaml
doctrine:
    orm:
        resolve_target_entities:
            RatingBundle\Model\AbstractVote: RatingBundle\Entity\Vote or AcmeRatingBundle\Entity\Vote
            RatingBundle\Model\AbstractRating: RatingBundle\Entity\Rating or AcmeRatingBundle\Entity\Rating
            Symfony\Component\Security\Core\User\UserInterface: RatingBundle\Entity\User or AcmeRatingBundle\Entity\User

Define mapping Bundle

Make sure you have registered the Bundle that holds the Entities as following:, <sub>(*5)</sub>

``` yaml doctrine: orm: entity_managers: default: mappings: RatingBundle: ~ or AcmeRatingBundle: ~, <sub>(*6)</sub>

### Update database schema

``` bash
$ bin/console doctrine:schema:update --force --no-debug

Using voting strategy

There are two strategies for rating, based on IP addresses or cookies. (both? feel free to contribute), <sub>(*7)</sub>

``` yaml oa_rating: strategy: cookie (default "ip") cookie_name: your_custom_name cookie_lifetime: '+1 year', <sub>(*8)</sub>

### Templates customization 

Templates can be overridden in the `<your-project>/templates/bundles/RatingBundle/` directory, the new templates must use the same name and path (relative to `RatingBundle/Resources/views/`) as the original templates.

To override the `Resources/views/rating/view.html.twig` template, create this template: `<your-project>/templates/bundles/RatingBundle/rating/view.html.twig`

### Usage

To see rating result for a Content (read-only mode), use the following twig code:

``` twig
{{ render( controller( 'RatingBundle:Rating:result', {'contentId': yourContentId} ) ) }}

Rating is based on Content, to enable voting for a Content use the following twig code:, <sub>(*9)</sub>

twig {{ render( controller( 'RatingBundle:Rating:vote', {'contentId': yourContentId} ) ) }}, <sub>(*10)</sub>

Example

A minimal Template that contains rating-call, javascripts and stylesheets., <sub>(*11)</sub>

Todos

• [ ] Make User dependencies optional.
• [ ] Write some Unit Tests.
• [ ] Add Fixtures.