README

DCSRatingBundle为Symfony2添加了评分系统的支持。功能包括

• 您可以使用一行代码为任何页面添加投票。
• 您可以将它与任何用户管理系统（例如FOSUserBundle）集成。
• 您可以为投票设置不同的角色访问权限
• 该bundle使用一个样式表文件，而不使用javascript文件

1) 安装

A) 下载并安装DCSRatingBundle

要安装DCSRatingBundle，请运行以下命令

bash $ php composer.phar require damianociarla/rating-bundle

B) 启用Bundle

在kernel中启用所需的bundles

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
    	// ...
    	new DCS\RatingBundle\DCSRatingBundle(),
	);
}

2) 创建您的投票和评分类

在这个第一个版本中，DCSRatingBundle只支持Doctrine ORM。然而，您必须提供一个具体的投票和评分类。您必须扩展由bundle提供的抽象实体，并创建适当的映射。

评分

<?php
// src/MyProject/MyBundle/Entity/Rating.php

namespace MyProject\MyBundle\Entity;

use DCS\RatingBundle\Entity\Rating as BaseRating;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\ChangeTrackingPolicy("DEFERRED_EXPLICIT")
 */
class Rating extends BaseRating
{
    /**
     * @ORM\Id
     * @ORM\Column(type="string")
     */
    protected $id;

    /**
     * @ORM\OneToMany(targetEntity="MyProject\MyBundle\Entity\Vote", mappedBy="rating")
     */
    protected $votes;
}

投票

<?php
// src/MyProject/MyBundle/Entity/Vote.php

namespace MyProject\MyBundle\Entity;

use DCS\RatingBundle\Entity\Vote as BaseVote;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\ChangeTrackingPolicy("DEFERRED_EXPLICIT")
 */
class Vote extends BaseVote
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @ORM\ManyToOne(targetEntity="MyProject\MyBundle\Entity\Rating", inversedBy="votes")
     * @ORM\JoinColumn(name="rating_id", referencedColumnName="id")
     */
    protected $rating;

    /**
     * @ORM\ManyToOne(targetEntity="MyProject\UserBundle\Entity\User")
     */
    protected $voter;
}

3) 配置您的应用程序

# app/config/config.yml

dcs_rating:
    db_driver: orm
    base_path_to_redirect: / # when the permalink is not configured
    max_value: 5 # maximum value for the vote (stars displayed)
    model:
        rating: MyProject\MyBundle\Entity\Rating
        vote: MyProject\MyBundle\Entity\Vote

4) 导入DCSRatingBundle路由

导入bundle路由

dcs_rating:
    resource: "@DCSRatingBundle/Resources/config/routing.xml"
	prefix:   /

5) 在模板中导入样式表

要导入样式表，请运行以下命令

bash $ php app/console assets:install

并在模板中包含样式表

<link rel="stylesheet" href="{{ asset('bundles/dcsrating/css/rating.css') }}" />

5.1) 通过AJAX启用投票

要通过AJAX投票，您必须在加载jQuery库后包含以下脚本

<script src="{{ asset('bundles/dcsrating/js/rating.js') }}"></script>

6) 显示评分和启用投票

您只能为您所在的页面投票。您不能在您处于不同页面时对页面进行投票。但是，您可以在任何页面上显示页面的评分（只读模式）

显示评分

您可以使用星星显示评分，而不启用投票

{% include 'DCSRatingBundle:Rating:rating.html.twig' with {'id' : 'YOUR_UNIQUE_ID'} %}

如果您的列表中有多个项目并且想要显示每个项目的评分，这很有用。

启用投票

要在页面上启用投票，请使用以下twig代码

{% include 'DCSRatingBundle:Rating:control.html.twig' with {'id' : 'YOUR_UNIQUE_ID'} %}

如果您需要更改特定页面的默认用户角色，请添加role参数

{% include 'DCSRatingBundle:Rating:control.html.twig' with {'id' : 'YOUR_UNIQUE_ID', 'role' : 'ROLE_USER'} %}

如果您需要更改永久链接，请添加permalink参数，否则它将存储当前路由

{% include 'DCSRatingBundle:Rating:control.html.twig' with {'id' : 'YOUR_UNIQUE_ID', 'permalink' : url('YOUR_ROUTE_ID')} %}