CMS Kit: Rating System

CMS Kit provides a rating system to to add ratings feature to any kind of resource like blog posts, comments, etc. Here how the rating component looks like on a sample page:

Enabling the Rating Feature

By default, CMS Kit features are disabled. Therefore, you need to enable the features you want, before starting to use it. You can use the Global Feature system to enable/disable CMS Kit features on development time. Alternatively, you can use the ABP's Feature System to disable a CMS Kit feature on runtime.

Check the "How to Install" section of the CMS Kit Module documentation to see how to enable/disable CMS Kit features on development time.

Options

The rating system provides a mechanism to group ratings by entity types. For example, if you want to use the rating system for products, you need to define an entity type named Product and then add ratings under the defined entity type.

CmsKitRatingOptions can be configured in the domain layer, in the ConfigureServices method of your module. Example:

Configure<CmsKitRatingOptions>(options =>
{
    options.EntityTypes.Add(new RatingEntityTypeDefinition("Product"));
});

If you're using the Blogging Feature, the ABP defines an entity type for the blog feature automatically. You can easily override or remove the predefined entity types in Configure method like shown above.

CmsKitRatingOptions properties:

• EntityTypes: List of defined entity types(RatingEntityTypeDefinition) in the rating system.

RatingEntityTypeDefinition properties:

• EntityType: Name of the entity type.

The Rating Widget

The ratings system provides a rating widget to allow users send ratings to resources in public websites. You can simply place the widget on a page like below.

@await Component.InvokeAsync(typeof(RatingViewComponent), new
{
  entityType = "Product",
  entityId = "entityId",
  isReadOnly = false
})

entityType was explained in the previous section. entityId should be the unique id of the product, in this example. If you have a Product entity, you can use its Id here.

Internals

Domain Layer

Aggregates

This module follows the Entity Best Practices & Conventions guide.

Rating

A rating represents a given rating from a user.

• Rating (aggregate root): Represents a given rating in the system.

Repositories

This module follows the Repository Best Practices & Conventions guide.

Following custom repositories are defined for this feature:

• IRatingRepository

Domain services

This module follows the Domain Services Best Practices & Conventions guide.

Reaction Manager

RatingManager is used to perform some operations for the Rating aggregate root.

Application layer

Application services

• RatingPublicAppService (implements IRatingPublicAppService): Implements the use cases of rating system.

Database providers

Common

Table / collection prefix & schema

All tables/collections use the Cms prefix by default. Set static properties on the CmsKitDbProperties class if you need to change the table prefix or set a schema name (if supported by your database provider).

Connection string

This module uses CmsKit for the connection string name. If you don't define a connection string with this name, it fallbacks to the Default connection string.

See the connection strings documentation for details.

Entity Framework Core

Tables

• CmsRatings

MongoDB

Collections

• CmsRatings