Skip to content

Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.

Allow to filtering by rating on catalog page

support877eee1d7bbc
diff --git a/src/Business/Grand.Business.System/Services/Installation/InstallDataSettings.cs b/src/Business/Grand.Business.System/Services/Installation/InstallDataSettings.cs
index 89fd595e1..7fcb99cb0 100644
--- a/src/Business/Grand.Business.System/Services/Installation/InstallDataSettings.cs
+++ b/src/Business/Grand.Business.System/Services/Installation/InstallDataSettings.cs
@@ -193,6 +193,7 @@ namespace Grand.Business.System.Services.Installation
ProductReviewsMustBeApproved = false,
DefaultProductRatingValue = 5,
AllowAnonymousUsersToReviewProduct = false,
+ FilterProductRating = "4.6,4.7,4.8,4.9,5",
ProductReviewPossibleOnlyAfterPurchasing = false,
ProductReviewPossibleOnlyOnce = false,
NotifyStoreOwnerAboutNewProductReviews = false,
diff --git a/src/Core/Grand.Domain/Catalog/CatalogSettings.cs b/src/Core/Grand.Domain/Catalog/CatalogSettings.cs
index a9e914dcc..19dea8f2e 100644
--- a/src/Core/Grand.Domain/Catalog/CatalogSettings.cs
+++ b/src/Core/Grand.Domain/Catalog/CatalogSettings.cs
@@ -129,6 +129,11 @@ namespace Grand.Domain.Catalog
/// </summary>
public bool NotifyStoreOwnerAboutNewProductReviews { get; set; }
+ /// <summary>
+ /// Gets or sets a value the filtering by product review
+ /// </summary>
+ public string FilterProductRating { get; set; }
+
/// <summary>
/// Gets or sets a value indicating whether product 'Email a friend' feature is enabled
/// </summary>
diff --git a/src/Web/Grand.Web.Admin/Areas/Admin/Views/Setting/Partials/Catalog.TabProductReviews.cshtml b/src/Web/Grand.Web.Admin/Areas/Admin/Views/Setting/Partials/Catalog.TabProductReviews.cshtml
index 640f6ac36..d9f8de534 100644
--- a/src/Web/Grand.Web.Admin/Areas/Admin/Views/Setting/Partials/Catalog.TabProductReviews.cshtml
+++ b/src/Web/Grand.Web.Admin/Areas/Admin/Views/Setting/Partials/Catalog.TabProductReviews.cshtml
@@ -71,5 +71,14 @@
<span asp-validation-for="DefaultProductRatingValue"></span>
</div>
</div>
+ <div class="form-group">
+ <div class="col-8 col-md-4 col-sm-4 text-right">
+ <admin-label asp-for="FilterProductRating" class="control-label" />
+ </div>
+ <div class="col-2 col-md-2 col-sm-2">
+ <admin-input asp-for="FilterProductRating" />
+ <span asp-validation-for="FilterProductRating"></span>
+ </div>
+ </div>
</div>
</div>
\ No newline at end of file
diff --git a/src/Web/Grand.Web.Admin/Models/Settings/CatalogSettingsModel.cs b/src/Web/Grand.Web.Admin/Models/Settings/CatalogSettingsModel.cs
index 61fe336f7..bc3971bc6 100644
--- a/src/Web/Grand.Web.Admin/Models/Settings/CatalogSettingsModel.cs
+++ b/src/Web/Grand.Web.Admin/Models/Settings/CatalogSettingsModel.cs
@@ -76,6 +76,9 @@ namespace Grand.Web.Admin.Models.Settings
[GrandResourceDisplayName("Admin.Settings.Catalog.NotifyStoreOwnerAboutNewProductReviews")]
public bool NotifyStoreOwnerAboutNewProductReviews { get; set; }
+
+ [GrandResourceDisplayName("Admin.Settings.Catalog.FilterProductRating")]
+ public string FilterProductRating { get; set; }
[GrandResourceDisplayName("Admin.Settings.Catalog.EmailAFriendEnabled")]
public bool EmailAFriendEnabled { get; set; }
diff --git a/src/Web/Grand.Web/App_Data/Resources/DefaultLanguage.xml b/src/Web/Grand.Web/App_Data/Resources/DefaultLanguage.xml
index 72e0db8d7..d72599658 100644
--- a/src/Web/Grand.Web/App_Data/Resources/DefaultLanguage.xml
+++ b/src/Web/Grand.Web/App_Data/Resources/DefaultLanguage.xml
@@ -10011,6 +10011,9 @@
<Resource Name="Admin.Settings.Catalog.EmailAFriendEnabled" Area="Admin">
<Value>'Email a friend' enabled</Value>
</Resource>
+ <Resource Name="Admin.Settings.Catalog.FilterProductRating" Area="Admin">
+ <Value>Filtering by product rating - options (comma separator, e.g: 4.8,4.9,5)</Value>
+ </Resource>
<Resource Name="Admin.Settings.Catalog.General" Area="Admin">
<Value>General</Value>
</Resource>
@@ -12572,6 +12575,9 @@
<Resource Name="Catalog.PageSize.PerPage" Area="Front">
<Value>per page</Value>
</Resource>
+ <Resource Name="Catalog.Rating" Area="Front">
+ <Value>Product rating</Value>
+ </Resource>
<Resource Name="Catalog.Selectors.Fiters" Area="Front">
<Value>Filters</Value>
</Resource>
diff --git a/src/Web/Grand.Web/App_Data/Resources/Upgrade/en_210.xml b/src/Web/Grand.Web/App_Data/Resources/Upgrade/en_210.xml
index 2b2f588e0..8a1208049 100644
--- a/src/Web/Grand.Web/App_Data/Resources/Upgrade/en_210.xml
+++ b/src/Web/Grand.Web/App_Data/Resources/Upgrade/en_210.xml
@@ -78,4 +78,10 @@
<Resource Name="Enums.Grand.Domain.Catalog.ProductSortingEnum.Rating" Area="Common">
<Value>Rating</Value>
</Resource>
+ <Resource Name="Admin.Settings.Catalog.FilterProductRating" Area="Admin">
+ <Value>Filtering by product rating - options (comma separator, e.g: 4.8,4.9,5)</Value>
+ </Resource>
+ <Resource Name="Catalog.Rating" Area="Front">
+ <Value>Product rating</Value>
+ </Resource>
</Language>
\ No newline at end of file
diff --git a/src/Web/Grand.Web/Features/Handlers/Catalog/GetCategoryHandler.cs b/src/Web/Grand.Web/Features/Handlers/Catalog/GetCategoryHandler.cs
index fe8e475fc..edf4e130b 100644
--- a/src/Web/Grand.Web/Features/Handlers/Catalog/GetCategoryHandler.cs
+++ b/src/Web/Grand.Web/Features/Handlers/Catalog/GetCategoryHandler.cs
@@ -192,7 +192,8 @@ namespace Grand.Web.Features.Handlers.Catalog
VisibleIndividuallyOnly = true,
FeaturedProducts = _catalogSettings.IncludeFeaturedProductsInNormalLists ? null : false,
FilteredSpecs = alreadyFilteredSpecOptionIds,
- OrderBy = (ProductSortingEnum)request.Command.OrderBy,
+ OrderBy = (ProductSortingEnum)request.Command.OrderBy!,
+ Rating = request.Command.Rating,
PageIndex = request.Command.PageNumber - 1,
PageSize = request.Command.PageSize
}, cancellationToken);
diff --git a/src/Web/Grand.Web/Features/Handlers/Catalog/GetViewSortSizeOptionsHandler.cs b/src/Web/Grand.Web/Features/Handlers/Catalog/GetViewSortSizeOptionsHandler.cs
index 64e78be26..0d5a7e910 100644
--- a/src/Web/Grand.Web/Features/Handlers/Catalog/GetViewSortSizeOptionsHandler.cs
+++ b/src/Web/Grand.Web/Features/Handlers/Catalog/GetViewSortSizeOptionsHandler.cs
@@ -8,28 +8,32 @@ using MediatR;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Http.Extensions;
using Microsoft.AspNetCore.Mvc.Rendering;
+using NUglify.Helpers;
namespace Grand.Web.Features.Handlers.Catalog
{
- public class GetViewSortSizeOptionsHandler : IRequestHandler<GetViewSortSizeOptions, (CatalogPagingFilteringModel pagingFilteringModel, CatalogPagingFilteringModel command)>
+ public class GetViewSortSizeOptionsHandler : IRequestHandler<GetViewSortSizeOptions, (CatalogPagingFilteringModel
+ pagingFilteringModel, CatalogPagingFilteringModel command)>
{
private readonly ITranslationService _translationService;
private readonly IHttpContextAccessor _httpContextAccessor;
private readonly CatalogSettings _catalogSettings;
- public GetViewSortSizeOptionsHandler(ITranslationService translationService, CatalogSettings catalogSettings, IHttpContextAccessor httpContextAccessor)
+ public GetViewSortSizeOptionsHandler(ITranslationService translationService, CatalogSettings catalogSettings,
+ IHttpContextAccessor httpContextAccessor)
{
_translationService = translationService;
_catalogSettings = catalogSettings;
_httpContextAccessor = httpContextAccessor;
}
- public async Task<(CatalogPagingFilteringModel pagingFilteringModel, CatalogPagingFilteringModel command)> Handle(GetViewSortSizeOptions request, CancellationToken cancellationToken)
+ public async Task<(CatalogPagingFilteringModel pagingFilteringModel, CatalogPagingFilteringModel command)>
+ Handle(GetViewSortSizeOptions request, CancellationToken cancellationToken)
{
PrepareSortingOptions(request);
PrepareViewModes(request);
PreparePageSizeOptions(request);
-
+ PrepareRatingModes(request);
return await Task.FromResult((request.PagingFilteringModel, request.Command));
}
@@ -41,12 +45,16 @@ namespace Grand.Web.Features.Handlers.Catalog
if (request.Command == null)
throw new ArgumentNullException(nameof(request.Command));
- var allDisabled = _catalogSettings.ProductSortingEnumDisabled.Count == Enum.GetValues(typeof(ProductSortingEnum)).Length;
+ var allDisabled = _catalogSettings.ProductSortingEnumDisabled.Count ==
+ Enum.GetValues(typeof(ProductSortingEnum)).Length;
request.PagingFilteringModel.AllowProductSorting = _catalogSettings.AllowProductSorting && !allDisabled;
var activeOptions = Enum.GetValues(typeof(ProductSortingEnum)).Cast<int>()
.Except(_catalogSettings.ProductSortingEnumDisabled)
- .Select(idOption => new KeyValuePair<int, int>(idOption, _catalogSettings.ProductSortingEnumDisplayOrder.TryGetValue(idOption, out var order) ? order : idOption))
+ .Select(idOption => new KeyValuePair<int, int>(idOption,
+ _catalogSettings.ProductSortingEnumDisplayOrder.TryGetValue(idOption, out var order)
+ ? order
+ : idOption))
.OrderBy(x => x.Value);
request.Command.OrderBy ??= allDisabled ? 0 : activeOptions.First().Key;
@@ -56,7 +64,8 @@ namespace Grand.Web.Features.Handlers.Catalog
var currentPageUrl = _httpContextAccessor.HttpContext?.Request.GetDisplayUrl();
var sortUrl = CommonExtensions.ModifyQueryString(currentPageUrl, "orderby", option.Key.ToString());
- var sortValue = ((ProductSortingEnum)option.Key).GetTranslationEnum(_translationService, request.Language.Id);
+ var sortValue =
+ ((ProductSortingEnum)option.Key).GetTranslationEnum(_translationService, request.Language.Id);
request.PagingFilteringModel.AvailableSortOptions.Add(new SelectListItem {
Text = sortValue,
Value = sortUrl,
@@ -64,9 +73,9 @@ namespace Grand.Web.Features.Handlers.Catalog
});
}
}
+
private void PrepareViewModes(GetViewSortSizeOptions request)
{
-
request.PagingFilteringModel.AllowProductViewModeChanging = _catalogSettings.AllowProductViewModeChanging;
var viewMode = !string.IsNullOrEmpty(request.Command.ViewMode)
@@ -74,7 +83,7 @@ namespace Grand.Web.Features.Handlers.Catalog
: _catalogSettings.DefaultViewMode;
request.PagingFilteringModel.ViewMode = viewMode;
if (!request.PagingFilteringModel.AllowProductViewModeChanging) return;
-
+
var currentPageUrl = _httpContextAccessor.HttpContext?.Request.GetDisplayUrl();
//grid
request.PagingFilteringModel.AvailableViewModes.Add(new SelectListItem {
@@ -89,16 +98,19 @@ namespace Grand.Web.Features.Handlers.Catalog
Selected = viewMode == "list"
});
}
+
private void PreparePageSizeOptions(GetViewSortSizeOptions request)
{
if (request.Command.PageNumber <= 0)
{
request.Command.PageNumber = 1;
}
+
request.PagingFilteringModel.AllowCustomersToSelectPageSize = false;
if (request.AllowCustomersToSelectPageSize && request.PageSizeOptions != null)
{
- var pageSizes = request.PageSizeOptions.Split(new[] { ',', ' ' }, StringSplitOptions.RemoveEmptyEntries);
+ var pageSizes =
+ request.PageSizeOptions.Split(new[] { ',', ' ' }, StringSplitOptions.RemoveEmptyEntries);
if (pageSizes.Any())
{
@@ -122,6 +134,7 @@ namespace Grand.Web.Features.Handlers.Catalog
{
continue;
}
+
if (temp <= 0)
{
continue;
@@ -130,18 +143,21 @@ namespace Grand.Web.Features.Handlers.Catalog
request.PagingFilteringModel.PageSizeOptions.Add(new SelectListItem {
Text = pageSize,
Value = CommonExtensions.ModifyQueryString(pageUrl, "pagesize", pageSize),
- Selected = pageSize.Equals(request.Command.PageSize.ToString(), StringComparison.OrdinalIgnoreCase)
+ Selected = pageSize.Equals(request.Command.PageSize.ToString(),
+ StringComparison.OrdinalIgnoreCase)
});
}
if (request.PagingFilteringModel.PageSizeOptions.Any())
{
- request.PagingFilteringModel.PageSizeOptions = request.PagingFilteringModel.PageSizeOptions.OrderBy(x => int.Parse(x.Text)).ToList();
+ request.PagingFilteringModel.PageSizeOptions = request.PagingFilteringModel.PageSizeOptions
+ .OrderBy(x => int.Parse(x.Text)).ToList();
request.PagingFilteringModel.AllowCustomersToSelectPageSize = true;
if (request.Command.PageSize <= 0)
{
- request.Command.PageSize = int.Parse(request.PagingFilteringModel.PageSizeOptions.FirstOrDefault()!.Text);
+ request.Command.PageSize =
+ int.Parse(request.PagingFilteringModel.PageSizeOptions.FirstOrDefault()!.Text);
}
}
}
@@ -159,5 +175,14 @@ namespace Grand.Web.Features.Handlers.Catalog
}
}
+ private void PrepareRatingModes(GetViewSortSizeOptions request)
+ {
+ if (string.IsNullOrEmpty(_catalogSettings.FilterProductRating)) return;
+ var currentRating = _httpContextAccessor.HttpContext?.Request.Query["rating"];
+ request.PagingFilteringModel.RatingOptions.Add(new SelectListItem("", ""));
+ _catalogSettings.FilterProductRating.Split(',', StringSplitOptions.RemoveEmptyEntries)
+ .Where(x => !string.IsNullOrWhiteSpace(x)).ForEach(x =>
+ request.PagingFilteringModel.RatingOptions.Add(new SelectListItem(x, x, currentRating?.ToString() == x)));
+ }
}
-}
+}
\ No newline at end of file
diff --git a/src/Web/Grand.Web/Models/Catalog/CatalogPagingFilteringModel.cs b/src/Web/Grand.Web/Models/Catalog/CatalogPagingFilteringModel.cs
index 78eaa5e30..7daec1d93 100644
--- a/src/Web/Grand.Web/Models/Catalog/CatalogPagingFilteringModel.cs
+++ b/src/Web/Grand.Web/Models/Catalog/CatalogPagingFilteringModel.cs
@@ -19,6 +19,7 @@ namespace Grand.Web.Models.Catalog
AvailableViewModes = new List<SelectListItem>();
PageSizeOptions = new List<SelectListItem>();
SpecificationFilter = new SpecificationFilterModel();
+ RatingOptions = new List<SelectListItem>();
}
#endregion
@@ -44,6 +45,16 @@ namespace Grand.Web.Models.Catalog
/// </summary>
public int? OrderBy { get; set; }
+ /// <summary>
+ /// Rating
+ /// </summary>
+ public double? Rating { get; set; }
+
+ /// <summary>
+ /// Rating list options
+ /// </summary>
+ public IList<SelectListItem> RatingOptions { get; set; }
+
/// <summary>
/// View mode
/// </summary>
diff --git a/src/Web/Grand.Web/Views/Catalog/Partials/Filtering.cshtml b/src/Web/Grand.Web/Views/Catalog/Partials/Filtering.cshtml
index 03312ad50..3aacc1343 100644
--- a/src/Web/Grand.Web/Views/Catalog/Partials/Filtering.cshtml
+++ b/src/Web/Grand.Web/Views/Catalog/Partials/Filtering.cshtml
@@ -65,4 +65,23 @@
</template>
</div>
</template>
+ @*Rating*@
+ <template v-if="catalog.Model.PagingFilteringContext.RatingOptions.length > 0">
+ <div class="block product-filter product-rating-filter">
+ <div class="card mb-3">
+ <h6 class="h6 card-header">
+ @Loc["Catalog.Rating"]:
+ </h6>
+ <div class="card-body">
+ <select class="custom-select form-control" id="rating" name="rating" v-on:change="catalog.setRating($event.target.value)" aria-label="@Loc["Catalog.Rating"]">
+ <template v-for="item in catalog.Model.PagingFilteringContext.RatingOptions">
+ <option :selected="item.Selected" :value="item.Value" :disabled="false">
+ {{item.Text}}
+ </option>
+ </template>
+ </select>
+ </div>
+ </div>
+ </div>
+ </template>
</template>
\ No newline at end of file
diff --git a/src/Web/Grand.Web/Views/Catalog/Partials/ModelScript.cshtml b/src/Web/Grand.Web/Views/Catalog/Partials/ModelScript.cshtml
index a5604df36..a4ceead09 100644
--- a/src/Web/Grand.Web/Views/Catalog/Partials/ModelScript.cshtml
+++ b/src/Web/Grand.Web/Views/Catalog/Partials/ModelScript.cshtml
@@ -15,6 +15,18 @@
stateurl.searchParams.delete('timestamp');
window.history.replaceState({ path: stateurl.href }, '', stateurl.href);
},
+ setRating(rating) {
+ const url = new URL(window.location.href);
+ if (rating === "") {
+ url.searchParams.delete('rating');
+ }
+ else {
+ url.searchParams.set('rating', rating);
+ }
+ url.searchParams.delete('pagenumber');
+
+ this.loadProducts(url.href);
+ },
getResponse(url) {
url = new URL(url);
url.searchParams.set('timestamp', new Date().getTime());