README

最新版本: 3.3.1
发布日期: 2020-08-23
联系方式: iionly@gmx.de
许可证: GNU 通用公共许可证第2版
版权: (c) iionly (适用于 Elgg 1.8 及以后版本)，Billy Gunn

描述

此插件将为您的网站上的某些视图添加投票小部件，例如博客、页面、书签、文件和群组讨论。默认情况下，投票小部件将显示5颗星，但您可以配置显示的星星数量。您还可以配置是否允许成员更改他们的投票。

安装

1. 如果您已安装了 Elggx Fivestar 插件的先前版本，请在您的网站管理员部分禁用该插件，然后从 Elgg 安装中的 mod 目录删除 elggx_fivestar 文件夹，
2. 将 elggx_fivestar 文件夹复制到您的 Elgg 安装中的 mod 目录，
3. 在您的网站管理员部分启用该插件，
4. 然后配置插件设置。至少需要将评分小部件添加到某些视图，以便 Elggx Fivestar 插件可使用。通过插件设置，您可以添加评分小部件到预定义的默认视图。以下将详细介绍如何为更多视图配置评分小部件。

如何自定义它

在第一次启用 Elggx Fivestar 插件后（或从 Elggx Fivestar < 1.8.0 版本升级后）要将在您的网站上包含评分小部件，您需要在您的网站管理员部分的 Elggx Fivestar 插件设置页面上设置默认视图。点击“设置/重置默认视图”并保存设置。在 elggx_fivestar/lib/functions.php 中已经定义了一些默认视图，其中评分小部件将在您的网站上包含，例如博客、页面和群组讨论。

您还可以自己配置评分小部件应出现的位置。您可以选择定义其他包含小部件的页面上的视图，或从某些页面上删除评分小部件。如果您对任何默认视图不满意并想要删除它，您可以在插件设置页面上通过删除相应的视图来完成此操作。或者，您可以调整 Elggx Fivestar 的 elggx_fivestar/lib/functions.php 中的默认视图（从第152行开始的 elggx_fivestar_defaults() 函数）并然后在设置页面上重置视图。

如果您想向视图添加评分小部件，您也可以通过直接通过设置页面添加视图或在 elggx_fivestar/lib/functions.php 中调整默认视图来完成此操作。您需要了解您想要添加评分小部件的视图的 php/html 代码，以便能够定义正确的位置。已定义的默认视图应提供给您如何工作的想法。

如果您想通过设置页面添加新的视图，则要包含的代码必须以

    elggx_fivestar_view=

后跟用于识别视图的参数。

将评分小部件添加到视图的方法，如定义的默认视图或其他通过设置页面或 elggx_fivestar/lib/functions.php 定义的视图，需要一个独特的HTML或CSS标签来定义评分小部件在相应页面上的位置，无论是此标签之前还是之后。有时，这种方法可能不适合定义评分小部件所需的精确位置。还有一种第二种方法可以将评分小部件添加到视图中，允许精确定位。您需要修改视图的代码以使此方法生效。

只需在插件代码中适当的位置添加以下内容，并相应调整参数。

echo elgg_view("elggx_fivestar/voting", array(
    'entity' => $entity,
    'min' => true,
    'subclass' => 'fivestar_subclass',
    'outerId' => 'fivestar_rating_list',
    'ratingTextClass' => 'fivestar_rating_text'
));

上述代码片段包含了配置投票小部件的所有可能选项。这些是

• 'entity' => $entity：这定义了要投票的实体。变量 $entity 必须在调用投票小部件之前在代码中分配正确的 Elgg 实体。
• 'min' => true：如果设置为 true，投票小部件将只显示投票的星星，而不会显示此实体的当前投票统计信息（投票数和平均投票）。
• 'subclass' => 'fivestar_subclass', 'outerId' => 'fivestar_rating_list', 'ratingTextClass' => 'fivestar_rating_text'：这些选项允许您通过CSS设置配置投票小部件的布局，例如在 Elggx Fivestar 的css文件中定义的设置（在 elggx_fivestar/views/default/elggx_fivestar/css.php）。这些字符串是CSS类别的标识符，您必须在使用之前定义这些类。

在插件代码中包含投票小部件的最简单方法就是只给出要投票的实体作为参数。

    echo elgg_view("elggx_fivestar/voting", array('entity' => $entity));

在这种情况下，使用的是投票小部件的默认CSS布局。仍然，在任何情况下，您都必须将正确的实体分配给变量 $entity。