nopDocs - MenuModelFactory.cs

nopCommerce v4.90.1
No results found.

Try your search with a different keyword or use * as a wildcard.
MenuModelFactory.cs

using System.util;
using Microsoft.AspNetCore.Mvc.Rendering;
using Nop.Core;
using Nop.Core.Domain.Catalog;
using Nop.Core.Domain.Menus;
using Nop.Core.Http;
using Nop.Services;
using Nop.Services.Catalog;
using Nop.Services.Localization;
using Nop.Services.Menus;
using Nop.Services.Messages;
using Nop.Services.Topics;
using Nop.Services.Vendors;
using Nop.Web.Areas.Admin.Infrastructure.Mapper.Extensions;
using Nop.Web.Areas.Admin.Models.Menus;
using Nop.Web.Framework.Extensions;
using Nop.Web.Framework.Factories;
using Nop.Web.Framework.Models.Extensions;

namespace Nop.Web.Areas.Admin.Factories;

/// 
/// Represents the menu model factory implementation
/// 
public partial class MenuModelFactory : IMenuModelFactory
{
    #region Fields

    protected readonly CatalogSettings _catalogSettings;
    protected readonly IBaseAdminModelFactory _baseAdminModelFactory;
    protected readonly ICategoryService _categoryService;
    protected readonly ILocalizationService _localizationService;
    protected readonly ILocalizedModelFactory _localizedModelFactory;
    protected readonly IManufacturerService _manufacturerService;
    protected readonly IMenuService _menuService;
    protected readonly INotificationService _notificationService;
    protected readonly IProductService _productService;
    protected readonly IStoreMappingSupportedModelFactory _storeMappingSupportedModelFactory;
    protected readonly ITopicService _topicService;
    protected readonly IVendorService _vendorService;
    protected readonly MenuSettings _menuSettings;

    #endregion

    #region Ctor

    public MenuModelFactory(
        CatalogSettings catalogSettings,
        IBaseAdminModelFactory baseAdminModelFactory,
        ICategoryService categoryService,
        ILocalizationService localizationService,
        ILocalizedModelFactory localizedModelFactory,
        IManufacturerService manufacturerService,
        IMenuService menuService,
        INotificationService notificationService,
        IProductService productService,
        IStoreMappingSupportedModelFactory storeMappingSupportedModelFactory,
        ITopicService topicService,
        IVendorService vendorService,
        MenuSettings menuSettings)
    {
        _catalogSettings = catalogSettings;
        _baseAdminModelFactory = baseAdminModelFactory;
        _categoryService = categoryService;
        _localizationService = localizationService;
        _localizedModelFactory = localizedModelFactory;
        _manufacturerService = manufacturerService;
        _menuService = menuService;
        _notificationService = notificationService;
        _productService = productService;
        _storeMappingSupportedModelFactory = storeMappingSupportedModelFactory;
        _topicService = topicService;
        _vendorService = vendorService;
        _menuSettings = menuSettings;
    }

    #endregion

    #region Utilities

    /// 
    /// Get breadcrumb for menu item
    /// 
    /// Menu item
    /// All menu items
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains menu item breadcrumb 
    /// 
    protected virtual async Task GetMenuItemBreadcrumbAsync(MenuItem item, IEnumerable allItems)
    {
        var titles = new List();
        var current = item;

        while (current is not null)
        {
            var entityId = current.EntityId ?? 0;

            titles.Insert(0, current.MenuItemType switch
            {
                MenuItemType.Vendor => (await _vendorService.GetVendorByIdAsync(entityId))?.Name,
                MenuItemType.Category => (await _categoryService.GetCategoryByIdAsync(entityId))?.Name,
                MenuItemType.TopicPage => (await _topicService.GetTopicByIdAsync(entityId))?.Title,
                MenuItemType.Product => (await _productService.GetProductByIdAsync(entityId))?.Name,
                MenuItemType.Manufacturer => (await _manufacturerService.GetManufacturerByIdAsync(entityId))?.Name,
                _ => null
            } ?? current.Title);

            current = allItems.FirstOrDefault(x => x.Id == current.ParentId);
        }

        return string.Join(" >> ", titles);
    }

    /// 
    /// Initialize an entity identifier of the menu item model
    /// 
    /// Menu item model
    /// Entity identifier
    /// 
    /// A task that represents the asynchronous operation
    /// 
    protected virtual async Task InitMenuItemModelEntityIdAsync(MenuItemModel model, int entityId)
    {
        ArgumentOutOfRangeException.ThrowIfZero(entityId);

        try
        {
            switch ((MenuItemType)model.MenuItemTypeId)
            {
                case MenuItemType.Product:
                {
                    var product = await _productService.GetProductByIdAsync(entityId);

                    if (product is null || product.Deleted)
                        throw new NopException("Product not found");

                    model.ProductName = product.Name;
                    model.ProductId = product.Id;
                    break;
                }
                case MenuItemType.TopicPage:
                {
                    var topic = await _topicService.GetTopicByIdAsync(entityId) ?? throw new NopException("Topic not found");
                    model.TopicId = topic.Id;
                    break;
                }
                case MenuItemType.Category:
                {
                    var category = await _categoryService.GetCategoryByIdAsync(entityId);

                    if (category is null || category.Deleted)
                        throw new NopException("Category not found");

                    model.CategoryId = category.Id;
                    break;
                }
                case MenuItemType.Vendor:
                {
                    var vendor = await _vendorService.GetVendorByIdAsync(entityId);

                    if (vendor is null || vendor.Deleted)
                        throw new NopException("Manufacturer not found");

                    model.VendorId = vendor.Id;
                    break;
                }
                case MenuItemType.Manufacturer:
                {
                    var manufacturer = await _manufacturerService.GetManufacturerByIdAsync(entityId);

                    if (manufacturer is null || manufacturer.Deleted)
                        throw new NopException("Manufacturer not found");

                    model.ManufacturerId = manufacturer.Id;
                    break;
                }
                default:
                    break;
            }
        }
        catch (NopException ex)
        {
            _notificationService.WarningNotification(ex.Message);
        }
    }

    #region Select lists

    /// 
    /// Prepare available menu items
    /// 
    /// Menu item model
    /// Number of menu levels
    /// List for adding menu items
    /// 
    /// A task that represents the asynchronous operation
    /// 
    protected virtual async Task PrepareModelAvailableParentMenuItemsAsync(MenuItemModel menuItemModel, int depth, IList menuItemsToAdd)
    {
        var items = await _menuService.GetAllMenuItemsAsync(menuId: menuItemModel.MenuId, treeSorting: true, showHidden: true);
        menuItemsToAdd.Add(new SelectListItem { Text = await _localizationService.GetResourceAsync("Admin.Common.No"), Value = string.Empty });

        if (menuItemModel.Id > 0 && childrenLevels(items, menuItemModel.Id) >= _menuSettings.MaximumMainMenuLevels - 1)
            return;

        var availableParents = _menuService
            .FilterMenuItemsByDepth(items, depthLimit: depth - 1)
            .Where(item => item.ParentId != item.Id && item.Id != menuItemModel.Id);

        foreach (var item in availableParents)
        {
            menuItemsToAdd.Add(new SelectListItem { Value = item.Id.ToString(), Text = await GetMenuItemBreadcrumbAsync(item, items) });
        }

        int childrenLevels(IEnumerable elements, int parentId, HashSet visited = null)
        {
            visited ??= new HashSet();

            if (!visited.Add(parentId))
                return 0;

            var children = elements.Where(x => x.ParentId == parentId).ToList();

            if (!children.Any())
                return 0;

            var maxChildDepth = 0;
            foreach (var child in children)
            {
                var childDepth = childrenLevels(elements, child.Id, visited);
                if (childDepth > maxChildDepth)
                    maxChildDepth = childDepth;
            }

            return maxChildDepth + 1;
        }
    }

    /// 
    /// Prepare topic list
    /// 
    /// List to add available topics
    /// 
    /// A task that represents the asynchronous operation
    /// 
    protected virtual async Task PrepareAvailableTopicsAsync(IList items)
    {
        ArgumentNullException.ThrowIfNull(items);

        //get topics
        var topics = await _topicService.GetAllTopicsAsync(storeId: 0, showHidden: true);

        var availableTopics = topics.Select(t => new SelectListItem
        {
            Text = !string.IsNullOrEmpty(t.SystemName) ? t.SystemName : t.Title,
            Value = t.Id.ToString()
        }).ToList();

        items.AddRange(availableTopics);
    }

    #endregion

    #endregion

    #region Methods

    #region Menus

    /// 
    /// Prepare menu search model
    /// 
    /// Menu search model
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains the menu search model
    /// 
    public virtual Task PrepareMenuSearchModelAsync(MenuSearchModel searchModel)
    {
        ArgumentNullException.ThrowIfNull(searchModel);

        //prepare page parameters
        searchModel.SetGridPageSize();

        return Task.FromResult(searchModel);
    }

    /// 
    /// Prepare paged menu list model
    /// 
    /// Menu search model
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains the menu list model
    /// 
    public virtual async Task PrepareMenuListModelAsync(MenuSearchModel searchModel)
    {
        var menus = await _menuService.GetAllMenusAsync(pageIndex: searchModel.Page - 1, pageSize: searchModel.PageSize, showHidden: true);

        //prepare list model
        return await new MenuListModel().PrepareToGridAsync(searchModel, menus, () =>
        {
            //fill in model values from the entity
            return menus.SelectAwait(async menu =>
            {
                var model = menu.ToModel();
                model.MenuTypeName = await _localizationService.GetLocalizedEnumAsync((MenuType)model.MenuTypeId);

                return model;
            });
        });
    }

    /// 
    /// Prepare menu model
    /// 
    /// Menu model
    /// Menu
    /// Whether to exclude populating of some properties of model
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains the menu model
    /// 
    public virtual async Task PrepareMenuModelAsync(MenuModel model, Menu menu, bool excludeProperties = false)
    {
        Func localizedModelConfiguration = null;

        if (menu != null)
        {
            if (model == null)
                model = menu.ToModel();

            //define localized model configuration action
            localizedModelConfiguration = async (locale, languageId) =>
            {
                locale.Name = await _localizationService.GetLocalizedAsync(menu, entity => entity.Name, languageId, false, false);
            };

            model.MenuItemSearchModel = await PrepareMenuItemSearchModelAsync(new MenuItemSearchModel { MenuId = menu.Id });
        }

        //prepare model stores
        await _storeMappingSupportedModelFactory.PrepareModelStoresAsync(model, menu, excludeProperties);
        model.AvailableMenuTypes = (await MenuType.Footer.ToSelectListAsync(false)).ToList();

        //prepare localized models
        if (!excludeProperties)
            model.Locales = await _localizedModelFactory.PrepareLocalizedModelsAsync(localizedModelConfiguration);

        return model;
    }

    #endregion

    #region Menu items

    /// 
    /// Prepare menu items search model
    /// 
    /// Menu item search model
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains the menu item search model
    /// 
    public virtual Task PrepareMenuItemSearchModelAsync(MenuItemSearchModel searchModel)
    {
        ArgumentNullException.ThrowIfNull(searchModel);

        //prepare page parameters
        searchModel.SetGridPageSize();

        return Task.FromResult(searchModel);
    }

    /// 
    /// Prepare paged menu item list model
    /// 
    /// Menu item search model
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains the menu item list model
    /// 
    public virtual async Task PrepareMenuItemListModelAsync(MenuItemSearchModel searchModel)
    {
        var allItems = await _menuService.GetAllMenuItemsAsync(menuId: searchModel.MenuId, treeSorting: true, showHidden: true);

        var itemsPaged = allItems.ToPagedList(searchModel);

        //prepare list model
        return await new MenuItemListModel().PrepareToGridAsync(searchModel, itemsPaged, () =>
        {
            //fill in model values from the entity
            return itemsPaged.SelectAwait(async menuItem =>
            {
                var model = menuItem.ToModel();

                model.Breadcrumb = await GetMenuItemBreadcrumbAsync(menuItem, allItems);
                model.MenuItemTypeName = await _localizationService.GetLocalizedEnumAsync((MenuItemType)model.MenuItemTypeId);

                return model;
            });
        });
    }

    /// 
    /// Prepare menu item model
    /// 
    /// Menu
    /// Menu item model
    /// Menu item
    /// Whether to exclude populating of some properties of model
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains the menu item model
    /// 
    public virtual async Task PrepareMenuItemModelAsync(Menu menu, MenuItemModel model, MenuItem menuItem, bool excludeProperties = false)
    {
        ArgumentNullException.ThrowIfNull(menu);
        Func localizedModelConfiguration = null;

        if (menuItem != null)
        {
            if (model == null)
                model = menuItem.ToModel();

            //define localized model configuration action
            localizedModelConfiguration = async (locale, languageId) =>
            {
                locale.Title = await _localizationService.GetLocalizedAsync(menuItem, entity => entity.Title, languageId, false, false);
            };

            if (menuItem.EntityId is int entityId && entityId > 0)
                await InitMenuItemModelEntityIdAsync(model, entityId);
        }
        else
        {
            model.MenuId = menu.Id;
            model.Published = true;
            model.MaximumNumberEntities = _menuSettings.MaximumNumberEntities;
            model.NumberOfSubItemsPerGridElement = _menuSettings.NumberOfSubItemsPerGridElement;
            model.NumberOfItemsPerGridRow = _menuSettings.NumberOfItemsPerGridRow;
        }

        var isMainMenu = menu.MenuType == MenuType.Main;
        if (isMainMenu)
        {
            model.AvailableMenuItemTemplates.AddRange(await MenuItemTemplate.Simple.ToSelectListAsync(false));
            await PrepareModelAvailableParentMenuItemsAsync(model, _menuSettings.MaximumMainMenuLevels, model.AvailableMenuItems);
        }

        model.AvailableMenuItemTypes = (await MenuItemType.StandardPage.ToSelectListAsync(false)).ToList();
        model.AvailableStandardRoutes = await model.AvailableStandardRoutes.ConstantsToSelectListAsync(typeof(NopRouteNames.General), sortItems: true);

        await PrepareAvailableTopicsAsync(model.AvailableTopics);
        await _storeMappingSupportedModelFactory.PrepareModelStoresAsync(model, menuItem, excludeProperties);
        await _baseAdminModelFactory.PrepareCategoriesAsync(model.AvailableCategories, isMainMenu);
        await _baseAdminModelFactory.PrepareManufacturersAsync(model.AvailableManufacturers, isMainMenu);
        await _baseAdminModelFactory.PrepareVendorsAsync(model.AvailableVendors, isMainMenu);

        //prepare localized models
        if (!excludeProperties)
            model.Locales = await _localizedModelFactory.PrepareLocalizedModelsAsync(localizedModelConfiguration);

        return model;
    }

    #region Products popup

    /// 
    /// Prepare product search model
    /// 
    /// Product search model
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains the product search model
    /// 
    public virtual async Task PrepareMenuItemSelectProductSearchModelAsync(SelectMenuItemProductSearchModel searchModel)
    {
        ArgumentNullException.ThrowIfNull(searchModel);

        //prepare available stores
        await _baseAdminModelFactory.PrepareStoresAsync(searchModel.AvailableStores);

        searchModel.HideStoresList = _catalogSettings.IgnoreStoreLimitations || searchModel.AvailableStores.SelectionIsNotPossible();

        //prepare page parameters
        searchModel.SetGridPageSize();

        return searchModel;
    }

    /// 
    /// Prepare product list model
    /// 
    /// Product search model
    /// 
    /// A task that represents the asynchronous operation
    /// The task result contains the product list model
    /// 
    public virtual async Task PrepareMenuItemSelectProductListModelAsync(SelectMenuItemProductSearchModel searchModel)
    {
        ArgumentNullException.ThrowIfNull(searchModel);

        //get categories
        var products = await _productService.SearchProductsAsync(keywords: searchModel.SearchKeywords,
            showHidden: true,
            storeId: searchModel.SearchStoreId,
            pageIndex: searchModel.Page - 1, pageSize: searchModel.PageSize);

        //prepare grid model
        return new SelectMenuItemProductListModel().PrepareToGrid(searchModel, products, () =>
        {
            return products.Select(product => new SelectMenuItemProductModel
            {
                Id = product.Id,
                Name = product.Name,
                Published = product.Published
            });
        });
    }

    #endregion

    #endregion

    #endregion
}
No results found.

MenuModelFactory.cs
